feat: New rule prefer-called-times

.eslint-doc-generatorrc.js

@@ -0,0 +1,14 @@
+import prettier from 'prettier'
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  ignoreConfig: ['legacy-all', 'legacy-recommended'],
+  postprocess: async (content, path) =>
+    prettier.format(content, {
+      ...(await prettier.resolveConfig(path)),
+      parser: 'markdown',
+    }),
+  ruleDocTitleFormat: 'name',
+}
+
+export default config

.github/workflows/ci.yml

@@ -51,5 +51,8 @@ jobs:
       - name: lint code
         run: pnpm lint:js
 
+      - name: lint docs
+        run: pnpm lint:eslint-docs
+
       - name: test
         run: pnpm test:ci

docs/rules/consistent-test-filename.md

@@ -1,6 +1,4 @@
-# Require .spec test file pattern (`vitest/consistent-test-filename`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# consistent-test-filename
 
 <!-- end auto-generated rule header -->
 

docs/rules/consistent-test-it.md

@@ -1,6 +1,4 @@
-# Enforce using test or it but not both (`vitest/consistent-test-it`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# consistent-test-it
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
@@ -12,48 +10,42 @@ Examples of **incorrect** code for this rule:
 
 ```js
 test('it works', () => {
-	// ...
+  // ...
 })
 
 it('it works', () => {
-	// ...
+  // ...
 })
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
 test('it works', () => {
-	// ...
+  // ...
 })
 ```
 
 ```js
 test('it works', () => {
-	// ...
+  // ...
 })
 ```
 
 #### Options
 
 ```json
 {
-   "type":"object",
-   "properties":{
-      "fn":{
-         "enum":[
-            "it",
-            "test"
-         ]
-      },
-      "withinDescribe":{
-         "enum":[
-            "it",
-            "test"
-         ]
-      }
-   },
-   "additionalProperties":false
+  "type": "object",
+  "properties": {
+    "fn": {
+      "enum": ["it", "test"]
+    },
+    "withinDescribe": {
+      "enum": ["it", "test"]
+    }
+  },
+  "additionalProperties": false
 }
 ```
 
@@ -68,23 +60,25 @@ Decides whether to prefer `test` or `it` when used within a `describe` block.
 ```js
 /*eslint vitest/consistent-test-it: ["error", {"fn": "test"}]*/
 
-test('it works', () => { // <-- Valid
-	// ...
+test('it works', () => {
+  // <-- Valid
+  // ...
 })
 
-test.only('it works', () => { // <-- Valid
-	// ...
+test.only('it works', () => {
+  // <-- Valid
+  // ...
 })
 
-
-it('it works', () => { // <-- Invalid
-	// ...
+it('it works', () => {
+  // <-- Invalid
+  // ...
 })
 
-it.only('it works', () => { // <-- Invalid
-	// ...
+it.only('it works', () => {
+  // <-- Invalid
+  // ...
 })
 ```
 
 The default configuration is top level `test` and all tests nested with `describe` to use `it`.
-

docs/rules/consistent-vitest-vi.md

@@ -1,6 +1,4 @@
-# Enforce using vitest or vi but not both (`vitest/consistent-vitest-vi`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# consistent-vitest-vi
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
@@ -11,39 +9,36 @@
 Examples of **incorrect** code for this rule:
 
 ```js
-vitest.mock('./src/calculator.ts', { spy: true });
+vitest.mock('./src/calculator.ts', { spy: true })
 
-vi.stubEnv('NODE_ENV', 'production');
+vi.stubEnv('NODE_ENV', 'production')
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
-vi.mock('./src/calculator.ts', { spy: true });
+vi.mock('./src/calculator.ts', { spy: true })
 
-vi.stubEnv('NODE_ENV', 'production');
+vi.stubEnv('NODE_ENV', 'production')
 ```
 
 ```js
-vitest.mock('./src/calculator.ts', { spy: true });
+vitest.mock('./src/calculator.ts', { spy: true })
 
-vitest.stubEnv('NODE_ENV', 'production');
+vitest.stubEnv('NODE_ENV', 'production')
 ```
 
 ## Options
 
 ```json
 {
-   "type":"object",
-   "properties":{
-      "fn":{
-         "enum":[
-            "vi",
-            "vitest"
-         ]
-      }
-   },
-   "additionalProperties":false
+  "type": "object",
+  "properties": {
+    "fn": {
+      "enum": ["vi", "vitest"]
+    }
+  },
+  "additionalProperties": false
 }
 ```
 

docs/rules/expect-expect.md

