feat: enable alwaysTryTypes by default, add noWarnOnMultipleProjects option

Author: JounQin

src/index.ts

@@ -59,7 +59,7 @@ const oxcResolve = (
 export const resolve = (
   source: string,
   file: string,
-  options?: TypeScriptResolverOptions,
+  options?: TypeScriptResolverOptions | null,
   resolver?: ResolverFactory | null,
   // eslint-disable-next-line sonarjs/cognitive-complexity
 ): ResolvedResult => {
@@ -91,10 +91,12 @@ export const resolve = (
 
   source = removeQuerystring(source)
 
+  options ||= {}
+
   // eslint-disable-next-line sonar/label-position, sonar/no-labels
   resolve: if (!resolver) {
     // must be a array with 2+ items here already ensured by `normalizeOptions`
-    const project = options!.project as string[]
+    const project = options.project as string[]
     for (const tsconfigPath of project) {
       const resolverCached = resolverCache.get(tsconfigPath)
       if (resolverCached) {
@@ -128,7 +130,7 @@ export const resolve = (
         ...options,
         tsconfig: {
           references: 'auto',
-          ...options!.tsconfig,
+          ...options.tsconfig,
           configFile: tsconfigPath,
         },
       }
@@ -171,7 +173,7 @@ export const resolve = (
   // if path is neither absolute nor relative
   if (
     ((foundPath && JS_EXT_PATTERN.test(foundPath)) ||
-      (options?.alwaysTryTypes && !foundPath)) &&
+      (options.alwaysTryTypes !== false && !foundPath)) &&
     !/^@types[/\\]/.test(source) &&
     !path.isAbsolute(source) &&
     !source.startsWith('.')
@@ -194,15 +196,15 @@ export const resolve = (
       "didn't find",
       source,
       'with',
-      options!.tsconfig?.configFile || options!.project,
+      options.tsconfig?.configFile || options.project,
     )
   }
 
   return resolved
 }
 
 export const createTypeScriptImportResolver = (
-  options?: TypeScriptResolverOptions,
+  options?: TypeScriptResolverOptions | null,
 ) => {
   options = normalizeOptions(options)
   const resolver = options.project ? null : new ResolverFactory(options)

src/normalize-options.ts

@@ -2,30 +2,32 @@ import { TsconfigOptions } from 'oxc-resolver'
 import { globSync, isDynamicPattern } from 'tinyglobby'
 
 import {
+  DEFAULT_CONFIGS,
+  DEFAULT_IGNORE,
+  DEFAULT_TRY_PATHS,
   defaultConditionNames,
-  defaultExtensions,
   defaultExtensionAlias,
+  defaultExtensions,
   defaultMainFields,
-  DEFAULT_CONFIGS,
-  DEFAULT_TRY_PATHS,
-  DEFAULT_IGNORE,
 } from './constants.js'
 import { tryFile } from './helpers.js'
 import { log } from './logger.js'
-import { TsResolverOptions, TypeScriptResolverOptions } from './types.js'
+import { TypeScriptResolverOptions } from './types.js'
 
 export let defaultConfigFile: string
 
 const configFileMapping = new Map<string, TypeScriptResolverOptions>()
 
+let warned: boolean | undefined
+
 export function normalizeOptions(
   options?: TypeScriptResolverOptions | null,
-): TsResolverOptions
+): TypeScriptResolverOptions
 // eslint-disable-next-line sonarjs/cognitive-complexity
 export function normalizeOptions(
-  options?: TsResolverOptions | null,
-): TsResolverOptions {
-  let { project, tsconfig } = (options ??= {})
+  options?: TypeScriptResolverOptions | null,
+): TypeScriptResolverOptions {
+  let { project, tsconfig, noWarnOnMultipleProjects } = (options ||= {})
 
   let { configFile, references }: Partial<TsconfigOptions> = tsconfig ?? {}
 
@@ -52,6 +54,11 @@ export function normalizeOptions(
     }
     if (project.length <= 1) {
       project = undefined
+    } else if (!warned && !noWarnOnMultipleProjects) {
+      warned = true
+      console.warn(
+        'Multiple projects found, consider using a single `tsconfig` with `references` to speed up, or use `noWarnOnMultipleProjects` to suppress this warning',
+      )
     }
   }
 

src/types.ts

@@ -1,8 +1,10 @@
 import type { NapiResolveOptions } from 'oxc-resolver'
 
-export interface TsResolverOptions extends NapiResolveOptions {
+export interface TypeScriptResolverOptions extends NapiResolveOptions {
   project?: string[] | string
+  /**
+   * @default true - whether to always try to resolve `@types` packages
+   */
   alwaysTryTypes?: boolean
+  noWarnOnMultipleProjects?: boolean
 }
-
-export type TypeScriptResolverOptions = TsResolverOptions | null

tests/baseEslintConfig.cjs

@@ -14,7 +14,7 @@ module.exports = project => ({
     'import/resolver': {
       typescript: {
         project,
-        alwaysTryTypes: true,
+        noWarnOnMultipleProjects: true,
       },
     },
   },

tests/importXResolverV3/eslint.config.js

@@ -24,6 +24,7 @@ module.exports =
           'import-x/resolver-next': [
             createTypeScriptImportResolver({
               project: absoluteGlobPath,
+              noWarnOnMultipleProjects: true,
             }),
           ],
         },