{"id":19838144,"url":"https://github.com/textlint/textlint-filter-rule-comments","last_synced_at":"2026-01-03T23:12:09.505Z","repository":{"id":65399705,"uuid":"58264692","full_name":"textlint/textlint-filter-rule-comments","owner":"textlint","description":"textlint filter rule that disables all rules between comments directive.","archived":false,"fork":false,"pushed_at":"2024-12-14T04:32:39.000Z","size":124,"stargazers_count":36,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-07T05:43:39.054Z","etag":null,"topics":["comment","disable","filter","ignore","supress","textlintrule"],"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/textlint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-07T12:18:59.000Z","updated_at":"2025-09-05T14:54:18.000Z","dependencies_parsed_at":"2024-06-18T16:52:01.222Z","dependency_job_id":"4476d1c3-2ef7-4c6b-bf61-a893c6c8c1f4","html_url":"https://github.com/textlint/textlint-filter-rule-comments","commit_stats":{"total_commits":27,"total_committers":4,"mean_commits":6.75,"dds":"0.14814814814814814","last_synced_commit":"5273aa6e52a010dd6580e4ceacae76910de2ff6c"},"previous_names":["textlint/textlint-rule-ignore-comments"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/textlint/textlint-filter-rule-comments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-filter-rule-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-filter-rule-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-filter-rule-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-filter-rule-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textlint","download_url":"https://codeload.github.com/textlint/textlint-filter-rule-comments/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-filter-rule-comments/sbom","scorecard":{"id":875695,"data":{"date":"2025-08-11","repo":{"name":"github.com/textlint/textlint-filter-rule-comments","commit":"5273aa6e52a010dd6580e4ceacae76910de2ff6c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":1,"reason":"Found 4/27 approved changesets -- score normalized to 1","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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint/textlint-filter-rule-comments/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint/textlint-filter-rule-comments/test.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:19","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"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":"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":9,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/textlint/.github/SECURITY.md:1","Info: Found linked content: github.com/textlint/.github/SECURITY.md:1","Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy","Info: Found text in security policy: github.com/textlint/.github/SECURITY.md:1"],"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 5 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"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T05:53:56.627Z","repository_id":65399705,"created_at":"2025-08-24T05:53:56.627Z","updated_at":"2025-08-24T05:53:56.627Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28194369,"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":"2026-01-03T02:00:06.471Z","response_time":75,"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":["comment","disable","filter","ignore","supress","textlintrule"],"created_at":"2024-11-12T12:16:53.291Z","updated_at":"2026-01-03T23:12:09.472Z","avatar_url":"https://github.com/textlint.png","language":"JavaScript","readme":"# textlint-filter-rule-comments [![Actions Status: test](https://github.com/textlint/textlint-filter-rule-comments/workflows/test/badge.svg)](https://github.com/textlint/textlint-filter-rule-comments/actions?query=workflow%3A\"test\")\n\ntextlint rule that ignore error using comments directive.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n    npm install textlint-filter-rule-comments\n\nDependencies:\n\n- [textlint](http://textlint.github.io/ \"textlint\") \u003e= 6.9\n\n## Usage\n\n### Ignore error messages using comments\n\nExample case in Markdown.\n\n```markdown\nThis is error text.\n\n\u003c!-- textlint-disable --\u003e\n\nThis is ignored text by rule.\nDisables all rules between comments\n\n\u003c!-- textlint-enable --\u003e\n\nThis is error text.\n```\n\nIgnore specified rules:\n\n```markdown\n\u003c!-- textlint-disable ruleA,ruleB --\u003e\n\nIgnore RuleA and RuleB\n\n\u003c!-- textlint-enable ruleA --\u003e\n\nStill ignore RuleB\n```\n\n**Limitation(markdown)**:\n\nRequire new-line around of `\u003c!-- textlint-disable --\u003e` in Markdown.\nThis limitation com from [remark](https://github.com/wooorm/remark \"remark\").\n\nNG:\n\n```markdown\n\u003c!-- textlint-disable --\u003e\nthis is wrong\n\u003c!-- textlint-enable --\u003e\n```\n\nOK:\n\n```markdown\n\u003c!-- textlint-disable --\u003e\n\nthis is ok\n\n\u003c!-- textlint-enable --\u003e\n```\n\n### Settings\n\nVia `.textlintrc`(Recommended)\n\n\n```json\n{\n    \"filters\": {\n        \"comments\": true\n    }\n}\n```\n\n### Options\n\n- `enablingComment`:\n    - default: `\"textlint-enable\"` \n    - enable comment directive\n    - e.g.) `\u003c!-- textlint-enable --\u003e`\n- `disablingComment`:\n    - default: `\"textlint-disable\"` \n    - disable comment directive\n    - e.g.) `\u003c!-- textlint-disable --\u003e`\n\n```js\n{\n    \"filters\": {\n        \"comments\": {\n            // enable comment directive\n            // if comment has the value, then enable textlint rule\n            \"enablingComment\": \"textlint-enable\",\n            // disable comment directive\n            // if comment has the value, then disable textlint rule\n           \"disablingComment\": \"textlint-disable\"\n        }\n    }\n}\n```\n\n\n\n## Changelog\n\nSee [Releases page](https://github.com/textlint/textlint-filter-rule-comments/releases).\n\n## Acknowledgement\n\n- [Documentation - ESLint - Pluggable JavaScript linter](http://eslint.org/docs/user-guide/configuring#disabling-rules-with-inline-comments \"Documentation - ESLint - Pluggable JavaScript linter\")\n\n## Running tests\n\nInstall devDependencies and Run `npm test`:\n\n    npm i -d \u0026\u0026 npm test\n\n## Contributing\n\nPull requests and stars are always welcome.\nFor bugs and feature requests, [please create an issue](https://github.com/textlint/textlint-filter-rule-comments/issues).\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Author\n\n- [github/azu](https://github.com/azu)\n- [twitter/azu_re](http://twitter.com/azu_re)\n\n## License\n\nMIT © azu\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-filter-rule-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextlint%2Ftextlint-filter-rule-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-filter-rule-comments/lists"}