@aarongoldenthal/eslint-config-standard 20.1.0 → 21.0.0

package/README.md

@@ -2,21 +2,34 @@
 
 ## 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.
+Custom standard ESLint configuration for all projects. Includes configurations
+for `eslint`, `@eslint-community/eslint-plugin-eslint-comments` (formerly
+`eslint-plugin-eslint-comments`), `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:
+Per recommended best practices, the following configurations include `overrides`
+so they are only applicable to a subset of files:
 
 - `jest-config`: applicable to files matching `['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)']`,
   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.
+- `playwright-config`: applicable to files matching `['**/*.pwtest.[jt]s']`,
+  which differentiates them from Jest test files.
 
-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.
+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.
 
-There is also an `esm-config` included with overrides for projects using ES modules instead of Common JS modules.
+There is also an `esm-config` included with overrides for projects using ES
+modules instead of Common JS modules.
 
 ### Usage
 
-There is a `recommended` configuration with all plugin configurations enabled except `esm-config` (but including `prettier`). To configure .eslintrc.json with this configuration:
+There is a `recommended` configuration with all plugin configurations enabled
+except `esm-config` (but including `prettier`). To configure .eslintrc.json
+with this configuration:
 
 ```json
 {
@@ -24,11 +37,13 @@ There is a `recommended` configuration with all plugin configurations enabled ex
 }
 ```
 
-To configure .eslintrc.json with individual plugins, use the appropriate subset of the options below:
+To configure .eslintrc.json with individual plugins, use the appropriate subset
+of the options below:
 
 ```json
 {
   "extends": [
+    "@aarongoldenthal/eslint-config-standard/eslint-comments-config.js",
     "@aarongoldenthal/eslint-config-standard/jest-config",
     "@aarongoldenthal/eslint-config-standard/jsdoc-config",
     "@aarongoldenthal/eslint-config-standard/node-config",
@@ -45,6 +60,10 @@ To configure .eslintrc.json with individual plugins, use the appropriate subset
 
 Notes:
 
-- If used, the `@aarongoldenthal/eslint-config-standard` config should be included after any other `@aarongoldenthal/eslint-config-standard/*` configurations except `esm-config` so those settings take precedence.
-- If used, the `esm-config` should be configured after all functional rules to ensure the overridden settings take precedence.
-- If used, the `prettier` should be included last to take priority in disabling the applicable rules from all other configurations.
+- If used, the `@aarongoldenthal/eslint-config-standard` config should be
+  included after any other `@aarongoldenthal/eslint-config-standard/*`
+  configurations except `esm-config` so those settings take precedence.
+- If used, the `esm-config` should be configured after all functional rules
+  to ensure the overridden settings take precedence.
+- If used, the `prettier` should be included last to take priority in disabling
+  the applicable rules from all other configurations.

package/eslint-comments-config.js

@@ -0,0 +1,28 @@
+'use strict';
+
+module.exports = {
+    plugins: ['@eslint-community/eslint-comments'],
+    rules: {
+        '@eslint-community/eslint-comments/disable-enable-pair': [
+            'error',
+            { allowWholeFile: true }
+        ],
+        '@eslint-community/eslint-comments/no-aggregating-enable': 'error',
+        '@eslint-community/eslint-comments/no-duplicate-disable': 'error',
+        '@eslint-community/eslint-comments/no-unlimited-disable': 'error',
+        '@eslint-community/eslint-comments/no-unused-disable': 'error',
+        '@eslint-community/eslint-comments/no-unused-enable': 'error',
+        '@eslint-community/eslint-comments/no-use': [
+            'error',
+            {
+                allow: [
+                    'eslint-disable',
+                    'eslint-disable-line',
+                    'eslint-disable-next-line',
+                    'eslint-enable'
+                ]
+            }
+        ],
+        '@eslint-community/eslint-comments/require-description': 'error'
+    }
+};

package/jsdoc-config.js

@@ -35,6 +35,7 @@ module.exports = {
         'jsdoc/check-values': 'error', // Recommended
         'jsdoc/empty-tags': 'error', // Recommended
         'jsdoc/implements-on-classes': 'error', // Recommended
+        'jsdoc/informative-docs': 'error',
         'jsdoc/match-description': 'error',
         'jsdoc/multiline-blocks': 'error', // Recommended
         'jsdoc/newline-after-description': 'error', // Recommended

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aarongoldenthal/eslint-config-standard",
-  "version": "20.1.0",
+  "version": "21.0.0",
   "description": "Standard ESLint configuration settings",
   "main": "index.js",
   "scripts": {
@@ -35,21 +35,22 @@
   },
   "homepage": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard",
   "dependencies": {
-    "eslint-config-prettier": "8.7.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "3.2.1",
+    "eslint-config-prettier": "8.8.0",
     "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-jsdoc": "40.0.2",
-    "eslint-plugin-n": "15.6.1",
+    "eslint-plugin-jsdoc": "41.1.1",
+    "eslint-plugin-n": "15.7.0",
     "eslint-plugin-playwright": "0.12.0",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-sonarjs": "0.18.0",
+    "eslint-plugin-sonarjs": "0.19.0",
     "eslint-plugin-unicorn": "46.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.36.0",
+    "eslint": "^8.38.0",
     "jest": "^29.5.0",
     "jest-junit": "^15.0.0",
     "markdownlint-cli": "^0.33.0",
-    "prettier": "^2.8.4"
+    "prettier": "^2.8.7"
   },
   "peerDependencies": {
     "eslint": "^8.27.0"

package/recommended.js

@@ -2,6 +2,7 @@
 
 module.exports = {
     extends: [
+        './eslint-comments-config.js',
         './jest-config.js',
         './jsdoc-config.js',
         './node-config.js',