Linter for Awesome lists

Intended to make it easier to create and maintain Awesome lists.

Includes a bunch of general Markdown rules and some Awesome specific rules.

CLI

Install

$ npm install --global awesome-lint

Usage

❯ awesome-lint

  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

Tip

Add it as a test script in package.json and activate Travis CI to lint on new commits and pull requests.

package.json

{
	"scripts": {
		"test": "awesome-lint"
	},
	"devDependencies": {
		"awesome-lint": "*"
	}
}

.travis.yml

language: node_js
node_js:
  - 'node'

API

Install

$ npm install awesome-lint

Usage

const awesomeLint = require('awesome-lint');

awesomeLint.report();

Docs

awesomeLint()

Returns a Promise for a VFile.

awesomeLint.report()

Show the lint output. This can be custom reported by setting options.reporter=<function> and passing in options as a parameter.

Maintainers

• Sindre Sorhus
• Travis Fischer

License

MIT