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:

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

Rules

• Array Foreach
• Async Currenttarget
• Async Preventdefault
• Authenticity Token
• Get Attribute
• JS Class Name
• No Blur
• No D None
• No Dataset
• No Dynamic Script Tag
• No Implicit Buggy Globals
• No Inner HTML
• No InnerText
• No Then
• No Useless Passive
• Prefer Observers
• Require Passive Events
• Unescaped HTML Literal

Accessibility-focused rules (prefixed with a11y)

• No Generic Link Text