eslint-plugin-github

An opinionated collection of ESLint shared configs and rules used by GitHub.

Usage no npm install needed!

<script type="module">
  import eslintPluginGithub from 'https://cdn.skypack.dev/eslint-plugin-github';
</script>

README

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:

  • 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.

Rules