refactor: drop @pkgr/core as dep

Author: JounQin

CHANGELOG.md

@@ -317,7 +317,7 @@
   export type ResolvedResult = ResultNotFound | ResultFound
   ```
 
-  You will be able to import `NewResolver` from `eslint-plugin-import-x/types`.
+  You will be able to import `NewResolver` from `eslint-plugin-import-x`.
 
   The most notable change is that `eslint-plugin-import-x` no longer passes the third argument (`options`) to the `resolve` function.
 

index.d.cts

@@ -1,3 +1,3 @@
-import eslintPluginImportX from './lib/index.js'
+import * as eslintPluginImportX from './lib/index.js'
 
 export = eslintPluginImportX

package.json

@@ -71,7 +71,6 @@
     "eslint": "^8.57.0 || ^9.0.0"
   },
   "dependencies": {
-    "@pkgr/core": "^0.2.4",
     "@typescript-eslint/utils": "^8.31.0",
     "comment-parser": "^1.4.1",
     "debug": "^4.4.0",

src/index.ts

@@ -19,6 +19,7 @@ import warnings from './config/warnings.js'
 // rules
 import { meta } from './meta.js'
 import { createNodeResolver } from './node-resolver.js'
+import { cjsRequire } from './require.js'
 import consistentTypeSpecifierStyle from './rules/consistent-type-specifier-style.js'
 import default_ from './rules/default.js'
 import dynamicImportChunkname from './rules/dynamic-import-chunkname.js'
@@ -183,6 +184,7 @@ export default {
   configs,
   flatConfigs,
   rules,
+  cjsRequire,
   importXResolverCompat,
   createNodeResolver,
 }
@@ -192,6 +194,7 @@ export {
   configs,
   flatConfigs,
   rules,
+  cjsRequire,
   importXResolverCompat,
   createNodeResolver,
 }

src/meta.ts

@@ -1,10 +1,4 @@
-import { createRequire } from 'node:module'
-
-import type { CjsRequire } from '@pkgr/core'
-
-const cjsRequire: CjsRequire = import.meta.url
-  ? createRequire(import.meta.url)
-  : /* istanbul ignore next */ require
+import { cjsRequire } from './require.js'
 
 export const { name, version } = cjsRequire<{ name: string; version: string }>(
   '../package.json',

src/require.ts

@@ -0,0 +1,9 @@
+import { createRequire } from 'node:module'
+
+import type { CjsRequire } from './types.js'
+
+const importMetaUrl = import.meta.url
+
+export const cjsRequire: CjsRequire = importMetaUrl
+  ? createRequire(importMetaUrl)
+  : /* istanbul ignore next */ require

src/rules/no-duplicates.ts

@@ -1,8 +1,8 @@
-import { cjsRequire } from '@pkgr/core'
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import * as semver from 'semver'
 import type { PackageJson } from 'type-fest'
 
+import { cjsRequire } from '../require.js'
 import type { RuleContext } from '../types.js'
 import { createRule, lazy, resolve } from '../utils/index.js'
 

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

@@ -1,9 +1,9 @@
 import path from 'node:path'
 
-import { cjsRequire } from '@pkgr/core'
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import { minimatch } from 'minimatch'
 
+import { cjsRequire } from '../require.js'
 import type { RuleContext } from '../types.js'
 import { createRule, pkgUp } from '../utils/index.js'
 

src/types.ts

@@ -235,3 +235,7 @@ export interface Ranks {
   pathGroups: RanksPathGroup[]
   maxPosition: number
 }
+
+export interface CjsRequire extends NodeJS.Require {
+  <T>(id: string): T
+}

src/utils/export-map.ts

@@ -1,7 +1,6 @@
 import fs from 'node:fs'
 import path from 'node:path'
 
-import { cjsRequire } from '@pkgr/core'
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import type * as commentParser from 'comment-parser'
 import debug from 'debug'
@@ -11,6 +10,7 @@ import type { TsConfigJsonResolved, TsConfigResult } from 'get-tsconfig'
 import { getTsconfig } from 'get-tsconfig'
 import { stableHash } from 'stable-hash'
 
+import { cjsRequire } from '../require.js'
 import type {
   ChildContext,
   DocStyle,
@@ -74,7 +74,7 @@ let parseComment_: typeof commentParser.parse | undefined
 
 const parseComment = (comment: string): commentParser.Block => {
   parseComment_ ??= cjsRequire<typeof commentParser>('comment-parser').parse
-  const restored = `/**${comment.split('\n').reduce((acc, line) => {
+  const restored = `/**${comment.split(/\r?\n/).reduce((acc, line) => {
     line = line.trim()
     return line && line !== '*' ? acc + '\n  ' + line : acc
   }, '')}

src/utils/legacy-resolver-settings.ts

@@ -3,9 +3,9 @@
 import { createRequire } from 'node:module'
 import path from 'node:path'
 
-import { cjsRequire } from '@pkgr/core'
 import type { LiteralUnion } from 'type-fest'
 
+import { cjsRequire } from '../require.js'
 import type {
   NodeResolverOptions,
   ResolvedResult,

src/utils/module-require.ts

@@ -1,7 +1,7 @@
 import Module from 'node:module'
 import path from 'node:path'
 
-import { cjsRequire } from '@pkgr/core'
+import { cjsRequire } from '../require.js'
 
 function createModule(filename: string) {
   const mod = new Module(filename)

src/utils/resolve.ts

@@ -18,8 +18,10 @@ import {
 } from './legacy-resolver-settings.js'
 import { ModuleCache } from './module-cache.js'
 
-const _filename = import.meta.url
-  ? fileURLToPath(import.meta.url)
+const importMetaUrl = import.meta.url
+
+const _filename = importMetaUrl
+  ? fileURLToPath(importMetaUrl)
   : /* istanbul ignore next */ __filename
 const _dirname = path.dirname(_filename)
 

