@zendeskgarden/eslint-config 40.0.0 → 42.0.0

package/README.md

@@ -1,11 +1,9 @@
-# Garden ESLint Config [![npm version][npm version badge]][npm version link] [![Build Status][build status badge]][build status link] [![Dependency Status][dependency status badge]][dependency status link]
+# Garden ESLint Config [![npm version][npm version badge]][npm version link] [![Build Status][build status badge]][build status link]
 
 [npm version badge]: https://flat.badgen.net/npm/v/@zendeskgarden/eslint-config
 [npm version link]: https://www.npmjs.com/package/@zendeskgarden/eslint-config
 [build status badge]: https://flat.badgen.net/circleci/github/zendeskgarden/eslint-config/main?label=build
 [build status link]: https://circleci.com/gh/zendeskgarden/eslint-config/tree/main
-[dependency status badge]: https://flat.badgen.net/david/dev/zendeskgarden/eslint-config?label=dependencies
-[dependency status link]: https://david-dm.org/zendeskgarden/eslint-config?type=dev
 
 > :seedling: Garden is the design system by Zendesk
 
@@ -16,22 +14,22 @@ selection of associated [plugins](#plugins).
 ## Installation
 
 ```sh
-npm install eslint @babel/eslint-parser eslint-plugin-node @zendeskgarden/eslint-config
+npm install eslint @zendeskgarden/eslint-config
 ```
 
 ## Usage
 
-Add a `.eslintrc.json` to your project with an `extends` property like this:
+Add a `eslint.config.mjs` to your project like this:
 
-```json
-{
-  "extends": "@zendeskgarden"
-}
+```js
+import config from '@zendeskgarden/eslint-config';
+
+export default config;
 ```
 
 Now Garden linting rules will apply to your project. See the [ESLint
-Documentation](http://eslint.org/docs/user-guide/configuring#extending-configuration-files)
-for more details on extending shareable configuration files.
+Documentation](https://eslint.org/docs/latest/extend/shareable-configs#using-a-shareable-config)
+for more details on using shareable configuration files.
 
 ### Plugins
 
@@ -43,104 +41,102 @@ Install the following dependency in addition to those [listed](#installation)
 above.
 
 ```sh
-npm install jest eslint-plugin-jest
+npm install jest
 ```
 
-Extend the base configuration.
+Update the default configuration.
+
+```js
+import config from '@zendeskgarden/eslint-config';
+import jestPlugin from '@zendeskgarden/eslint-config/plugins/jest.js';
 
-```json
-{
-  "extends": ["@zendeskgarden", "@zendeskgarden/eslint-config/plugins/jest"]
-}
+export default [...config, jestPlugin];
 ```
 
 In some cases, it may be useful to limit the scope of the Jest rules via
-`overrides`.
-
-```json
-{
-  "extends": "@zendeskgarden",
-  "overrides": [
-    {
-      "files": ["*.spec.*"],
-      "extends": "@zendeskgarden/eslint-config/plugins/jest"
-    }
-  ]
-}
+`files`.
+
+```js
+export default [
+  ...config,
+  {
+    files: ['**/*.spec.*'],
+    ...jestPlugin
+  }
+];
 ```
 
 #### React
 
 The React plugin bundles rules for React, React Hooks, and JSX accessibility.
-Install the following dependencies in addition to those
-[listed](#installation) above.
+Install the following dependency in addition to those [listed](#installation)
+above.
 
 ```sh
-npm install eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y
+npm install react
 ```
 
-Extend the base configuration.
+Update the default configuration.
+
+```js
+import config from '@zendeskgarden/eslint-config';
+import reactPlugin from '@zendeskgarden/eslint-config/plugins/react.js';
 
-```json
-{
-  "extends": ["@zendeskgarden", "@zendeskgarden/eslint-config/plugins/react"]
-}
+export default [...config, reactPlugin];
 ```
 
 #### TypeScript
 
-Install the following dependencies in addition to those
-[listed](#installation) above.
+Install the following dependency in addition to those [listed](#installation)
+above.
 
 ```sh
-npm install typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
+npm install typescript
 ```
 
-Extend the base configuration.
+Update the default configuration.
+
+```js
+import config from '@zendeskgarden/eslint-config';
+import typescriptPlugin from '@zendeskgarden/eslint-config/plugins/typescript.js';
 
-```json
-{
-  "extends": [
-    "@zendeskgarden",
-    "@zendeskgarden/eslint-config/plugins/typescript"
-  ]
-}
+export default [...config, typescriptPlugin];
 ```
 
 For mixed JS and TS codebases, it may be useful to limit the scope of the
-TypeScript rules via `overrides`.
-
-```json
-{
-  "extends": "@zendeskgarden",
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx"],
-      "extends": "@zendeskgarden/eslint-config/plugins/typescript"
-    }
-  ]
-}
+TypeScript rules via `files`.
+
+```js
+export default [
+  ...config,
+  {
+    files: ['**/*.{ts, tsx}'],
+    ...typescriptPlugin
+  }
+];
 ```
 
 The `typescript` plugin covers rules for syntax checking. An additional
-`typescript-semantics` plugin provides rules based on semantics. The
-`typescript-semantics` plugin requires type information in order to execute.
-Set `parserOptions.project` to a valid TSConfig for the project. See
-[typescript-eslint
-documentation](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md)
+`typescript-type-checked` plugin provides rules based on semantics. The
+`typescript-type-checked` plugin requires type information in order to execute.
+Set `languageOptions.parserOptions.project` to a valid TSConfig for the project. See
+[typescript-eslint documentation](https://typescript-eslint.io/getting-started/typed-linting)
 for details.
 
-```json
-{
-  "extends": [
-    "@zendeskgarden",
-    "@zendeskgarden/eslint-config/plugins/typescript",
-    "@zendeskgarden/eslint-config/plugins/typescript-semantics"
-  ],
-  "parserOptions": {
-    "project": ["./tsconfig.json"]
+```js
+export default [
+  ...config,
+  typescriptPlugin,
+  typescriptTypeCheckedPlugin,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.json'],
+        requireConfigFile: false
+      }
+    }
   }
