@aarongoldenthal/eslint-config-standard 22.1.0 → 23.1.0

package/README.md

@@ -28,8 +28,8 @@ 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:
+except `esm-config` and `vitest-config` (it includes `jest-config`). To
+configure .eslintrc.json with this configuration:
 
 ```json
 {
@@ -37,6 +37,16 @@ with this configuration:
 }
 ```
 
+There is also a `recommended-vitest` configuration that is the same as the
+`recommended` config, but includes the `vitest-config` instead of the
+`jest-config`, and can be configured with:
+
+```json
+{
+  "extends": ["@aarongoldenthal/eslint-config-standard/recommended-vitest"]
+}
+```
+
 To configure .eslintrc.json with individual plugins, use the appropriate subset
 of the options below:
 
@@ -51,6 +61,7 @@ of the options below:
     "@aarongoldenthal/eslint-config-standard/promise-config",
     "@aarongoldenthal/eslint-config-standard/sonarjs-config",
     "@aarongoldenthal/eslint-config-standard/unicorn-config",
+    "@aarongoldenthal/eslint-config-standard/vitest-config",
     "@aarongoldenthal/eslint-config-standard",
     "@aarongoldenthal/eslint-config-standard/esm-config",
     "prettier"
@@ -63,6 +74,8 @@ 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.
+- The `jest-config` and `vitest-config` have the same file overrides, so only
+  one should be used.
 - 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

package/jsdoc-config.js

