Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
detect-indent
Advanced tools
The detect-indent npm package is designed to analyze a given piece of text and determine the indentation style used. This can be particularly useful in scenarios where maintaining consistent code formatting is crucial, such as in collaborative coding projects. It can detect both spaces and tabs used for indentation and provide information about the most used indentation type and size.
Detecting indentation from a string
This feature allows you to pass a string of text to the `detectIndent` function, which analyzes the indentation used in the text. It returns an object containing the amount of indentation, the type of indentation (spaces or tabs), and the actual indentation string.
const detectIndent = require('detect-indent');
const code = ' const x = 1;\n const y = 2;';
const indent = detectIndent(code);
console.log(indent); // {amount: 2, type: 'space', indent: ' '}
The indent-string package is used for adding indentation to strings. While detect-indent is focused on detecting and analyzing indentation, indent-string allows you to modify strings by adding a specified amount of indentation. This makes indent-string complementary to detect-indent, as you could detect indentation with one and apply it with the other.
Strip-indent is designed to remove leading indentation from every line in a string. This is somewhat the inverse of what detect-indent does; while detect-indent identifies the indentation style and level, strip-indent removes it entirely. This can be useful in preprocessing text to normalize indentation before further processing or display.
Detect the indentation of code
Pass in a string of any kind of text and get the indentation.
$ npm install --save detect-indent
Here we modify a JSON file while persisting the indentation:
var fs = require('fs');
var detectIndent = require('detect-indent');
/*
{
"ilove": "pizza"
}
*/
var file = fs.readFileSync('foo.json', 'utf8');
// tries to detect the indentation and falls back to a default if it can't
var indent = detectIndent(file).indent || ' ';
var json = JSON.parse(file);
json.ilove = 'unicorns';
fs.writeFileSync('foo.json', JSON.stringify(json, null, indent));
/*
{
"ilove": "unicorns"
}
*/
Accepts a string and returns an object with stats about the indentation:
amount
{number} - Amount of indentation, e.g. 2
type
{string|null} - Type of indentation. Possible values are tab
, space
or null
if no indentation is detectedindent
{string} - Actual indentationThe current algorithm looks for the most common difference between two consecutive non-empty lines.
In the following example, even if the 4-space indentation is used 3 times whereas the 2-space one is used 2 times, it is detected as less used because there were only 2 differences with this value instead of 4 for the 2-space indentation:
html {
box-sizing: border-box;
}
body {
background: gray;
}
p {
line-height: 1.3em;
margin-top: 1em;
text-indent: 2em;
}
Furthermore, if there are more than one most used difference, the indentation with the most lines is selected.
In the following example, the indentation is detected as 4-spaces:
body {
background: gray;
}
p {
line-height: 1.3em;
margin-top: 1em;
text-indent: 2em;
}
MIT © Sindre Sorhus
FAQs
Detect the indentation of code
The npm package detect-indent receives a total of 13,572,979 weekly downloads. As such, detect-indent popularity was classified as popular.
We found that detect-indent demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.