@aarongoldenthal/eslint-config-standard 18.0.0 → 19.0.1

package/README.md

@@ -1,6 +1,8 @@
 # @aarongoldenthal/eslint-config-standard
 
-Custom standard ESLint configuration for all projects. Includes configurations for `eslint`, `eslint-plugin-jest`, `eslint-plugin-jsdoc`, `eslint-plugin-n` (formerly `eslint-plugin-node`), `eslint-plugin-playwright`, `eslint-plugin-sonarjs`, and `eslint-plugin-unicorn`. This package defines all required configurations as `dependencies` so they are installed and do not have to be defined in each project.
+## Summary
+
+Custom standard ESLint configuration for all projects. Includes configurations for `eslint`, `eslint-plugin-jest`, `eslint-plugin-jsdoc`, `eslint-plugin-n` (formerly `eslint-plugin-node`), `eslint-plugin-playwright`, `eslint-plugin-promise`, `eslint-plugin-sonarjs`, and `eslint-plugin-unicorn`. This package defines all required configurations as `dependencies` so they are installed and do not have to be defined in each project.
 
 Per recommended best practices, the following configurations include `overrides` so they are only applicable to a subset of files:
 
@@ -8,25 +10,19 @@ Per recommended best practices, the following configurations include `overrides`
   which is the [default filter for Jest test files](https://jestjs.io/docs/configuration#testmatch-arraystring).
 - `playwright-config`: applicable to files matching `['**/*.pwtest.[jt]s']`, which differentiates them from Jest test files.
 
-To configure .eslintrc.json for all plugins:
+The configuration as-defined includes a number of formatting rules. The `eslint-config-prettier` package is included as well, and can be added to the config if `prettier` is also being used so it takes priority for formatting.
+
+### Usage
+
+There is a `recommended` configuration with all plugin configurations enabled (including `prettier`). To configure .eslintrc.json with this configuration:
 
 ```json
 {
-  "extends": [
-    "@aarongoldenthal/eslint-config-standard/jest-config",
-    "@aarongoldenthal/eslint-config-standard/jsdoc-config",
-    "@aarongoldenthal/eslint-config-standard/node-config",
-    "@aarongoldenthal/eslint-config-standard/playwright-config",
-    "@aarongoldenthal/eslint-config-standard/sonarjs-config",
-    "@aarongoldenthal/eslint-config-standard/unicorn-config",
-    "@aarongoldenthal/eslint-config-standard"
-  ]
+  "extends": ["@aarongoldenthal/eslint-config-standard/recommended"]
 }
 ```
 
-Note `@aarongoldenthal/eslint-config-standard` is included last so those settings take precedence.
-
-The configuration as-defined includes a number of formatting rules. The `eslint-config-prettier` package is included as well, and can be added to the config if `prettier` is also being used so it takes priority for formatting.
+To configure .eslintrc.json with individual plugins, use the appropriate subset of the options below:
 
 ```json
 {
@@ -35,6 +31,7 @@ The configuration as-defined includes a number of formatting rules. The `eslint-
     "@aarongoldenthal/eslint-config-standard/jsdoc-config",
     "@aarongoldenthal/eslint-config-standard/node-config",
     "@aarongoldenthal/eslint-config-standard/playwright-config",
+    "@aarongoldenthal/eslint-config-standard/promise-config",
     "@aarongoldenthal/eslint-config-standard/sonarjs-config",
     "@aarongoldenthal/eslint-config-standard/unicorn-config",
     "@aarongoldenthal/eslint-config-standard",
@@ -43,4 +40,7 @@ The configuration as-defined includes a number of formatting rules. The `eslint-
 }
 ```
 
-In this case `prettier` is included last to take priority in disabling the applicable rules from all other configurations.
+Notes:
+
+- If used, the `@aarongoldenthal/eslint-config-standard` config should be included after any other `@aarongoldenthal/eslint-config-standard/*` configurations so those settings take precedence.
+- If used, the `prettier` should be included last to take priority in disabling the applicable rules from all other configurations.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aarongoldenthal/eslint-config-standard",
-  "version": "18.0.0",
+  "version": "19.0.1",
   "description": "Standard ESLint configuration settings",
   "main": "index.js",
   "scripts": {
@@ -27,7 +27,8 @@
   },
   "files": [
     "index.js",
-    "*-config.js"
+    "*-config.js",
+    "recommended.js"
   ],
   "bugs": {
     "url": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard/issues"
@@ -35,19 +36,20 @@
   "homepage": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard",
   "dependencies": {
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^27.1.5",
-    "eslint-plugin-jsdoc": "^39.6.2",
-    "eslint-plugin-n": "^15.5.1",
+    "eslint-plugin-jest": "^27.1.7",
+    "eslint-plugin-jsdoc": "^39.6.4",
+    "eslint-plugin-n": "^15.6.0",
     "eslint-plugin-playwright": "^0.11.2",
-    "eslint-plugin-sonarjs": "^0.16.0",
-    "eslint-plugin-unicorn": "^44.0.2"
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-sonarjs": "^0.17.0",
+    "eslint-plugin-unicorn": "^45.0.2"
   },
   "devDependencies": {
-    "eslint": "^8.27.0",
+    "eslint": "^8.30.0",
     "jest": "^29.3.1",
-    "jest-junit": "^14.0.1",
+    "jest-junit": "^15.0.0",
     "markdownlint-cli": "^0.32.2",
-    "prettier": "^2.7.1"
+    "prettier": "^2.8.1"
   },
   "peerDependencies": {
     "eslint": "^8.27.0"

package/promise-config.js

@@ -0,0 +1,25 @@
+'use strict';
+
+module.exports = {
+    plugins: ['promise'],
+    rules: {
+        'promise/always-return': 'error',
+        'promise/avoid-new': 'error',
+        'promise/catch-or-return': 'error',
+        'promise/no-callback-in-promise': 'error',
+        'promise/no-multiple-resolved': 'error',
+        'promise/no-native': 'off',
+        'promise/no-nesting': 'error',
+        'promise/no-new-statics': 'error',
+        'promise/no-promise-in-callback': 'error',
+        'promise/no-return-in-finally': 'error',
+        'promise/no-return-wrap': 'error',
+        'promise/param-names': [
+            'error',
+            { resolvePattern: '^resolve$', rejectPattern: '^reject$' }
+        ],
+        'promise/prefer-await-to-callbacks': 'error',
+        'promise/prefer-await-to-then': 'error',
+        'promise/valid-params': 'error'
+    }
+};

package/recommended.js

@@ -0,0 +1,15 @@
+'use strict';
+
+module.exports = {
+    extends: [
+        './jest-config.js',
+        './jsdoc-config.js',
+        './node-config.js',
+        './playwright-config.js',
+        './promise-config.js',
+        './sonarjs-config.js',
+        './unicorn-config.js',
+        './index.js',
+        'prettier'
+    ]
+};

package/unicorn-config.js

@@ -32,6 +32,7 @@ module.exports = {
         'unicorn/no-invalid-remove-event-listener': 'error',
         'unicorn/no-keyword-prefix': 'off',
         'unicorn/no-lonely-if': 'error',
+        'unicorn/no-negated-condition': 'error',
         'unicorn/no-nested-ternary': 'error',
         'unicorn/no-new-array': 'error',
         'unicorn/no-new-buffer': 'off',
@@ -41,6 +42,7 @@ module.exports = {
         'unicorn/no-static-only-class': 'error',
         'unicorn/no-thenable': 'error',
         'unicorn/no-this-assignment': 'error',
+        'unicorn/no-typeof-undefined': 'error',
         'unicorn/no-unnecessary-await': 'error',
         'unicorn/no-unreadable-array-destructuring': 'error',
         'unicorn/no-unreadable-iife': 'error',
@@ -90,6 +92,7 @@ module.exports = {
         'unicorn/prefer-reflect-apply': 'off',
         'unicorn/prefer-regexp-test': 'error',
         'unicorn/prefer-set-has': 'error',
+        'unicorn/prefer-set-size': 'error',
         'unicorn/prefer-spread': 'error',
         'unicorn/prefer-string-replace-all': 'off',
         'unicorn/prefer-string-slice': 'error',