redent

What is redent?

The npm package 'redent' is used to modify the indentation of a string. It can remove excess indentation and add desired indentation to each line of a given text. This is particularly useful when working with multi-line strings in programming environments where indentation matters, such as in source code or markdown files.

What are redent's main functionalities?

Remove excess indentation

This feature removes excess indentation from a text. The example shows how to use redent to dedent a string to the least indented line.

const redent = require('redent');

const text = '    foo\n        bar';
const dedentedText = redent(text, 0);
console.log(dedentedText); // 'foo\n    bar'

Add indentation

This feature adds a specified number of spaces to the beginning of each line in the text. The example demonstrates adding 4 spaces of indentation to each line of a string.

const redent = require('redent');

const text = 'foo\nbar';
const indentedText = redent(text, 4);
console.log(indentedText); // '    foo\n    bar'

Other packages similar to redent

indent-string

Similar to redent, 'indent-string' allows adding or modifying the indentation of a string. However, it focuses more on adding indentation rather than both adding and removing like redent.

strip-indent

This package is similar to the dedenting aspect of redent. 'strip-indent' is used to remove the leading whitespace from every line in a string, which is useful for cleaning up multi-line strings.

README

redent

Strip redundant indentation and indent the string

Install

$ npm install redent

Usage

import redent from 'redent';

redent('\n  foo\n    bar\n', 1);
//=> '\n foo\n   bar\n'

API

redent(string, count?, options?)

string

Type: string

The string to normalize indentation.

count

Type: number
Default: 0

How many times you want options.indent repeated.

options

Type: object

indent

Type: string
Default: ' '

The string to use for the indent.

includeEmptyLines

Type: boolean
Default: false

Also indent empty lines.

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.}