Configs

This ESLint plugin comes with a few configuration presets. After installing the package, the recommended set of rules can be enabled with:

.eslintrc.json

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

When setting up a new project, it's recommended that you use the initialization to generate a customized ESLint config for the project.

$ node_modules/.bin/eslint-github-init

Available Configs

A base layer of configuration recommended for any JS project. The Prettier formatter is used to format code.

Recommended rules when using Babel to transpile features from ES2015+.

Recommended rules when writing a browser application.

Recommended rules when writing a node application.