Deprecated
Use GitHub Community Profile.
ghlint
A linter for GitHub projects.
ghlint focuses on improving your GitHub project for its users and contributors. It's kind of like flint, except it knows about GitHub features and doesn't require your repository to be cloned locally.
ghlint can be used as a command line tool or a library. There is also a web app in development.
Usage
It is recommended that you register a GitHub application to increase your rate limits. Please register a GitHub application and set the GHLINT_ID
and GHLINT_SECRET
environment variables to your app's ID and secret.
Command Line
Please note that the command line is experimental, still requires a client ID and secret, and may be removed in the future.
- Install Node.
npm install -g ghlint
ghlint
Library
- Install Node.
npm install --save ghlint
API Documentation
There's no online copy of the docs yet, but they can be generated locally by installing docco and running docco *.js
in the root of the repo. Then just open docs/index.html
.