test: migrate to type-friendly createRuleTestCaseFunction (#184)

Author: marcalexiei

.changeset/cuddly-ligers-wonder.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix(no-cycle): improves the type declaration of the rule `no-cycle`’s `maxDepth` option

.changeset/fluffy-dolls-pump.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix(first): improves the type declaration of the rule `first`'s option

.changeset/nice-schools-drive.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix(no-unused-modules): improves the type declaration of the rule `no-unused-modules`’s `missingExports` option

.changeset/nine-wolves-repeat.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix(no-deprecated): improve error message when no description is available

.eslintrc.js

@@ -3,6 +3,7 @@
  */
 module.exports = {
   root: true,
+  reportUnusedDisableDirectives: true,
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
@@ -33,7 +34,7 @@ module.exports = {
     'eslint-plugin/report-message-format': 'error',
     'eslint-plugin/require-meta-docs-description': [
       'error',
-      { pattern: '^(Enforce|Ensure|Prefer|Forbid).+\\.$' },
+      { pattern: String.raw`^(Enforce|Ensure|Prefer|Forbid).+\.$` },
     ],
     'eslint-plugin/require-meta-schema': 'error',
     'eslint-plugin/require-meta-type': 'error',

package.json

@@ -48,6 +48,7 @@
     "eslint": "^8.57.0 || ^9.0.0"
   },
   "dependencies": {
+    "@typescript-eslint/scope-manager": "^8.1.0",
     "@typescript-eslint/utils": "^8.1.0",
     "debug": "^4.3.4",
     "doctrine": "^3.0.0",
@@ -82,8 +83,8 @@
     "@total-typescript/ts-reset": "^0.5.1",
     "@types/debug": "^4.1.12",
     "@types/doctrine": "^0.0.9",
-    "@types/eslint8.56": "npm:@types/eslint@^8.56.11",
     "@types/eslint": "^9.6.1",
+    "@types/eslint8.56": "npm:@types/eslint@^8.56.11",
     "@types/eslint9": "npm:@types/eslint@^9.6.1",
     "@types/is-glob": "^4.0.4",
     "@types/jest": "^29.5.12",
@@ -97,9 +98,7 @@
     "cross-env": "^7.0.3",
     "enhanced-resolve": "^5.16.0",
     "escope": "^4.0.0",
-    "eslint8.56": "npm:eslint@^8.56.0",
     "eslint": "^9.15.0",
-    "eslint9": "npm:eslint@^9.15.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-doc-generator": "^1.7.1",
     "eslint-import-resolver-typescript": "^3.6.1",
@@ -112,6 +111,8 @@
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-unicorn": "^56.0.1",
+    "eslint8.56": "npm:eslint@^8.56.0",
+    "eslint9": "npm:eslint@^9.15.0",
     "hermes-eslint": "^0.23.1",
     "jest": "^29.7.0",
     "klaw-sync": "^6.0.0",

src/rules/dynamic-import-chunkname.ts

@@ -73,7 +73,7 @@ export = createRule<[Options?], MessageId>({
     const {
       importFunctions = [],
       allowEmpty = false,
-      webpackChunknameFormat = '([0-9a-zA-Z-_/.]|\\[(request|index)\\])+',
+      webpackChunknameFormat = String.raw`([0-9a-zA-Z-_/.]|\[(request|index)\])+`,
     } = context.options[0] || {}
 
     const paddedCommentRegex = /^ (\S[\S\s]+\S) $/

src/rules/first.ts

@@ -20,9 +20,11 @@ function isPossibleDirective(node: TSESTree.ProgramStatement) {
   )
 }
 
+type Options = 'absolute-first' | 'disable-absolute-first'
+
 type MessageId = 'absolute' | 'order'
 
-export = createRule<['absolute-first'?], MessageId>({
+export = createRule<[Options?], MessageId>({
   name: 'first',
   meta: {
     type: 'suggestion',

src/rules/group-exports.ts

@@ -35,7 +35,9 @@ function accessorChain(node: TSESTree.MemberExpression) {
   return chain
 }
 
-export = createRule<[], 'ExportNamedDeclaration' | 'AssignmentExpression'>({
+type MessageId = 'ExportNamedDeclaration' | 'AssignmentExpression'
+
+export = createRule<[], MessageId>({
   name: 'group-exports',
   meta: {
     type: 'suggestion',

src/rules/namespace.ts

@@ -15,6 +15,7 @@ type MessageId =
   | 'namespaceMember'
   | 'topLevelNames'
   | 'notFoundInNamespace'
+  | 'notFoundInNamespaceDeep'
 
 type Options = {
   allowComputed?: boolean
@@ -86,15 +87,16 @@ function makeMessage(
   namepath: string[],
   node: TSESTree.Node = last,
 ) {
+  const messageId =
+    namepath.length > 1 ? 'notFoundInNamespaceDeep' : 'notFoundInNamespace'
   return {
     node,
-    messageId: 'notFoundInNamespace' as const,
+    messageId,
     data: {
       name: last.name,
-      depth: namepath.length > 1 ? 'deeply ' : '',
       namepath: namepath.join('.'),
     },
-  }
+  } as const
 }
 
 export = createRule<[Options], MessageId>({
@@ -127,7 +129,9 @@ export = createRule<[Options], MessageId>({
       namespaceMember: "Assignment to member of namespace '{{namespace}}'.",
       topLevelNames: 'Only destructure top-level names.',
       notFoundInNamespace:
-        "'{{name}}' not found in {{depth}}imported namespace '{{namepath}}'.",
+        "'{{name}}' not found in imported namespace '{{namepath}}'.",
+      notFoundInNamespaceDeep:
+        "'{{name}}' not found in deeply imported namespace '{{namepath}}'.",
     },
   },
   defaultOptions: [