dedent
TypeScript icon, indicating that this package has built-in type declarations

1.5.3 • Public • Published

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

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 first + "\n\n" + second + "\n\n" + third;
}

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.

Options

You can customize the options dedent runs with by calling its withOptions method with an object:

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:

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
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.

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.

Package Sidebar

Install

npm i dedent

Weekly Downloads

19,383,813

Version

1.5.3

License

MIT

Unpacked Size

23.9 kB

Total Files

8

Last publish

Collaborators

  • dmnd
  • joshuakgoldberg