fix: tsconfig paths should be relative to baseUrl when set (#1155)

sorccu · web-flow · commit 36763294f6b9 · 2025-10-06T19:08:37.000+09:00
* fix: tsconfig paths should be relative to baseUrl when set

* chore: remove unused import
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/.gitignore b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/.gitignore
@@ -0,0 +1 @@
+node_modules/
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/.node-version b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/.node-version
@@ -0,0 +1 @@
+v22.12.0
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/checkly.config.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/checkly.config.ts
@@ -0,0 +1,22 @@
+import { defineConfig } from 'checkly'
+
+const config = defineConfig({
+  projectName: 'TSConfig Paths Sample Project',
+  logicalId: 'tsconfig-paths-sample-project',
+  checks: {
+    frequency: 10,
+    locations: ['us-east-1'],
+    tags: ['mac'],
+    runtimeId: '2024.09',
+    checkMatch: '**/__checks__/**/*.check.ts',
+    browserChecks: {
+      testMatch: '**/__checks__/**/*.spec.ts',
+    },
+  },
+  cli: {
+    runLocation: 'us-east-1',
+    reporters: ['list'],
+  },
+})
+
+export default config
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/package-lock.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/package-lock.json
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/package.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "tsconfig-paths-sample-project",
+  "dependencies": {
+    "checkly": "^4.15.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.51.1",
+    "typescript": "^5.7.2"
+  }
+}
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/entrypoint.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/entrypoint.ts
@@ -0,0 +1,3 @@
+import { value1 } from '@internal/lib1'
+import { value } from '@/foo/bar'
+import { name } from 'lib2'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/file1.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/file1.ts
@@ -0,0 +1 @@
+export const value = 'file1'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/file2.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/file2.ts
@@ -0,0 +1 @@
+export const value = 'file2'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/folder/file1.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/folder/file1.ts
@@ -0,0 +1 @@
+export { value } from './file2'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/folder/file2.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/folder/file2.ts
@@ -0,0 +1 @@
+export const value = 'file2'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/index.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/index.ts
@@ -0,0 +1,3 @@
+export { value as value1 } from './file1'
+export { value as value2 } from './file2'
+export { value as value3 } from './folder/file1'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/package-lock.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/package-lock.json
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/package.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@internal/lib",
+  "main": "dist/index.js",
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "prepare": "npm run clean && tsc --build"
+  },
+  "devDependencies": {
+    "rimraf": "^6.0.1",
+    "typescript": "^5.7.2"
+  }
+}
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/tsconfig.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib1/tsconfig.json
@@ -0,0 +1,18 @@
+{
+  "exclude": [
+    "dist",
+    "node_modules"
+  ],
+  "include": [
+    "./**/*.ts"
+  ],
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "outDir": "dist",
+    "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true
+  }
+}
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib2/index.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib2/index.ts
@@ -0,0 +1 @@
+export const name = 'lib2'
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib3/foo/bar.ts b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib3/foo/bar.ts
@@ -0,0 +1 @@
+export const value = 11517
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib3/jsconfig.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/src/lib3/jsconfig.json
@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "baseUrl": "."
+  }
+}
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/tsconfig.json b/packages/cli/src/services/check-parser/__tests__/check-parser-fixtures/tsconfig-paths-baseurl-relative/tsconfig.json
@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "baseUrl": "./src",
+    "paths": {
+      "@internal/lib1": [
+        "./lib1"
+      ],
+      "@/*": [
+        "./lib3/*"
+      ]
+    }
+  }
+}
diff --git a/packages/cli/src/services/check-parser/__tests__/check-parser.spec.ts b/packages/cli/src/services/check-parser/__tests__/check-parser.spec.ts
@@ -146,7 +146,7 @@ describe('dependency-parser - parser()', () => {
     ])
   })
 
