Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

detect-indent

Package Overview
Dependencies
0
Maintainers
1
Versions
17
Issues
File Explorer

Advanced tools

detect-indent

Detect the indentation of code

    7.0.1latest

Version published
Maintainers
1
Weekly downloads
10,531,814
decreased by-5.57%

Weekly downloads

Changelog

Source

  • Fix detecting the indent of files with many repeats after a single indent (#34) 477e390

https://github.com/sindresorhus/detect-indent/compare/v7.0.0...v7.0.1

Readme

Source

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 detect-indent

Usage

Here we modify a JSON file while persisting the indentation:

import fs from 'node:fs'; import detectIndent from '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, undefined, 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 {'tab' | 'space' | undefined} - Type of indentation. Possible values are 'tab', 'space' or undefined 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:

html { box-sizing: border-box; } body { background: gray; } p { line-height: 1.3em; margin-top: 1em; text-indent: 2em; }

Source.

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; }
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

What is detect-indent?

Detect the indentation of code

Is detect-indent popular?

The npm package detect-indent receives a total of 9,972,376 weekly downloads. As such, detect-indent popularity was classified as popular.

Is detect-indent well maintained?

We found that detect-indent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 11 Sep 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc