Skip to content

An opinionated collection of ESLint rules used by GitHub.

License

Notifications You must be signed in to change notification settings

cordis-dev/eslint-plugin-github

 
 

Repository files navigation

eslint-plugin-github

Node CI

Installation

$ npm install --save-dev eslint eslint-plugin-github

Setup

Add github to your list of plugins in your ESLint config.

JSON ESLint config example:

{
  "plugins": ["github"]
}

Extend the configs you wish to use.

JSON ESLint config example:

{
  "extends": ["plugin:github/recommended"]
}

The available configs are:

  • internal
    • Rules useful for github applications.
  • browser
    • Useful rules when shipping your app to the browser.
  • recommended
    • Recommended rules for every application.
  • typescript
    • Useful rules when writing TypeScript.

About

An opinionated collection of ESLint rules used by GitHub.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%