60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
|
# Dedent
|
||
|
|
|
||
|
|
An ES6 string tag that strips indentation from multi-line strings.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```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;
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
```js
|
||
|
|
> console.log(usageExample());
|
||
|
|
```
|
||
|
|
|
||
|
|
```
|
||
|
|
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.
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|