feat: migrate rule no-unresolved and related modules

.eslintrc.js

@@ -1,3 +1,6 @@
+/**
+ * @type {import('eslint').Linter.Config}
+ */
 module.exports = {
   root: true,
   plugins: ['eslint-plugin', 'import-x'],
@@ -18,6 +21,7 @@ module.exports = {
     ecmaVersion: 2020,
   },
   rules: {
+    '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-var-requires': 'off',
 
     'eslint-plugin/consistent-output': ['error', 'always'],
@@ -56,7 +60,8 @@ module.exports = {
 
   overrides: [
     {
-      files: ['src/**/*.ts'],
+      files: ['*.js', '*.ts'],
+      excludedFiles: ['test/fixtures'],
       settings: {
         'import-x/resolver': {
           typescript: true,

jest.config.js

@@ -10,13 +10,14 @@ module.exports = {
   modulePathIgnorePatterns: ['<rootDir>/test/fixtures/with-syntax-error'],
   moduleNameMapper: {
     '^core/(.+)$': `<rootDir>/${srcDir}/core/$1`,
-    '^eslint-plugin-import-x$': `<rootDir>/${srcDir}/index.js`,
+    '^eslint-plugin-import-x$': `<rootDir>/${srcDir}`,
     '^eslint-plugin-import-x/package.json$': '<rootDir>/package.json',
     '^eslint-plugin-import-x/(.+)$': `<rootDir>/${srcDir}/$1`,
     '^rules/(.+)$': `<rootDir>/${srcDir}/rules/$1`,
   },
   testMatch: [
     '<rootDir>/test/**/*.spec.js',
+    '<rootDir>/test/**/*.spec.ts',
     '!<rootDir>/test/fixtures/**/*.js',
   ],
 }

package.json

@@ -33,6 +33,7 @@
     "build": "rimraf lib && tsc -p src",
     "lint": "yarn lint:es && yarn update:eslint-docs --check",
     "lint:es": "eslint . --cache",
+    "prepare": "patch-package",
     "release": "changeset publish",
     "test": "jest",
     "test-compiled": "yarn build && cross-env TEST_COMPILED=1 jest",
@@ -43,6 +44,7 @@
     "eslint": "^7.2.0 || ^8"
   },
   "dependencies": {
+    "@typescript-eslint/utils": "^5.62.0",
     "debug": "^4.3.4",
     "doctrine": "^3.0.0",
     "eslint-import-resolver-node": "^0.3.9",
@@ -70,8 +72,11 @@
     "@test-scope/some-module": "link:./test/fixtures/symlinked-module",
     "@types/eslint": "^8.56.5",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@types/json-schema": "^7.0.15",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/typescript-estree": "^5.62.0",
+    "@unts/patch-package": "^8.0.0",
     "cross-env": "^7.0.3",
     "enhanced-resolve": "^5.16.0",
     "escope": "^4.0.0",
@@ -92,6 +97,6 @@
     "rimraf": "^5.0.5",
     "svelte": "^4.2.12",
     "type-fest": "^4.12.0",
-    "typescript": "^5.4.2"
+    "typescript": "~5.1.0"
   }
 }

patches/@typescript-eslint+utils+5.62.0.patch

@@ -0,0 +1,15 @@
+diff --git a/node_modules/@typescript-eslint/utils/dist/ts-eslint/Rule.d.ts b/node_modules/@typescript-eslint/utils/dist/ts-eslint/Rule.d.ts
+index 9a3a1fd..46b3961 100644
+--- a/node_modules/@typescript-eslint/utils/dist/ts-eslint/Rule.d.ts
++++ b/node_modules/@typescript-eslint/utils/dist/ts-eslint/Rule.d.ts
+@@ -6,6 +6,10 @@ import type { Scope } from './Scope';
+ import type { SourceCode } from './SourceCode';
+ export type RuleRecommendation = 'error' | 'strict' | 'warn' | false;
+ interface RuleMetaDataDocs {
++    /**
++     * The category the rule falls under
++     */
++    category?: string;
+     /**
+      * Concise description of the rule
+      */

src/ExportMap.js

@@ -9,7 +9,7 @@ import { SourceCode } from 'eslint'
 
 import parse from './utils/parse'
 import visit from './utils/visit'
-import resolve from './utils/resolve'
+import { relative, resolve } from './utils/resolve'
 import isIgnored, { hasValidExtension } from './utils/ignore'
 
 import { hashObject } from './utils/hash'
@@ -506,7 +506,7 @@ ExportMap.parse = function (path, content, context) {
   const namespaces = new Map()
 
   function remotePath(value) {
-    return resolve.relative(value, path, context.settings)
+    return relative(value, path, context.settings)
   }
 
   function resolveImport(value) {

src/config/typescript.ts

@@ -9,9 +9,9 @@ import type { PluginConfig } from '../types'
 // Omit `.d.ts` because 1) TypeScript compilation already confirms that
 // types are resolved, and 2) it would mask an unresolved
 // `.ts`/`.tsx`/`.js`/`.jsx` implementation.
-const typeScriptExtensions = ['.ts', '.tsx']
+const typeScriptExtensions = ['.ts', '.tsx'] as const
 
-const allExtensions = [...typeScriptExtensions, '.js', '.jsx']
+const allExtensions = [...typeScriptExtensions, '.js', '.jsx'] as const
 
 export = {
   settings: {

src/core/importType.js

@@ -5,7 +5,7 @@ import {
 } from 'path'
 
 import { isCoreModule } from '../utils/is-core-module'
-import resolve from '../utils/resolve'
+import { resolve } from '../utils/resolve'
 import { getContextPackagePath } from './packagePath'
 
 function baseModule(name) {

src/core/packagePath.js

@@ -1,6 +1,6 @@
 import { dirname } from 'path'
-import pkgUp from '../utils/pkgUp'
-import readPkgUp from '../utils/readPkgUp'
+import { pkgUp } from '../utils/pkgUp'
+import { readPkgUp } from '../utils/readPkgUp'
 
 export function getContextPackagePath(context) {
   return getFilePackagePath(

src/docs-url.ts

@@ -0,0 +1,8 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore - We're using commonjs
+import pkg from '../package.json'
+
+const repoUrl = 'https://github.com/un-es/eslint-plugin-import-x'
+
+export const docsUrl = (ruleName: string, commitish = `v${pkg.version}`) =>
+  `${repoUrl}/blob/${commitish}/docs/rules/${ruleName}.md`

src/import-declaration.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint'
+
+export const importDeclaration = (context: Rule.RuleContext) => {
+  const ancestors = context.getAncestors()
+  return ancestors[ancestors.length - 1]
+}

src/index.js → src/index.ts

@@ -1,5 +1,10 @@
+import type { PluginConfig } from './types'
+
+import noUnresolved from './rules/no-unresolved'
+import { TSESLint } from '@typescript-eslint/utils'
+
 export const rules = {
-  'no-unresolved': require('./rules/no-unresolved'),
+  'no-unresolved': noUnresolved,
   named: require('./rules/named'),
   default: require('./rules/default'),
   namespace: require('./rules/namespace'),
@@ -52,7 +57,7 @@ export const rules = {
 
   // deprecated aliases to rules
   'imports-first': require('./rules/imports-first'),
-}
+} satisfies Record<string, TSESLint.RuleModule<string, readonly unknown[]>>
 
 export const configs = {
   recommended: require('./config/recommended'),
@@ -68,4 +73,4 @@ export const configs = {
   'react-native': require('./config/react-native'),
   electron: require('./config/electron'),
   typescript: require('./config/typescript'),
-}
+} satisfies Record<string, PluginConfig>

src/rules/consistent-type-specifier-style.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function isComma(token) {
   return token.type === 'Punctuator' && token.value === ','

src/rules/default.js

@@ -1,5 +1,5 @@
 import Exports from '../ExportMap'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 module.exports = {
   meta: {

src/rules/dynamic-import-chunkname.js

@@ -1,5 +1,5 @@
 import vm from 'vm'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 module.exports = {
   meta: {

src/rules/export.js

@@ -1,5 +1,5 @@
 import ExportMap, { recursivePatternCapture } from '../ExportMap'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 /*
 Notes on TypeScript namespaces aka TSModuleDeclaration:

src/rules/exports-last.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function isNonExportStatement({ type }) {
   return (

src/rules/extensions.js

@@ -1,9 +1,9 @@
 import path from 'path'
 
-import resolve from '../utils/resolve'
+import { resolve } from '../utils/resolve'
 import { isBuiltIn, isExternalModule, isScoped } from '../core/importType'
-import moduleVisitor from '../utils/moduleVisitor'
-import docsUrl from '../docsUrl'
+import { moduleVisitor } from '../utils/moduleVisitor'
+import { docsUrl } from '../docs-url'
 
 const enumValues = { enum: ['always', 'ignorePackages', 'never'] }
 const patternProperties = {

src/rules/first.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function getImportValue(node) {
   return node.type === 'ImportDeclaration'

src/rules/group-exports.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 const meta = {
   type: 'suggestion',

src/rules/imports-first.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 const first = require('./first')
 

src/rules/max-dependencies.js

@@ -1,5 +1,5 @@
-import moduleVisitor from '../utils/moduleVisitor'
-import docsUrl from '../docsUrl'
+import { moduleVisitor } from '../utils/moduleVisitor'
+import { docsUrl } from '../docs-url'
 
 const DEFAULT_MAX = 10
 const DEFAULT_IGNORE_TYPE_IMPORTS = false

src/rules/named.js

@@ -1,6 +1,6 @@
 import * as path from 'path'
 import Exports from '../ExportMap'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 module.exports = {
   meta: {

src/rules/namespace.js

@@ -1,7 +1,7 @@
 import declaredScope from '../utils/declaredScope'
 import Exports from '../ExportMap'
-import importDeclaration from '../importDeclaration'
-import docsUrl from '../docsUrl'
+import { importDeclaration } from '../import-declaration'
+import { docsUrl } from '../docs-url'
 
 function processBodyStatement(context, namespaces, declaration) {
   if (declaration.type !== 'ImportDeclaration') {

src/rules/newline-after-import.js

@@ -4,7 +4,7 @@
  */
 
 import isStaticRequire from '../core/staticRequire'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 import debug from 'debug'
 const log = debug('eslint-plugin-import-x:rules:newline-after-import')

src/rules/no-absolute-path.js

@@ -1,7 +1,7 @@
 import path from 'path'
-import moduleVisitor, { makeOptionsSchema } from '../utils/moduleVisitor'
+import { moduleVisitor, makeOptionsSchema } from '../utils/moduleVisitor'
 import { isAbsolute } from '../core/importType'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 module.exports = {
   meta: {

src/rules/no-amd.js

@@ -3,7 +3,7 @@
  * @author Jamund Ferguson
  */
 
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 //------------------------------------------------------------------------------
 // Rule Definition

src/rules/no-anonymous-default-export.js

@@ -3,7 +3,7 @@
  * @author Duncan Beevers
  */
 
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 const hasOwn = Function.bind.bind(Function.prototype.call)(
   Object.prototype.hasOwnProperty,

src/rules/no-commonjs.js

@@ -3,7 +3,7 @@
  * @author Jamund Ferguson
  */
 
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 const EXPORT_MESSAGE = 'Expected "export" or "export default"'
 const IMPORT_MESSAGE = 'Expected "import" instead of "require()"'

src/rules/no-cycle.js

@@ -3,11 +3,11 @@
  * @author Ben Mosher
  */
 
-import resolve from '../utils/resolve'
+import { resolve } from '../utils/resolve'
 import Exports from '../ExportMap'
 import { isExternalModule } from '../core/importType'
-import moduleVisitor, { makeOptionsSchema } from '../utils/moduleVisitor'
-import docsUrl from '../docsUrl'
+import { moduleVisitor, makeOptionsSchema } from '../utils/moduleVisitor'
+import { docsUrl } from '../docs-url'
 
 const traversed = new Set()
 

src/rules/no-default-export.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 module.exports = {
   meta: {

src/rules/no-deprecated.js

@@ -1,6 +1,6 @@
 import declaredScope from '../utils/declaredScope'
 import Exports from '../ExportMap'
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function message(deprecation) {
   return `Deprecated${deprecation.description ? `: ${deprecation.description}` : '.'}`

src/rules/no-duplicates.js

@@ -1,7 +1,7 @@
-import resolve from '../utils/resolve'
+import { resolve } from '../utils/resolve'
 import semver from 'semver'
 
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 let typescriptPkg
 try {

src/rules/no-dynamic-require.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function isRequire(node) {
   return (

src/rules/no-empty-named-blocks.js

@@ -1,4 +1,4 @@
-import docsUrl from '../docsUrl'
+import { docsUrl } from '../docs-url'
 
 function getEmptyBlockRange(tokens, index) {
   const token = tokens[index]