test/fixtures/foo-bar-resolver-v3.js

@@ -1,17 +1,19 @@
+/** @import {NewResolver} from 'eslint-plugin-import-x' */
+
 var path = require('path')
 
-exports.foobarResolver =
-  /** @type {import('eslint-plugin-import-x/types').NewResolver} */ {
-    name: 'resolver-foo-bar',
-    interfaceVersion: 3,
-    resolve(modulePath, sourceFile) {
-      var sourceFileName = path.basename(sourceFile)
-      if (sourceFileName === 'foo.js') {
-        return { found: true, path: path.join(__dirname, 'bar.jsx') }
-      }
-      if (sourceFileName === 'exception.js') {
-        throw new Error('foo-bar-resolver-v3 resolve test exception')
-      }
-      return { found: false }
-    },
-  }
+/** @type {NewResolver} */
+exports.foobarResolver = {
+  name: 'resolver-foo-bar',
+  interfaceVersion: 3,
+  resolve(modulePath, sourceFile) {
+    var sourceFileName = path.basename(sourceFile)
+    if (sourceFileName === 'foo.js') {
+      return { found: true, path: path.join(__dirname, 'bar.jsx') }
+    }
+    if (sourceFileName === 'exception.js') {
+      throw new Error('foo-bar-resolver-v3 resolve test exception')
+    }
+    return { found: false }
+  },
+}

test/rules/consistent-type-specifier-style.spec.ts

@@ -1,10 +1,10 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 
 import { parsers, createRuleTestCaseFunctions } from '../utils.js'
 import type { RuleRunTests } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/consistent-type-specifier-style'
 
 const { tValid } = createRuleTestCaseFunctions<typeof rule>()

test/rules/default.spec.ts

