Socket
Socket
Sign inDemoInstall

detect-indent

Package Overview
Dependencies
0
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

detect-indent

Detect the indentation of code


Version published
Maintainers
1
Weekly downloads
13,225,726
decreased by-9.33%

Weekly downloads

Package description

What is detect-indent?

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.

What are detect-indent's main functionalities?

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: '  '}

Other packages similar to detect-indent

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

Last updated on 11 Sep 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc