This package has been deprecated

    Author message:

    Use GitHub Community Profile. https://help.github.com/articles/about-community-profiles-for-public-repositories/

    ghlint

    0.9.1 • Public • Published

    Deprecated

    Use GitHub Community Profile.

    ghlint

    npm version Build Status Dependency Status Code Climate

    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.

    1. Install Node.
    2. npm install -g ghlint
    3. ghlint

    Library

    1. Install Node.
    2. 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.

    Keywords

    Install

    npm i ghlint

    DownloadsWeekly Downloads

    6

    Version

    0.9.1

    License

    MIT

    Unpacked Size

    33.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • nickmccurdy