Gathering detailed insights and metrics for dedent
Gathering detailed insights and metrics for dedent
⬅️ ES6 string tag that strips indentation from multi-line strings.
Installations
npm install dedentDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Node Version
22.12.0
NPM Version
10.9.0
Releases
11
Languages
3
TypeScript
JavaScript
Shell
TypeScript (64.32%)
JavaScript (35.3%)
Shell (0.38%)
Developer
dmnd
Download Statistics
Total Downloads
4,524,775,692
Last Day
6,207,975
Last Week
38,755,194
Last Month
180,422,280
Last Year
1,524,268,662
GitHub Statistics
MIT License
1,037 Stars
92 Commits
38 Forks
8 Watchers
3 Branches
13 Contributors
Updated on Jul 18, 2025
Maintainers
2
Package Meta Information
Latest Version
1.6.0
Package Id
dedent@1.6.0
Unpacked Size
23.91 kB
Size
6.63 kB
File Count
8
NPM Version
10.9.0
Node Version
22.12.0
Published on
May 01, 2025
Total Downloads
Cumulative downloads
Total Downloads
4,524,775,692
Last Day
25.1%
6,207,975
Compared to previous day
Last Week
-0.1%
38,755,194
Compared to previous week
Last Month
17.4%
180,422,280
Compared to previous month
Last Year
36.3%
1,524,268,662
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
42
@babel/cli@babel/preset-env@babel/preset-typescript@release-it/conventional-changelog@types/babel-plugin-macros@types/eslint@types/jest@typescript-eslint/eslint-plugin@typescript-eslint/parserbabel-plugin-add-module-exportsbabel-plugin-testerconsole-fail-testcspelleslinteslint-plugin-deprecationeslint-plugin-eslint-commentseslint-plugin-jesteslint-plugin-jsdoceslint-plugin-jsonceslint-plugin-markdowneslint-plugin-neslint-plugin-no-only-testseslint-plugin-perfectionisteslint-plugin-regexpeslint-plugin-ymlhuskyjestjsonc-eslint-parserkniplint-stagedmarkdownlintmarkdownlint-clinpm-package-json-lintnpm-package-json-lint-config-defaultprettierprettier-plugin-curlyprettier-plugin-packagejsonrelease-itshould-semantic-releasetsuptypescriptyaml-eslint-parser
dedent
A string tag that strips indentation from multi-line strings. ⬅️
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: whendedentis called as a functiontrue: whendedentis 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.
trimWhitespace
By default, dedent will trim leading and trailing whitespace from the overall string.
This can be disabled by setting trimWhitespace: false.
1import dedent from "dedent"; 2 3// "hello!" 4dedent` 5 hello! 6`; 7 8// "\nhello! \n" 9dedent.withOptions({ trimWhitespace: false })` 10 hello! 11`; 12 13// "hello!" 14dedent.withOptions({ trimWhitespace: true })` 15 hello! 16`;
License
MIT
Contributors
💙 This package was templated with create-typescript-app.
No vulnerabilities found.
Reason
security policy file detected
Details
- Info: security policy file detected: .github/SECURITY.md:1
- Info: Found linked content: .github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/SECURITY.md:1
- Info: Found text in security policy: .github/SECURITY.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
3 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 5
Reason
Found 9/29 approved changesets -- score normalized to 3
Reason
no effort to earn an OpenSSF best practices badge detected
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
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build.yml:1
- Warn: no topLevel permission defined: .github/workflows/contributors.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-knip.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-markdown.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-package-json.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-packages.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-spelling.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/post-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/prettier.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:27
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Warn: no topLevel permission defined: .github/workflows/tsc.yml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
11 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Score
4.3
/10
Last Scanned on 2025-07-14
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