npmpackage.info

Gathering detailed insights and metrics for dedent

dedent

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

1.5.3

931

MIT

TypeScript

890.00 B

3,523,460,291 4.2

Installations

npm install dedent

Pull Requests

Open

0

Total

48

Closed

8

Merged

40

Issues

Open

9

Total

47

Closed

38

Releases

v1.5.3

Published on 11 Apr 2024

v1.5.2

Published on 11 Apr 2024

v1.5.1

Published on 31 Jul 2023

v1.5.0

Published on 30 Jul 2023

v1.4.0

Published on 30 Jul 2023

v1.0.1

Published on 30 Jul 2023

View all 10 releases

Developer

dmnd

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

21.5.0

NPM Version

10.2.4 Statistics

931 Stars

89 Commits

36 Forks

8 Watching

3 Branches

12 Contributors

Updated on 25 Nov 2024

Bundle Size

1.77 kB

Minified

890.00 B

Minified + Gzipped

Bundlephobia

Languages

TypeScript (62.42%)

JavaScript (37.18%)

Shell (0.4%)

Total Downloads

Cumulative downloads

Total Downloads

3,523,460,291

Last day

-8.9%

5,453,667

Compared to previous day

Last week

2.1%

32,029,685

Compared to previous week

Last month

15.1%

129,537,743

Compared to previous month

Last year

35.9%

1,251,999,838

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

dedent

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

npm package version

Usage

1npm i dedent

1import dedent from "dedent";
2
3function usageExample() {
4	const first = dedent`A string that gets so long you need to break it over
5                       multiple lines. Luckily dedent is here to keep it
6                       readable without lots of spaces ending up in the string
7                       itself.`;
8
9	const second = dedent`
10    Leading and trailing lines will be trimmed, so you can write something like
11    this and have it work as you expect:
12
13      * how convenient it is
14      * that I can use an indented list
15         - and still have it do the right thing
16
17    That's all.
18  `;
19
20	const third = dedent(`
21    Wait! I lied. Dedent can also be used as a function.
22  `);
23
24	return first + "\n\n" + second + "\n\n" + third;
25}
26
27console.log(usageExample());

1A string that gets so long you need to break it over
2multiple lines. Luckily dedent is here to keep it
3readable without lots of spaces ending up in the string
4itself.
5
6Leading and trailing lines will be trimmed, so you can write something like
7this and have it work as you expect:
8
9  * how convenient it is
10  * that I can use an indented list
11    - and still have it do the right thing
12
13That's all.
14
15Wait! 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:

1import dedent from 'dedent';
2
3dedent.withOptions({ /* ... */ })`input`;
4dedent.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:

1import dedent from 'dedent';
2
3const dedenter = dedent.withOptions({ /* ... */ });
4
5dedenter`input`;
6dedenter(`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

1import dedent from "dedent";
2
3// "$hello!"
4dedent`
5  $hello!
6`;
7
8// "\$hello!"
9dedent.withOptions({ escapeSpecialCharacters: false })`
10  $hello!
11`;
12
13// "$hello!"
14dedent.withOptions({ escapeSpecialCharacters: true })`
15  $hello!
16`;

For more context, see 🚀 Feature: Add an option to disable special character escaping.

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.

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/accessibility-alt-text-bot.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/accessibility-alt-text-bot.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/compliance.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/compliance.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/contributors.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/contributors.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/contributors.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/contributors.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-knip.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint-knip.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-markdown.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint-markdown.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-package-json.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint-package-json.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-packages.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint-packages.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-spelling.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint-spelling.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/post-release.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/post-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/post-release.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/post-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-review-requested.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/pr-review-requested.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tsc.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/dmnd/dedent/tsc.yml/main?enable=pin
Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 6 third-party GitHubAction dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

dedent

Installations

Pull Requests

0

48

8

40

Issues

9

47

38

Releases

Developer

dmnd

Developer Guide

CommonJS, ESM

Yes

21.5.0

10.2.4

Statistics

Bundle Size

1.77 kB

890.00 B

Languages

Total Downloads

3,523,460,291

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

dedent

Usage

Options

escapeSpecialCharacters

License

Contributors

10

10

10

10

4

3

0

0

0

0

0

0

4.2

/10

`escapeSpecialCharacters`