blob: c09ffddcd0ad1f4e2b235c0057995ec70d04ff6d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# detect-indent [](https://travis-ci.org/sindresorhus/detect-indent)
> Detect the indentation of code
Pass in a string of any kind of text and get the indentation.
## Use cases
- Persisting the indentation when modifying a file.
- Have new content match the existing indentation.
- Setting the right indentation in your editor.
## Install
```sh
$ npm install --save detect-indent
```
## Usage
```js
// modify a JSON file while persisting the indentation in Node
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"
}
*/
```
## API
Accepts a string and returns an object with stats about the indentation:
* `amount`: {Number} the amount of indentation, e.g. `2`
* `type`: {String|Null} the type of indentation. Possible values are `tab`, `space` or `null` if no indentation is detected
* `indent`: {String} the actual indentation
## CLI
```sh
$ npm install --global detect-indent
```
```
$ detect-indent --help
Usage
detect-indent <file>
echo <string> | detect-indent
Example
echo ' foo\n bar' | detect-indent | wc --chars
2
```
## Algorithm
The 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:
```css
html {
box-sizing: border-box;
}
body {
background: grey;
}
p {
line-height: 1.3em;
margin-top: 1em;
text-indent: 2em;
}
```
[Source](https://medium.com/@heatherarthur/detecting-code-indentation-eff3ed0fb56b#3918).
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:
```css
body {
background: grey;
}
p {
line-height: 1.3em;
margin-top: 1em;
text-indent: 2em;
}
```
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)
|
