Merge pull request #571 from github/gracepark-support-flat-config

Support flat config and upgrade eslint to v9

.eslint-doc-generatorrc.js

@@ -3,7 +3,7 @@ module.exports = {
   configEmoji: [
     ['browser', '🔍'],
     ['internal', '🔐'],
-    ['react', '⚛️']
+    ['react', '⚛️'],
   ],
   ruleDocSectionInclude: ['Rule Details', 'Version'],
-};
+}

README.md

@@ -8,6 +8,8 @@ npm install --save-dev eslint eslint-plugin-github
 
 ## Setup
 
+### Legacy Configuration (`.eslintrc`)
+
 Add `github` to your list of plugins in your ESLint config.
 
 JSON ESLint config example:
@@ -28,6 +30,31 @@ JSON ESLint config example:
 }
 ```
 
+### Flat Configuration (`eslint-config.js`)
+
+Import the `eslint-plugin-github`, and extend any of the configurations using `getFlatConfigs()` as needed like so:
+
+```js
+import github from 'eslint-plugin-github'
+
+export default [
+  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`

eslint.config.js

@@ -0,0 +1,39 @@
+const globals = require('globals')
+const eslintPlugin = require('eslint-plugin-eslint-plugin')
+const importPlugin = require('eslint-plugin-import')
+const filenames = require('eslint-plugin-filenames')
+const i18nTextPlugin = require('eslint-plugin-i18n-text')
+const recommendedGitHub = require('./lib/configs/flat/recommended')
+const {fixupPluginRules} = require('@eslint/compat')
+
+module.exports = [
+  recommendedGitHub,
+  eslintPlugin.configs['flat/all'],
+  {
+    ignores: ['test-examples/**'],
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 13,
+      globals: {
+        ...globals.es6,
+        ...globals.node,
+      },
+    },
+    plugins: {
+      eslintPlugin,
+      importPlugin,
+      filenames,
+      'i18n-text': fixupPluginRules(i18nTextPlugin),
+    },
+    rules: {
+      'importPlugin/extensions': 'off',
+      'importPlugin/no-commonjs': 'off',
+      'filenamesPlugin/match-regex': 'off',
+      'i18n-text/no-en': 'off',
+      'eslint-plugin/prefer-placeholders': 'off',
+      'eslint-plugin/test-case-shorthand-strings': 'off',
+      'eslint-plugin/require-meta-docs-url': 'off',
+    },
+  },
+]

lib/configs/flat/browser.js

@@ -0,0 +1,36 @@
+const globals = require('globals')
+const github = require('../../plugin')
+const importPlugin = require('eslint-plugin-import')
+const escompatPlugin = require('eslint-plugin-escompat')
+
+module.exports = {
+  ...escompatPlugin.configs['flat/recommended'],
+  languageOptions: {
+    globals: {
+      ...globals.browser,
+    },
+  },
+  plugins: {importPlugin, escompatPlugin, github},
+  rules: {
+    'escompatPlugin/no-dynamic-imports': 'off',
+    'github/async-currenttarget': 'error',
+    'github/async-preventdefault': 'error',
+    'github/get-attribute': 'error',
+    'github/no-blur': 'error',
+    'github/no-dataset': 'error',
+    'github/no-innerText': 'error',
+    'github/no-inner-html': 'error',
+    'github/unescaped-html-literal': 'error',
+    'github/no-useless-passive': 'error',
+    'github/require-passive-events': 'error',
+    'github/prefer-observers': 'error',
+    'importPlugin/no-nodejs-modules': 'error',
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: "NewExpression[callee.name='URL'][arguments.length=1]",
+        message: 'Please pass in `window.location.origin` as the 2nd argument to `new URL()`',
+      },
+    ],
+  },
+}

lib/configs/flat/internal.js

@@ -0,0 +1,10 @@
+const github = require('../../plugin')
+
+module.exports = {
+  plugins: {github},
+  rules: {
+    'github/authenticity-token': 'error',
+    'github/js-class-name': 'error',
+    'github/no-d-none': 'error',
+  },
+}

lib/configs/flat/react.js

@@ -0,0 +1,47 @@
+const github = require('../../plugin')
+const jsxA11yPlugin = require('eslint-plugin-jsx-a11y')
+
+module.exports = {
+  ...jsxA11yPlugin.flatConfigs.recommended,
+  languageOptions: {
+    sourceType: 'module',
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+  plugins: {github, jsxA11yPlugin},
+  rules: {
+    'jsxA11yPlugin/role-supports-aria-props': 'off', // Override with github/a11y-role-supports-aria-props until https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/910 is resolved
+    'github/a11y-aria-label-is-well-formatted': 'error',
+    'github/a11y-no-visually-hidden-interactive-element': 'error',
+    'github/a11y-no-title-attribute': 'error',
+    'github/a11y-svg-has-accessible-name': 'error',
+    'github/a11y-role-supports-aria-props': 'error',
+    'jsxA11yPlugin/no-aria-hidden-on-focusable': 'error',
+    'jsxA11yPlugin/no-autofocus': 'off',
+    'jsxA11yPlugin/anchor-ambiguous-text': [
+      'error',
+      {
+        words: ['this', 'more', 'read here', 'read more'],
+      },
+    ],
+    'jsxA11yPlugin/no-interactive-element-to-noninteractive-role': [
+      'error',
+      {
+        tr: ['none', 'presentation'],
+        td: ['cell'], // TODO: Remove once https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/pull/937#issuecomment-1638128318 is addressed.
+        canvas: ['img'],
+      },
+    ],
+    'jsxA11yPlugin/no-redundant-roles': [
+      'error',
+      {
+        nav: ['navigation'], // default in eslint-plugin-jsx-a11y
+        tbody: ['rowgroup'],
+        thead: ['rowgroup'],
+      },
+    ],
+  },
+}

lib/configs/flat/recommended.js

@@ -0,0 +1,150 @@
+const globals = require('globals')
+const github = require('../../plugin')
+const prettierPlugin = require('eslint-plugin-prettier')
+const eslintComments = require('eslint-plugin-eslint-comments')
+const importPlugin = require('eslint-plugin-import')
+const filenames = require('eslint-plugin-filenames')
+const i18nTextPlugin = require('eslint-plugin-i18n-text')
+const noOnlyTestsPlugin = require('eslint-plugin-no-only-tests')
+const {fixupPluginRules} = require('@eslint/compat')
+
+module.exports = {
+  languageOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+    globals: {
+      ...globals.es6,
+    },
+  },
+  plugins: {
+    filenamesPlugin: fixupPluginRules(filenames),
+    prettierPlugin,
+    eslintComments,
+    importPlugin,
+    'i18n-text': fixupPluginRules(i18nTextPlugin),
+    noOnlyTestsPlugin,
+    github,
+  },
+  rules: {
+    'constructor-super': 'error',
+    'eslintComments/disable-enable-pair': 'off',
+    'eslintComments/no-aggregating-enable': 'off',
+    'eslintComments/no-duplicate-disable': 'error',
+    'eslintComments/no-unlimited-disable': 'error',
+    'eslintComments/no-unused-disable': 'error',
+    'eslintComments/no-unused-enable': 'error',
+    'eslintComments/no-use': ['error', {allow: ['eslint', 'eslint-disable-next-line', 'eslint-env', 'globals']}],
+    'filenamesPlugin/match-regex': ['error', '^[a-z0-9-]+(.[a-z0-9-]+)?$'],
+    'func-style': ['error', 'declaration', {allowArrowFunctions: true}],
+    'github/array-foreach': 'error',
+    'github/no-implicit-buggy-globals': 'error',
+    'github/no-then': 'error',
+    'github/no-dynamic-script-tag': 'error',
+    'i18n-text/no-en': ['error'],
+    'importPlugin/default': 'error',
+    'importPlugin/export': 'error',
+    'importPlugin/extensions': 'error',
+    'importPlugin/first': 'error',
+    'importPlugin/named': 'error',
+    'importPlugin/namespace': 'error',
+    'importPlugin/no-absolute-path': 'error',
+    'importPlugin/no-amd': 'error',
+    'importPlugin/no-anonymous-default-export': [
+      'error',
+      {
+        allowAnonymousClass: false,
+        allowAnonymousFunction: false,
+        allowArray: true,
+        allowArrowFunction: false,
+        allowLiteral: true,
+        allowObject: true,
+      },
+    ],
+    'importPlugin/no-commonjs': 'error',
+    'importPlugin/no-deprecated': 'error',
+    'importPlugin/no-duplicates': 'error',
+    'importPlugin/no-dynamic-require': 'error',
+    'importPlugin/no-extraneous-dependencies': [0, {devDependencies: false}],
+    'importPlugin/no-mutable-exports': 'error',
+    'importPlugin/no-named-as-default': 'error',
+    'importPlugin/no-named-as-default-member': 'error',
+    'importPlugin/no-namespace': 'error',
+    'importPlugin/no-unresolved': 'error',
+    'importPlugin/no-webpack-loader-syntax': 'error',
+    'no-case-declarations': 'error',
+    'no-class-assign': 'error',
+    'no-compare-neg-zero': 'error',
+    'no-cond-assign': 'error',
+    'no-console': 'error',
+    'no-const-assign': 'error',
+    'no-constant-condition': 'error',
+    'no-control-regex': 'error',
+    'no-debugger': 'error',
+    'no-delete-var': 'error',
+    'no-dupe-args': 'error',
+    'no-dupe-class-members': 'error',
+    'no-dupe-keys': 'error',
+    'no-duplicate-case': 'error',
+    'no-empty': 'error',
+    'no-empty-character-class': 'error',
+    'no-empty-pattern': 'error',
+    'no-ex-assign': 'error',
+    'no-extra-boolean-cast': 'error',
+    'no-fallthrough': 'error',
+    'no-func-assign': 'error',
+    'no-global-assign': 'error',
+    'no-implicit-globals': 'error',
+    'no-implied-eval': 'error',
+    'no-inner-declarations': 'error',
+    'no-invalid-regexp': 'error',
+    'no-invalid-this': 'error',
+    'no-irregular-whitespace': 'error',
+    'no-new-symbol': 'error',
+    'no-obj-calls': 'error',
+    'no-octal': 'error',
+    'noOnlyTestsPlugin/no-only-tests': [
+      'error',
+      {
+        block: ['describe', 'it', 'context', 'test', 'tape', 'fixture', 'serial', 'suite'],
+      },
+    ],
+    'no-redeclare': 'error',
+    'no-regex-spaces': 'error',
+    'no-return-assign': 'error',
+    'no-self-assign': 'error',
+    'no-sequences': ['error'],
+    'no-shadow': 'error',
+    'no-sparse-arrays': 'error',
+    'no-this-before-super': 'error',
+    'no-throw-literal': 'error',
+    'no-undef': 'error',
+    'no-unreachable': 'error',
+    'no-unsafe-finally': 'error',
+    'no-unsafe-negation': 'error',
+    'no-unused-labels': 'error',
+    'no-unused-vars': 'error',
+    'no-useless-concat': 'error',
+    'no-useless-escape': 'error',
+    'no-var': 'error',
+    'object-shorthand': ['error', 'always', {avoidQuotes: true}],
+    'one-var': ['error', 'never'],
+    'prefer-const': 'error',
+    'prefer-promise-reject-errors': 'error',
+    'prefer-rest-params': 'error',
+    'prefer-spread': 'error',
+    'prefer-template': 'error',
+    'prettierPlugin/prettier': 'error',
+    'require-yield': 'error',
+    'use-isnan': 'error',
+    'valid-typeof': 'error',
+    camelcase: ['error', {properties: 'always'}],
+    eqeqeq: ['error', 'smart'],
+  },
+  settings: {
+    'importPlugin/resolver': {
+      node: {
+        extensions: ['.js', '.ts'],
+      },
+    },
+  },
+}

lib/configs/flat/typescript.js

@@ -0,0 +1,27 @@
+const eslint = require('@eslint/js')
+const tseslint = require('typescript-eslint')
+const escompatPlugin = require('eslint-plugin-escompat')
+const github = require('../../plugin')
+
+module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs.recommended, {
+  languageOptions: {
+    parser: tseslint.parser,
+  },
+  plugins: {'@typescript-eslint': tseslint.plugin, escompatPlugin, github},
+  rules: {
+    camelcase: 'off',
+    'no-unused-vars': 'off',
+    'no-shadow': 'off',
+    'no-invalid-this': 'off',
+    '@typescript-eslint/no-invalid-this': ['error'],
+    '@typescript-eslint/no-shadow': ['error'],
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/array-type': ['error', {default: 'array-simple'}],
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/explicit-member-accessibility': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+  },
+})