{"id":13431939,"url":"https://github.com/sindresorhus/awesome-lint","last_synced_at":"2025-09-27T17:32:03.919Z","repository":{"id":38206124,"uuid":"64659785","full_name":"sindresorhus/awesome-lint","owner":"sindresorhus","description":"Linter for Awesome lists","archived":false,"fork":false,"pushed_at":"2025-09-19T12:03:07.000Z","size":372,"stargazers_count":687,"open_issues_count":24,"forks_count":63,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-09-20T14:20:57.624Z","etag":null,"topics":["awesome","lint","linter","nodejs"],"latest_commit_sha":null,"homepage":null,"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/sindresorhus.png","metadata":{"funding":{"github":"sindresorhus","open_collective":"sindresorhus","buy_me_a_coffee":"sindresorhus","custom":"https://sindresorhus.com/donate"},"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,"zenodo":null}},"created_at":"2016-08-01T10:55:57.000Z","updated_at":"2025-09-19T12:13:13.000Z","dependencies_parsed_at":"2023-02-16T07:01:41.116Z","dependency_job_id":"48bdccdf-8be1-4eba-b5fe-5cb882fa7c7e","html_url":"https://github.com/sindresorhus/awesome-lint","commit_stats":{"total_commits":128,"total_committers":24,"mean_commits":5.333333333333333,"dds":0.4375,"last_synced_commit":"d83d0361be944593b27d3060942a6a7dce33216d"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/sindresorhus/awesome-lint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fawesome-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fawesome-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fawesome-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fawesome-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sindresorhus","download_url":"https://codeload.github.com/sindresorhus/awesome-lint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Fawesome-lint/sbom","scorecard":{"id":826104,"data":{"date":"2025-08-11","repo":{"name":"github.com/sindresorhus/awesome-lint","commit":"614e82d1ea431a1d5b83dcc9b19675db31298c39"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.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":"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":"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":4,"reason":"Found 12/30 approved changesets -- score normalized to 4","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":"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/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/awesome-lint/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/awesome-lint/main.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/main.yml:24","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":"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":"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 'main'"],"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 12 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-23T16:40:25.490Z","repository_id":38206124,"created_at":"2025-08-23T16:40:25.490Z","updated_at":"2025-08-23T16:40:25.490Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277170793,"owners_count":25773069,"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-27T02:00:08.978Z","response_time":73,"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":["awesome","lint","linter","nodejs"],"created_at":"2024-07-31T02:01:07.210Z","updated_at":"2025-09-27T17:32:03.913Z","avatar_url":"https://github.com/sindresorhus.png","language":"JavaScript","funding_links":["https://github.com/sponsors/sindresorhus","https://opencollective.com/sindresorhus","https://buymeacoffee.com/sindresorhus","https://sindresorhus.com/donate"],"categories":["JavaScript","HarmonyOS","What will it do?","Related","Linters","Contributing","Tools","awesome","TODO","Accessibility Packages and Tools","Contributing \u003c!-- omit in toc --\u003e","Uncategorized"],"sub_categories":["Windows Manager","Awesome Lists","Learning Resources","Adanced","Testing \u0026 Auditing","𝕏 : [x.AI](https://docs.x.ai/docs/overview)'s Grok models","Uncategorized"],"readme":"\u003ch1 align=\"center\"\u003e\n\t\u003cbr\u003e\n\t\u003cimg width=\"500\" src=\"media/logo.svg\" alt=\"awesome-lint\"\u003e\n\t\u003cbr\u003e\n\t\u003cbr\u003e\n\t\u003cbr\u003e\n\u003c/h1\u003e\n\n\u003e Linter for [Awesome](https://awesome.re) lists\n\nIntended to make it easier to create and maintain Awesome lists.\n\nIncludes a bunch of [general Markdown rules](config.js) and some [Awesome specific rules](rules).\n\n![](media/screenshot.png)\n\n## CLI\n\n### Usage\n\nThe CLI requires Node.js and Git.\n\nType the command `npx awesome-lint` followed by the URL of the repo you want to check:\n\n```\n❯ npx awesome-lint https://github.com/sindresorhus/awesome-something\n\n  readme.md:1:1\n  ✖    1:1  Missing Awesome badge after the main heading      awesome-badge\n  ✖   12:1  Marker style should be -                          unordered-list-marker-style\n  ✖  199:3  Remove trailing slash (https://sindresorhus.com)  trailing-slash\n\n  3 errors\n```\n\n### Special comments\n\nYou can enable, disable, and ignore rules using special comments. This is based on [remark-message-control](https://github.com/remarkjs/remark-message-control#markers).\n\nBy default, all rules are turned on. For example, 4 errors (2 of `no-dead-urls` and 2 of `awesome-list-item`) will be generated for following code snippets.\n\n```md\n- [foo](https://foo.com) - an invalid description.\n- [foo](https://foo.com) - invalid description.\n```\n\n###### `disable`\n\nThe `disable` keyword turns off all messages of the given rule identifiers. If no identifiers are specified, all messages are turned off.\n\n**Don't leave spaces after the last rule identifier.**\n\nFor example, only the 2 `no-dead-urls` errors are left:\n\n```md\n\u003c!--lint disable awesome-list-item--\u003e\n- [foo](https://foo.com) - an invalid description.\n- [foo](https://foo.com) - invalid description.\n```\n\n###### `enable`\n\nThe `enable` keyword turns on all messages of the given rule identifiers. If no identifiers are specified, all messages are turned on.\n\nFor example, only the second line reports a `awesome-list-item` rule violation:\n\n```md\n\u003c!--lint disable awesome-list-item--\u003e\n- [foo](https://foo.com) - an invalid description.\n\u003c!--lint enable awesome-list-item--\u003e\n- [foo](https://foo.com) - invalid description.\n```\n\n###### `ignore`\n\nThe `ignore` keyword turns off all messages of the given rule identifiers occurring in the following node. If no identifiers are specified, all messages are turned ignored. After the end of the following node, messages are turned on again. This is the main difference with `disable`.\n\nFor example, to turn off certain messages for the next node:\n\n```md\n\u003c!--lint ignore awesome-list-item--\u003e\n- [foo](https://foo.com) - an invalid description.\n\nList items share the same parent node. So let's create a new list.\n\n- [foo](https://foo.com) - invalid description.\n```\n\n### Continuous Integration\n\n#### GitHub Actions\n\nYou can use [GitHub Actions](https://github.com/features/actions) for free to automatically run `awesome-lint` against all pull requests.\n\nCreate `/.github/workflows/main.yml` with the following contents:\n\n```yml\nname: CI\non:\n  pull_request:\n    branches: [main]\njobs:\n  Awesome_Lint:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          fetch-depth: 0\n      - run: npx awesome-lint\n```\n\n*`fetch-depth: 0`* is needed so that we can check the repo age.\n\nYou may add [branch protection rules](https://docs.github.com/en/github/administering-a-repository/configuring-protected-branches) to prevent merging branches not passing `awesome-lint`.\n\n## API\n\n### Install\n\n```sh\nnpm install awesome-lint\n```\n\n### Usage\n\n```js\nimport awesomeLint from 'awesome-lint';\n\n// Lint the current directory's readme.md\nawait awesomeLint.report();\n\n// Lint a specific file\nawait awesomeLint.report({filename: 'my-awesome-list.md'});\n\n// Lint a GitHub repository\nawait awesomeLint.report({filename: 'https://github.com/sindresorhus/awesome'});\n\n// Get raw results without console output\nconst files = await awesomeLint();\n```\n\n### API\n\n#### awesomeLint(options?)\n\nReturns a `Promise` for an array of [`VFile`](https://github.com/vfile/vfile) objects containing lint results.\n\n##### options\n\nType: `object`\n\n###### filename\n\nType: `string`\nDefault: `'readme.md'`\n\nPath to the file to lint, or a GitHub repository URL.\n\n###### config\n\nType: `Array`\nDefault: `config` (from `config.js`)\n\nCustom remark plugins configuration.\n\n#### awesomeLint.report(options?)\n\nLint and display results to the console. Returns a `Promise` that resolves when linting is complete.\n\nTakes the same options as `awesomeLint()`, plus:\n\n##### options.reporter\n\nType: `Function`\n\nCustom reporter function to format the output.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Fawesome-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsindresorhus%2Fawesome-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Fawesome-lint/lists"}