@@ -1,7 +1,6 @@
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 
 import {
@@ -11,6 +10,7 @@ import {
 } from '../utils.js'
 import type { RuleRunTests } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/default'
 import { CASE_SENSITIVE_FS } from 'eslint-plugin-import-x/utils'
 

test/rules/dynamic-import-chunkname.spec.ts

@@ -1,11 +1,11 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
 import type { TSESLint } from '@typescript-eslint/utils'
 
 import { SYNTAX_VALID_CASES, parsers } from '../utils.js'
 import type { GetRuleModuleOptions, RuleRunTests } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/dynamic-import-chunkname'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/export.spec.ts

@@ -1,4 +1,3 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 
 import {
@@ -9,6 +8,7 @@ import {
 } from '../utils.js'
 import type { RuleRunTests } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/export'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/first.spec.ts

@@ -1,10 +1,10 @@
 import fs from 'node:fs'
 
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 
 import { createRuleTestCaseFunctions, parsers, testFilePath } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/first'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/group-exports.spec.ts

@@ -1,8 +1,8 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 
 import { createRuleTestCaseFunctions, parsers } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/group-exports'
 
 const ruleTester = new TSESLintRuleTester({

test/rules/max-dependencies.spec.ts

@@ -1,8 +1,8 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 
 import { parsers, createRuleTestCaseFunctions } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/max-dependencies'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/named.spec.ts

@@ -1,7 +1,6 @@
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 import type { AST_NODE_TYPES } from '@typescript-eslint/utils'
@@ -14,6 +13,7 @@ import {
 } from '../utils.js'
 import type { RuleRunTests, GetRuleModuleMessageIds } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/named'
 import { CASE_SENSITIVE_FS } from 'eslint-plugin-import-x/utils'
 

test/rules/namespace.spec.ts

@@ -1,4 +1,3 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 import { AST_NODE_TYPES } from '@typescript-eslint/utils'
@@ -11,6 +10,7 @@ import {
 } from '../utils.js'
 import type { GetRuleModuleMessageIds, RuleRunTests } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/namespace'
 
 const ruleTester = new TSESLintRuleTester({

test/rules/newline-after-import.spec.ts

@@ -1,10 +1,10 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 
 import { parsers } from '../utils.js'
 import type { GetRuleModuleMessageIds } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/newline-after-import'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/no-absolute-path.spec.ts

@@ -1,10 +1,10 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 
 import { createRuleTestCaseFunctions, parsers } from '../utils.js'
 import type { GetRuleModuleMessageIds } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/no-absolute-path'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/no-anonymous-default-export.spec.ts

@@ -1,4 +1,3 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 
@@ -9,6 +8,7 @@ import {
 } from '../utils.js'
 import type { GetRuleModuleMessageIds, RuleRunTests } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/no-anonymous-default-export'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/no-cycle.spec.ts

@@ -1,10 +1,10 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 
 import { createRuleTestCaseFunctions, parsers, testFilePath } from '../utils.js'
 import type { GetRuleModuleMessageIds } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/no-cycle'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/no-default-export.spec.ts

@@ -1,11 +1,11 @@
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 import type { AST_NODE_TYPES } from '@typescript-eslint/utils'
 
 import { parsers, createRuleTestCaseFunctions } from '../utils.js'
 import type { GetRuleModuleMessageIds } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/no-default-export'
 
 const ruleTester = new TSESLintRuleTester()

test/rules/no-duplicates.spec.ts

@@ -1,6 +1,5 @@
 import path from 'node:path'
 
-import { cjsRequire as require } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TestCaseError as TSESLintTestCaseError } from '@typescript-eslint/rule-tester'
 
@@ -12,6 +11,7 @@ import {
 } from '../utils.js'
 import type { GetRuleModuleMessageIds, RuleRunTests } from '../utils.js'
 
+import { cjsRequire as require } from 'eslint-plugin-import-x'
 import jsxConfig from 'eslint-plugin-import-x/config/flat/react'
 import rule from 'eslint-plugin-import-x/rules/no-duplicates'
 

test/rules/no-dynamic-require.spec.ts

@@ -1,9 +1,9 @@
-import { cjsRequire } from '@pkgr/core'
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester'
 import type { TSESLint } from '@typescript-eslint/utils'
 
 import { parsers, createRuleTestCaseFunctions } from '../utils.js'
 
+import { cjsRequire } from 'eslint-plugin-import-x'
 import rule from 'eslint-plugin-import-x/rules/no-dynamic-require'
 
 const ruleTester = new TSESLintRuleTester()