eslint-config-uphold 5.0.1 → 6.1.0

package/README.md

@@ -7,26 +7,49 @@ extend the [eslint-recommended](https://github.com/eslint/eslint/blob/master/con
 as well as the [overrides](https://github.com/prettier/eslint-config-prettier/blob/master/index.js)
 that allow the [Prettier](https://prettier.io) pretty-printer to reformat the code without conflicts.
 
+## Status
+
+[![npm version][npm-image]][npm-url]
+
 ## Installation
 
 ```sh
-$ npm install eslint eslint-config-uphold prettier --save-dev
+npm install eslint eslint-config-uphold prettier --save-dev
 ```
 
 ## Usage
 
-Create an `.eslintrc.yml` file with the following content:
+Create an `eslint.config.js` file with the following content:
+
+```js
+const uphold = require('eslint-config-uphold');
+
+module.exports = uphold;
+```
+
+If you'd like to extend the config, you can do so like this:
+
+```js
+const uphold = require('eslint-config-uphold');
+const yourPlugin = require('your-eslint-plugin');
 
-```yaml
-extends: uphold
+module.exports = [
+  ...uphold,
+  plugins: {
+    ...uphold[0].plugins,
+    yourPlugin,
+  }
+];
 ```
 
+See [Using a Shareable Config](https://eslint.org/docs/latest/extend/shareable-configs#using-a-shareable-config) for more information.
+
 Add a `lint` command to the `scripts` section of your `package.json`, like so:
 
 ```json
 {
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint"
   }
 }
 ```
@@ -34,19 +57,34 @@ Add a `lint` command to the `scripts` section of your `package.json`, like so:
 and run the linter with:
 
 ```sh
-$ npm run lint
+npm run lint
 ```
 
 To automatically fix all lint issues, use the `--fix` option:
 
 ```sh
-$ npm run lint --fix
+npm run lint --fix
 ```
 
-## Upgrading eslint
+## Upgrading ESLint
+
+See the [ESLint repo](https://github.com/eslint/eslint#semantic-versioning-policy) for ESLint's guidelines on semantic versioning.
+
+A [tilde range](https://docs.npmjs.com/cli/v6/using-npm/semver#tilde-ranges-123-12-1) is set for the ESLint dependency to pick up any patch changes by default.
+
+For any minor/major upgrades to ESLint it is recommended to update both `eslint` and `eslint-config-uphold` and keep them in parallel.
+This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules.
+The downside here is a package update is required for any security or other bug fixes.
+The benefit however is the included rules are always guaranteed to be stable.
+
+## Release process
+
+The release of a version is automated via the [release](https://github.com/uphold/eslint-config-uphold/.github/workflows/release.yml) GitHub workflow.
+Run it by clicking the "Run workflow" button.
 
-See the [eslint repo](https://github.com/eslint/eslint#semantic-versioning-policy) for eslint's guidelines on semantic versioning.
+## License
 
-A [tilde range](https://docs.npmjs.com/cli/v6/using-npm/semver#tilde-ranges-123-12-1) is set for the eslint dependency to pick up any patch changes by default.
+MIT
 
-For any minor/major upgrades to `eslint` it is recommended to update both eslint and `eslint-config-uphold` and keep them in parallel. This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules. The downside here is a package update is required for any security or other bug fixes. The benefit however is the included rules are always guaranteed to be stable.
+[npm-image]: https://img.shields.io/npm/v/eslint-config-uphold.svg
+[npm-url]: https://www.npmjs.com/package/eslint-config-uphold

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-uphold",
-  "version": "5.0.1",
+  "version": "6.1.0",
   "description": "Uphold-flavored ESLint config",
   "keywords": [
     "config",
@@ -22,42 +22,56 @@
   "files": [
     "src"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "changelog": "echo \"$(github-changelog-generator --owner uphold --repo eslint-config-uphold --future-release=$npm_package_version)\n$(tail -n +2 CHANGELOG.md)\" > CHANGELOG.md",
     "lint": "eslint src test/index.js",
-    "test": "mocha $npm_package_options_mocha",
-    "version": "npm run changelog --future-release=$npm_package_version && git add -A CHANGELOG.md"
+    "release": "release-it",
+    "test": "mocha $npm_package_options_mocha"
   },
   "dependencies": {
-    "@babel/core": "^7.21.4",
-    "@babel/eslint-parser": "^7.21.3",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-mocha": "^10.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.1.1",
+    "@babel/core": "^7.26.10",
+    "@babel/eslint-parser": "^7.26.10",
+    "@eslint/js": "^9.22.0",
+    "@stylistic/eslint-plugin-js": "2.13.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsdoc": "50.6.8",
+    "eslint-plugin-mocha": "^10.5.0",
+    "eslint-plugin-n": "17.16.2",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-rulesdir": "^0.2.2",
-    "eslint-plugin-sort-destructure-keys": "^1.5.0",
-    "eslint-plugin-sort-imports-requires": "^1.0.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",
-    "eslint-plugin-sql-template": "^2.0.0"
+    "eslint-plugin-sql-template": "^3.1.0",
+    "globals": "^15.15.0"
   },
   "devDependencies": {
-    "@uphold/github-changelog-generator": "^3.3.1",
-    "eslint": "^8.38.0",
-    "mocha": "^10.2.0",
+    "@types/eslint": "^9.6.1",
+    "@uphold/github-changelog-generator": "^3.4.0",
+    "eslint": "9.22.0",
+    "mocha": "^10.4.0",
     "pre-commit": "^1.2.2",
-    "prettier": "^2.8.7",
+    "prettier": "3.5.3",
+    "release-it": "^17.11.0",
     "should": "^13.2.3"
   },
   "peerDependencies": {
-    "eslint": "^8.20.0",
-    "prettier": "^2.8.7"
+    "eslint": "~9.22.0",
+    "prettier": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
   },
   "pre-commit": [
     "lint"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=20"
   },
   "options": {
     "mocha": "-t 10000 --require should test"

package/src/index.js

@@ -1,51 +1,71 @@
 /**
  * Module dependencies.
+ *
+ * @typedef {import('eslint').Linter.Config} LinterConfig
  */
 
+const babelParser = require('@babel/eslint-parser');
+const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+const globals = require('globals');
+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 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.
+ * Configure the `rulesDir` plugin.
  */
 
-rulesDir.RULES_DIR = `${__dirname}/rules`;
+rulesDir.RULES_DIR = path.join(__dirname, 'rules');
 
 /**
- * Export `uphold` shared configuration preset.
+ * Language options.
+ *
+ * @type {LinterConfig['languageOptions']}
  */
-
-module.exports = {
-  env: {
-    es6: true,
-    jasmine: true,
-    jest: true,
-    mocha: true,
-    node: true
+const languageOptions = {
+  ecmaVersion: 2020,
+  globals: {
+    ...globals.jasmine,
+    ...globals.jest,
+    ...globals.mocha,
+    ...globals.node
   },
-  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-  overrides: [
-    {
-      files: ['**/bin/**', '**/scripts/**'],
-      rules: {
-        'no-console': 'off'
-      }
-    }
-  ],
-  parser: '@babel/eslint-parser',
+  parser: babelParser,
   parserOptions: {
     requireConfigFile: false
+  }
+};
+
+/**
+ * Base configuration for Uphold.
+ *
+ * @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
   },
-  plugins: [
-    'mocha',
-    'promise',
-    'rulesdir',
-    'sort-destructure-keys',
-    'sort-imports-requires',
-    'sort-keys-fix',
-    'sql-template'
-  ],
-  root: true,
   rules: {
+    ...js.configs.recommended.rules,
     'accessor-pairs': 'error',
     'array-callback-return': 'error',
     'block-scoped-var': 'error',
@@ -59,8 +79,15 @@ module.exports = {
     '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 }
+      {
+        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',
@@ -90,50 +117,52 @@ module.exports = {
     'no-lone-blocks': 'error',
     'no-lonely-if': 'error',
     'no-loop-func': 'error',
-    'no-mixed-requires': 'error',
     'no-multi-str': 'error',
     'no-nested-ternary': 'error',
     'no-new': 'error',
     'no-new-func': 'error',
-    'no-new-object': 'error',
-    'no-new-require': 'error',
     'no-new-wrappers': 'error',
+    'no-object-constructor': 'error',
     'no-octal-escape': 'error',
-    'no-path-concat': 'error',
-    'no-process-env': 'error',
-    'no-process-exit': 'error',
     'no-proto': 'error',
-    'no-restricted-modules': 'error',
     'no-return-assign': 'error',
     'no-script-url': 'error',
     'no-self-compare': 'error',
     'no-sequences': 'error',
-    'no-sync': 'error',
-    'no-tabs': ['error', { allowIndentationTabs: true }],
     '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',
-    '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'] }
-    ],
     'prefer-const': 'error',
     'prefer-destructuring': [
       'error',
       {
-        AssignmentExpression: { array: false, object: false },
-        VariableDeclarator: { array: true, object: true }
+        AssignmentExpression: {
+          array: false,
+          object: false
+        },
+
+        VariableDeclarator: {
+          array: true,
+          object: true
+        }
       },
       {
         enforceForRenamedProperties: false
@@ -141,33 +170,75 @@ module.exports = {
     ],
     'prefer-spread': 'error',
     'prefer-template': 'error',
-    'prettier/prettier': ['error', { arrowParens: 'avoid', printWidth: 120, singleQuote: true, trailingComma: 'none' }],
+    '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': [
+    'sort-imports-requires/sort-imports': ['error', { unsafeAutofix: true, useOldSingleMemberSyntax: true }],
+    'sort-imports-requires/sort-requires': [
       'error',
-      {
-        unsafeAutofix: true,
-        useOldSingleMemberSyntax: true
-      }
+      { unsafeAutofix: true, useAliases: false, useOldSingleMemberSyntax: true }
     ],
-    'sort-imports-requires/sort-requires': [
+    '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',
       {
-        unsafeAutofix: true,
-        useAliases: false,
-        useOldSingleMemberSyntax: true
+        blankLine: 'always',
+        next: 'return',
+        prev: '*'
+      },
+      {
+        blankLine: 'always',
+        next: '*',
+        prev: ['const', 'let', 'var']
+      },
+      {
+        blankLine: 'any',
+        next: ['const', 'let', 'var'],
+        prev: ['const', 'let', 'var']
       }
     ],
-    'sort-keys-fix/sort-keys-fix': ['error', 'asc', { natural: true }],
-    'spaced-comment': 'error',
-    'sql-template/no-unsafe-query': 'error',
-    'valid-jsdoc': 'error',
+    'stylistic/spaced-comment': 'error',
     'vars-on-top': 'error',
     yoda: 'error'
   }
 };
+
+/**
+ * Configuration for bin and scripts files.
+ *
+ * @type {LinterConfig}
+ */
+const upholdBinScriptsConfig = {
+  files: ['**/bin/**', '**/scripts/**'],
+  languageOptions,
+  rules: {
+    'no-console': 'off',
+    'node-plugin/no-process-exit': 'off'
+  }
+};
+
+/**
+ * Export `uphold` shared configuration preset.
+ *
+ * @type {LinterConfig[]}
+ */
+module.exports = [
+  jsdoc.configs['flat/recommended-error'],
+  eslintPluginPrettierRecommended,
+  upholdBaseConfig,
+  upholdBinScriptsConfig
+];