@vitest/eslint-plugin 1.6.8 → 1.6.10

package/dist/index.cjs

@@ -4,7 +4,7 @@ let node_path = require("node:path");
 let _typescript_eslint_scope_manager = require("@typescript-eslint/scope-manager");
 
 //#region package.json
-var version = "1.6.8";
+var version = "1.6.10";
 
 //#endregion
 //#region src/utils/index.ts
@@ -1806,18 +1806,22 @@ var consistent_each_for_default = createEslintRule({
 			type: "object",
 			properties: {
 				test: {
+					description: "Preferred method for `test`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				it: {
+					description: "Preferred method for `it`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				describe: {
+					description: "Preferred method for `describe`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				suite: {
+					description: "Preferred method for `suite`.",
 					type: "string",
 					enum: ["each", "for"]
 				}
@@ -1871,10 +1875,12 @@ var consistent_test_filename_default = createEslintRule({
 			additionalProperties: false,
 			properties: {
 				pattern: {
+					description: "Regex pattern for files that should be treated as tests.",
 					type: "string",
 					format: "regex"
 				},
 				allTestPattern: {
+					description: "Regex pattern used to identify all possible test files.",
 					type: "string",
 					format: "regex"
 				}
@@ -1930,10 +1936,12 @@ var consistent_test_it_default = createEslintRule({
 			type: "object",
 			properties: {
 				fn: {
+					description: "Preferred global test function keyword.",
 					type: "string",
 					enum: [TestCaseName.test, TestCaseName.it]
 				},
 				withinDescribe: {
+					description: "Preferred test function keyword inside `describe`.",
 					type: "string",
 					enum: [TestCaseName.test, TestCaseName.it]
 				}
@@ -2038,6 +2046,7 @@ var consistent_vitest_vi_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { fn: {
+				description: "Preferred utility keyword to enforce.",
 				type: "string",
 				enum: [UtilName.vi, UtilName.vitest]
 			} },
@@ -2120,10 +2129,12 @@ var expect_expect_default = createEslintRule({
 			type: "object",
 			properties: {
 				assertFunctionNames: {
+					description: "List of function names treated as assertions.",
 					type: "array",
 					items: { type: "string" }
 				},
 				additionalTestBlockFunctions: {
+					description: "Additional functions that should be treated as test blocks.",
 					type: "array",
 					items: { type: "string" }
 				}
@@ -2271,7 +2282,10 @@ var max_expects_default = createEslintRule({
 		type: "suggestion",
 		schema: [{
 			type: "object",
-			properties: { max: { type: "number" } },
+			properties: { max: {
+				description: "Maximum number of `expect` calls allowed in a test.",
+				type: "number"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ max: 5 }]
@@ -2316,7 +2330,10 @@ var max_nested_describe_default = createEslintRule({
 		},
 		schema: [{
 			type: "object",
-			properties: { max: { type: "number" } },
+			properties: { max: {
+				description: "Maximum allowed nesting depth for `describe` blocks.",
+				type: "number"
+			} },
 			additionalProperties: false
 		}],
 		messages: { maxNestedDescribe: "Nested describe block should be less than set max value" },
@@ -2789,7 +2806,10 @@ var no_focused_tests_default = createEslintRule({
 		fixable: "code",
 		schema: [{
 			type: "object",
-			properties: { fixable: { type: "boolean" } },
+			properties: { fixable: {
+				description: "Whether the rule should provide an autofix.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		messages: { noFocusedTests: "Focused tests are not allowed" },
@@ -3160,9 +3180,16 @@ var no_large_snapshots_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				maxSize: { type: "number" },
-				inlineMaxSize: { type: "number" },
+				maxSize: {
+					description: "Maximum number of lines allowed in external snapshots.",
+					type: "number"
+				},
+				inlineMaxSize: {
+					description: "Maximum number of lines allowed in inline snapshots.",
+					type: "number"
+				},
 				allowedSnapshots: {
+					description: "Allowed snapshot names by absolute snapshot file path.",
 					type: "object",
 					additionalProperties: { type: "array" }
 				}
@@ -3238,6 +3265,7 @@ var no_restricted_matchers_default = createEslintRule({
 		},
 		type: "suggestion",
 		schema: [{
+			description: "Restricted matcher chains mapped to optional custom messages.",
 			type: "object",
 			additionalProperties: { type: ["string", "null"] }
 		}],
@@ -3282,6 +3310,7 @@ var no_restricted_vi_methods_default = createEslintRule({
 			recommended: false
 		},
 		schema: [{
+			description: "Restricted `vi` methods mapped to optional custom messages.",
 			type: "object",
 			additionalProperties: { type: ["string", "null"] }
 		}],
@@ -3340,6 +3369,7 @@ var no_standalone_expect_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { additionalTestBlockFunctions: {
+				description: "Additional functions that should be treated as test blocks.",
 				type: "array",
 				items: { type: "string" }
 			} },
@@ -4369,9 +4399,18 @@ var prefer_expect_assertions_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				onlyFunctionsWithAsyncKeyword: { type: "boolean" },
-				onlyFunctionsWithExpectInLoop: { type: "boolean" },
-				onlyFunctionsWithExpectInCallback: { type: "boolean" }
+				onlyFunctionsWithAsyncKeyword: {
+					description: "Only check test functions declared with the async keyword.",
+					type: "boolean"
+				},
+				onlyFunctionsWithExpectInLoop: {
+					description: "Only check test functions that contain `expect` inside loops.",
+					type: "boolean"
+				},
+				onlyFunctionsWithExpectInCallback: {
+					description: "Only check test functions that contain `expect` in callbacks.",
+					type: "boolean"
+				}
 			},
 			additionalProperties: false
 		}],
@@ -4685,6 +4724,7 @@ var prefer_hooks_on_top_default = createEslintRule({
 //#endregion
 //#region src/rules/prefer-import-in-mock.ts
 const RULE_NAME$30 = "prefer-import-in-mock";
+const MOCK_METHODS = new Set(["mock", "doMock"]);
 var prefer_import_in_mock_default = createEslintRule({
 	name: RULE_NAME$30,
 	meta: {
@@ -4694,7 +4734,10 @@ var prefer_import_in_mock_default = createEslintRule({
 		messages: { preferImport: "Replace '{{path}}' with import('{{path}}')" },
 		schema: [{
 			type: "object",
-			properties: { fixable: { type: "boolean" } },
+			properties: { fixable: {
+				description: "Whether the rule should provide an autofix.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ fixable: true }]
@@ -4705,7 +4748,7 @@ var prefer_import_in_mock_default = createEslintRule({
 			if (node.callee.type !== _typescript_eslint_utils.AST_NODE_TYPES.MemberExpression) return;
 			if (parseVitestFnCall(node, context)?.type !== "vi") return false;
 			const { property } = node.callee;
-			if (property.type != _typescript_eslint_utils.AST_NODE_TYPES.Identifier || property.name != "mock") return;
+			if (property.type != _typescript_eslint_utils.AST_NODE_TYPES.Identifier || !MOCK_METHODS.has(property.name)) return;
 			const pathArg = node.arguments[0];
 			if (pathArg && pathArg.type === _typescript_eslint_utils.AST_NODE_TYPES.Literal) context.report({
 				messageId: "preferImport",
@@ -4822,6 +4865,7 @@ var prefer_lowercase_title_default = createEslintRule({
 			type: "object",
 			properties: {
 				ignore: {
+					description: "Functions whose titles should be ignored when checking case.",
 					type: "array",
 					items: {
 						type: "string",
@@ -4833,12 +4877,19 @@ var prefer_lowercase_title_default = createEslintRule({
 					}
 				},
 				allowedPrefixes: {
+					description: "Title prefixes that are exempt from this rule.",
 					type: "array",
 					items: { type: "string" },
 					additionalItems: false
 				},
-				ignoreTopLevelDescribe: { type: "boolean" },
-				lowercaseFirstCharacterOnly: { type: "boolean" }
+				ignoreTopLevelDescribe: {
+					description: "Ignore the first top-level `describe` title.",
+					type: "boolean"
+				},
+				lowercaseFirstCharacterOnly: {
+					description: "Only require the first character to be lowercase.",
+					type: "boolean"
+				}
 			},
 			additionalProperties: false
 		}],
@@ -5010,6 +5061,7 @@ var prefer_snapshot_hint_default = createEslintRule({
 		},
 		messages: { missingHint: "You should provide a hint for this snapshot" },
 		schema: [{
+			description: "When to require snapshot hints.",
 			type: "string",
 			enum: ["always", "multi"]
 		}],
@@ -5638,6 +5690,7 @@ var require_hook_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { allowedFunctionCalls: {
+				description: "Function calls that are allowed outside of hooks.",
 				type: "array",
 				items: { type: "string" }
 			} },
@@ -5811,7 +5864,10 @@ var require_mock_type_parameters_default = createEslintRule({
 		fixable: "code",
 		schema: [{
 			type: "object",
-			properties: { checkImportFunctions: { type: "boolean" } },
+			properties: { checkImportFunctions: {
+				description: "Also require type parameters for `importActual` and `importMock`.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ checkImportFunctions: false }]
@@ -5883,6 +5939,7 @@ var require_top_level_describe_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { maxNumberOfTopLevelDescribes: {
+				description: "Maximum number of `describe` blocks allowed at the top level.",
 				type: "number",
 				minimum: 1
 			} },
@@ -6264,16 +6321,22 @@ var valid_expect_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				alwaysAwait: { type: "boolean" },
+				alwaysAwait: {
+					description: "Require awaiting every async assertion.",
+					type: "boolean"
+				},
 				asyncMatchers: {
+					description: "Matchers that should be considered async assertions.",
 					type: "array",
 					items: { type: "string" }
 				},
 				minArgs: {
+					description: "Minimum number of arguments allowed for `expect`.",
 					type: "number",
 					minimum: 1
 				},
 				maxArgs: {
+					description: "Maximum number of arguments allowed for `expect`.",
 					type: "number",
 					minimum: 1
 				}
@@ -6494,9 +6557,16 @@ var valid_title_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				ignoreTypeOfDescribeName: { type: "boolean" },
-				allowArguments: { type: "boolean" },
+				ignoreTypeOfDescribeName: {
+					description: "Skip validating `describe` titles that come from `typeof`.",
+					type: "boolean"
+				},
+				allowArguments: {
+					description: "Allow dynamic arguments as titles.",
+					type: "boolean"
+				},
 				disallowedWords: {
+					description: "Words that are not allowed in test titles.",
 					type: "array",
 					items: { type: "string" }
 				}

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { isAbsolute, posix } from "node:path";
 import { DefinitionType } from "@typescript-eslint/scope-manager";
 
 //#region package.json
-var version = "1.6.8";
+var version = "1.6.10";
 
 //#endregion
 //#region src/utils/index.ts
@@ -1806,18 +1806,22 @@ var consistent_each_for_default = createEslintRule({
 			type: "object",
 			properties: {
 				test: {
+					description: "Preferred method for `test`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				it: {
+					description: "Preferred method for `it`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				describe: {
+					description: "Preferred method for `describe`.",
 					type: "string",
 					enum: ["each", "for"]
 				},
 				suite: {
+					description: "Preferred method for `suite`.",
 					type: "string",
 					enum: ["each", "for"]
 				}
@@ -1871,10 +1875,12 @@ var consistent_test_filename_default = createEslintRule({
 			additionalProperties: false,
 			properties: {
 				pattern: {
+					description: "Regex pattern for files that should be treated as tests.",
 					type: "string",
 					format: "regex"
 				},
 				allTestPattern: {
+					description: "Regex pattern used to identify all possible test files.",
 					type: "string",
 					format: "regex"
 				}
@@ -1930,10 +1936,12 @@ var consistent_test_it_default = createEslintRule({
 			type: "object",
 			properties: {
 				fn: {
+					description: "Preferred global test function keyword.",
 					type: "string",
 					enum: [TestCaseName.test, TestCaseName.it]
 				},
 				withinDescribe: {
+					description: "Preferred test function keyword inside `describe`.",
 					type: "string",
 					enum: [TestCaseName.test, TestCaseName.it]
 				}
@@ -2038,6 +2046,7 @@ var consistent_vitest_vi_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { fn: {
+				description: "Preferred utility keyword to enforce.",
 				type: "string",
 				enum: [UtilName.vi, UtilName.vitest]
 			} },
@@ -2120,10 +2129,12 @@ var expect_expect_default = createEslintRule({
 			type: "object",
 			properties: {
 				assertFunctionNames: {
+					description: "List of function names treated as assertions.",
 					type: "array",
 					items: { type: "string" }
 				},
 				additionalTestBlockFunctions: {
+					description: "Additional functions that should be treated as test blocks.",
 					type: "array",
 					items: { type: "string" }
 				}
@@ -2271,7 +2282,10 @@ var max_expects_default = createEslintRule({
 		type: "suggestion",
 		schema: [{
 			type: "object",
-			properties: { max: { type: "number" } },
+			properties: { max: {
+				description: "Maximum number of `expect` calls allowed in a test.",
+				type: "number"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ max: 5 }]
@@ -2316,7 +2330,10 @@ var max_nested_describe_default = createEslintRule({
 		},
 		schema: [{
 			type: "object",
-			properties: { max: { type: "number" } },
+			properties: { max: {
+				description: "Maximum allowed nesting depth for `describe` blocks.",
+				type: "number"
+			} },
 			additionalProperties: false
 		}],
 		messages: { maxNestedDescribe: "Nested describe block should be less than set max value" },
@@ -2789,7 +2806,10 @@ var no_focused_tests_default = createEslintRule({
 		fixable: "code",
 		schema: [{
 			type: "object",
-			properties: { fixable: { type: "boolean" } },
+			properties: { fixable: {
+				description: "Whether the rule should provide an autofix.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		messages: { noFocusedTests: "Focused tests are not allowed" },
@@ -3160,9 +3180,16 @@ var no_large_snapshots_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				maxSize: { type: "number" },
-				inlineMaxSize: { type: "number" },
+				maxSize: {
+					description: "Maximum number of lines allowed in external snapshots.",
+					type: "number"
+				},
+				inlineMaxSize: {
+					description: "Maximum number of lines allowed in inline snapshots.",
+					type: "number"
+				},
 				allowedSnapshots: {
+					description: "Allowed snapshot names by absolute snapshot file path.",
 					type: "object",
 					additionalProperties: { type: "array" }
 				}
@@ -3238,6 +3265,7 @@ var no_restricted_matchers_default = createEslintRule({
 		},
 		type: "suggestion",
 		schema: [{
+			description: "Restricted matcher chains mapped to optional custom messages.",
 			type: "object",
 			additionalProperties: { type: ["string", "null"] }
 		}],
@@ -3282,6 +3310,7 @@ var no_restricted_vi_methods_default = createEslintRule({
 			recommended: false
 		},
 		schema: [{
+			description: "Restricted `vi` methods mapped to optional custom messages.",
 			type: "object",
 			additionalProperties: { type: ["string", "null"] }
 		}],
@@ -3340,6 +3369,7 @@ var no_standalone_expect_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { additionalTestBlockFunctions: {
+				description: "Additional functions that should be treated as test blocks.",
 				type: "array",
 				items: { type: "string" }
 			} },
@@ -4369,9 +4399,18 @@ var prefer_expect_assertions_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				onlyFunctionsWithAsyncKeyword: { type: "boolean" },
-				onlyFunctionsWithExpectInLoop: { type: "boolean" },
-				onlyFunctionsWithExpectInCallback: { type: "boolean" }
+				onlyFunctionsWithAsyncKeyword: {
+					description: "Only check test functions declared with the async keyword.",
+					type: "boolean"
+				},
+				onlyFunctionsWithExpectInLoop: {
+					description: "Only check test functions that contain `expect` inside loops.",
+					type: "boolean"
+				},
+				onlyFunctionsWithExpectInCallback: {
+					description: "Only check test functions that contain `expect` in callbacks.",
+					type: "boolean"
+				}
 			},
 			additionalProperties: false
 		}],
@@ -4685,6 +4724,7 @@ var prefer_hooks_on_top_default = createEslintRule({
 //#endregion
 //#region src/rules/prefer-import-in-mock.ts
 const RULE_NAME$30 = "prefer-import-in-mock";
+const MOCK_METHODS = new Set(["mock", "doMock"]);
 var prefer_import_in_mock_default = createEslintRule({
 	name: RULE_NAME$30,
 	meta: {
@@ -4694,7 +4734,10 @@ var prefer_import_in_mock_default = createEslintRule({
 		messages: { preferImport: "Replace '{{path}}' with import('{{path}}')" },
 		schema: [{
 			type: "object",
-			properties: { fixable: { type: "boolean" } },
+			properties: { fixable: {
+				description: "Whether the rule should provide an autofix.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ fixable: true }]
@@ -4705,7 +4748,7 @@ var prefer_import_in_mock_default = createEslintRule({
 			if (node.callee.type !== AST_NODE_TYPES.MemberExpression) return;
 			if (parseVitestFnCall(node, context)?.type !== "vi") return false;
 			const { property } = node.callee;
-			if (property.type != AST_NODE_TYPES.Identifier || property.name != "mock") return;
+			if (property.type != AST_NODE_TYPES.Identifier || !MOCK_METHODS.has(property.name)) return;
 			const pathArg = node.arguments[0];
 			if (pathArg && pathArg.type === AST_NODE_TYPES.Literal) context.report({
 				messageId: "preferImport",
@@ -4822,6 +4865,7 @@ var prefer_lowercase_title_default = createEslintRule({
 			type: "object",
 			properties: {
 				ignore: {
+					description: "Functions whose titles should be ignored when checking case.",
 					type: "array",
 					items: {
 						type: "string",
@@ -4833,12 +4877,19 @@ var prefer_lowercase_title_default = createEslintRule({
 					}
 				},
 				allowedPrefixes: {
+					description: "Title prefixes that are exempt from this rule.",
 					type: "array",
 					items: { type: "string" },
 					additionalItems: false
 				},
-				ignoreTopLevelDescribe: { type: "boolean" },
-				lowercaseFirstCharacterOnly: { type: "boolean" }
+				ignoreTopLevelDescribe: {
+					description: "Ignore the first top-level `describe` title.",
+					type: "boolean"
+				},
+				lowercaseFirstCharacterOnly: {
+					description: "Only require the first character to be lowercase.",
+					type: "boolean"
+				}
 			},
 			additionalProperties: false
 		}],
@@ -5010,6 +5061,7 @@ var prefer_snapshot_hint_default = createEslintRule({
 		},
 		messages: { missingHint: "You should provide a hint for this snapshot" },
 		schema: [{
+			description: "When to require snapshot hints.",
 			type: "string",
 			enum: ["always", "multi"]
 		}],
@@ -5638,6 +5690,7 @@ var require_hook_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { allowedFunctionCalls: {
+				description: "Function calls that are allowed outside of hooks.",
 				type: "array",
 				items: { type: "string" }
 			} },
@@ -5811,7 +5864,10 @@ var require_mock_type_parameters_default = createEslintRule({
 		fixable: "code",
 		schema: [{
 			type: "object",
-			properties: { checkImportFunctions: { type: "boolean" } },
+			properties: { checkImportFunctions: {
+				description: "Also require type parameters for `importActual` and `importMock`.",
+				type: "boolean"
+			} },
 			additionalProperties: false
 		}],
 		defaultOptions: [{ checkImportFunctions: false }]
@@ -5883,6 +5939,7 @@ var require_top_level_describe_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: { maxNumberOfTopLevelDescribes: {
+				description: "Maximum number of `describe` blocks allowed at the top level.",
 				type: "number",
 				minimum: 1
 			} },
@@ -6264,16 +6321,22 @@ var valid_expect_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				alwaysAwait: { type: "boolean" },
+				alwaysAwait: {
+					description: "Require awaiting every async assertion.",
+					type: "boolean"
+				},
 				asyncMatchers: {
+					description: "Matchers that should be considered async assertions.",
 					type: "array",
 					items: { type: "string" }
 				},
 				minArgs: {
+					description: "Minimum number of arguments allowed for `expect`.",
 					type: "number",
 					minimum: 1
 				},
 				maxArgs: {
+					description: "Maximum number of arguments allowed for `expect`.",
 					type: "number",
 					minimum: 1
 				}
@@ -6494,9 +6557,16 @@ var valid_title_default = createEslintRule({
 		schema: [{
 			type: "object",
 			properties: {
-				ignoreTypeOfDescribeName: { type: "boolean" },
-				allowArguments: { type: "boolean" },
+				ignoreTypeOfDescribeName: {
+					description: "Skip validating `describe` titles that come from `typeof`.",
+					type: "boolean"
+				},
+				allowArguments: {
+					description: "Allow dynamic arguments as titles.",
+					type: "boolean"
+				},
 				disallowedWords: {
+					description: "Words that are not allowed in test titles.",
 					type: "array",
 					items: { type: "string" }
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vitest/eslint-plugin",
-  "version": "1.6.8",
+  "version": "1.6.10",
   "license": "MIT",
   "description": "ESLint plugin for Vitest",
   "repository": "vitest-dev/eslint-plugin-vitest",
@@ -15,11 +15,15 @@
   "author": "Verite Mugabo <https://veritemugabo.com/>",
   "type": "module",
   "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
+      "types": {
+        "import": "./dist/index.d.mts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     },
     "./package.json": "./package.json"