https://github.com/sindresorhus/awesome-lint
Linter for Awesome lists
https://github.com/sindresorhus/awesome-lint
awesome lint linter nodejs
Last synced: 9 months ago
JSON representation
Linter for Awesome lists
- Host: GitHub
- URL: https://github.com/sindresorhus/awesome-lint
- Owner: sindresorhus
- License: mit
- Created: 2016-08-01T10:55:57.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-09-19T12:03:07.000Z (9 months ago)
- Last Synced: 2025-09-20T14:20:57.624Z (9 months ago)
- Topics: awesome, lint, linter, nodejs
- Language: JavaScript
- Size: 363 KB
- Stars: 687
- Watchers: 15
- Forks: 63
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-linters - awesome-lint - Linter for (Linters / Awesome Lists)
- awesome-starz - sindresorhus/awesome-lint - Linter for Awesome lists (JavaScript)
- awesome-starred - sindresorhus/awesome-lint - Linter for Awesome lists (awesome)
- awesome-machine-learning-art - awesome-lint
- awesome-accessibility - awesome-lint - Linter for Awesome lists, useful for maintaining list quality. (MIT License) (Accessibility Packages and Tools / Testing & Auditing)
- awesome-password-cracking - awesome-lint
- awesome-starred-test - sindresorhus/awesome-lint - Linter for Awesome lists (JavaScript)
README
> Linter for [Awesome](https://awesome.re) lists
Intended to make it easier to create and maintain Awesome lists.
Includes a bunch of [general Markdown rules](config.js) and some [Awesome specific rules](rules).
## CLI
### Usage
The CLI requires Node.js and Git.
Type the command `npx awesome-lint` followed by the URL of the repo you want to check:
```
❯ npx awesome-lint https://github.com/sindresorhus/awesome-something
readme.md:1:1
✖ 1:1 Missing Awesome badge after the main heading awesome-badge
✖ 12:1 Marker style should be - unordered-list-marker-style
✖ 199:3 Remove trailing slash (https://sindresorhus.com) trailing-slash
3 errors
```
### Special comments
You can enable, disable, and ignore rules using special comments. This is based on [remark-message-control](https://github.com/remarkjs/remark-message-control#markers).
By 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.
```md
- [foo](https://foo.com) - an invalid description.
- [foo](https://foo.com) - invalid description.
```
###### `disable`
The `disable` keyword turns off all messages of the given rule identifiers. If no identifiers are specified, all messages are turned off.
**Don't leave spaces after the last rule identifier.**
For example, only the 2 `no-dead-urls` errors are left:
```md
- [foo](https://foo.com) - an invalid description.
- [foo](https://foo.com) - invalid description.
```
###### `enable`
The `enable` keyword turns on all messages of the given rule identifiers. If no identifiers are specified, all messages are turned on.
For example, only the second line reports a `awesome-list-item` rule violation:
```md
- [foo](https://foo.com) - an invalid description.
- [foo](https://foo.com) - invalid description.
```
###### `ignore`
The `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`.
For example, to turn off certain messages for the next node:
```md
- [foo](https://foo.com) - an invalid description.
List items share the same parent node. So let's create a new list.
- [foo](https://foo.com) - invalid description.
```
### Continuous Integration
#### GitHub Actions
You can use [GitHub Actions](https://github.com/features/actions) for free to automatically run `awesome-lint` against all pull requests.
Create `/.github/workflows/main.yml` with the following contents:
```yml
name: CI
on:
pull_request:
branches: [main]
jobs:
Awesome_Lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- run: npx awesome-lint
```
*`fetch-depth: 0`* is needed so that we can check the repo age.
You 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`.
## API
### Install
```sh
npm install awesome-lint
```
### Usage
```js
import awesomeLint from 'awesome-lint';
// Lint the current directory's readme.md
await awesomeLint.report();
// Lint a specific file
await awesomeLint.report({filename: 'my-awesome-list.md'});
// Lint a GitHub repository
await awesomeLint.report({filename: 'https://github.com/sindresorhus/awesome'});
// Get raw results without console output
const files = await awesomeLint();
```
### API
#### awesomeLint(options?)
Returns a `Promise` for an array of [`VFile`](https://github.com/vfile/vfile) objects containing lint results.
##### options
Type: `object`
###### filename
Type: `string`
Default: `'readme.md'`
Path to the file to lint, or a GitHub repository URL.
###### config
Type: `Array`
Default: `config` (from `config.js`)
Custom remark plugins configuration.
#### awesomeLint.report(options?)
Lint and display results to the console. Returns a `Promise` that resolves when linting is complete.
Takes the same options as `awesomeLint()`, plus:
##### options.reporter
Type: `Function`
Custom reporter function to format the output.