{"id":13801971,"url":"https://github.com/jfmengels/eslint-rule-documentation","last_synced_at":"2025-10-09T09:14:04.829Z","repository":{"id":10108279,"uuid":"64509885","full_name":"jfmengels/eslint-rule-documentation","owner":"jfmengels","description":"Find the url for the documentation of an ESLint rule","archived":false,"fork":false,"pushed_at":"2023-03-11T03:26:00.000Z","size":59,"stargazers_count":31,"open_issues_count":3,"forks_count":31,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-06T03:53:10.887Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jfmengels.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-07-29T20:53:54.000Z","updated_at":"2025-07-12T17:35:19.000Z","dependencies_parsed_at":"2024-01-29T16:08:45.234Z","dependency_job_id":"5cc6bba5-74bb-4d68-876f-9c59a2940342","html_url":"https://github.com/jfmengels/eslint-rule-documentation","commit_stats":{"total_commits":63,"total_committers":22,"mean_commits":"2.8636363636363638","dds":0.6825396825396826,"last_synced_commit":"58b76af656cb7c07066df6078f76311bda2eeeae"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/jfmengels/eslint-rule-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfmengels%2Feslint-rule-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfmengels%2Feslint-rule-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfmengels%2Feslint-rule-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfmengels%2Feslint-rule-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jfmengels","download_url":"https://codeload.github.com/jfmengels/eslint-rule-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfmengels%2Feslint-rule-documentation/sbom","scorecard":{"id":517548,"data":{"date":"2025-08-11","repo":{"name":"github.com/jfmengels/eslint-rule-documentation","commit":"58b76af656cb7c07066df6078f76311bda2eeeae"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":5,"reason":"Found 15/26 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T02:12:47.475Z","repository_id":10108279,"created_at":"2025-08-20T02:12:47.475Z","updated_at":"2025-08-20T02:12:47.475Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277462533,"owners_count":25822032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-29T02:00:09.175Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T00:01:31.931Z","updated_at":"2025-10-09T09:14:04.811Z","avatar_url":"https://github.com/jfmengels.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":["Testing Tools"],"readme":"# eslint-rule-documentation [![Build Status](https://travis-ci.org/jfmengels/eslint-rule-documentation.svg?branch=master)](https://travis-ci.org/jfmengels/eslint-rule-documentation)\n\n\u003e Find the url for the documentation of an [ESLint] rule\n\n\n## Install\n\n```\n$ npm install --save eslint-rule-documentation\n```\n\n\n## Usage\n\n```js\nconst getRuleURI = require('eslint-rule-documentation');\n\n// find url for core rules\ngetRuleURI('no-var');\n// =\u003e { found: true, url: 'https://eslint.org/docs/rules/no-var' }\n\n// find url for known plugins\ngetRuleURI('import/no-unresolved');\n// =\u003e { found: true, url: 'https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md' }\n\n// If the plugin is not known, get a link to help improve this\ngetRuleURI('unknown-foo/bar');\n// =\u003e { found: false, url: 'https://github.com/jfmengels/eslint-rule-documentation/blob/master/contributing.md' }\n```\n\n## Contributing\n\nIf you find a plugin that you use is not in the [list of supported plugins](./plugins.json), please consider adding it to the project by following the instructions [here](./contributing.md).\n\n\n## API\n\n### getRuleURI(ruleId)\n\n\n\n#### ruleId\n\nType: `string`\n\nId of an [ESLint] rule.\n\nExamples:\n- core rule: `no-var`\n- plugin rule: `import/no-unresolved` (from the [eslint-plugin-import] plugin).\n\n#### returns\n\nType: `object`\n\n```js\n{\n  found: \u003cboolean\u003e,\n  url: \u003cstring\u003e\n}\n```\n\n- `found`: `true` if the rule is an ESLint core rule, or a rule of a known plugin, `false` otherwise.\n- `url`: if `found` is `true`, url of the documentation of a rule. If `found` is `false`, url of the [contribution guidelines](./contributing.md).\n\n## Thanks\n\nSpecial thanks to the team behind [linter-eslint] for the original work, and the people who contributed there.\n\n\n## License\n\nMIT © [Jeroen Engels](https://github.com/jfmengels)\n\n[eslint-plugin-import]: https://github.com/benmosher/eslint-plugin-import\n[ESLint]: https://eslint.org/\n[linter-eslint]: https://github.com/AtomLinter/linter-eslint\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfmengels%2Feslint-rule-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjfmengels%2Feslint-rule-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfmengels%2Feslint-rule-documentation/lists"}