Repository files navigation

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

Addgithub 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"]}

Import theeslint-plugin-github, and extend any of the configurations usinggetFlatConfigs() as needed like so:

importgithubfrom'eslint-plugin-github'exportdefault[github.getFlatConfigs().browser,github.getFlatConfigs().recommended,github.getFlatConfigs().react,  ...github.getFlatConfigs().typescript,{files:['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],ignores:['eslint.config.mjs'],rules:{'github/array-foreach':'error','github/async-preventdefault':'warn','github/no-then':'error','github/no-blur':'error',},},]

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.

Note: This is experimental and subject to change.

Thereact config includes rules which target specific HTML elements. You may provide a mapping of custom components to an HTML element in youreslintrc configuration to increase linter coverage.

By default, these eslint rules will check the "as" prop for underlying element changes. If your repo uses a different prop name for polymorphic components provide the prop name in youreslintrc configuration underpolymorphicPropName.

{"settings": {"github": {"polymorphicPropName":"asChild","components": {"Box":"p","Link":"a"      }    }  }}

This config will be interpreted in the following way:

• All<Box> elements will be treated as ap element type.
• <Link> without a definedas prop will be treated as aa.
• <Link as='button'> will be treated as abutton element type.

💼 Configurations enabled in.
🔍 Set in thebrowser configuration.
🔐 Set in theinternal configuration.
⚛️ Set in thereact configuration.
✅ Set in therecommended configuration.
🔧 Automatically fixable by the--fix CLI option.
❌ Deprecated.