Skip to content
An opinionated collection of ESLint shared configs and rules used by GitHub.
JavaScript
Branch: master
Clone or download

Latest commit

Latest commit 70e8521 May 12, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows deprecate node 8 May 11, 2020
bin remove scripts Mar 19, 2020
docs/rules remove docs/configs.md Mar 19, 2020
lib turn off `interface-name-prefix` rule Apr 1, 2020
tests set output in tests May 11, 2020
.eslintrc.js set root file May 11, 2020
.flowconfig Add flowconfig Jan 13, 2018
.gitignore Check in package-lock file Aug 20, 2019
.prettierignore Format package json with npm, not prettier Apr 23, 2018
.travis.yml Update node versions Aug 20, 2019
CODEOWNERS Create CODEOWNERS Mar 19, 2020
LICENSE Add LICENSE Mar 28, 2016
README.md fix weird docs example Mar 19, 2020
package-lock.json update eslint May 11, 2020
package.json update eslint May 11, 2020

README.md

eslint-plugin-github

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:

  • app
    • 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.
You can’t perform that action at this time.