s-string-indent

A TypeScript library for reindenting multi-line strings with configurable space and trim options.

Installation

npm install s-string-indent

Usage

Using the s tagged template literal

The s function is a tagged template literal that allows you to specify reindentation configuration directly in the template string.

import { s } from 's-string-indent';

const result = s`
    @space = auto
    @trim = all
    hello world
    this is nice
        let's put a new line
    and then we back again
`;

console.log(result);

Output

hello world
this is nice
    let's put a new line
and then we back again

Configuration Options

• @space: Controls indentation removal.

  • auto: Automatically calculates the minimum indentation to remove.
  • A number (e.g., 4): Removes exactly that many spaces from the start of each line.
  • Negative number (e.g., -2): Adds spaces instead of removing.

• @trim: Controls trimming of empty lines.

  • none: No trimming.
  • head: Remove empty lines from the beginning.
  • tail: Remove empty lines from the end.
  • all: Remove empty lines from both ends.
  • head-once, tail-once, all-once: Remove only one empty line from the respective positions.

Using the s function with a config object

You can create a templator function by passing a configuration object to s.

import { s } from 's-string-indent';

const templator = s({
    space: 'auto',
    trim: 'all'
});

const result = templator`
    hello world
    this is nice
        let's put a new line
    and then we back again
`;

console.log(result);

Output

hello world
this is nice
    let's put a new line
and then we back again

Using the reindent function

For programmatic usage, you can use the reindent function directly.

import { reindent } from 's-string-indent';

const input = `
    hello world
    this is nice
`;

const config = {
    space: 'auto',
    trim: 'all'
};

const result = reindent(input, config);
console.log(result);

Output

hello world
this is nice