multiline-ts

Readable multi-line template strings for Javascript or Typescript.

multiline is a template tag function which removes leading indentation from each line of a string, and the first/last newline, to allow it to be more readable in code.

multiline also indents multi-line strings in template variables.

Installation

1npm install multiline-ts

Usage

1import multiline from 'multiline-ts';
2
3const string = multiline`
4  Multiline string
5    with varying
6      indentation
7`;

Is equivalent to:

1const string = `Multiline string
2  with varying
3    indentation`;

Which creates the string:

1Multiline string
2  with varying
3    indentation

In indented code

1import multiline from 'multiline-ts';
2const condition1 = true;
3const condition2 = true;
4
5if (condition1) {
6  if (condition2) {
7    const string = multiline`
8      Multiline string
9        with varying
10          indentation
11    `;
12  }
13}

Creates the same string:

1Multiline string
2  with varying
3    indentation

With template variables

1import multiline from 'multiline-ts';
2
3const value = '1\n2\n3';
4
5const string = multiline`
6  Indented value:
7    ${value}
8`;

Creates the string:

1Indented value:
2  1
3  2
4  3

With with extra newlines

Extra newlines are respected:

1import multiline from 'multiline-ts';
2
3const string = multiline`
4
5    Here is
6  Another string
7      For you
8
9`;

Creates the string:

1
2  Here is
3Another string
4    For you
5

With CommonJS / require()

If you want to use this with CommonJS imports use the following syntax:

1const multiline = require('multiline-ts');
2const string = multiline(`
3  Multiline string
4    with varying
5      indentation
6`);

As a function

You can also call multiline as a normal function, however this will not be able to intelligently indent multi-line template variables.

1import multiline from 'multiline-ts';
2
3const string = multiline(`
4  Multiline string
5    with varying
6      indentation
7`);

Creates the string:

1Multiline string
2  with varying
3    indentation