node-detect-indent-5.0.0/000077500000000000000000000000001302040203300151515ustar00rootroot00000000000000node-detect-indent-5.0.0/.editorconfig000066400000000000000000000002761302040203300176330ustar00rootroot00000000000000root = true [*] indent_style = tab end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [{package.json,*.yml}] indent_style = space indent_size = 2 node-detect-indent-5.0.0/.gitattributes000066400000000000000000000000351302040203300200420ustar00rootroot00000000000000* text=auto *.js text eol=lf node-detect-indent-5.0.0/.gitignore000066400000000000000000000000151302040203300171350ustar00rootroot00000000000000node_modules node-detect-indent-5.0.0/.travis.yml000066400000000000000000000000671302040203300172650ustar00rootroot00000000000000sudo: false language: node_js node_js: - '6' - '4' node-detect-indent-5.0.0/fixture/000077500000000000000000000000001302040203300166375ustar00rootroot00000000000000node-detect-indent-5.0.0/fixture/mixed-space.js000066400000000000000000000014001302040203300213670ustar00rootroot00000000000000// devtools-detect // by Sindre Sorhus // MIT License (function (window) { /*global CustomEvent */ 'use strict'; var devtools = window.devtools = { open: false }; var threshold = 150; var emitEvent = function (state) { window.dispatchEvent(new CustomEvent('devtoolschange', { detail: { open: state } })); }; setInterval(function () { if (window.outerWidth - window.innerWidth > threshold || window.outerHeight - window.innerHeight > threshold) { if (!devtools.open) { emitEvent(true); } devtools.open = true; } else { if (devtools.open) { emitEvent(false); } devtools.open = false; } }, 500); })(window); node-detect-indent-5.0.0/fixture/mixed-tab.js000066400000000000000000000012701302040203300210470ustar00rootroot00000000000000// devtools-detect // by Sindre Sorhus // MIT License (function (window) { /*global CustomEvent */ 'use strict'; var devtools = window.devtools = { open: false }; var threshold = 150; var emitEvent = function (state) { window.dispatchEvent(new CustomEvent('devtoolschange', { detail: { open: state } })); }; setInterval(function () { if (window.outerWidth - window.innerWidth > threshold || window.outerHeight - window.innerHeight > threshold) { if (!devtools.open) { emitEvent(true); } devtools.open = true; } else { if (devtools.open) { emitEvent(false); } devtools.open = false; } }, 500); })(window); node-detect-indent-5.0.0/fixture/space.js000066400000000000000000000015021302040203300202660ustar00rootroot00000000000000// devtools-detect // by Sindre Sorhus // MIT License (function (window) { /*global CustomEvent */ 'use strict'; var devtools = window.devtools = { open: false }; var threshold = 150; var emitEvent = function (state) { window.dispatchEvent(new CustomEvent('devtoolschange', { detail: { open: state } })); }; setInterval(function () { if (window.outerWidth - window.innerWidth > threshold || window.outerHeight - window.innerHeight > threshold) { if (!devtools.open) { emitEvent(true); } devtools.open = true; } else { if (devtools.open) { emitEvent(false); } devtools.open = false; } }, 500); })(window); node-detect-indent-5.0.0/fixture/tab-four.js000066400000000000000000000000261302040203300207120ustar00rootroot00000000000000 * four * tabs node-detect-indent-5.0.0/fixture/tab.js000066400000000000000000000012271302040203300177450ustar00rootroot00000000000000// devtools-detect // by Sindre Sorhus // MIT License (function (window) { /*global CustomEvent */ 'use strict'; var devtools = window.devtools = { open: false }; var threshold = 150; var emitEvent = function (state) { window.dispatchEvent(new CustomEvent('devtoolschange', { detail: { open: state } })); }; setInterval(function () { if (window.outerWidth - window.innerWidth > threshold || window.outerHeight - window.innerHeight > threshold) { if (!devtools.open) { emitEvent(true); } devtools.open = true; } else { if (devtools.open) { emitEvent(false); } devtools.open = false; } }, 500); })(window); node-detect-indent-5.0.0/fixture/vendor-prefixed-css.css000066400000000000000000000004331302040203300232400ustar00rootroot00000000000000#leaflet { position: absolute; top: 0; right: 0; bottom: 0; left: 0; -webkit-box-shadow: inset -5px -5px 5px rgba(0, 0, 0, 0.6); -moz-box-shadow: inset -5px -5px 5px rgba(0, 0, 0, 0.6); box-shadow: inset -5px -5px 5px rgba(0, 0, 0, 0.6); } node-detect-indent-5.0.0/index.js000066400000000000000000000042711302040203300166220ustar00rootroot00000000000000'use strict'; // detect either spaces or tabs but not both to properly handle tabs // for indentation and spaces for alignment const INDENT_RE = /^(?:( )+|\t+)/; function getMostUsed(indents) { let result = 0; let maxUsed = 0; let maxWeight = 0; for (const entry of indents) { // TODO: use destructuring when targeting Node.js 6 const key = entry[0]; const val = entry[1]; const u = val[0]; const w = val[1]; if (u > maxUsed || (u === maxUsed && w > maxWeight)) { maxUsed = u; maxWeight = w; result = Number(key); } } return result; } module.exports = str => { if (typeof str !== 'string') { throw new TypeError('Expected a string'); } // used to see if tabs or spaces are the most used let tabs = 0; let spaces = 0; // remember the size of previous line's indentation let prev = 0; // remember how many indents/unindents as occurred for a given size // and how much lines follow a given indentation // // indents = { // 3: [1, 0], // 4: [1, 5], // 5: [1, 0], // 12: [1, 0], // } const indents = new Map(); // pointer to the array of last used indent let current; // whether the last action was an indent (opposed to an unindent) let isIndent; for (const line of str.split(/\n/g)) { if (!line) { // ignore empty lines continue; } let indent; const matches = line.match(INDENT_RE); if (matches) { indent = matches[0].length; if (matches[1]) { spaces++; } else { tabs++; } } else { indent = 0; } const diff = indent - prev; prev = indent; if (diff) { // an indent or unindent has been detected isIndent = diff > 0; current = indents.get(isIndent ? diff : -diff); if (current) { current[0]++; } else { current = [1, 0]; indents.set(diff, current); } } else if (current) { // if the last action was an indent, increment the weight current[1] += Number(isIndent); } } const amount = getMostUsed(indents); let type; let indent; if (!amount) { type = null; indent = ''; } else if (spaces >= tabs) { type = 'space'; indent = ' '.repeat(amount); } else { type = 'tab'; indent = '\t'.repeat(amount); } return { amount, type, indent }; }; node-detect-indent-5.0.0/license000066400000000000000000000021371302040203300165210ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) Sindre Sorhus (sindresorhus.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. node-detect-indent-5.0.0/package.json000066400000000000000000000012311302040203300174340ustar00rootroot00000000000000{ "name": "detect-indent", "version": "5.0.0", "description": "Detect the indentation of code", "license": "MIT", "repository": "sindresorhus/detect-indent", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "sindresorhus.com" }, "engines": { "node": ">=4" }, "scripts": { "test": "xo && ava" }, "files": [ "index.js" ], "keywords": [ "indent", "indentation", "detect", "infer", "identify", "code", "string", "text", "source", "space", "tab" ], "devDependencies": { "ava": "*", "xo": "*" }, "xo": { "esnext": true } } node-detect-indent-5.0.0/readme.md000066400000000000000000000046721302040203300167410ustar00rootroot00000000000000# detect-indent [![Build Status](https://travis-ci.org/sindresorhus/detect-indent.svg?branch=master)](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 ``` $ npm install --save detect-indent ``` ## Usage Here we modify a JSON file while persisting the indentation: ```js const fs = require('fs'); const detectIndent = require('detect-indent'); /* { "ilove": "pizza" } */ const file = fs.readFileSync('foo.json', 'utf8'); // tries to detect the indentation and falls back to a default if it can't const indent = detectIndent(file).indent || ' '; const 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} - Amount of indentation, for example `2` * `type` {string|null} - Type of indentation. Possible values are `tab`, `space` or `null` if no indentation is detected * `indent` {string} - Actual indentation ## 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: gray; } 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: gray; } p { line-height: 1.3em; margin-top: 1em; text-indent: 2em; } ``` ## Related - [detect-indent-cli](https://github.com/sindresorhus/detect-indent-cli) - CLI for this module - [detect-newline](https://github.com/sindresorhus/detect-newline) - Detect the dominant newline character of a string ## License MIT © [Sindre Sorhus](https://sindresorhus.com) node-detect-indent-5.0.0/test.js000066400000000000000000000042761302040203300164770ustar00rootroot00000000000000import fs from 'fs'; import path from 'path'; import test from 'ava'; import m from './'; function getFile(file) { return fs.readFileSync(path.join(__dirname, file), 'utf8'); } test('detect the indent of a file with space indent', t => { t.is(m(getFile('fixture/space.js')).indent, ' '); }); test('return indentation stats for spaces', t => { const stats = m(getFile('fixture/space.js')); t.deepEqual(stats, { amount: 4, indent: ' ', type: 'space' }); }); test('return indentation stats for multiple tabs', t => { const stats = m(getFile('fixture/tab-four.js')); t.deepEqual(stats, { amount: 4, indent: '\t\t\t\t', type: 'tab' }); }); test('detect the indent of a file with tab indent', t => { t.is(m(getFile('fixture/tab.js')).indent, '\t'); }); test('return indentation stats for tabs', t => { const stats = m(getFile('fixture/tab.js')); t.deepEqual(stats, { amount: 1, indent: '\t', type: 'tab' }); }); test('detect the indent of a file with equal tabs and spaces', t => { t.is(m(getFile('fixture/mixed-tab.js')).indent, '\t'); }); test('return indentation stats for equal tabs and spaces', t => { const indent = m(getFile('fixture/mixed-tab.js')); t.deepEqual(indent, { amount: 1, indent: '\t', type: 'tab' }); }); test('detect the indent of a file with mostly spaces', t => { const stats = m(getFile('fixture/mixed-space.js')); t.is(stats.indent, ' '); }); test('return indentation stats for mostly spaces', t => { const stats = m(getFile('fixture/mixed-space.js')); t.deepEqual(stats, { amount: 4, indent: ' ', type: 'space' }); }); test('detect the indent of a weirdly indented vendor prefixed CSS', t => { const stats = m(getFile('fixture/vendor-prefixed-css.css')); t.is(stats.indent, ' '); }); test('return indentation stats for various spaces', t => { const stats = m(getFile('fixture/vendor-prefixed-css.css')); t.deepEqual(stats, { amount: 4, indent: ' ', type: 'space' }); }); test('return `0` when there is no indentation', t => { t.is(m('').amount, 0); }); test('return indentation stats for no indentation', t => { const stats = m(''); t.deepEqual(stats, { amount: 0, indent: '', type: null }); });