Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmnd/dedent
⬅️ ES6 string tag that strips indentation from multi-line strings.
https://github.com/dmnd/dedent
dedent es2015 es6 javascript template-string
Last synced: 7 days ago
JSON representation
⬅️ ES6 string tag that strips indentation from multi-line strings.
- Host: GitHub
- URL: https://github.com/dmnd/dedent
- Owner: dmnd
- License: mit
- Created: 2015-01-13T10:00:21.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T00:16:02.000Z (9 months ago)
- Last Synced: 2024-12-13T19:47:04.614Z (8 days ago)
- Topics: dedent, es2015, es6, javascript, template-string
- Language: TypeScript
- Homepage:
- Size: 365 KB
- Stars: 936
- Watchers: 8
- Forks: 36
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-nodejs - dedent - ES6 string tag that strips indentation from multi-line strings.  (Repository / Text/String)
- awesome-list - dedent - line strings. | dmnd | 594 | (JavaScript)
README
dedent
A string tag that strips indentation from multi-line strings. ⬅️
## 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
💻
Andri Möll
🐛
Benny Powers - עם ישראל חי!
🔧
Craig Spence
💻
Desmond Brand
🐛 💻 📖 🤔 🚇 🚧 📆 🔧
Gareth Jones
💻 🐛
Gray Zhang
🐛
Haroen Viaene
💻 🚧
Hyeseong Kim
🔧 🚇
John L. Armstrong IV
🐛
Josh Goldberg ✨
🐛 💻 📖 🤔 🚇 🚧 📆 🔧
Pratap Vardhan
💻
Simon Lydell
🐛
Yusuke Iinuma
💻
Yves M.
🔧
d07riv
🐛
mizdra
💻
sirian
🐛
> 💙 This package was templated with [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).