dedent

A string tag that strips indentation from multi-line strings. ⬅️

All Contributors: 18 πŸ‘ͺ Codecov Test Coverage Contributor Covenant License: MIT Style: Prettier TypeScript: Strict npm package version Contributor Covenant

## Usage ```shell npm i dedent ``` ```js 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 first + "\n\n" + second + "\n\n" + third; } console.log(usageExample()); ``` ```plaintext 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. 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. 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: ```js import dedent from 'dedent'; dedent.withOptions({ /* ... */ })`input`; dedent.withOptions({ /* ... */ })(`input`); ``` `options` returns a new `dedent` function, so if you'd like to reuse the same options, you can create a dedicated `dedent` function: ```js import dedent from 'dedent'; const dedenter = dedent.withOptions({ /* ... */ }); dedenter`input`; dedenter(`input`); ``` ### `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: - `false`: when `dedent` is called as a function - `true`: when `dedent` is called as a string tag ```js import dedent from "dedent"; // "$hello!" dedent` $hello! `; // "\$hello!" dedent.withOptions({ escapeSpecialCharacters: false })` $hello! `; // "$hello!" dedent.withOptions({ escapeSpecialCharacters: true })` $hello! `; ``` For more context, see [πŸš€ Feature: Add an option to disable special character escaping](https://github.com/dmnd/dedent/issues/63). ## License MIT ## Contributors
Adrian Jost
Adrian Jost

πŸ’»
Andri MΓΆll
Andri MΓΆll

πŸ›
Benny Powers - גם Χ™Χ©Χ¨ΧΧœ Χ—Χ™!
Benny Powers - גם Χ™Χ©Χ¨ΧΧœ Χ—Χ™!

πŸ”§
Craig Spence
Craig Spence

πŸ’»
Desmond Brand
Desmond Brand

πŸ› πŸ’» πŸ“– πŸ€” πŸš‡ 🚧 πŸ“† πŸ”§
Gareth Jones
Gareth Jones

πŸ’» πŸ›
Gray Zhang
Gray Zhang

πŸ›
Haroen Viaene
Haroen Viaene

πŸ’» 🚧
Hyeseong Kim
Hyeseong Kim

πŸ”§ πŸš‡
John L. Armstrong IV
John L. Armstrong IV

πŸ›
Josh Goldberg ✨
Josh Goldberg ✨

πŸ› πŸ’» πŸ“– πŸ€” πŸš‡ 🚧 πŸ“† πŸ”§
Pratap Vardhan
Pratap Vardhan

πŸ’»
Simon Lydell
Simon Lydell

πŸ›
Yusuke Iinuma
Yusuke Iinuma

πŸ’»
Yves M.
Yves M.

πŸ”§
d07riv
d07riv

πŸ›
mizdra
mizdra

πŸ’»
sirian
sirian

πŸ›
> πŸ’™ This package was templated with [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).