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: [

src/rules/no-cycle.ts

@@ -15,10 +15,10 @@ import {
 type Options = {
   allowUnsafeDynamicCyclicDependency?: boolean
   ignoreExternal?: boolean
-  maxDepth?: number
+  maxDepth?: number | '∞'
 } & ModuleOptions
 
-type MessageId = 'cycle'
+type MessageId = 'cycle' | 'cycleSource'
 
 type Traverser = {
   mget(): ExportMap | null
@@ -65,7 +65,8 @@ export = createRule<[Options?], MessageId>({
       }),
     ],
     messages: {
-      cycle: 'Dependency cycle {{source}}',
+      cycle: 'Dependency cycle detected',
+      cycleSource: 'Dependency cycle via "{{source}}"',
     },
   },
   defaultOptions: [],
@@ -187,16 +188,20 @@ export = createRule<[Options?], MessageId>({
         while (untraversed.length > 0) {
           const next = untraversed.shift()! // bfs!
           if (detectCycle(next)) {
-            context.report({
-              node: importer,
-              messageId: 'cycle',
-              data: {
-                source:
-                  next.route.length > 0
-                    ? `via ${routeString(next.route)}`
-                    : 'detected.',
-              },
-            })
+            if (next.route.length > 0) {
+              context.report({
+                node: importer,
+                messageId: 'cycleSource',
+                data: {
+                  source: routeString(next.route),
+                },
+              })
+            } else {
+              context.report({
+                node: importer,
+                messageId: 'cycle',
+              })
+            }
             return
           }
         }

src/rules/no-default-export.ts

@@ -37,7 +37,8 @@ export = createRule({
 
       ExportNamedDeclaration(node) {
         for (const specifier of node.specifiers.filter(
-          specifier => getValue(specifier.exported) === 'default')) {
+          specifier => getValue(specifier.exported) === 'default',
+        )) {
           const { loc } = sourceCode.getFirstTokens(node)[1] || {}
           // @ts-expect-error - experimental parser type
           if (specifier.type === 'ExportDefaultSpecifier') {

src/rules/no-deprecated.ts

@@ -5,14 +5,14 @@ import type { ModuleNamespace } from '../utils'
 import { ExportMap, createRule, declaredScope, getValue } from '../utils'
 
 function message(deprecation: Tag) {
-  return {
-    messageId: 'deprecated',
-    data: {
-      description: deprecation.description
-        ? `: ${deprecation.description}`
-        : '.',
-    },
-  } as const
+  if (deprecation.description) {
+    return {
+      messageId: 'deprecatedDesc',
+      data: { description: deprecation.description },
+    } as const
+  }
+
+  return { messageId: 'deprecated' } as const
 }
 
 function getDeprecation(metadata?: ModuleNamespace | null) {
@@ -34,7 +34,8 @@ export = createRule({
     },
     schema: [],
     messages: {
-      deprecated: 'Deprecated{{description}}',
+      deprecatedDesc: 'Deprecated: {{description}}',
+      deprecated: 'Deprecated: consider to find an alternative.',
     },
   },
   defaultOptions: [],

src/rules/no-duplicates.ts

@@ -381,7 +381,7 @@ function hasCommentInsideNonSpecifiers(
   // `node` (only inside). If there's a `{...}` part, look for comments before
   // the `{`, but not before the `}` (hence the `+1`s).
   const someTokens =
-    openBraceIndex >= 0 && closeBraceIndex >= 0
+    openBraceIndex !== -1 && closeBraceIndex !== -1
       ? [
           ...tokens.slice(1, openBraceIndex + 1),
           ...tokens.slice(closeBraceIndex + 1),

src/rules/no-import-module-exports.ts

@@ -21,17 +21,15 @@ function getEntryPoint(context: RuleContext) {
 
 function findScope(context: RuleContext, identifier: string) {
   const { scopeManager } = context.sourceCode
-  return (
-    scopeManager?.scopes
-      // eslint-disable-next-line unicorn/prefer-spread
-      .slice()
-      .reverse()
-      .find(scope =>
-        scope.variables.some(variable =>
-          variable.identifiers.some(node => node.name === identifier),
-        ),
-      )
-  )
+  return scopeManager?.scopes
+
+    .slice()
+    .reverse()
+    .find(scope =>
+      scope.variables.some(variable =>
+        variable.identifiers.some(node => node.name === identifier),
+      ),
+    )
 }
 
 function findDefinition(objectScope: TSESLint.Scope.Scope, identifier: string) {

src/rules/no-named-export.ts

@@ -32,8 +32,7 @@ export = createRule({
         }
 
         const someNamed = node.specifiers.some(
-          specifier => getValue(specifier.exported) !==
-            'default',
+          specifier => getValue(specifier.exported) !== 'default',
         )
         if (someNamed) {
           context.report({ node, messageId: 'noAllowed' })

src/rules/no-unused-modules.ts

@@ -391,7 +391,7 @@ const fileIsInPkg = (file: string) => {
 type Options = {
   src?: string[]
   ignoreExports?: string[]
-  missingExports?: string[]
+  missingExports?: true
   unusedExports?: boolean
   ignoreUnusedTypeExports?: boolean
 }

src/rules/prefer-default-export.ts

@@ -69,9 +69,7 @@ export = createRule<[Options?], MessageId>({
       },
 
       ExportSpecifier(node) {
-        if (
-          getValue(node.exported) === 'default'
-        ) {
+        if (getValue(node.exported) === 'default') {
           hasDefaultExport = true
         } else {
           specifierExportCount++

src/utils/declared-scope.ts

@@ -1,5 +1,5 @@
+import type { ScopeType } from '@typescript-eslint/scope-manager'
 import type { TSESTree } from '@typescript-eslint/utils'
-import type { ScopeType } from '@typescript-eslint/scope-manager';
 
 import type { RuleContext } from '../types'
 

src/utils/export-map.ts

@@ -241,7 +241,10 @@ export class ExportMap {
       }
     }
 
-    function addNamespace(object: object, identifier: TSESTree.Identifier | TSESTree.StringLiteral) {
+    function addNamespace(
+      object: object,
+      identifier: TSESTree.Identifier | TSESTree.StringLiteral,
+    ) {
       const nsfn = getNamespace(getValue(identifier))
       if (nsfn) {
         Object.defineProperty(object, 'namespace', { get: nsfn })

src/utils/pkg-up.ts

@@ -7,7 +7,6 @@ function findUp(filename: string | string[], cwd?: string): string | null {
 
   const filenames = [filename].flat()
 
-  // eslint-disable-next-line no-constant-condition
   while (true) {
     const file = filenames.find(el => fs.existsSync(path.resolve(dir, el)))
 

src/utils/read-pkg-up.ts

@@ -8,7 +8,6 @@ function stripBOM(str: string) {
   return str.replace(/^\uFEFF/, '')
 }
 
-// eslint-disable-next-line eslint-plugin/require-meta-docs-description, eslint-plugin/require-meta-type, eslint-plugin/prefer-message-ids, eslint-plugin/prefer-object-rule, eslint-plugin/require-meta-schema
 export function readPkgUp(opts?: { cwd?: string }) {
   const fp = pkgUp(opts)
 

test/fixtures/deprecated.js

@@ -50,3 +50,8 @@ export function fine() {
 export function _undocumented() {
   return 'sneaky!'
 }
+
+/** @deprecated */
+export function _deprecatedNoDescription() {
+  return '_deprecatedNoDescription'
+}