chore: patch eslint-doc-generator (#810)

Author: paescuj

.github/workflows/ci.yaml

@@ -32,9 +32,8 @@ jobs:
       - name: Lint code
         run: pnpm lint:js
 
-      ### Temporarily disabled, see https://github.com/vitest-dev/eslint-plugin-vitest/issues/754
-      #- name: Lint docs
-      #  run: pnpm lint:eslint-docs
+      - name: Lint docs
+        run: pnpm lint:eslint-docs
 
   test:
     name: Test (Node.js ${{ matrix.node-version }}, ${{ matrix.os.name }})

README.md

@@ -185,9 +185,9 @@ export default defineConfig({
 💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
 ❌ Deprecated.
 
-| Name                                                                                                                     | Description                                                                                     | 💼  | ⚠️  | 🚫  | 🔧  | 💡  | 💭  | ❌  |
+| Name                                                                                                                     | Description                                                                                     | 💼  | ⚠️  | 🚫  | 🔧  | 💡  | 💭  | ❌  |
 | :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- | :-- | :-- | :-- |
-| [consistent-test-filename](docs/rules/consistent-test-filename.md)                                                       | require .spec test file pattern                                                                 |     | 🌐  |     |     |     |     |     |
+| [consistent-test-filename](docs/rules/consistent-test-filename.md)                                                       | require test file pattern                                                                       |     | 🌐  |     |     |     |     |     |
 | [consistent-test-it](docs/rules/consistent-test-it.md)                                                                   | enforce using test or it but not both                                                           |     | 🌐  |     | 🔧  |     |     |     |
 | [consistent-vitest-vi](docs/rules/consistent-vitest-vi.md)                                                               | enforce using vitest or vi but not both                                                         |     | 🌐  |     | 🔧  |     |     |     |
 | [expect-expect](docs/rules/expect-expect.md)                                                                             | enforce having expectation in test body                                                         | ✅  | 🌐  |     |     |     |     |     |
@@ -236,6 +236,7 @@ export default defineConfig({
 | [prefer-expect-type-of](docs/rules/prefer-expect-type-of.md)                                                             | enforce using `expectTypeOf` instead of `expect(typeof ...)`                                    |     | 🌐  |     | 🔧  |     |     |     |
 | [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md)                                                             | enforce having hooks in consistent order                                                        |     | 🌐  |     |     |     |     |     |
 | [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)                                                                 | enforce having hooks before any test cases                                                      |     | 🌐  |     |     |     |     |     |
+| [prefer-import-in-mock](docs/rules/prefer-import-in-mock.md)                                                             | prefer dynamic import in mock                                                                   |     | 🌐  |     | 🔧  |     |     |     |
 | [prefer-importing-vitest-globals](docs/rules/prefer-importing-vitest-globals.md)                                         | enforce importing Vitest globals                                                                |     | 🌐  |     | 🔧  |     |     |     |
 | [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md)                                                           | enforce lowercase titles                                                                        |     | 🌐  |     | 🔧  |     |     |     |
 | [prefer-mock-promise-shorthand](docs/rules/prefer-mock-promise-shorthand.md)                                             | enforce mock resolved/rejected shorthands for promises                                          |     | 🌐  |     | 🔧  |     |     |     |
@@ -261,7 +262,6 @@ export default defineConfig({
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)                                                         | require promises that have expectations in their chain to be valid                              |     | 🌐  |     |     |     |     |     |
 | [valid-title](docs/rules/valid-title.md)                                                                                 | enforce valid titles                                                                            | ✅  | 🌐  |     | 🔧  |     |     |     |
 | [warn-todo](docs/rules/warn-todo.md)                                                                                     | disallow `.todo` usage                                                                          |     |     |     |     |     |     |     |
-| [prefer-import-in-moc](docs/rules/prefer-import-in-moc.md)                                                               | enforce dynamic import in mock                                                                  | ✅  | 🌐  |     | 🔧  |     |     |     |
 
 <!-- end auto-generated rules list -->
 

docs/rules/consistent-test-filename.md

@@ -1,4 +1,4 @@
-# Require .spec test file pattern (`vitest/consistent-test-filename`)
+# Require test file pattern (`vitest/consistent-test-filename`)
 
 ⚠️ This rule _warns_ in the 🌐 `all` config.
 

docs/rules/hoisted-apis-on-top.md

@@ -1,4 +1,6 @@
-# Enforce hoisted APIs to be on top of the file (`@vitest/hoisted-apis-on-top`)
+# Enforce hoisted APIs to be on top of the file (`vitest/hoisted-apis-on-top`)
+
+⚠️ This rule _warns_ in the 🌐 `all` config.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 

docs/rules/padding-around-describe-blocks.md

@@ -17,17 +17,17 @@ its scope.
 Examples of **incorrect** code for this rule:
 
 ```js
-const someText = 'hoge';
-describe("hoge", () => {});
-describe('foo', () => {});
+const someText = 'hoge'
+describe('hoge', () => {})
+describe('foo', () => {})
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
-const someText = 'hoge';
+const someText = 'hoge'
 
-describe("hoge", () => {});
+describe('hoge', () => {})
 
-describe('foo', () => {});
+describe('foo', () => {})
 ```

docs/rules/padding-around-test-blocks.md

@@ -17,31 +17,31 @@ its scope.
 Examples of **incorrect** code for this rule:
 
 ```js
-const someText = 'hoge';
-test("hoge", () => {});
-test('foo', () => {});
+const someText = 'hoge'
+test('hoge', () => {})
+test('foo', () => {})
 ```
 
 ```js
-const someText = 'hoge';
-it("hoge", () => {});
-it('foo', () => {});
+const someText = 'hoge'
+it('hoge', () => {})
+it('foo', () => {})
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
-const someText = 'hoge';
+const someText = 'hoge'
 
-test("hoge", () => {});
+test('hoge', () => {})
 
-test('foo', () => {});
+test('foo', () => {})
 ```
 
 ```js
-const someText = 'hoge';
+const someText = 'hoge'
 
-it("hoge", () => {});
+it('hoge', () => {})
 
-it('foo', () => {});
+it('foo', () => {})
 ```

docs/rules/prefer-called-once.md

@@ -1,6 +1,6 @@
 # Enforce using `toBeCalledOnce()` or `toHaveBeenCalledOnce()` (`vitest/prefer-called-once`)
 
-⚠️ This rule _warns_ in the 🌐 `all` config.
+🚫 This rule is _disabled_ in the 🌐 `all` config.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 

docs/rules/prefer-expect-assertions.md

@@ -50,19 +50,19 @@ when this option is enabled the following code will be considered incorrect:
 
 ```js
 test('assertions first', async () => {
-   const data = await fetchData();
-   expect(data).toBe('peanut butter');
-});
+  const data = await fetchData()
+  expect(data).toBe('peanut butter')
+})
 ```
 
 To fix this, you'll need to add `expect.assertions(1)` or `expect.hasAssertions()` as the first expression:
 
 ```js
 test('assertions first', async () => {
-   expect.assertions(1);
-   const data = await fetchData();
-   expect(data).toBe('peanut butter');
-});
+  expect.assertions(1)
+  const data = await fetchData()
+  expect(data).toBe('peanut butter')
+})
 ```
 
 `onlyFunctionsWithExpectInLoop` (default: `false`)

docs/rules/prefer-expect-type-of.md

@@ -1,4 +1,6 @@
-# Enforce using `expectTypeOf` instead of `expect(typeof ...)` (`@vitest/prefer-expect-type-of`)
+# Enforce using `expectTypeOf` instead of `expect(typeof ...)` (`vitest/prefer-expect-type-of`)
+
+⚠️ This rule _warns_ in the 🌐 `all` config.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
@@ -42,4 +44,4 @@ test('type checking', () => {
   expectTypeOf(123n).toBeBigInt()
   expectTypeOf(undefined).toBeUndefined()
 })
-```
+```

docs/rules/prefer-import-in-mock.md

@@ -1,4 +1,4 @@
-# Enforce using dynamic import in `mock` (`vitest/prefer-import-in-mock`)
+# Prefer dynamic import in mock (`vitest/prefer-import-in-mock`)
 
 ⚠️ This rule _warns_ in the 🌐 `all` config.
 
@@ -13,11 +13,11 @@ This rule enforces using a dynamic import() in vi.mock(), which improves type in
 The following pattern is considered a warning:
 
 ```js
-vi.mock('./path/to/module');
+vi.mock('./path/to/module')
 ```
 
 The following pattern is not considered a warning:
 
 ```js
-vi.mock(import('./path/to/module'));
+vi.mock(import('./path/to/module'))
 ```