-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Rewrote resolution strategy + various improvements (see notes)
- Several improvements were made for speed and efficiency. - Now accommodating for new TS empty baseURL provision (closes #109) - Pre-checking necessity before overwriting paths (closes #110) - Rewrote core resolution methodology to: - Properly handle implicit indexes (closes #106) - Properly handle implicit sub-package indexes set via package.json 'main' #108) - Not follow symlinks (#107) - Resolve from output path as opposed to SourceFile path (#103)
- Loading branch information
Showing
22 changed files
with
378 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| import { VisitorContext } from "../types"; | ||
| import { isBaseDir, isURL, maybeAddRelativeLocalPrefix } from "./general-utils"; | ||
| import * as path from "path"; | ||
| import { removeFileExtension, removeSuffix, ResolvedModuleFull } from "typescript"; | ||
| import { getOutputFile } from "./ts-helpers"; | ||
|
|
||
| /* ****************************************************************************************************************** */ | ||
| // region: Types | ||
| /* ****************************************************************************************************************** */ | ||
|
|
||
| export interface ResolvedModule { | ||
| /** | ||
| * Absolute path to resolved module | ||
| */ | ||
| resolvedPath: string | undefined; | ||
| /** | ||
| * Output path | ||
| */ | ||
| outputPath: string; | ||
| /** | ||
| * Resolved to URL | ||
| */ | ||
| isURL: boolean; | ||
| } | ||
|
|
||
| enum IndexType { | ||
| NonIndex, | ||
| Explicit, | ||
| Implicit, | ||
| ImplicitPackage, | ||
| } | ||
|
|
||
| // endregion | ||
|
|
||
| /* ****************************************************************************************************************** */ | ||
| // region: Helpers | ||
| /* ****************************************************************************************************************** */ | ||
|
|
||
| function getPathDetail(moduleName: string, resolvedModule: ResolvedModuleFull) { | ||
| let resolvedFileName = resolvedModule.originalPath ?? resolvedModule.resolvedFileName; | ||
| const implicitPackageIndex = resolvedModule.packageId?.subModuleName; | ||
|
|
||
| const resolvedDir = implicitPackageIndex | ||
| ? removeSuffix(resolvedFileName, `/${implicitPackageIndex}`) | ||
| : path.dirname(resolvedFileName); | ||
| const resolvedBaseName = implicitPackageIndex ? void 0 : path.basename(resolvedFileName); | ||
| const resolvedBaseNameNoExtension = resolvedBaseName && removeFileExtension(resolvedBaseName); | ||
| const resolvedExtName = resolvedBaseName && path.extname(resolvedFileName); | ||
|
|
||
| let baseName = !implicitPackageIndex ? path.basename(moduleName) : void 0; | ||
| let baseNameNoExtension = baseName && removeFileExtension(baseName); | ||
| let extName = baseName && path.extname(moduleName); | ||
|
|
||
| // Account for possible false extensions. Example scenario: | ||
| // moduleName = './file.accounting' | ||
| // resolvedBaseName = 'file.accounting.ts' | ||
| // ('accounting' would be considered the extension) | ||
| if (resolvedBaseNameNoExtension && baseName && resolvedBaseNameNoExtension === baseName) { | ||
| baseNameNoExtension = baseName; | ||
| extName = void 0; | ||
| } | ||
|
|
||
| // prettier-ignore | ||
| const indexType = | ||
| implicitPackageIndex ? IndexType.ImplicitPackage : | ||
| baseNameNoExtension === 'index' && resolvedBaseNameNoExtension === 'index' ? IndexType.Explicit : | ||
| baseNameNoExtension !== 'index' && resolvedBaseNameNoExtension === 'index' ? IndexType.Implicit : | ||
| IndexType.NonIndex; | ||
|
|
||
| if (indexType === IndexType.Implicit) { | ||
| baseName = void 0; | ||
| baseNameNoExtension = void 0; | ||
| extName = void 0; | ||
| } | ||
|
|
||
| return { | ||
| baseName, | ||
| baseNameNoExtension, | ||
| extName, | ||
| resolvedBaseName, | ||
| resolvedBaseNameNoExtension, | ||
| resolvedExtName, | ||
| resolvedDir, | ||
| indexType, | ||
| implicitPackageIndex, | ||
| resolvedFileName, | ||
| }; | ||
| } | ||
|
|
||
| // endregion | ||
|
|
||
| /* ****************************************************************************************************************** */ | ||
| // region: Utils | ||
| /* ****************************************************************************************************************** */ | ||
|
|
||
| /** | ||
| * Resolve a module name | ||
| */ | ||
| export function resolveModuleName(context: VisitorContext, moduleName: string): ResolvedModule | undefined { | ||
| const { tsInstance, compilerOptions, sourceFile, config, rootDirs } = context; | ||
|
|
||
| // Attempt to resolve with TS Compiler API | ||
| const { resolvedModule, failedLookupLocations } = tsInstance.resolveModuleName( | ||
| moduleName, | ||
| sourceFile.fileName, | ||
| compilerOptions, | ||
| tsInstance.sys | ||
| ); | ||
|
|
||
| // Handle non-resolvable module | ||
| if (!resolvedModule) { | ||
| const maybeURL = failedLookupLocations[0]; | ||
| if (!isURL(maybeURL)) return void 0; | ||
| return { | ||
| isURL: true, | ||
| resolvedPath: void 0, | ||
| outputPath: maybeURL, | ||
| }; | ||
| } | ||
|
|
||
| const { | ||
| indexType, | ||
| resolvedBaseNameNoExtension, | ||
| resolvedFileName, | ||
| implicitPackageIndex, | ||
| extName, | ||
| resolvedDir, | ||
| } = getPathDetail(moduleName, resolvedModule); | ||
|
|
||
| /* Determine output filename */ | ||
| let outputBaseName = resolvedBaseNameNoExtension ?? ""; | ||
|
|
||
| if (indexType === IndexType.Implicit) outputBaseName = outputBaseName.replace(/(\/index$)|(^index$)/, ""); | ||
| if (outputBaseName && extName) outputBaseName = `${outputBaseName}${extName}`; | ||
|
|
||
| /* Determine output dir */ | ||
| let srcFileOutputDir = path.dirname(getOutputFile(context, sourceFile.fileName)); | ||
| let moduleFileOutputDir = implicitPackageIndex ? resolvedDir : path.dirname(getOutputFile(context, resolvedFileName)); | ||
|
|
||
| // Handle rootDirs remapping | ||
| if (config.useRootDirs && rootDirs) { | ||
| let fileRootDir = ""; | ||
| let moduleRootDir = ""; | ||
| for (const rootDir of rootDirs) { | ||
| if (isBaseDir(rootDir, moduleFileOutputDir) && rootDir.length > moduleRootDir.length) moduleRootDir = rootDir; | ||
| if (isBaseDir(rootDir, srcFileOutputDir) && rootDir.length > fileRootDir.length) fileRootDir = rootDir; | ||
| } | ||
|
|
||
| /* Remove base dirs to make relative to root */ | ||
| if (fileRootDir && moduleRootDir) { | ||
| srcFileOutputDir = path.relative(fileRootDir, srcFileOutputDir); | ||
| moduleFileOutputDir = path.relative(moduleRootDir, moduleFileOutputDir); | ||
| } | ||
| } | ||
|
|
||
| const outputDir = path.relative(srcFileOutputDir, moduleFileOutputDir); | ||
|
|
||
| /* Compose final output path */ | ||
| const outputPath = maybeAddRelativeLocalPrefix(tsInstance.normalizePath(path.join(outputDir, outputBaseName))); | ||
|
|
||
| return { isURL: false, outputPath, resolvedPath: resolvedFileName }; | ||
| } | ||
|
|
||
| // endregion |
Oops, something went wrong.