-}
+];
 ```
 
 ## Resources
@@ -167,6 +163,6 @@ conduct](.github/CODE_OF_CONDUCT.md). Please participate accordingly.
 
 ## License
 
-Copyright 2021 Zendesk
+Copyright 2024 Zendesk
 
 Licensed under the [Apache License, Version 2.0](LICENSE.md)

package/index.js

@@ -5,34 +5,38 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-module.exports = {
-  extends: [
-    './rules/possible-errors',
-    './rules/best-practices',
-    './rules/strict-mode',
-    './rules/variables',
-    './rules/stylistic-issues',
-    './rules/es6',
-    './plugins/node/possible-errors',
-    './plugins/node/best-practices',
-    './plugins/node/stylistic-issues'
-  ].map(require.resolve),
-  parser: '@babel/eslint-parser',
-  env: {
-    browser: true,
-    es2020: true,
-    node: true
-  },
-  parserOptions: {
-    sourceType: 'module',
-    ecmaFeatures: {
-      // allow `return` statements in the global scope
-      globalReturn: false,
-      // enable global strict mode
-      impliedStrict: true,
-      // enable JSX
-      jsx: true
+import babelParser from '@babel/eslint-parser';
+import eslintLayoutFormatting from './rules/layout-formatting.js';
+import eslintPossibleProblems from './rules/possible-problems.js';
+import eslintSuggestions from './rules/suggestions.js';
+import globals from 'globals';
+import nodePlugin from './plugins/node.js';
+
+export default [
+  eslintLayoutFormatting,
+  eslintPossibleProblems,
+  eslintSuggestions,
+  nodePlugin,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.es2020
+      },
+      parser: babelParser,
+      parserOptions: {
+        ecmaFeatures: {
+          // allow `return` statements in the global scope
+          globalReturn: false,
+          // enable global strict mode
+          impliedStrict: true,
+          // enable JSX
+          jsx: true
+        }
+      }
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: true
     }
-  },
-  reportUnusedDisableDirectives: true
-};
+  }
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/eslint-config",
-  "version": "40.0.0",
+  "version": "42.0.0",
   "description": "Garden ESLint config",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -9,6 +9,7 @@
   "bugs": {
     "url": "https://github.com/zendeskgarden/eslint-config/issues"
   },
+  "type": "module",
   "main": "index.js",
   "files": [
     "plugins",
@@ -16,28 +17,29 @@
   ],
   "scripts": {
     "format": "prettier-package-json --write",
-    "lint": "eslint index.js plugins/*.js rules/*.js --max-warnings 0",
+    "lint": "eslint eslint.config.js index.js plugins/*.js rules/*.js --max-warnings 0",
     "prepare": "husky",
     "tag": "[ `git rev-parse --abbrev-ref HEAD` = 'main' ] && standard-version --no-verify",
     "test": "npm run format && npm run lint && git diff --quiet"
   },
+  "dependencies": {
+    "@babel/eslint-parser": "7.24.7",
+    "@eslint/compat": "1.1.0",
+    "eslint-plugin-jest": "28.6.0",
+    "eslint-plugin-jsx-a11y": "6.9.0",
+    "eslint-plugin-n": "17.9.0",
+    "eslint-plugin-notice": "1.0.0",
+    "eslint-plugin-react": "7.34.3",
+    "eslint-plugin-react-hooks": "4.6.2",
+    "globals": "15.6.0",
+    "typescript-eslint": "7.13.1"
+  },
   "peerDependencies": {
-    "@babel/eslint-parser": "^7.15.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-n": "^17.0.0"
+    "eslint": "^9.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.24.5",
-    "@babel/eslint-parser": "7.24.5",
-    "@typescript-eslint/eslint-plugin": "7.8.0",
-    "@typescript-eslint/parser": "7.8.0",
-    "eslint": "8.57.0",
-    "eslint-plugin-jest": "28.5.0",
-    "eslint-plugin-jsx-a11y": "6.8.0",
-    "eslint-plugin-n": "17.6.0",
-    "eslint-plugin-notice": "0.9.10",
-    "eslint-plugin-react": "7.34.1",
-    "eslint-plugin-react-hooks": "4.6.2",
+    "@babel/core": "7.24.7",
+    "eslint": "9.5.0",
     "husky": "9.0.11",
     "jest": "29.7.0",
     "prettier-package-json": "2.8.0",

package/plugins/jest.js

@@ -5,14 +5,25 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-module.exports = {
-  plugins: ['jest'],
-  env: { 'jest/globals': true },
+import globals from 'globals';
+import jestPlugin from 'eslint-plugin-jest';
+
+export default {
+  plugins: {
+    jest: jestPlugin
+  },
+  languageOptions: {
+    globals: globals.jest
+  },
   rules: {
     // have control over `test` and `it` usages
     'jest/consistent-test-it': 0,
     // enforce assertion to be made in a test body
     'jest/expect-expect': 2,
+    // enforces a maximum number assertion calls in a test body
+    'max-expects': 0,
+    // enforces a maximum depth to nested describe calls
+    'max-nested-describe': 0,
     // disallow alias methods
     'jest/no-alias-methods': 2,
     // disallow commented out tests
@@ -21,6 +32,8 @@ module.exports = {
     'jest/no-conditional-expect': 0,
     // disallow conditionals in test
     'jest/no-conditional-in-test': 0,
+    // isallow confusing usages of jest.setTimeout
+    'jest/no-confusing-set-timeout': 2,
     // disallow use of deprecated functions
     'jest/no-deprecated-functions': 2,
     // disallow disabled tests
@@ -45,6 +58,8 @@ module.exports = {
     'jest/no-large-snapshots': 0,
     // disallow manually importing from `__mocks__`
     'jest/no-mocks-import': 2,
+    // disallow specific `jest.` methods
+    'jest/no-restricted-jest-methods': 0,
     // disallow specific matchers & modifiers
     'jest/no-restricted-matchers': 0,
     // disallow using `expect` outside of `it` or `test` blocks
@@ -57,16 +72,28 @@ module.exports = {
     'jest/no-untyped-mock-factory': 2,
     // suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()`
     'jest/prefer-called-with': 0,
+    // suggest using the built-in comparison matchers
+    'jest/prefer-comparison-matcher': 2,
     // prefer using `.each` rather than manual loops
     'jest/prefer-each': 2,
+    // suggest using the built-in equality matchers
+    'jest/prefer-equality-matcher': 2,
     // suggest using `expect.assertions()` OR `expect.hasAssertions()`
     'jest/prefer-expect-assertions': 0,
     // suggest `await expect(...).resolves` over `expect(await ...)` syntax
     'jest/prefer-expect-resolves': 2,
+    // prefer having hooks in a consistent order
+    'jest/prefer-hooks-in-order': 2,
     // suggest having hooks before any test cases
     'jest/prefer-hooks-on-top': 0,
+    // prefer importing Jest globals
+    'jest/prefer-importing-jest-globals': 0,
+    // prefer `jest.mocked()` over `fn as jest.Mock`
+    'jest/prefer-jest-mocked': 2,
     // enforce lowercase test names
     'jest/prefer-lowercase-title': [1, { ignore: ['describe'] }],
+    // prefer mock resolved/rejected shorthands for promises
+    'jest/prefer-mock-promise-shorthand': 1,
     // suggest having a hint for snapshots
     'jest/prefer-snapshot-hint': 1,
     // suggest using `jest.spyOn()`

package/plugins/node.js

@@ -0,0 +1,96 @@
+/**
+ * Copyright Zendesk, Inc.
+ *
+ * Use of this source code is governed under the Apache License, Version 2.0
+ * found at http://www.apache.org/licenses/LICENSE-2.0.
+ */
+
+import globals from 'globals';
+import nodePlugin from 'eslint-plugin-n';
+
+export default {
+  plugins: {
+    n: nodePlugin
+  },
+  languageOptions: {
+    globals: globals.node
+  },
+  rules: {
+    // enforce `return` after a callback
+    'n/callback-return': 0,
+    // enforce either `module.exports` or `exports`
+    'n/exports-style': 0,
+    // enforce the style of file extensions in `import` declarations
+    'n/file-extension-in-import': 0,
+    // enforce `require()` on top-level module scope
+    'n/global-require': 1,
+    // require error handling in callbacks
+    'n/handle-callback-err': 0,
+    // suggest correct usage of hashbang
+    'n/hashbang': 0,
+    // ensure Node.js-style error-first callback pattern is followed
+    'n/no-callback-literal': 1,
+    // disallow deprecated APIs
+    'n/no-deprecated-api': 2,
+    // disallow the assignment to `exports`
+    'n/no-exports-assign': 2,
+    // disallow `import` declarations which import extraneous modules
+    'n/no-extraneous-import': 0,
+    // disallow `require()` expressions which import extraneous modules
+    'n/no-extraneous-require': 0,
+    // disallow `import` declarations which import non-existence modules
+    'n/no-missing-import': 0,
+    // disallow `require()` expressions which import non-existence modules
+    'n/no-missing-require': 2,
+    // disallow mixing regular variable and `require` declarations
+    'n/no-mixed-requires': [0, false],
+    // disallow `new` operators with calls to `require`
+    'n/no-new-require': 0,
+    // disallow string concatenation with `__dirname` and `__filename`
+    'n/no-path-concat': 2,
+    // disallow use of `process.env`
+    'n/no-process-env': 0,
+    // disallow `process.exit()`
+    'n/no-process-exit': 2,
+    // disallow specified modules when loaded by `import` declarations
+    'n/no-restricted-import': 0,
+    // disallow specified modules when loaded by `require`
+    'n/no-restricted-require': 0,
+    // disallow use of synchronous methods
+    'n/no-sync': 0,
+    // disallow `bin` files that npm ignores
+    'n/no-unpublished-bin': 2,
+    // disallow `import` declarations which import private modules
+    'n/no-unpublished-import': 0,
+    // disallow `require()` expressions which import private modules
+    'n/no-unpublished-require': 0,
+    // disallow unsupported ECMAScript built-ins on the specified version
+    'n/no-unsupported-features/es-builtins': 2,
+    // disallow unsupported ECMAScript syntax on the specified version
+    'n/no-unsupported-features/es-syntax': 0,
+    // disallow unsupported Node.js built-in APIs on the specified version
+    'n/no-unsupported-features/node-builtins': 2,
+    // enforce either `Buffer` or `require("buffer").Buffer`
+    'n/prefer-global/buffer': [2, 'always'],
+    // enforce either `console` or `require("console")`
+    'n/prefer-global/console': [2, 'always'],
+    // enforce either `process` or `require("process")`
+    'n/prefer-global/process': [2, 'always'],
+    // enforce either `TextDecoder` or `require("util").TextDecoder`
+    'n/prefer-global/text-decoder': [2, 'always'],
+    // enforce either `TextEncoder` or `require("util").TextEncoder`
+    'n/prefer-global/text-encoder': [2, 'always'],
+    // enforce either `URL` or `require("url").URL`
+    'n/prefer-global/url': [2, 'always'],
+    // enforce either `URLSearchParams` or `require("url").URLSearchParams`
+    'n/prefer-global/url-search-params': [2, 'always'],
+    // enforce using the `node:` protocol when importing Node.js builtin modules
+    'n/prefer-node-protocol': [2, { version: '>=16.0.0' }],
+    // enforce `require("dns").promises`
+    'n/prefer-promises/dns': 1,
+    // enforce `require("fs").promises`
+    'n/prefer-promises/fs': 1,
+    // make process.exit() expressions the same code path as throw
+    'n/process-exit-as-throw': 2
+  }
+};

