feat(sort-imports): allow to find alternate tsconfig file

Author: hugop95

docs/content/rules/sort-imports.mdx

@@ -267,14 +267,32 @@ Specifies a maximum line length for sorting imports. When the line length exceed
 
 This option is only available when the type is set to `'line-length'`.
 
-### tsconfigRootDir
+### tsconfig
+
+<sub>
+  type: `{ rootDir: string; filename?: string }`
+</sub>
+<sub>default: undefined</sub>
+
+- `rootDir` — Specifies the directory of the root `tsconfig.json` file (ex: `.`). This is used in [`groups`](#groups) for:
+  - Marking aliased imports as `internal`.
+  - Marking imports matching [tsconfig paths](https://www.typescriptlang.org/tsconfig/#paths) as `tsconfig-path`.
+- `filename` — Specifies the `tsconfig` filename to search for (by default: `tsconfig.json`).
+
+If this option is not set, the rule will not search for a `tsconfig.json` file.
+
+### [DEPRECATED] tsconfigRootDir
 
 <sub>default: `undefined`</sub>
 
+Use the [tsconfig](#tsconfig) option with the `rootDir` attribute.
+
 Specifies the  directory of the root `tsconfig.json` file (ex: `.`). This is used in [`groups`](#groups) for:
 - Marking aliased imports as `internal`.
 - Marking imports matching [tsconfig paths](https://www.typescriptlang.org/tsconfig/#paths) as `tsconfig-path`.
 
+If this option is not set, the rule will not search for a `tsconfig.json` file.
+
 ### groups
 
 <sub>

rules/sort-imports.ts

@@ -62,47 +62,50 @@ import { complete } from '../utils/complete'
  */
 let cachedGroupsByModifiersAndSelectors = new Map<string, string[]>()
 
-let defaultGroups = [
-  'type-import',
-  ['value-builtin', 'value-external'],
-  'type-internal',
-  'value-internal',
-  ['type-parent', 'type-sibling', 'type-index'],
-  ['value-parent', 'value-sibling', 'value-index'],
-  'ts-equals-import',
-  'unknown',
-]
-
 export type MESSAGE_ID =
   | 'unexpectedImportsDependencyOrder'
   | 'missedSpacingBetweenImports'
   | 'unexpectedImportsGroupOrder'
   | 'extraSpacingBetweenImports'
   | 'unexpectedImportsOrder'
 
+let defaultOptions: Required<
+  Omit<Options[0], 'tsconfigRootDir' | 'maxLineLength' | 'tsconfig'>
+> &
+  Pick<Options[0], 'tsconfigRootDir' | 'maxLineLength' | 'tsconfig'> = {
+  groups: [
+    'type-import',
+    ['value-builtin', 'value-external'],
+    'type-internal',
+    'value-internal',
+    ['type-parent', 'type-sibling', 'type-index'],
+    ['value-parent', 'value-sibling', 'value-index'],
+    'ts-equals-import',
+    'unknown',
+  ],
+  internalPattern: ['^~/.+', '^@/.+'],
+  fallbackSort: { type: 'unsorted' },
+  partitionByComment: false,
+  partitionByNewLine: false,
+  newlinesBetween: 'always',
+  specialCharacters: 'keep',
+  sortSideEffects: false,
+  type: 'alphabetical',
+  environment: 'node',
+  customGroups: [],
+  ignoreCase: true,
+  locales: 'en-US',
+  alphabet: '',
+  order: 'asc',
+}
+
 export default createEslintRule<Options, MESSAGE_ID>({
   create: context => {
     let settings = getSettings(context.settings)
 
     let userOptions = context.options.at(0)
     let options = getOptionsWithCleanGroups(
-      complete(userOptions, settings, {
-        internalPattern: ['^~/.+', '^@/.+'],
-        fallbackSort: { type: 'unsorted' },
-        partitionByComment: false,
-        partitionByNewLine: false,
-        newlinesBetween: 'always',
-        specialCharacters: 'keep',
-        sortSideEffects: false,
-        groups: defaultGroups,
-        type: 'alphabetical',
-        environment: 'node',
-        customGroups: [],
-        ignoreCase: true,
-        locales: 'en-US',
-        alphabet: '',
-        order: 'asc',
-      } as const),
+      complete(userOptions, settings, defaultOptions),
     )
 
     validateGeneratedGroupsConfiguration({
@@ -122,9 +125,12 @@ export default createEslintRule<Options, MESSAGE_ID>({
     validateNewlinesAndPartitionConfiguration(options)
     validateSideEffectsConfiguration(options)
 
-    let tsConfigOutput = options.tsconfigRootDir
+    let tsconfigRootDirectory =
+      options.tsconfig?.rootDir ?? options.tsconfigRootDir
+    let tsConfigOutput = tsconfigRootDirectory
       ? readClosestTsConfigByPath({
-          tsconfigRootDir: options.tsconfigRootDir,
+          tsconfigFilename: options.tsconfig?.filename ?? 'tsconfig.json',
+          tsconfigRootDir: tsconfigRootDirectory,
           filePath: context.physicalFilename,
           contextCwd: context.cwd,
         })
@@ -439,6 +445,21 @@ export default createEslintRule<Options, MESSAGE_ID>({
               buildCustomGroupsArrayJsonSchema({ singleCustomGroupJsonSchema }),
             ],
           },
+          tsconfig: {
+            properties: {
+              rootDir: {
+                description: 'Specifies the tsConfig root directory.',
+                type: 'string',
+              },
+              filename: {
+                description: 'Specifies the tsConfig filename.',
+                type: 'string',
+              },
+            },
+            additionalProperties: false,
+            required: ['rootDir'],
+            type: 'object',
+          },
           maxLineLength: {
             description: 'Specifies the maximum line length.',
             exclusiveMinimum: true,
@@ -486,24 +507,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     type: 'suggestion',
     fixable: 'code',
   },
-  defaultOptions: [
-    {
-      customGroups: { value: {}, type: {} },
-      internalPattern: ['^~/.+', '^@/.+'],
-      partitionByComment: false,
-      partitionByNewLine: false,
-      specialCharacters: 'keep',
-      newlinesBetween: 'always',
-      sortSideEffects: false,
-      groups: defaultGroups,
-      type: 'alphabetical',
-      environment: 'node',
-      ignoreCase: true,
-      locales: 'en-US',
-      alphabet: '',
-      order: 'asc',
-    },
-  ],
+  defaultOptions: [defaultOptions],
   name: 'sort-imports',
 })
 
@@ -594,7 +598,7 @@ let computeGroupExceptUnknown = ({
 }: {
   options: Omit<
     Required<Options[0]>,
-    'tsconfigRootDir' | 'maxLineLength' | 'customGroups'
+    'tsconfigRootDir' | 'maxLineLength' | 'customGroups' | 'tsconfig'
   >
   customGroups: DeprecatedCustomGroupsOption | CustomGroupsOption | undefined
   selectors?: Selector[]

rules/sort-imports/read-closest-ts-config-by-path.ts

@@ -15,31 +15,33 @@ export interface ReadClosestTsConfigByPathValue {
   cache: ts.ModuleResolutionCache
 }
 
-interface ReadClosestTsConfigByPathParameters {
-  tsconfigRootDir: string
-  contextCwd: string
-  filePath: string
-}
-
 export let directoryCacheByPath = new Map<string, string>()
 export let contentCacheByPath = new Map<
   string,
   ReadClosestTsConfigByPathValue
 >()
 
-export let readClosestTsConfigByPath = (
-  input: ReadClosestTsConfigByPathParameters,
-): ReadClosestTsConfigByPathValue | null => {
+export let readClosestTsConfigByPath = ({
+  tsconfigFilename,
+  tsconfigRootDir,
+  contextCwd,
+  filePath,
+}: {
+  tsconfigFilename: string
+  tsconfigRootDir: string
+  contextCwd: string
+  filePath: string
+}): ReadClosestTsConfigByPathValue | null => {
   let typescriptImport = getTypescriptImport()
   if (!typescriptImport) {
     return null
   }
 
-  let directory = path.dirname(input.filePath)
+  let directory = path.dirname(filePath)
   let checkedDirectories = [directory]
 
   do {
-    let tsconfigPath = path.join(directory, 'tsconfig.json')
+    let tsconfigPath = path.join(directory, tsconfigFilename)
     let cachedDirectory = directoryCacheByPath.get(directory)
     if (!cachedDirectory && fs.existsSync(tsconfigPath)) {
       cachedDirectory = tsconfigPath
@@ -49,22 +51,15 @@ export let readClosestTsConfigByPath = (
       for (let checkedDirectory of checkedDirectories) {
         directoryCacheByPath.set(checkedDirectory, cachedDirectory)
       }
-      return getCompilerOptions(
-        typescriptImport,
-        input.contextCwd,
-        cachedDirectory,
-      )
+      return getCompilerOptions(typescriptImport, contextCwd, cachedDirectory)
     }
 
     directory = path.dirname(directory)
     checkedDirectories.push(directory)
-  } while (
-    directory.length > 1 &&
-    directory.length >= input.tsconfigRootDir.length
-  )
+  } while (directory.length > 1 && directory.length >= tsconfigRootDir.length)
 
   throw new Error(
-    `Couldn't find any tsconfig.json relative to '${input.filePath}' within '${input.tsconfigRootDir}'.`,
+    `Couldn't find any ${tsconfigFilename} relative to '${filePath}' within '${tsconfigRootDir}'.`,
   )
 }
 

rules/sort-imports/types.ts

@@ -28,18 +28,27 @@ export type Options = Partial<{
         type?: DeprecatedCustomGroupsOption
       }
     | CustomGroupsOption<SingleCustomGroup>
+  tsconfig:
+    | {
+        filename?: string
+        rootDir: string
+      }
+    | undefined
   partitionByComment: PartitionByCommentOption
   specialCharacters: SpecialCharactersOption
   locales: NonNullable<Intl.LocalesArgument>
   newlinesBetween: NewlinesBetweenOption
+  /**
+   * @deprecated for `tsconfig`
+   */
+  tsconfigRootDir: undefined | string
+  maxLineLength: undefined | number
   fallbackSort: FallbackSortOption
   internalPattern: RegexOption[]
   groups: GroupsOptions<Group>
   environment: 'node' | 'bun'
   partitionByNewLine: boolean
   sortSideEffects: boolean
-  tsconfigRootDir?: string
-  maxLineLength?: number
   ignoreCase: boolean
   order: OrderOption
   type: TypeOption