A string tag that strips indentation from multi-line strings. ⬅️
Usage
npm i dedent
import dedent from "dedent";function usageExample() { const first = dedent`A string that gets so long you need to break it over multiple lines. Luckily dedent is here to keep it readable without lots of spaces ending up in the string itself.`; const second = dedent` Leading and trailing lines will be trimmed, so you can write something like this and have it work as you expect: * how convenient it is * that I can use an indented list - and still have it do the right thing That's all. `; const third = dedent(` Wait! I lied. Dedent can also be used as a function. `); return
A string that gets so long you need to break it overmultiple lines. Luckily dedent is here to keep itreadable without lots of spaces ending up in the stringitself.Leading and trailing lines will be trimmed, so you can write something likethis and have it work as you expect: * how convenient it is * that I can use an indented list - and still have it do the right thingThat's all.Wait! I lied. Dedent can also be used as a function.
Options
You can customize the options dedent runs with by calling its withOptions method with an object:
When an interpolation evaluates to a multi-line string, only its first line is placed where the ${...} appears. Subsequent lines keep whatever indentation they already had inside that value (often none), so they can appear “shifted left”.
Enable alignValues to fix that visual jump. When true, for every multi-line interpolated value, each line after the first gets extra indentation appended so it starts in the same column as the first line.
import dedent from "dedent";const list = dedent` - apples - bananas - cherries`;const withoutAlign = dedent` List without alignValues (default): ${list} Done.`;const withAlign = dedent.withOptions({ alignValues: true })` List with alignValues: true ${list} Done.`;console.log(withoutAlign);console.log(
List without alignValues (default): - apples- bananas- cherriesDone.---List with alignValues: true - apples - bananas - cherriesDone.
escapeSpecialCharacters
JavaScript string tags by default add an extra \ escape in front of some special characters such as $ dollar signs.
dedent will escape those special characters when called as a string tag.
If you'd like to change the behavior, an escapeSpecialCharacters option is available.
It defaults to: