@aarongoldenthal/eslint-config-standard 34.0.0 → 35.0.0

package/README.md

@@ -5,25 +5,25 @@
 Custom ESLint configuration for all projects. Includes flat-config formatted
 configurations compatible with ESLint v9+ for the following:
 
-| Plugin Name                                       | Config filename                                                                  | Rule Prefix  |
-| ------------------------------------------------- | -------------------------------------------------------------------------------- | ------------ |
-| `eslint`                                          | [`base-configs.js`](./base-configs.js)                                           | none, `core` |
-| `@eslint-community/eslint-plugin-eslint-comments` | [`eslint-comments-config.js`](./eslint-comments-config.js)                       | `comments`   |
-| `eslint-plugin-jest`                              | [`jest-config.js`](./jest-config.js)                                             | `jest`       |
-| `eslint-plugin-jsdoc`                             | [`jsdoc-config.js`](./jsdoc-config.js)                                           | `jsdoc`      |
-| `eslint-plugin-n`                                 | [`node-config.js`](./node-config.js)                                             | `node`       |
-| `eslint-plugin-playwright`                        | [`playwright-config.js`](./playwright-config.js)                                 | `playwright` |
-| `eslint-plugin-promise`                           | [`promise-config.js`](./promise-config.js)                                       | `promise`    |
-| `eslint-plugin-unicorn`                           | [`unicorn-configs.js`](./unicorn-configs.js), [`esm-config.js`](./esm-config.js) | `unicorn`    |
-| `eslint-plugin-vitest`                            | [`vitest-config.js`](./vitest-config.js)                                         | `vitest`     |
+| Plugin Name                                       | Config name                                                                | Rule Prefix  |
+| ------------------------------------------------- | -------------------------------------------------------------------------- | ------------ |
+| `eslint`                                          | [`base-configs`](./base-configs.js)                                        | none, `core` |
+| `@eslint-community/eslint-plugin-eslint-comments` | [`eslint-comments-config`](./eslint-comments-config.js)                    | `comments`   |
+| `eslint-plugin-jest`                              | [`jest-config`](./jest-config.js)                                          | `jest`       |
+| `eslint-plugin-jsdoc`                             | [`jsdoc-config`](./jsdoc-config.js)                                        | `jsdoc`      |
+| `eslint-plugin-n`                                 | [`node-config`](./node-config.js)                                          | `node`       |
+| `eslint-plugin-playwright`                        | [`playwright-config`](./playwright-config.js)                              | `playwright` |
+| `eslint-plugin-promise`                           | [`promise-config`](./promise-config.js)                                    | `promise`    |
+| `eslint-plugin-unicorn`                           | [`unicorn-configs`](./unicorn-configs.js), [`esm-config`](./esm-config.js) | `unicorn`    |
+| `eslint-plugin-vitest`                            | [`vitest-config`](./vitest-config.js)                                      | `vitest`     |
 
 As flat configs, the package defines all required plugins/configurations as
 `dependencies`. Since flat config allows flexibility in the rule prefixes (that
 is, they don't have to match the plugin name), the rules prefixes are adapted
 in some cases to be more intuitive or readable. Since they may be combined, and
 flat config doesn't allow nested arrays of rules, file names that are singular
-export a single config object (for example `jsdoc-config.js`), and file names
-that are plural export an array of config objects (for example `base-configs.js`).
+export a single config object (for example `jsdoc-config`), and file names
+that are plural export an array of config objects (for example `base-configs`).
 
 The `core` prefix has only one rule, `core/complexity`, that has a higher threshold.
 This provides a secondary check for cases where the lower threshold in the `complexity`
@@ -34,7 +34,9 @@ rules is an experimental capability, this must be enabled with environment varia
 Most rule configurations are applicable to files matching `'**/*.{js,mjs,cjs}'`. The
 following configurations are exceptions and are applicable to files as noted:
 
-- `base-configs.js` includes a config that disables some rules for test files
+- `base-configs` sets `sourceType` to `commonjs` for `*.js`/`*.cjs` files and
+  `module` for `*.mjs` files.
+- `base-configs` includes a config that disables some rules for test files
   matching any of the following test patterns (for example `max-lines`,
   `max-lines-per-function`).
 - `jest-config` applies rules to files matching
@@ -43,33 +45,38 @@ following configurations are exceptions and are applicable to files as noted:
   `'**/__tests__/**/*.{js,mjs}'` or `'**/?(*.)+(spec|test).{js,mjs}'`.
 - `playwright-config`: applies rules to files matching `'**/*.pwtest.{js,mjs,cjs}'`,
   which differentiates them from Jest/Vitest test files.
-- `unicorn-configs.js` includes a config that disables some rules for test files
-  (matching any of the following test patterns).
+- `unicorn-configs` includes a config that disables some rules for test files
+  (matching any of the following test patterns), and applies some ESM-specific
+  rules only applicable to `*.mjs` files.
 
 With ESLint v9 the majority of formatting rules are deprecated and removed from
 `base-configs`, but the `eslint-config-prettier` package is included and can be
-added to the config if `prettier` is also being used to ensure it takes priority for
-formatting.
+added to the config if `prettier` is also being used to ensure it takes priority
+for formatting.
 
-There is also an `esm-config` included with rule overrides for projects using
-ES modules instead of Common JS modules.
+There is also an `esm-config` included for projects using ES modules instead of
+CommonJS modules. This config sets `sourceType` to `module` for `*.js` files and
+includes `unicorn-config` ESM-specific rules.
 
 ### Usage
 
-There is a `recommended` configuration with all plugin configurations enabled
-except `esm-config` and `vitest-config` (it does include `jest-config`). To
-configure `eslint.config.js` with this configuration:
+This module is now pure ESM, so must be called from an ESM file, either
+`eslint.config.js` (if the project is ESM) or `eslint.config.mjs` (if the
+project is CJS).
+
+There is a `recommended` configuration for CJS with all plugin configurations
+enabled except `vitest-config` (it does include `jest-config`, and applies
+ESM-specific rules to `*.mjs files`). To configure `eslint.config.mjs` with
+this configuration:
 
 ```js
-const recommendedConfig = require('@aarongoldenthal/eslint-config-standard/recommended');
-
-module.exports = [
-  ...recommendedConfig,
-  {
-    ignores: ['.vscode/**', 'archive/**', 'node_modules/**', 'coverage/**'],
-    name: 'ignores'
-  }
-];
+import { defineConfig, globalIgnores } from 'eslint/config';
+import recommendedConfig from '@aarongoldenthal/eslint-config-standard/recommended';
+
+export default defineConfig([
+  recommendedConfig,
+  globalIgnores(['.vscode/**', 'archive/**', 'node_modules/**', 'coverage/**'])
+]);
 ```
 
 Note the optional `ignores` config that can be added last to ignore certain
@@ -77,18 +84,17 @@ directories.
 
 There is also a `recommended-esm` configuration that's the same as the
 `recommended` config, but includes the `vitest-config` instead of the
-`jest-config`, and also the `esm-config`. It can be configured with:
+`jest-config`, and also the `esm-config` (applicable to `*.js` files).
+It can be configured with:
 
 ```js
-import recommendedConfig from '@aarongoldenthal/eslint-config-standard/recommended-esm.js';
-
-export default [
-  ...recommendedConfig,
-  {
-    ignores: ['.vscode/**', 'archive/**', 'node_modules/**', 'coverage/**'],
-    name: 'ignores'
-  }
-];
+import { defineConfig, globalIgnores } from 'eslint/config';
+import recommendedConfig from '@aarongoldenthal/eslint-config-standard/recommended-esm';
+
+export default defineConfig([
+  recommendedConfig,
+  globalIgnores(['.vscode/**', 'archive/**', 'node_modules/**', 'coverage/**'])
+]);
 ```
 
 To configure `eslint.config.js` with individual plugins, see the

package/base-configs.js

@@ -1,5 +1,5 @@
 /* eslint-disable max-lines -- required given number of rules */
-'use strict';
+import { defineConfig } from 'eslint/config';
 
 const complexityThresholdLow = 5;
 const maxFunctionLinesThreshold = 30;
@@ -10,12 +10,24 @@ const nestedThreshold = 5;
 
 const configs = [
     {
-        files: ['**/*.{js,mjs,cjs}'],
+        files: ['**/*.{js,cjs}'],
         languageOptions: {
             sourceType: 'commonjs'
         },
+        name: 'CJS files'
+    },
+    {
+        files: ['**/*.mjs'],
+        languageOptions: {
+            sourceType: 'module'
+        },
+        name: 'ESM files'
+    },
+    {
+        files: ['**/*.{js,mjs,cjs}'],
         linterOptions: {
-            reportUnusedDisableDirectives: 'error'
+            reportUnusedDisableDirectives: 'error',
+            reportUnusedInlineConfigs: 'error'
         },
         name: 'eslint (all files)',
         rules: {
@@ -370,9 +382,7 @@ const configs = [
 ];
 
 if (process.env.ENABLE_ESLINT_CORE_RULE_DUPLICATES === 'true') {
-    /* eslint-disable-next-line node/global-require -- given the experimental
-       nature, only require when enabled */
-    const { builtinRules } = require('eslint/use-at-your-own-risk');
+    const { builtinRules } = await import('eslint/use-at-your-own-risk');
     const complexity = builtinRules.get('complexity');
 
     const complexityThresholdHigh = 15;
@@ -394,4 +404,4 @@ if (process.env.ENABLE_ESLINT_CORE_RULE_DUPLICATES === 'true') {
     configs.push(coreDuplicateConfig);
 }
 
-module.exports = configs;
+export default defineConfig(configs);

package/eslint-comments-config.js

@@ -1,8 +1,7 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import eslintCommentsPlugin from '@eslint-community/eslint-plugin-eslint-comments';
 
-const eslintCommentsPlugin = require('@eslint-community/eslint-plugin-eslint-comments');
-
-module.exports = {
+export default defineConfig({
     files: ['**/*.{js,mjs,cjs}'],
     name: 'eslint-comments (all files)',
     plugins: { comments: eslintCommentsPlugin },
@@ -26,4 +25,4 @@ module.exports = {
         ],
         'comments/require-description': 'error'
     }
-};
+});

package/esm-config.js

@@ -1,18 +1,15 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import unicornPlugin from 'eslint-plugin-unicorn';
 
-const unicornPlugin = require('eslint-plugin-unicorn');
-
-module.exports = {
-    files: ['**/*.{js,mjs}'],
+export default defineConfig({
+    files: ['**/*.js'],
     languageOptions: {
         sourceType: 'module'
     },
-    name: 'esm (all files)',
+    name: 'esm (js files)',
     plugins: { unicorn: unicornPlugin },
     rules: {
-        'unicorn/prefer-export-from': 'error',
         'unicorn/prefer-module': 'error',
-        'unicorn/prefer-node-protocol': 'error',
         'unicorn/prefer-top-level-await': 'error'
     }
-};
+});

package/jest-config.js

@@ -1,9 +1,8 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+import jestPlugin from 'eslint-plugin-jest';
 
-const jestPlugin = require('eslint-plugin-jest');
-const globals = require('globals');
-
-module.exports = {
+export default defineConfig({
     files: [
         '**/__tests__/**/*.{js,mjs,cjs}',
         '**/?(*.)+(spec|test).{js,mjs,cjs}'
@@ -87,4 +86,4 @@ module.exports = {
         'jest/valid-expect-in-promise': 'error',
         'jest/valid-title': 'error'
     }
-};
+});

package/jsdoc-config.js

@@ -1,8 +1,7 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import jsdocPlugin from 'eslint-plugin-jsdoc';
 
-const jsdocPlugin = require('eslint-plugin-jsdoc');
-
-module.exports = {
+export default defineConfig({
     files: ['**/*.{js,mjs,cjs}'],
     name: 'jsdoc (all files)',
     plugins: { jsdoc: jsdocPlugin },
@@ -98,4 +97,4 @@ module.exports = {
         ],
         'jsdoc/valid-types': 'error' // Recommended
     }
-};
+});

package/node-config.js

@@ -1,9 +1,8 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+import nodePlugin from 'eslint-plugin-n';
 
-const nodePlugin = require('eslint-plugin-n');
-const globals = require('globals');
-
-module.exports = {
+export default defineConfig({
     files: ['**/*.{js,mjs,cjs}'],
     languageOptions: {
         globals: {
@@ -52,4 +51,4 @@ module.exports = {
         'node/prefer-promises/fs': 'error',
         'node/process-exit-as-throw': 'error'
     }
-};
+});

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@aarongoldenthal/eslint-config-standard",
-  "version": "34.0.0",
+  "version": "35.0.0",
   "description": "Standard ESLint configuration settings",
+  "type": "module",
   "scripts": {
     "hooks:pre-commit": "npm run lint && npm run prettier:check",
-    "hooks:pre-push": "npm audit --audit-level=high && npm test",
+    "hooks:pre-push": "npm audit --audit-level=critical && npm test",
     "lint": "npm run lint:js && npm run lint:md",
     "lint:js": "eslint .",
     "lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"",
     "prettier:check": "prettier --check .",
     "prettier:fix": "prettier --write .",
-    "test": "jest --ci",
-    "test:no-coverage": "jest --ci --collectCoverage false"
+    "test": "vitest run --coverage",
+    "test:no-coverage": "vitest run"
   },
   "repository": {
     "type": "git",
@@ -25,6 +26,20 @@
   "engines": {
     "node": "^18.12.0 || ^20.9.0 || >=22.0.0"
   },
+  "exports": {
+    "./base-configs": "./base-configs.js",
+    "./eslint-comments-config": "./eslint-comments-config.js",
+    "./esm-config": "./esm-config.js",
+    "./jest-config": "./jest-config.js",
+    "./jsdoc-config": "./jsdoc-config.js",
+    "./node-config": "./node-config.js",
+    "./playwright-config": "./playwright-config.js",
+    "./promise-config": "./promise-config.js",
+    "./recommended": "./recommended.js",
+    "./recommended-esm": "./recommended-esm.js",
+    "./unicorn-configs": "./unicorn-configs.js",
+    "./vitest-config": "./vitest-config.js"
+  },
   "files": [
     "*-config*.js",
     "recommended*.js"
@@ -35,25 +50,26 @@
   "homepage": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard",
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "4.4.1",
-    "@vitest/eslint-plugin": "1.1.25",
-    "eslint-config-prettier": "10.0.1",
+    "@vitest/eslint-plugin": "1.1.38",
+    "eslint-config-prettier": "10.1.1",
     "eslint-plugin-jest": "28.11.0",
-    "eslint-plugin-jsdoc": "50.6.2",
-    "eslint-plugin-n": "17.15.1",
+    "eslint-plugin-jsdoc": "50.6.8",
+    "eslint-plugin-n": "17.16.2",
     "eslint-plugin-playwright": "2.2.0",
     "eslint-plugin-promise": "7.2.1",
-    "eslint-plugin-unicorn": "56.0.1",
-    "globals": "15.14.0"
+    "eslint-plugin-unicorn": "57.0.0",
+    "globals": "16.0.0"
   },
   "devDependencies": {
-    "@eslint/config-inspector": "1.0.0",
-    "eslint": "9.18.0",
+    "@eslint/config-inspector": "1.0.2",
+    "@vitest/coverage-v8": "3.0.9",
+    "eslint": "9.23.0",
     "jest": "29.7.0",
-    "jest-junit": "16.0.0",
     "markdownlint-cli2": "0.17.2",
-    "prettier": "3.4.2"
+    "prettier": "3.5.3",
+    "vitest": "3.0.9"
   },
   "peerDependencies": {
-    "eslint": "^9.18.0"
+    "eslint": "^9.22.0"
   }
 }

package/playwright-config.js

@@ -1,11 +1,10 @@
-'use strict';
-
-const playwrightPlugin = require('eslint-plugin-playwright');
-const globals = require('globals');
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+import playwrightPlugin from 'eslint-plugin-playwright';
 
 const maxExpects = 5;
 
-module.exports = {
+export default defineConfig({
     files: ['**/*.pwtest.{js,mjs,cjs}'],
     languageOptions: {
         globals: {
@@ -65,4 +64,4 @@ module.exports = {
         'playwright/valid-expect-in-promise': 'error',
         'playwright/valid-title': 'error'
     }
-};
+});

package/promise-config.js

@@ -1,8 +1,7 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import promisePlugin from 'eslint-plugin-promise';
 
-const promisePlugin = require('eslint-plugin-promise');
-
-module.exports = {
+export default defineConfig({
     files: ['**/*.{js,mjs,cjs}'],
     name: 'promise (all files)',
     plugins: { promise: promisePlugin },
@@ -26,4 +25,4 @@ module.exports = {
         'promise/prefer-await-to-then': 'error',
         'promise/valid-params': 'error'
     }
-};
+});

package/recommended-esm.js

@@ -1,25 +1,25 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
 
-const eslintCommentsConfig = require('./eslint-comments-config.js');
-const jsdocConfig = require('./jsdoc-config.js');
-const nodeConfig = require('./node-config.js');
-const playwrightConfig = require('./playwright-config.js');
-const promiseConfig = require('./promise-config.js');
-const unicornConfigs = require('./unicorn-configs.js');
-const vitestConfig = require('./vitest-config.js');
-const baseConfigs = require('./base-configs.js');
-const esmConfig = require('./esm-config.js');
-const prettierConfig = require('eslint-config-prettier');
+import baseConfigs from './base-configs.js';
+import eslintCommentsConfig from './eslint-comments-config.js';
+import esmConfig from './esm-config.js';
+import jsdocConfig from './jsdoc-config.js';
+import nodeConfig from './node-config.js';
+import playwrightConfig from './playwright-config.js';
+import prettierConfig from 'eslint-config-prettier';
+import promiseConfig from './promise-config.js';
+import unicornConfigs from './unicorn-configs.js';
+import vitestConfig from './vitest-config.js';
 
-module.exports = [
+export default defineConfig([
     eslintCommentsConfig,
     jsdocConfig,
     nodeConfig,
     playwrightConfig,
     promiseConfig,
-    ...unicornConfigs,
+    unicornConfigs,
     vitestConfig,
-    ...baseConfigs,
+    baseConfigs,
     esmConfig,
     prettierConfig
-];
+]);

package/recommended.js

@@ -1,23 +1,23 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
 
-const eslintCommentsConfig = require('./eslint-comments-config.js');
-const jestConfig = require('./jest-config.js');
-const jsdocConfig = require('./jsdoc-config.js');
-const nodeConfig = require('./node-config.js');
-const playwrightConfig = require('./playwright-config.js');
-const promiseConfig = require('./promise-config.js');
-const unicornConfigs = require('./unicorn-configs.js');
-const baseConfigs = require('./base-configs.js');
-const prettierConfig = require('eslint-config-prettier');
+import baseConfigs from './base-configs.js';
+import eslintCommentsConfig from './eslint-comments-config.js';
+import jestConfig from './jest-config.js';
+import jsdocConfig from './jsdoc-config.js';
+import nodeConfig from './node-config.js';
+import playwrightConfig from './playwright-config.js';
+import prettierConfig from 'eslint-config-prettier';
+import promiseConfig from './promise-config.js';
+import unicornConfigs from './unicorn-configs.js';
 
-module.exports = [
+export default defineConfig([
     eslintCommentsConfig,
     jestConfig,
     jsdocConfig,
     nodeConfig,
     playwrightConfig,
     promiseConfig,
-    ...unicornConfigs,
-    ...baseConfigs,
+    unicornConfigs,
+    baseConfigs,
     { name: 'prettier (all files)', ...prettierConfig }
-];
+]);

package/unicorn-configs.js

@@ -1,8 +1,7 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import unicornPlugin from 'eslint-plugin-unicorn';
 
-const unicornPlugin = require('eslint-plugin-unicorn');
-
-module.exports = [
+export default defineConfig([
     {
         files: ['**/*.{js,mjs,cjs}'],
         name: 'unicorn (all files)',
@@ -10,6 +9,8 @@ module.exports = [
         rules: {
             'unicorn/better-regex': 'error',
             'unicorn/catch-error-name': 'error', // Recommended
+            'unicorn/consistent-assert': 'error', // Recommended
+            'unicorn/consistent-date-clone': 'error', // Recommended
             'unicorn/consistent-destructuring': 'error',
             'unicorn/consistent-empty-array-spread': 'error', // Recommended
             'unicorn/consistent-existence-index-check': 'error', // Recommended
@@ -24,6 +25,7 @@ module.exports = [
             'unicorn/import-style': 'error', // Recommended
             'unicorn/new-for-builtins': 'error', // Recommended
             'unicorn/no-abusive-eslint-disable': 'error', // Recommended
+            'unicorn/no-accessor-recursion': 'error', // Recommended
             'unicorn/no-anonymous-default-export': 'error', // Recommended
             'unicorn/no-array-callback-reference': 'error', // Recommended
             'unicorn/no-array-for-each': 'error', // Recommended
@@ -37,13 +39,14 @@ module.exports = [
             'unicorn/no-empty-file': 'error', // Recommended
             'unicorn/no-for-loop': 'error', // Recommended
             'unicorn/no-hex-escape': 'error', // Recommended
-            'unicorn/no-instanceof-array': 'error', // Recommended
+            'unicorn/no-instanceof-builtins': 'error', // Recommended
             'unicorn/no-invalid-fetch-options': 'error', // Recommended
             'unicorn/no-invalid-remove-event-listener': 'error', // Recommended
             'unicorn/no-keyword-prefix': 'off', // Recommended
             'unicorn/no-length-as-slice-end': 'error', // Recommended
             'unicorn/no-lonely-if': 'error', // Recommended
             'unicorn/no-magic-array-flat-depth': 'error', // Recommended
+            'unicorn/no-named-default': 'error', // Recommended
             'unicorn/no-negated-condition': 'error', // Recommended
             'unicorn/no-negation-in-equality-check': 'error', // Recommended
             'unicorn/no-nested-ternary': 'error', // Recommended, Prettier
@@ -157,5 +160,13 @@ module.exports = [
             // nested with the tests
             'unicorn/consistent-function-scoping': 'off'
         }
+    },
+    {
+        files: ['**/*.mjs'],
+        name: 'esm (mjs files)',
+        rules: {
+            'unicorn/prefer-module': 'error',
+            'unicorn/prefer-top-level-await': 'error'
+        }
     }
-];
+]);

package/vitest-config.js

@@ -1,8 +1,7 @@
-'use strict';
+import { defineConfig } from 'eslint/config';
+import vitestPlugin from '@vitest/eslint-plugin';
 
-const vitestPlugin = require('@vitest/eslint-plugin');
-
-module.exports = {
+export default defineConfig({
     files: ['**/__tests__/**/*.{js,mjs}', '**/?(*.)+(spec|test).{js,mjs}'],
     name: 'vitest (test files)',
     plugins: { vitest: vitestPlugin },
@@ -27,7 +26,6 @@ module.exports = {
         'vitest/no-conditional-in-test': 'error',
         'vitest/no-conditional-tests': 'error',
         'vitest/no-disabled-tests': 'error',
-        'vitest/no-done-callback': 'error',
         'vitest/no-duplicate-hooks': 'error',
         'vitest/no-focused-tests': 'error',
         'vitest/no-hooks': 'off',
@@ -74,4 +72,4 @@ module.exports = {
         'vitest/valid-expect': 'error', // Recommended
         'vitest/valid-title': 'error' // Recommended
     }
-};
+});