awesome-lint 0,0,0,0 editorconfig travis-ci npm

Linter for Awesome lists

2 years after


awesome-lint


Linter for Awesome lists

Build Status Gitter

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 --save awesome-lint

Usage

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

awesomeLint.report();

Docs

awesomeLint()

Returns a Promise for a VFile.

awesomeLint.report()

Show the lint output.

License

MIT © Sindre Sorhus

Related Repositories

awesome-ruby

awesome-ruby

A curated list of awesome Ruby frameworks, libraries and resources. Inspired by ...

awesome-webpack

awesome-webpack

A curated list of awesome Webpack resources, libraries and tools ...

awesome-eslint

awesome-eslint

A list of awesome ESLint plugins, configs, etc. ...

awesome-android-tools

awesome-android-tools

A curated list of awesome Android Tools. ...

lint-review

lint-review

An automated code linting bot that integrates various code lint tools with githu ...


Top Contributors

sindresorhus matheuss

Dependencies

package version
globby ^6.0.0
meow ^3.7.0
pify ^2.3.0
remark ^5.0.1
remark-lint ^4.1.0
remark-lint-no-empty-sections ^1.0.0
remark-lint-no-url-trailing-slash ^2.0.0
to-vfile ^1.0.0
unist-util-visit ^1.1.0
vfile-reporter-pretty ^0.1.0
dev ava *
execa ^0.4.0
xo *

Releases

-   v0.1.0 zip tar