eslint-config-uphold 6.2.0 → 6.3.1

package/README.md

@@ -17,6 +17,8 @@ that allow the [Prettier](https://prettier.io) pretty-printer to reformat the co
 npm install eslint eslint-config-uphold prettier --save-dev
 ```
 
+!! Node.js minimum versions are `v22.12.0` and `v20.19.0`, as `@stylistic/eslint-plugin-js` depends on the `require('esm')` module from `v4.0.0`.
+
 ## Usage
 
 Create an `eslint.config.js` file with the following content:
@@ -27,19 +29,25 @@ const uphold = require('eslint-config-uphold');
 module.exports = uphold;
 ```
 
-If you'd like to extend the config, you can do so like this:
+If you'd like to extend the config, or change rules, you can do so like this:
 
 ```js
+const { defineConfig } = require('eslint/config');
 const uphold = require('eslint-config-uphold');
 const yourPlugin = require('your-eslint-plugin');
 
-module.exports = [
-  ...uphold,
-  plugins: {
-    ...uphold[0].plugins,
-    yourPlugin,
+module.exports = defineConfig([
+  {
+    extends: [uphold],
+    name: 'uphold-config',
+    plugins: {
+      'your-plugin': yourPlugin,
+    },
+    rules: {
+      'your-plugin/rule-name': 'error'
+    },
   }
-];
+]);
 ```
 
 See [Using a Shareable Config](https://eslint.org/docs/latest/extend/shareable-configs#using-a-shareable-config) for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-uphold",
-  "version": "6.2.0",
+  "version": "6.3.1",
   "description": "Uphold-flavored ESLint config",
   "keywords": [
     "config",
@@ -33,15 +33,14 @@
   "dependencies": {
     "@babel/core": "^7.26.10",
     "@babel/eslint-parser": "^7.26.10",
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.23.0",
     "@stylistic/eslint-plugin-js": "4.2.0",
     "eslint-config-prettier": "^10.1.1",
-    "eslint-plugin-jsdoc": "^50.6.8",
+    "eslint-plugin-jsdoc": "^50.6.9",
     "eslint-plugin-mocha": "^10.5.0",
     "eslint-plugin-n": "^17.16.2",
-    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-prettier": "^5.2.4",
     "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-rulesdir": "^0.2.2",
     "eslint-plugin-sort-destructure-keys": "^2.0.0",
     "eslint-plugin-sort-imports-requires": "^2.0.0",
     "eslint-plugin-sort-keys-fix": "^1.1.2",
@@ -52,14 +51,14 @@
     "@fastify/pre-commit": "^2.2.0",
     "@types/eslint": "^9.6.1",
     "@uphold/github-changelog-generator": "^4.0.2",
-    "eslint": "^9.22.0",
+    "eslint": "^9.23.0",
     "mocha": "^11.1.0",
     "prettier": "^3.5.3",
     "release-it": "^18.1.2",
     "should": "^13.2.3"
   },
   "peerDependencies": {
-    "eslint": "~9.22.0",
+    "eslint": "~9.23.0",
     "prettier": ">=3.0.0"
   },
   "peerDependenciesMeta": {
@@ -71,7 +70,7 @@
     "lint"
   ],
   "engines": {
-    "node": ">=20"
+    "node": "^20.19.0 || ^22.12.0"
   },
   "options": {
     "mocha": "-t 10000 --require should test"

package/src/index.js

@@ -1,9 +1,12 @@
+'use strict';
+
 /**
  * Module dependencies.
  *
  * @typedef {import('eslint').Linter.Config} LinterConfig
  */
 
+const { defineConfig } = require('eslint/config');
 const babelParser = require('@babel/eslint-parser');
 const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
 const globals = require('globals');
@@ -11,26 +14,20 @@ const js = require('@eslint/js');
 const jsdoc = require('eslint-plugin-jsdoc');
 const mocha = require('eslint-plugin-mocha');
 const nodePlugin = require('eslint-plugin-n');
-const path = require('node:path');
 const promise = require('eslint-plugin-promise');
-const rulesDir = require('eslint-plugin-rulesdir');
+const rules = require('./rules');
 const sortDestructureKeys = require('eslint-plugin-sort-destructure-keys');
 const sortImportsRequires = require('eslint-plugin-sort-imports-requires');
 const sortKeysFix = require('eslint-plugin-sort-keys-fix');
 const sqlTemplate = require('eslint-plugin-sql-template');
 const stylistic = require('@stylistic/eslint-plugin-js');
 
-/**
- * Configure the `rulesDir` plugin.
- */
-
-rulesDir.RULES_DIR = path.join(__dirname, 'rules');
-
 /**
  * Language options.
  *
  * @type {LinterConfig['languageOptions']}
  */
+
 const languageOptions = {
   ecmaVersion: 2020,
   globals: {
@@ -48,183 +45,193 @@ const languageOptions = {
 /**
  * Base configuration for Uphold.
  *
- * @type {LinterConfig}
+ * @type {LinterConfig[]}
  */
-const upholdBaseConfig = {
-  languageOptions,
-  plugins: {
-    jsdoc,
-    mocha,
-    'node-plugin': nodePlugin,
-    promise,
-    rulesdir: rulesDir,
-    'sort-destructure-keys': sortDestructureKeys,
-    'sort-imports-requires': sortImportsRequires,
-    'sort-keys-fix': sortKeysFix,
-    'sql-template': sqlTemplate,
-    stylistic
-  },
-  rules: {
-    ...js.configs.recommended.rules,
-    'accessor-pairs': 'error',
-    'array-callback-return': 'error',
-    'block-scoped-var': 'error',
-    'consistent-this': ['error', 'self'],
-    curly: 'error',
-    'default-case': 'error',
-    'dot-notation': 'error',
-    eqeqeq: ['error', 'smart'],
-    'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-    'id-length': ['error', { exceptions: ['_', 'e', 'i'] }],
-    'id-match': [
-      'error',
-      '^_$|^[$_a-zA-Z]*[_a-zA-Z0-9]*[a-zA-Z0-9]*$|^[A-Z][_A-Z0-9]+[A-Z0-9]$',
-      {
-        onlyDeclarations: true,
-        properties: true
-      }
-    ],
-    'jsdoc/no-defaults': 0,
-    'jsdoc/require-description-complete-sentence': 'error',
-    'jsdoc/require-jsdoc': 0,
-    'jsdoc/tag-lines': 0,
-    'max-depth': 'error',
-    'max-params': ['error', 4],
-    'mocha/no-exclusive-tests': 'error',
-    'mocha/no-identical-title': 'error',
-    'mocha/no-nested-tests': 'error',
-    'mocha/no-sibling-hooks': 'error',
-    'new-cap': 'error',
-    'no-alert': 'error',
-    'no-array-constructor': 'error',
-    'no-bitwise': 'error',
-    'no-caller': 'error',
-    'no-cond-assign': ['error', 'always'],
-    'no-console': 'warn',
-    'no-div-regex': 'error',
-    'no-dupe-keys': 'error',
-    'no-duplicate-imports': 'error',
-    'no-else-return': 'error',
-    'no-eq-null': 'error',
-    'no-eval': 'error',
-    'no-extend-native': 'error',
-    'no-extra-bind': 'error',
-    'no-implied-eval': 'error',
-    'no-inline-comments': 'error',
-    'no-irregular-whitespace': ['error', { skipComments: false, skipStrings: false, skipTemplates: false }],
-    'no-iterator': 'error',
-    'no-labels': 'error',
-    'no-lone-blocks': 'error',
-    'no-lonely-if': 'error',
-    'no-loop-func': 'error',
-    'no-multi-str': 'error',
-    'no-nested-ternary': 'error',
-    'no-new': 'error',
-    'no-new-func': 'error',
-    'no-new-wrappers': 'error',
-    'no-object-constructor': 'error',
-    'no-octal-escape': 'error',
-    'no-proto': 'error',
-    'no-return-assign': 'error',
-    'no-script-url': 'error',
-    'no-self-compare': 'error',
-    'no-sequences': 'error',
-    'no-throw-literal': 'error',
-    'no-undef-init': 'error',
-    'no-underscore-dangle': 'error',
-    'no-unneeded-ternary': 'error',
-    'no-unused-expressions': 'error',
-    'no-unused-vars': ['error', { caughtErrors: 'none' }],
-    'no-use-before-define': 'error',
-    'no-useless-call': 'error',
-    'no-useless-concat': 'error',
-    'no-var': 'error',
-    'no-void': 'error',
-    'node-plugin/no-mixed-requires': 'error',
-    'node-plugin/no-new-require': 'error',
-    'node-plugin/no-path-concat': 'error',
-    'node-plugin/no-process-env': 'error',
-    'node-plugin/no-process-exit': 'error',
-    'node-plugin/no-restricted-import': 'error',
-    'node-plugin/no-restricted-require': 'error',
-    'node-plugin/no-sync': 'error',
-    'object-shorthand': 'error',
-    'operator-assignment': 'error',
-    'prefer-const': 'error',
-    'prefer-destructuring': [
-      'error',
-      {
-        AssignmentExpression: {
-          array: false,
-          object: false
-        },
 
-        VariableDeclarator: {
-          array: true,
-          object: true
+const upholdBaseConfig = defineConfig([
+  {
+    extends: [js.configs.recommended, jsdoc.configs['flat/recommended-error'], eslintPluginPrettierRecommended],
+    languageOptions,
+    name: 'uphold/base',
+    plugins: {
+      jsdoc,
+      mocha,
+      'node-plugin': nodePlugin,
+      promise,
+      'sort-destructure-keys': sortDestructureKeys,
+      'sort-imports-requires': sortImportsRequires,
+      'sort-keys-fix': sortKeysFix,
+      'sql-template': sqlTemplate,
+      stylistic,
+      'uphold-plugin': { rules }
+    },
+    rules: {
+      'accessor-pairs': 'error',
+      'array-callback-return': 'error',
+      'block-scoped-var': 'error',
+      'consistent-this': ['error', 'self'],
+      curly: 'error',
+      'default-case': 'error',
+      'dot-notation': 'error',
+      eqeqeq: ['error', 'smart'],
+      'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
+      'id-length': ['error', { exceptions: ['_', 'e', 'i'] }],
+      'id-match': [
+        'error',
+        '^_$|^[$_a-zA-Z]*[_a-zA-Z0-9]*[a-zA-Z0-9]*$|^[A-Z][_A-Z0-9]+[A-Z0-9]$',
+        {
+          onlyDeclarations: true,
+          properties: true
         }
-      },
-      {
-        enforceForRenamedProperties: false
-      }
-    ],
-    'prefer-spread': 'error',
-    'prefer-template': 'error',
-    'prettier/prettier': [
-      'error',
-      {
-        arrowParens: 'avoid',
-        printWidth: 120,
-        singleQuote: true,
-        trailingComma: 'none'
-      }
-    ],
-    'promise/prefer-await-to-then': 'error',
-    radix: 'error',
-    'require-atomic-updates': 'off',
-    'require-await': 'error',
-    'rulesdir/explicit-sinon-use-fake-timers': 'error',
-    'sort-destructure-keys/sort-destructure-keys': 'error',
-    'sort-imports-requires/sort-imports': ['error', { unsafeAutofix: true, useOldSingleMemberSyntax: true }],
-    'sort-imports-requires/sort-requires': [
-      'error',
-      { unsafeAutofix: true, useAliases: false, useOldSingleMemberSyntax: true }
-    ],
-    'sort-keys-fix/sort-keys-fix': ['error', 'asc', { natural: true }],
-    'sql-template/no-unsafe-query': 'error',
-    'stylistic/no-tabs': ['error', { allowIndentationTabs: true }],
-    'stylistic/padding-line-between-statements': [
-      'error',
-      {
-        blankLine: 'always',
-        next: 'return',
-        prev: '*'
-      },
-      {
-        blankLine: 'always',
-        next: '*',
-        prev: ['const', 'let', 'var']
-      },
-      {
-        blankLine: 'any',
-        next: ['const', 'let', 'var'],
-        prev: ['const', 'let', 'var']
-      }
-    ],
-    'stylistic/spaced-comment': 'error',
-    'vars-on-top': 'error',
-    yoda: 'error'
+      ],
+      'jsdoc/no-defaults': 0,
+      'jsdoc/require-description-complete-sentence': 'error',
+      'jsdoc/require-jsdoc': 0,
+      'jsdoc/tag-lines': 0,
+      'max-depth': 'error',
+      'max-params': ['error', 4],
+      'mocha/no-exclusive-tests': 'error',
+      'mocha/no-identical-title': 'error',
+      'mocha/no-nested-tests': 'error',
+      'mocha/no-sibling-hooks': 'error',
+      'new-cap': 'error',
+      'no-alert': 'error',
+      'no-array-constructor': 'error',
+      'no-bitwise': 'error',
+      'no-caller': 'error',
+      'no-cond-assign': ['error', 'always'],
+      'no-console': 'warn',
+      'no-div-regex': 'error',
+      'no-dupe-keys': 'error',
+      'no-duplicate-imports': 'error',
+      'no-else-return': 'error',
+      'no-eq-null': 'error',
+      'no-eval': 'error',
+      'no-extend-native': 'error',
+      'no-extra-bind': 'error',
+      'no-implied-eval': 'error',
+      'no-inline-comments': 'error',
+      'no-irregular-whitespace': ['error', { skipComments: false, skipStrings: false, skipTemplates: false }],
+      'no-iterator': 'error',
+      'no-labels': 'error',
+      'no-lone-blocks': 'error',
+      'no-lonely-if': 'error',
+      'no-loop-func': 'error',
+      'no-multi-str': 'error',
+      'no-nested-ternary': 'error',
+      'no-new': 'error',
+      'no-new-func': 'error',
+      'no-new-wrappers': 'error',
+      'no-object-constructor': 'error',
+      'no-octal-escape': 'error',
+      'no-proto': 'error',
+      'no-return-assign': 'error',
+      'no-script-url': 'error',
+      'no-self-compare': 'error',
+      'no-sequences': 'error',
+      'no-throw-literal': 'error',
+      'no-undef-init': 'error',
+      'no-underscore-dangle': 'error',
+      'no-unneeded-ternary': 'error',
+      'no-unused-expressions': 'error',
+      'no-unused-vars': ['error', { caughtErrors: 'none' }],
+      'no-use-before-define': 'error',
+      'no-useless-call': 'error',
+      'no-useless-concat': 'error',
+      'no-var': 'error',
+      'no-void': 'error',
+      'node-plugin/no-mixed-requires': 'error',
+      'node-plugin/no-new-require': 'error',
+      'node-plugin/no-path-concat': 'error',
+      'node-plugin/no-process-env': 'error',
+      'node-plugin/no-process-exit': 'error',
+      'node-plugin/no-restricted-import': 'error',
+      'node-plugin/no-restricted-require': 'error',
+      'node-plugin/no-sync': 'error',
+      'object-shorthand': 'error',
+      'operator-assignment': 'error',
+      'prefer-const': 'error',
+      'prefer-destructuring': [
+        'error',
+        {
+          AssignmentExpression: {
+            array: false,
+            object: false
+          },
+
+          VariableDeclarator: {
+            array: true,
+            object: true
+          }
+        },
+        {
+          enforceForRenamedProperties: false
+        }
+      ],
+      'prefer-spread': 'error',
+      'prefer-template': 'error',
+      'prettier/prettier': [
+        'error',
+        {
+          arrowParens: 'avoid',
+          printWidth: 120,
+          singleQuote: true,
+          trailingComma: 'none'
+        }
+      ],
+      'promise/prefer-await-to-then': 'error',
+      radix: 'error',
+      'require-atomic-updates': 'off',
+      'require-await': 'error',
+      'sort-destructure-keys/sort-destructure-keys': 'error',
+      'sort-imports-requires/sort-imports': ['error', { unsafeAutofix: true, useOldSingleMemberSyntax: true }],
+      'sort-imports-requires/sort-requires': [
+        'error',
+        {
+          unsafeAutofix: true,
+          useAliases: false,
+          useOldSingleMemberSyntax: true
+        }
+      ],
+      'sort-keys-fix/sort-keys-fix': ['error', 'asc', { natural: true }],
+      'sql-template/no-unsafe-query': 'error',
+      'stylistic/no-tabs': ['error', { allowIndentationTabs: true }],
+      'stylistic/padding-line-between-statements': [
+        'error',
+        {
+          blankLine: 'always',
+          next: 'return',
+          prev: '*'
+        },
+        {
+          blankLine: 'always',
+          next: '*',
+          prev: ['const', 'let', 'var']
+        },
+        {
+          blankLine: 'any',
+          next: ['const', 'let', 'var'],
+          prev: ['const', 'let', 'var']
+        }
+      ],
+      'stylistic/spaced-comment': 'error',
+      'uphold-plugin/explicit-sinon-use-fake-timers': 'error',
+      'vars-on-top': 'error',
+      yoda: 'error'
+    }
   }
-};
+]);
 
 /**
  * Configuration for bin and scripts files.
  *
  * @type {LinterConfig}
  */
+
 const upholdBinScriptsConfig = {
   files: ['**/bin/**', '**/scripts/**'],
   languageOptions,
+  name: 'uphold/scripts',
   rules: {
     'no-console': 'off',
     'node-plugin/no-process-exit': 'off'
@@ -236,9 +243,11 @@ const upholdBinScriptsConfig = {
  *
  * @type {LinterConfig[]}
  */
-module.exports = [
-  jsdoc.configs['flat/recommended-error'],
-  eslintPluginPrettierRecommended,
-  upholdBaseConfig,
-  upholdBinScriptsConfig
-];
+
+module.exports = defineConfig([
+  {
+    extends: [upholdBaseConfig, upholdBinScriptsConfig],
+    languageOptions,
+    name: 'uphold/default'
+  }
+]);

package/src/rules/explicit-sinon-use-fake-timers.js

@@ -1,16 +1,13 @@
 'use strict';
 
-// ------------------------------------------------------------------------------
-// Validates that `sinon.useFakeTimers()` is always called with an explicit `toFake` property.
-// ------------------------------------------------------------------------------
+/**
+ * Export `explicit-sinon-use-fake-timers` rule.
+ * - Validates that `sinon.useFakeTimers()` is always called with an explicit `toFake` property.
+ *
+ * @type {import('eslint').Rule.RuleModule}
+ */
 
 module.exports = {
-  meta: {
-    messages: {
-      avoidName: 'Calls to `sinon.useFakeTimers()` must provide a `toFake` configuration'
-    }
-  },
-  // eslint-disable-next-line sort-keys-fix/sort-keys-fix
   create(context) {
     return {
       CallExpression(node) {
@@ -18,33 +15,41 @@ module.exports = {
           return;
         }
 
-        if (node.callee.object.name === 'sinon' && node.callee.property.name === 'useFakeTimers') {
-          if (!node.arguments.length) {
-            context.report({
-              message: 'Must pass an object with `toFake` configuration',
-              node
-            });
+        const isCalleeSinonUseFakeTimers =
+          node.callee.object.name === 'sinon' && node.callee.property.name === 'useFakeTimers';
+
+        if (!isCalleeSinonUseFakeTimers) {
+          return;
+        }
+
+        if (!node.arguments.length) {
+          context.report({ messageId: 'mustPassObject', node });
+        }
+
+        for (const argument of node.arguments) {
+          const isArgumentObjectExpression = argument.type === 'ObjectExpression';
+
+          if (!isArgumentObjectExpression) {
+            context.report({ messageId: 'notAnObject', node });
           }
 
-          for (const argument of node.arguments) {
-            if (argument.type === 'ObjectExpression') {
-              if (!argument.properties.find(({ key: { name } }) => name === 'toFake')) {
-                context.report({
-                  message: 'Object must contain `toFake` configuration',
-                  node
-                });
-              }
-
-              continue;
-            }
-
-            context.report({
-              message: 'Not an object',
-              node
-            });
+          if (!argument.properties.find(({ key }) => key && key.name === 'toFake')) {
+            context.report({ messageId: 'objectMustContainToFake', node });
           }
         }
       }
     };
+  },
+  meta: {
+    docs: {
+      description:
+        'Calls to `sinon.useFakeTimers()` must provide a `toFake` configuration. (e.g. `sinon.useFakeTimers({ toFake: ["Date"] })`)'
+    },
+    messages: {
+      mustPassObject: 'Must pass an object with `toFake` configuration',
+      notAnObject: 'Not an object',
+      objectMustContainToFake: 'Object must contain `toFake` configuration'
+    },
+    type: 'problem'
   }
 };

package/src/rules/index.js

@@ -0,0 +1,11 @@
+'use strict';
+
+/**
+ * Export `rules`.
+ *
+ * @type {Record<string, import('eslint').Rule.RuleModule>}
+ */
+
+module.exports = {
+  'explicit-sinon-use-fake-timers': require('./explicit-sinon-use-fake-timers.js')
+};