-  it('should parse typescript dependencies using tsconfig', async () => {
+  it('should parse typescript dependencies using tsconfig paths', async () => {
     const toAbsolutePath = (...filepath: string[]) => path.join(__dirname, 'check-parser-fixtures', 'tsconfig-paths-sample-project', ...filepath)
     const parser = new Parser({
       supportedNpmModules: defaultNpmModules,
@@ -166,6 +166,26 @@ describe('dependency-parser - parser()', () => {
     ])
   })
 
+  it('should parse typescript dependencies using tsconfig paths relative to baseUrl', async () => {
+    const toAbsolutePath = (...filepath: string[]) => path.join(__dirname, 'check-parser-fixtures', 'tsconfig-paths-baseurl-relative', ...filepath)
+    const parser = new Parser({
+      supportedNpmModules: defaultNpmModules,
+    })
+    const { dependencies } = await parser.parse(toAbsolutePath('src', 'entrypoint.ts'))
+    expect(dependencies.map(d => d.filePath).sort()).toEqual([
+      toAbsolutePath('src', 'lib1', 'file1.ts'),
+      toAbsolutePath('src', 'lib1', 'file2.ts'),
+      toAbsolutePath('src', 'lib1', 'folder', 'file1.ts'),
+      toAbsolutePath('src', 'lib1', 'folder', 'file2.ts'),
+      toAbsolutePath('src', 'lib1', 'index.ts'),
+      toAbsolutePath('src', 'lib1', 'package.json'),
+      toAbsolutePath('src', 'lib1', 'tsconfig.json'),
+      toAbsolutePath('src', 'lib2', 'index.ts'),
+      toAbsolutePath('src', 'lib3', 'foo', 'bar.ts'),
+      toAbsolutePath('tsconfig.json'),
+    ])
+  })
+
   it('should not include tsconfig if not needed', async () => {
     const toAbsolutePath = (...filepath: string[]) => path.join(__dirname, 'check-parser-fixtures', 'tsconfig-paths-unused', ...filepath)
     const parser = new Parser({
diff --git a/packages/cli/src/services/check-parser/package-files/paths.ts b/packages/cli/src/services/check-parser/package-files/paths.ts
@@ -186,7 +186,10 @@ export type PathResult = {
   target: TargetPathResult
 }
 
-export type ResolveResult = PathResult[]
+export type ResolveResult = {
+  root: string
+  paths: PathResult[]
+}
 
 export class PathResolver {
   baseUrl: string
@@ -207,19 +210,25 @@ export class PathResolver {
       if (match.ok) {
         // We can just return the first match since matchers are already
         // sorted by longest prefix.
-        return match.results.map(result => {
-          return {
-            source: {
-              spec,
-              path: importPath,
-            },
-            target: result,
-          }
-        })
+        return {
+          root: this.baseUrl,
+          paths: match.results.map(result => {
+            return {
+              source: {
+                spec,
+                path: importPath,
+              },
+              target: result,
+            }
+          }),
+        }
       }
     }
 
-    return []
+    return {
+      root: this.baseUrl,
+      paths: [],
+    }
   }
 
   static createFromPaths (baseUrl: string, paths: Paths): PathResolver {
diff --git a/packages/cli/src/services/check-parser/package-files/resolver.ts b/packages/cli/src/services/check-parser/package-files/resolver.ts
@@ -294,11 +294,11 @@ export class PackageFilesResolver {
           continue
         }
 
-        const resolvedPaths = configJson.resolvePath(importPath)
+        const { root, paths: resolvedPaths } = configJson.resolvePath(importPath)
         if (resolvedPaths.length > 0) {
           let found = false
           for (const { source, target } of resolvedPaths) {
-            const relativePath = path.resolve(configJson.basePath, target.path)
+            const relativePath = path.resolve(root, target.path)
             const sourceFile = await this.cache.sourceFile(relativePath, context)
             if (sourceFile !== undefined) {
               const resolvedFiles = await this.resolveSourceFile(sourceFile, context)
diff --git a/packages/cli/src/services/check-parser/package-files/tsconfig-json-file.ts b/packages/cli/src/services/check-parser/package-files/tsconfig-json-file.ts
@@ -69,7 +69,7 @@ export class TSConfigFile {
   jsonFile: JsonTextSourceFile<Schema>
   basePath: string
   moduleResolution: string
-  baseUrl?: string
+  baseUrl: string
   pathResolver: PathResolver
 
   relatedSourceFiles: SourceFile[] = []
@@ -81,12 +81,11 @@ export class TSConfigFile {
 
     this.moduleResolution = jsonFile.data.compilerOptions?.moduleResolution?.toLocaleLowerCase() ?? 'unspecified'
 
-    const baseUrl = jsonFile.data.compilerOptions?.baseUrl
-    if (baseUrl !== undefined) {
-      this.baseUrl = path.resolve(this.jsonFile.meta.dirname, baseUrl)
-    }
+    this.baseUrl = jsonFile.data.compilerOptions?.baseUrl !== undefined
+      ? path.resolve(this.basePath, jsonFile.data.compilerOptions.baseUrl)
+      : this.basePath
 
-    this.pathResolver = PathResolver.createFromPaths(this.baseUrl ?? '.', jsonFile.data.compilerOptions?.paths ?? {})
+    this.pathResolver = PathResolver.createFromPaths(this.baseUrl, jsonFile.data.compilerOptions?.paths ?? {})
   }
 
   public get meta () {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { value1 } from '@internal/lib1'`
	`2`	`+import { value } from '@/foo/bar'`
	`3`	`+import { name } from 'lib2'`