chore: valid title (#453)

* chore: begining of work on valid title

* update

* feat(valid-title): adding class and function names works

* chore(docs): update valid-title docs

* feat(alot): fixed a bunch of bugs

.eslintrc.json

@@ -1,15 +1,11 @@
 {
-	"extends": [
-		"@veritem"
-	],
+	"extends": [ "@veritem" ],
 	"rules": {
-		"indent": [
-			0,
-			"tab"
-		],
+		"indent": [ 0, "tab" ],
 		"no-case-declarations": 0,
 		"no-tabs": "off",
 		"no-mixed-spaces-and-tabs": "off",
 		"vitest/unbound-method": "off"
 	}
-}
+}
+

docs/rules/valid-title.md

@@ -18,7 +18,7 @@ This rule has an object option:
 {
   "vitest/valid-title": [
 	"error",
-   { 
+   {
     "ignoreTypeOfDescribeName": false,
     "allowArguments": false,
     "disallowedWords": ["skip", "only"],
@@ -154,9 +154,9 @@ describe('foo', () => {
 Examples of **incorrect** code for this rule with the `{ "mustMatch": { "it": ["^should .+\.$"] } }` option:
 
 ```js
-// The describe title is checked with the default regex, so it's valid 
+// The describe title is checked with the default regex, so it's valid
 describe('foo', () => {
-  // This check fails because the title does not match the regex  
+  // This check fails because the title does not match the regex
   it('Should be a number', () => {
     expect(1).toBeNumber()
   })
@@ -168,9 +168,34 @@ Examples of **correct** code for this rule with the `{ "mustMatch": { "describe"
 ```js
 // The describe title is checked with the default regex, so it's valid
 describe('foo', () => {
-  // This check succeeds because the title matches the regex  
+  // This check succeeds because the title matches the regex
   it('should be a number.', () => {
     expect(1).toBeNumber()
   })
 })
 ```
+
+Note: If you'd like to use a function or class names inside `describe`, `test` or `it` blocks as a parameter, you must enable vitest's type checking.
+
+To enable typechecking for vistest make sure settings key is added in your configuration
+
+```js
+import vitest from "eslint-plugin-vitest";
+
+export defualt [
+ {
+  files: ["tests/**"],
+  plugins: {
+     vitest
+  },
+  rules: {
+   ...vitest.configs.recommended.rules
+  },
+  settings: {
+      vitest: {
+        typecheck: true
+    }
+   }
+ }
+]
+```

eslint.config.js

@@ -16,8 +16,6 @@ export default [
   vitest.configs.recommended,
   vitest.configs.env,
   {
-    ignores: ['node_modules/*', 'dist/*', '**/*.md'],
-    files: ['**/*.ts', '**/*.js'],
     plugins: {
       vitest,
       '@stylistic': stylistic
@@ -34,5 +32,5 @@ export default [
     languageOptions: {
       parser
     }
-  }
+  },
 ]

package.json

@@ -3,7 +3,6 @@
 	"version": "0.5.4",
 	"license": "MIT",
 	"description": "Eslint plugin for vitest",
-	"type": "module",
 	"repository": "veritem/eslint-plugin-vitest",
 	"keywords": [
 		"eslint",
@@ -13,15 +12,16 @@
 		"vitest",
 		"eslint plugin"
 	],
-	"author": "Verite Mugabo Makuza <https://veritemugabo.com/>",
-	"main": "./dist/index.cjs",
+	"author": "Verite Mugabo <https://veritemugabo.com/>",
+	"type": "module",
+	"main": "./dist/index.mjs",
 	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
-			"require": "./dist/index.cjs",
-			"default": "./dist/index.mjs",
-			"types": "./dist/index.d.ts"
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.mjs",
+			"require": "./dist/index.cjs"
 		}
 	},
 	"files": [
@@ -54,7 +54,7 @@
 		"eslint": "^8.57.0",
 		"eslint-doc-generator": "^1.7.1",
 		"eslint-plugin-eslint-plugin": "^6.1.0",
-		"eslint-plugin-vitest": "0.5.3",
+		"eslint-plugin-vitest": "^0.5.4",
 		"eslint-remote-tester": "^3.0.1",
 		"eslint-remote-tester-repositories": "^1.0.1",
 		"ts-node": "^10.9.2",
@@ -63,18 +63,15 @@
 		"unbuild": "^2.0.0",
 		"vitest": "^1.6.0"
 	},
-	"engines": {
-		"node": "^18.0.0 || >= 20.0.0"
-	},
 	"peerDependencies": {
-		"eslint": "^8.57.0 || ^9.0.0",
+		"eslint": ">= 8.57.0",
 		"vitest": "*"
 	},
 	"peerDependenciesMeta": {
-		"@typescript-eslint/eslint-plugin": {
+		"vitest": {
 			"optional": true
 		},
-		"vitest": {
+		"typescript": {
 			"optional": true
 		}
 	},