@@ -35,12 +35,13 @@ module.exports = {
         'jsdoc/check-values': 'error', // Recommended
         'jsdoc/empty-tags': 'error', // Recommended
         'jsdoc/implements-on-classes': 'error', // Recommended
+        'jsdoc/imports-as-dependencies': 'error',
         'jsdoc/informative-docs': 'error',
         'jsdoc/match-description': 'error',
         'jsdoc/multiline-blocks': 'error', // Recommended
         'jsdoc/no-bad-blocks': 'error',
         'jsdoc/no-blank-blocks': 'error',
-        'jsdoc/no-defaults': 'off',
+        'jsdoc/no-defaults': ['error', { contexts: ['any'] }],
         'jsdoc/no-missing-syntax': 'off',
         'jsdoc/no-multi-asterisks': 'error', // Recommended
         'jsdoc/no-restricted-syntax': 'off',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aarongoldenthal/eslint-config-standard",
-  "version": "22.1.0",
+  "version": "23.1.0",
   "description": "Standard ESLint configuration settings",
   "main": "index.js",
   "scripts": {
@@ -9,8 +9,8 @@
     "lint": "npm run lint-js && npm run lint-md",
     "lint-js": "eslint .",
     "lint-md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"",
-    "prettier-check": "prettier --check --ignore-path=.gitignore .",
-    "prettier-fix": "prettier --write --ignore-path=.gitignore .",
+    "prettier-check": "prettier --check .",
+    "prettier-fix": "prettier --write .",
     "test": "jest --ci"
   },
   "repository": {
@@ -28,31 +28,30 @@
   "files": [
     "index.js",
     "*-config.js",
-    "recommended.js"
+    "recommended*.js"
   ],
   "bugs": {
     "url": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard/issues"
   },
   "homepage": "https://gitlab.com/gitlab-ci-utils/eslint-config-standard",
-  "dependencies": {
+  "devDependencies": {
+    "eslint": "8.45.0",
+    "jest": "29.6.1",
+    "jest-junit": "16.0.0",
+    "markdownlint-cli2": "0.8.1",
+    "prettier": "3.0.0"
+  },
+  "peerDependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "3.2.1",
+    "eslint": "^8.27.0",
     "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-jest": "27.2.1",
-    "eslint-plugin-jsdoc": "44.2.5",
-    "eslint-plugin-n": "16.0.0",
-    "eslint-plugin-playwright": "0.12.0",
+    "eslint-plugin-jest": "27.2.3",
+    "eslint-plugin-jsdoc": "46.4.4",
+    "eslint-plugin-n": "16.0.1",
+    "eslint-plugin-playwright": "0.15.3",
     "eslint-plugin-promise": "6.1.1",
     "eslint-plugin-sonarjs": "0.19.0",
-    "eslint-plugin-unicorn": "47.0.0"
-  },
-  "devDependencies": {
-    "eslint": "^8.41.0",
-    "jest": "^29.5.0",
-    "jest-junit": "^16.0.0",
-    "markdownlint-cli2": "^0.7.1",
-    "prettier": "^2.8.8"
-  },
-  "peerDependencies": {
-    "eslint": "^8.27.0"
+    "eslint-plugin-unicorn": "48.0.1",
+    "eslint-plugin-vitest": "0.2.6"
   }
 }

package/playwright-config.js

@@ -9,6 +9,7 @@ module.exports = {
             files: ['**/*.pwtest.[jt]s'],
             plugins: ['playwright'],
             rules: {
+                'playwright/expect-expect': 'error',
                 'playwright/max-nested-describe': 'error',
                 'playwright/missing-playwright-await': 'error',
                 'playwright/no-conditional-in-test': 'error',
@@ -16,14 +17,20 @@ module.exports = {
                 'playwright/no-eval': 'error',
                 'playwright/no-focused-test': 'error',
                 'playwright/no-force-option': 'error',
+                'playwright/no-nested-step': 'error',
+                'playwright/no-networkidle': 'error',
+                'playwright/no-nth-methods': 'error',
                 'playwright/no-page-pause': 'error',
                 'playwright/no-skipped-test': 'error',
+                'playwright/no-useless-await': 'error',
                 'playwright/no-useless-not': 'error',
                 'playwright/no-wait-for-timeout': 'error',
                 'playwright/prefer-lowercase-title': 'error',
                 'playwright/prefer-strict-equal': 'error',
                 'playwright/prefer-to-be': 'error',
+                'playwright/prefer-to-contain': 'error',
                 'playwright/prefer-to-have-length': 'error',
+                'playwright/prefer-web-first-assertions': 'error',
                 'playwright/require-soft-assertions': 'off',
                 'playwright/require-top-level-describe': 'error',
                 'playwright/valid-expect': 'error'

package/recommended-vitest.js

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

package/unicorn-config.js

@@ -56,7 +56,6 @@ module.exports = {
         'unicorn/no-unnecessary-await': 'error', // Recommended
         'unicorn/no-unreadable-array-destructuring': 'error', // Recommended
         'unicorn/no-unreadable-iife': 'error', // Recommended
-        'unicorn/no-unsafe-regex': 'error',
         'unicorn/no-unused-properties': 'error',
         'unicorn/no-useless-fallback-in-spread': 'error', // Recommended
         'unicorn/no-useless-length-check': 'error', // Recommended

package/vitest-config.js

@@ -0,0 +1,73 @@
+'use strict';
+
+module.exports = {
+    overrides: [
+        {
+            files: [
+                '**/__tests__/**/*.[jt]s?(x)',
+                '**/?(*.)+(spec|test).[jt]s?(x)'
+            ],
+            plugins: ['vitest'],
+            rules: {
+                'vitest/consistent-test-filename': [
+                    'error',
+                    {
+                        allTestPattern: '.*\\.test\\.[tj]sx?$',
+                        pattern: '.*\\.test\\.[tj]sx?$'
+                    }
+                ],
+                'vitest/consistent-test-it': [
+                    'error',
+                    { fn: 'it', withinDescribe: 'it' }
+                ],
+                'vitest/expect-expect': 'error', // Recommended
+                'vitest/max-expects': ['error', { max: 5 }],
+                'vitest/max-nested-describe': ['error', { max: 3 }],
+                'vitest/no-alias-methods': 'error',
+                'vitest/no-commented-out-tests': 'error', // Recommended
+                'vitest/no-conditional-expect': 'error',
+                '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',
+                'vitest/no-identical-title': 'error', // Recommended
+                'vitest/no-interpolation-in-snapshots': 'error',
+                'vitest/no-large-snapshots': 'off',
+                'vitest/no-mocks-import': 'error',
+                'vitest/no-restricted-matchers': 'off',
+                'vitest/no-restricted-vi-methods': 'off',
+                'vitest/no-standalone-expect': 'error',
+                'vitest/no-test-prefixes': 'error',
+                'vitest/no-test-return-statement': 'error',
+                'vitest/prefer-called-with': 'error',
+                'vitest/prefer-comparison-matcher': 'error',
+                'vitest/prefer-each': 'error',
+                'vitest/prefer-equality-matcher': 'error',
+                'vitest/prefer-expect-resolves': 'error',
+                'vitest/prefer-hooks-in-order': 'error',
+                'vitest/prefer-hooks-on-top': 'error',
+                'vitest/prefer-lowercase-title': 'error',
+                'vitest/prefer-mock-promise-shorthand': 'error',
+                'vitest/prefer-snapshot-hint': 'error',
+                'vitest/prefer-spy-on': 'error',
+                'vitest/prefer-strict-equal': 'error',
+                'vitest/prefer-to-be': 'error', // Recommended
+                'vitest/prefer-to-be-falsy': 'off',
+                'vitest/prefer-to-be-object': 'error',
+                'vitest/prefer-to-be-truthy': 'off',
+                'vitest/prefer-to-contain': 'error',
+                'vitest/prefer-to-have-length': 'error',
+                'vitest/prefer-todo': 'error',
+                'vitest/require-hook': 'error',
+                'vitest/require-to-throw-message': 'error',
+                'vitest/require-top-level-describe': 'error',
+                'vitest/valid-describe-callback': 'error', // Recommended
+                'vitest/valid-expect': 'error', // Recommended
+                'vitest/valid-title': 'error' // Recommended
+            }
+        }
+    ]
+};