@wistia/eslint-config 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @wistia/eslint-config
 
+## 2.2.0
+
+### Minor Changes
+
+- [#440](https://github.com/wistia/eslint-config/pull/440) [`57cb9e5`](https://github.com/wistia/eslint-config/commit/57cb9e5613d00dbecdcf325072aea6762419d97e) Thanks [@okize](https://github.com/okize)! - feat: add additional vitest rules
+
+## 2.1.1
+
+### Patch Changes
+
+- [#438](https://github.com/wistia/eslint-config/pull/438) [`bd5eaaa`](https://github.com/wistia/eslint-config/commit/bd5eaaa1c65f68969a61d67871dbe177cecc94ca) Thanks [@okize](https://github.com/okize)! - fix: official vitest plugin includes formatting rules so we do not need to use `eslint-plugin-jest-formatting`
+
 ## 2.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Wistia's ESLint configurations",
   "packageManager": "yarn@4.12.0",
   "type": "module",

package/src/configs/vitest.mjs

@@ -1,9 +1,7 @@
 import globalsVitest from 'globals-vitest';
 import vitestPlugin from '@vitest/eslint-plugin';
-import jestFormattingPlugin from 'eslint-plugin-jest-formatting';
 import noOnlyTestsPlugin from 'eslint-plugin-no-only-tests';
 import vitestRules from '../rules/vitest.mjs';
-import jestFormattingRules from '../rules/jest-formatting.mjs';
 
 export default [
   {
@@ -16,12 +14,10 @@ export default [
     },
     plugins: {
       vitest: vitestPlugin,
-      'jest-formatting': jestFormattingPlugin,
       'no-only-tests': noOnlyTestsPlugin,
     },
     rules: {
       ...vitestRules,
-      ...jestFormattingRules,
     },
   },
 ];

package/src/rules/vitest.mjs

@@ -10,14 +10,26 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
   'vitest/consistent-test-filename': 'error',
 
+  // Enforce consistent usage of each with for...of
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-each-for.md
+  'vitest/consistent-each-for': 'error',
+
   // Prefer test or it but not both
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md
   'vitest/consistent-test-it': 'error',
 
+  // Enforce consistent usage of vi vs vitest
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/consistent-vitest-vi.md
+  'vitest/consistent-vitest-vi': 'error',
+
   // Enforce having expectation in test body
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md
   'vitest/expect-expect': 'error',
 
+  // Ensure hoisted APIs (vi.mock, vi.hoisted, etc.) are at the top
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/hoisted-apis-on-top.md
+  'vitest/hoisted-apis-on-top': 'error',
+
   // Enforce a maximum number of expect per test
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md
   'vitest/max-expects': [
@@ -81,6 +93,10 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
   'vitest/no-import-node-test': 'error',
 
+  // Disallow importing vitest globals when using globals: true
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-importing-vitest-globals.md
+  'vitest/no-importing-vitest-globals': 'error',
+
   // Disallow string interpolation in snapshots
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md
   'vitest/no-interpolation-in-snapshots': 'error',
@@ -113,6 +129,54 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md
   'vitest/no-test-return-statement': 'error',
 
+  // Disallow unnecessary async in expect functions
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-unneeded-async-expect-function.md
+  'vitest/no-unneeded-async-expect-function': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `afterAll` statements.
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-after-all-blocks.md
+  'vitest/padding-around-after-all-blocks': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `afterEach` statements.
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-after-each-blocks.md
+  'vitest/padding-around-after-each-blocks': 'error',
+
+  // This rule enforces a line of padding before and after `beforeAll` statements.
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-before-all-blocks.md
+  'vitest/padding-around-before-all-blocks': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `beforeEach` statements
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-before-each-blocks.md
+  'vitest/padding-around-before-each-blocks': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `expect` statements
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-expect-groups.md
+  'vitest/padding-around-expect-groups': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `describe` statements
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-describe-blocks.md
+  'vitest/padding-around-describe-blocks': 'error',
+
+  // This rule enforces a line of padding before and after 1 or more `test`/`it` statements
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-test-blocks.md
+  'vitest/padding-around-test-blocks': 'error',
+
+  // This is a meta rule that simply enables all of the previous rules
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/padding-around-all.md
+  'vitest/padding-around-all': 'off',
+
+  // Prefer toHaveBeenCalledExactlyOnceWith over separate assertions
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-exactly-once-with.md
+  'vitest/prefer-called-exactly-once-with': 'error',
+
+  // Prefer toHaveBeenCalledOnce() over toHaveBeenCalledTimes(1)
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-once.md
+  'vitest/prefer-called-once': 'error',
+
+  // Prefer toHaveBeenCalledTimes over multiple assertions
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-times.md
+  'vitest/prefer-called-times': 'error',
+
   // Suggest using toBeCalledWith() or toHaveBeenCalledWith()
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md
   'vitest/prefer-called-with': 'error',
@@ -121,6 +185,10 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md
   'vitest/prefer-comparison-matcher': 'error',
 
+  // Enforce describe titles to match function names
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-describe-function-title.md
+  'vitest/prefer-describe-function-title': 'error',
+
   // Prefer each rather than manual loops
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md
   'vitest/prefer-each': 'error',
@@ -137,6 +205,10 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md
   'vitest/prefer-expect-resolves': 'error',
 
+  // Prefer expect.typeOf() usage
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-type-of.md
+  'vitest/prefer-expect-type-of': 'error',
+
   // Prefer having hooks in consistent order
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
   'vitest/prefer-hooks-in-order': 'error',
@@ -145,6 +217,14 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md
   'vitest/prefer-hooks-on-top': 'error',
 
+  // Prefer vi.importActual/vi.importMock in vi.mock factories
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-import-in-mock.md
+  'vitest/prefer-import-in-mock': 'error',
+
+  // Prefer importing vitest globals instead of using them implicitly
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-importing-vitest-globals.md
+  'vitest/prefer-importing-vitest-globals': 'error',
+
   // Enforce lowercase titles
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-lowercase-title.md
   'vitest/prefer-lowercase-title': 'off',
@@ -153,6 +233,10 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md
   'vitest/prefer-mock-promise-shorthand': 'error',
 
+  // Prefer mock return shorthands
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-return-shorthand.md
+  'vitest/prefer-mock-return-shorthand': 'error',
+
   // Prefer including a hint with external snapshots
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-snapshot-hint.md
   'vitest/prefer-snapshot-hint': 'error',
@@ -161,6 +245,10 @@ export default {
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
   'vitest/prefer-spy-on': 'error',
 
+  // Prefer strict boolean matchers (toBe(true) over toBeTruthy())
+  // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-boolean-matchers.md
+  'vitest/prefer-strict-boolean-matchers': 'error',
+
   // Prefer strict equal over equal
   // https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-equal.md
   'vitest/prefer-strict-equal': 'error',

package/test/__snapshots__/vitest.mjs.snap

@@ -36,36 +36,15 @@
   "plugins": [
     "@",
     "vitest:vitest@1.6.13",
-    "jest-formatting",
     "no-only-tests",
   ],
   "rules": {
-    "jest-formatting/padding-around-after-all-blocks": [
-      2,
-    ],
-    "jest-formatting/padding-around-after-each-blocks": [
-      2,
-    ],
-    "jest-formatting/padding-around-all": [
-      0,
-    ],
-    "jest-formatting/padding-around-before-all-blocks": [
-      2,
-    ],
-    "jest-formatting/padding-around-before-each-blocks": [
-      2,
-    ],
-    "jest-formatting/padding-around-describe-blocks": [
-      2,
-    ],
-    "jest-formatting/padding-around-expect-groups": [
-      2,
-    ],
-    "jest-formatting/padding-around-test-blocks": [
+    "no-only-tests/no-only-tests": [
       2,
     ],
-    "no-only-tests/no-only-tests": [
+    "vitest/consistent-each-for": [
       2,
+      {},
     ],
     "vitest/consistent-test-filename": [
       2,
@@ -78,6 +57,12 @@
       2,
       {},
     ],
+    "vitest/consistent-vitest-vi": [
+      2,
+      {
+        "fn": "vi",
+      },
+    ],
     "vitest/expect-expect": [
       2,
       {
@@ -88,6 +73,9 @@
         ],
       },
     ],
+    "vitest/hoisted-apis-on-top": [
+      2,
+    ],
     "vitest/max-expects": [
       2,
       {
@@ -142,6 +130,9 @@
     "vitest/no-import-node-test": [
       2,
     ],
+    "vitest/no-importing-vitest-globals": [
+      2,
+    ],
     "vitest/no-interpolation-in-snapshots": [
       2,
     ],
@@ -174,12 +165,51 @@
     "vitest/no-test-return-statement": [
       2,
     ],
+    "vitest/no-unneeded-async-expect-function": [
+      2,
+    ],
+    "vitest/padding-around-after-all-blocks": [
+      2,
+    ],
+    "vitest/padding-around-after-each-blocks": [
+      2,
+    ],
+    "vitest/padding-around-all": [
+      0,
+    ],
+    "vitest/padding-around-before-all-blocks": [
+      2,
+    ],
+    "vitest/padding-around-before-each-blocks": [
+      2,
+    ],
+    "vitest/padding-around-describe-blocks": [
+      2,
+    ],
+    "vitest/padding-around-expect-groups": [
+      2,
+    ],
+    "vitest/padding-around-test-blocks": [
+      2,
+    ],
+    "vitest/prefer-called-exactly-once-with": [
+      2,
+    ],
+    "vitest/prefer-called-once": [
+      2,
+    ],
+    "vitest/prefer-called-times": [
+      2,
+    ],
     "vitest/prefer-called-with": [
       2,
     ],
     "vitest/prefer-comparison-matcher": [
       2,
     ],
+    "vitest/prefer-describe-function-title": [
+      2,
+    ],
     "vitest/prefer-each": [
       2,
     ],
@@ -197,12 +227,24 @@
     "vitest/prefer-expect-resolves": [
       2,
     ],
+    "vitest/prefer-expect-type-of": [
+      2,
+    ],
     "vitest/prefer-hooks-in-order": [
       2,
     ],
     "vitest/prefer-hooks-on-top": [
       2,
     ],
+    "vitest/prefer-import-in-mock": [
+      2,
+      {
+        "fixable": true,
+      },
+    ],
+    "vitest/prefer-importing-vitest-globals": [
+      2,
+    ],
     "vitest/prefer-lowercase-title": [
       0,
       {
@@ -215,6 +257,9 @@
     "vitest/prefer-mock-promise-shorthand": [
       2,
     ],
+    "vitest/prefer-mock-return-shorthand": [
+      2,
+    ],
     "vitest/prefer-snapshot-hint": [
       2,
       "multi",
@@ -222,6 +267,9 @@
     "vitest/prefer-spy-on": [
       2,
     ],
+    "vitest/prefer-strict-boolean-matchers": [
+      2,
+    ],
     "vitest/prefer-strict-equal": [
       2,
     ],