@@ -1,12 +1,7 @@
-# Enforce having expectation in test body (`vitest/expect-expect`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# expect-expect
 
 <!-- end auto-generated rule header -->
 
-
 ## Rule Details
 
 This rule aims to enforce having at least one expectation in test body to ensure that the test is actually testing something.
@@ -15,7 +10,7 @@ Examples of **incorrect** code for this rule:
 
 ```js
 test('myLogic', () => {
-	console.log('myLogic')
+  console.log('myLogic')
 })
 
 test('myLogic', () => {})
@@ -52,20 +47,17 @@ If you're using Vitest's [type-testing feature](https://vitest.dev/guide/testing
 
 An array of strings that are the names of the functions that are used for assertions. Function names can also be wildcard patterns like `expect*`,`function.**.expect` or `expect.anything`.
 
-
 The following is an example of correct code for this rule with the option `assertFunctionNames`:
 
 ```js
 import CheckForMe from 'check-for-me'
 test('myLogic', () => {
- expect("myLogic").toBe("myOutput")
+  expect('myLogic').toBe('myOutput')
 })
 ```
 
-
 ### `additionalTestBlockFunctions`
 
-
 ```json
 {
   "rules": {
@@ -85,8 +77,8 @@ The following is an example of correct code for this rule with the option `addit
 import CheckForMe from 'check-for-me'
 checkForMe('myLogic', () => {
   checkForMe('myLogic', () => {
-	const actual = myLogic()
-	expect(actual).toBe(true)
+    const actual = myLogic()
+    expect(actual).toBe(true)
   })
 })
 ```

docs/rules/max-expects.md

@@ -1,6 +1,4 @@
-# Enforce a maximum number of expect per test (`vitest/max-expects`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# max-expects
 
 <!-- end auto-generated rule header -->
 

docs/rules/max-nested-describe.md

@@ -1,6 +1,4 @@
-# Require describe block to be less than set max value or default value (`vitest/max-nested-describe`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# max-nested-describe
 
 <!-- end auto-generated rule header -->
 
@@ -10,17 +8,17 @@ Examples of **incorrect** code for this rule with `max: 1`:
 
 ```js
 describe('outer', () => {
-	describe('inner', () => {
-		// ...
-	})
+  describe('inner', () => {
+    // ...
+  })
 })
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
 describe('inner', () => {
-	// ...
+  // ...
 })
 ```
 
@@ -32,6 +30,6 @@ Maximum number of nested `describe` blocks.
 
 ```js
 {
-	max: number
+  max: number
 }
 ```

docs/rules/no-alias-methods.md

@@ -1,12 +1,9 @@
-# Disallow alias methods (`vitest/no-alias-methods`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# no-alias-methods
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
 
-
 ## Rule Details
 
 This rule disallows alias methods and forces the use of the original method.
@@ -21,7 +18,6 @@ expect(a).toBeCalled()
 expect(a).toBeCalledTimes(1)
 ```
 
-
 Examples of **correct** code for this rule:
 
 ```js

docs/rules/no-commented-out-tests.md

@@ -1,8 +1,4 @@
-# Disallow commented out tests (`vitest/no-commented-out-tests`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# no-commented-out-tests
 
 <!-- end auto-generated rule header -->
 

docs/rules/no-conditional-expect.md

@@ -1,6 +1,4 @@
-# Disallow conditional expects (`vitest/no-conditional-expect`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# no-conditional-expect
 
 <!-- end auto-generated rule header -->
 
@@ -13,7 +11,7 @@ Examples of **incorrect** code for this rule:
 ```ts
 test('foo', () => {
   if (true) {
-	expect(1).toBe(1)
+    expect(1).toBe(1)
   }
 })
 ```

docs/rules/no-conditional-in-test.md

@@ -1,8 +1,7 @@
-# Disallow conditional tests (`vitest/no-conditional-in-test`)
-
-⚠️ This rule _warns_ in the 🌐 `all` config.
+# no-conditional-in-test
 
 <!-- end auto-generated rule header -->
+
 ### Rule Details
 
 This rule aims to prevent conditional tests.
@@ -12,7 +11,7 @@ Examples of **incorrect** code for this rule:
 ```js
 test('my test', () => {
   if (true) {
-	doTheThing()
+    doTheThing()
   }
 })
 ```
@@ -21,6 +20,6 @@ Examples of **correct** code for this rule:
 
 ```js
 test('my test', () => {
-   expect(true).toBe(true)
+  expect(true).toBe(true)
 })
 ```