Gathering detailed insights and metrics for eslint-docs
eslint-rule-docs
Find documentation url for a given ESLint rule
eslint-doc-generator
Automatic documentation generator for ESLint plugins and rules.
eslint-plugin-sort-keys-fix
Fork of eslint rule that sorts keys in objects (https://eslint.org/docs/rules/sort-keys) with autofix enabled
@mapbox/eslint-config-docs
eslint configuration for docs.mapbox.com
npm install eslint-docsTypescript
Module System
Min. Node Version
TypeScript (93.16%)
HCL (5.42%)
JavaScript (1.42%)
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Total Downloads
24,643
Last Day
3
Last Week
4
Last Month
52
Last Year
8,671
ISC License
3 Stars
206 Commits
3 Forks
3 Watchers
233 Branches
4 Contributors
Updated on May 26, 2023
Minified
Minified + Gzipped
Latest Version
0.4.0
Package Id
eslint-docs@0.4.0
Unpacked Size
32.44 kB
Size
9.64 kB
File Count
37
Cumulative downloads
Total Downloads
Last Day
50%
3
Compared to previous day
Last Week
-69.2%
4
Compared to previous week
Last Month
-45.3%
52
Compared to previous month
Last Year
431.3%
8,671
Compared to previous year
27
Keep your rule names and descriptions up-to-date across your repo
1$ npm install --save-dev eslint-docs
In the shell
1$ eslint-docs 2✔ docs/rules/no-insecure-random.md is up-to-date 3✔ docs/rules/no-stateless-class.md is up-to-date 4✔ docs/rules/promise-must-complete.md is up-to-date 5✔ README.md is up-to-date 6 7$ eslint-docs check # Run this in CI! 8✔ docs/rules/no-insecure-random.md is valid 9✔ docs/rules/no-stateless-class.md is valid 10✔ docs/rules/promise-must-complete.md is valid 11✔ The README is valid
In package.json:
1{ 2 "scripts": { 3 "docs": "eslint-docs", 4 "docs:check": "eslint-docs check" 5 } 6}
In a Node.js script
1const eslintDocs = require('eslint-docs') 2 3eslintDocs(yourProjectDirectory).then( 4 () => { 5 // Everything went OK! 6 }, 7 () => { 8 // Something went wrong! 9 // Currently, you’ll have to ask the user to look at the terminal. sorry :( 10 } 11)
yourProjectDirectory defaults to the closest directory above process.cwd()
that includes a package.json
ISC © Jed Fox
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
project is archived
Details
Reason
Found 1/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
95 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-03-10
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