package/plugins/notice.js

@@ -7,13 +7,20 @@ const TEMPLATE = `/**
 
 `;
 
-module.exports = {
-  plugins: ['notice'],
+import noticePlugin from 'eslint-plugin-notice';
+
+export default {
+  plugins: {
+    notice: noticePlugin
+  },
   rules: {
     // throw an error when a file doesn't have a copyright notice
-    'notice/notice': [2, {
-      template: TEMPLATE,
-      onNonMatchingHeader: 'replace'
-    }]
+    'notice/notice': [
+      2,
+      {
+        template: TEMPLATE,
+        onNonMatchingHeader: 'replace'
+      }
+    ]
   }
 };

package/plugins/react.js

@@ -5,12 +5,23 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 
-module.exports = {
-  plugins: ['react', 'react-hooks', 'jsx-a11y'],
-  extends: ['plugin:jsx-a11y/recommended'],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true
+import { fixupPluginRules } from '@eslint/compat';
+import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import reactPlugin from 'eslint-plugin-react';
+
+export default {
+  plugins: {
+    react: reactPlugin,
+    // TODO remove fixup when eslint-plugin-react-hooks 5.x is released
+    'react-hooks': fixupPluginRules(reactHooksPlugin),
+    'jsx-a11y': jsxA11yPlugin
+  },
+  languageOptions: {
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true
+      }
     }
   },
   settings: {
@@ -19,6 +30,9 @@ module.exports = {
     }
   },
   rules: {
+    ...jsxA11yPlugin.configs.recommended.rules,
+    // disallow `aria-hidden="true"` from being set on focusable elements
+    'jsx-a11y/no-aria-hidden-on-focusable': 2,
     // enforces using semantic DOM elements over the ARIA role property.
     'jsx-a11y/prefer-tag-over-role': 2,
 
@@ -26,6 +40,8 @@ module.exports = {
     'react/boolean-prop-naming': 1,
     // forbid "button" element without an explicit "type" attribute
     'react/button-has-type': 2,
+    // enforce using `onChange` or `readonly` attribute when checked is used
+    'react/checked-requires-onchange-or-readonly': 2,
     // enforce all defaultProps are defined and not "required" in propTypes
     'react/default-props-match-prop-types': 0,
     // enforce consistent usage of destructuring assignment of props, state, and context
@@ -102,6 +118,8 @@ module.exports = {
     'react/jsx-no-constructed-context-values': 2,
     // enforce no duplicate props
     'react/jsx-no-duplicate-props': 2,
+    // disallow problematic leaked values from being rendered
+    'react/jsx-no-leaked-render': 2,
     // prevent using string literals in React component definition
     'react/jsx-no-literals': 0,
     // forbid `javascript:` URLs
@@ -182,6 +200,8 @@ module.exports = {
     'react/no-unknown-property': 2,
     // prevent usage of unsafe lifecycle methods
     'react/no-unsafe': 2,
+    // disallow creating unstable components inside components
+    'react/no-unstable-nested-components': 2,
     // Prevent declaring unused methods of component class
     'react/no-unused-class-component-methods': 2,
     // prevent definitions of unused prop types