Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typescript 5.5 parse for configDir #179

Merged
merged 10 commits into from
Jun 27, 2024
Merged

Fix typescript 5.5 parse for configDir #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8fdc653
Fix normalizeSnapshot when repository path contains special characters
lPernod-sorare Jun 26, 2024
472cf87
Fix check for TS 5.5
lPernod-sorare Jun 26, 2024
e7efaf6
Fix configDir tests
lPernod-sorare Jun 26, 2024
46b9cf3
Add support for baseUrl
lPernod-sorare Jun 26, 2024
c44024b
Fix index.d.ts.map file
lPernod-sorare Jun 26, 2024
9732cf4
Add changeset
lPernod-sorare Jun 26, 2024
8bbf4bc
test: add testcase for configDir replacement to avoid regressions on …
dominikg Jun 26, 2024
b0421f2
chore: refactor version detection in tests
dominikg Jun 26, 2024
8b291aa
refactor: shorten baseUrl resolve code
dominikg Jun 26, 2024
d0b1804
chore: generate types map
dominikg Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cyan-pumas-dream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'tsconfck': patch
---

Fix ts 5.5 `${configDir}` expansion
9 changes: 5 additions & 4 deletions packages/tsconfck/src/parse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export async function parse(filename, options) {
result = await parseFile(tsconfigFile, cache, filename === tsconfigFile);
await Promise.all([parseExtends(result, cache), parseReferences(result, options)]);
}
result.tsconfig = replaceTokens(result.tsconfig, path.dirname(tsconfigFile));
resolve(resolveSolutionTSConfig(filename, result));
} catch (e) {
reject(e);
Expand Down Expand Up @@ -134,11 +135,11 @@ async function parseFile(tsconfigFile, cache, skipCache) {
*/
function normalizeTSConfig(tsconfig, dir) {
// set baseUrl to absolute path
if (tsconfig.compilerOptions?.baseUrl && !path.isAbsolute(tsconfig.compilerOptions.baseUrl)) {
tsconfig.compilerOptions.baseUrl = resolve2posix(dir, tsconfig.compilerOptions.baseUrl);
const baseUrl = tsconfig.compilerOptions?.baseUrl;
if (baseUrl && !baseUrl.startsWith('${') && !path.isAbsolute(baseUrl)) {
tsconfig.compilerOptions.baseUrl = resolve2posix(dir, baseUrl);
}

return replaceTokens(tsconfig, dir);
return tsconfig;
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/tsconfck/tests/fixtures/parse/valid/configDir/tsconfig.base.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"paths": {
"$src": ["${configDir}/src/**/*"]
},
"baseUrl": "${configDir}/src",
"outDir": "${configDir}/build"
}
}
5 changes: 2 additions & 3 deletions packages/tsconfck/tests/parse-native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import { transform as esbuildTransform } from 'esbuild';
import ts from 'typescript';
import { TSConfckCache } from '../src/cache.js';

const ts_ver = ts.version.slice(3).split('.');
const IS_TS_5_5 = ts_ver[0] >= 5 && ts_ver[1] >= 5;
import { FEAT_$CONFIGDIR } from './util/features.js';

describe('parse', () => {
it('should be a function', () => {
Expand Down Expand Up @@ -54,7 +53,7 @@ describe('parse', () => {
it('should resolve with expected valid tsconfig.json', async () => {
const samples = await globFixtures('parse/valid/**/tsconfig.json');
for (const filename of samples) {
if (!IS_TS_5_5 && filename.includes('configDir')) {
if (!FEAT_$CONFIGDIR && filename.includes('configDir')) {
continue; // configDir doesn't work in 5.4
}
const actual = await parseNative(filename);
Expand Down
12 changes: 12 additions & 0 deletions packages/tsconfck/tests/parse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { promises as fs } from 'node:fs';
import { transform as esbuildTransform } from 'esbuild';
import ts from 'typescript';
import { TSConfckCache } from '../src/cache.js';
import { native2posix } from '../src/util.js';

describe('parse', () => {
it('should be a function', () => {
Expand Down Expand Up @@ -56,6 +57,17 @@ describe('parse', () => {
}
});

it('should replace configDir', async () => {
const samples = await globFixtures('parse/valid/configDir/**/tsconfig.json');
for (const filename of samples) {
const actual = await parse(filename);
expect(actual.tsconfigFile).toBe(filename);
expect(actual.tsconfig.compilerOptions.outDir).toBe(
native2posix(path.dirname(filename) + '/build')
);
}
});

it('should resolve with expected valid jsconfig.json with configName=jsconfig.json', async () => {
const samples = await globFixtures('parse/valid/**/jsconfig.json');
for (const filename of samples) {
Expand Down
1 change: 1 addition & 0 deletions packages/tsconfck/tests/snapshots/parse/valid/configDir/a/tsconfig.json.parse-native.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"<fixture-dir>/parse/valid/configDir/a/src/**/*"
]
},
"baseUrl": "<fixture-dir>/parse/valid/configDir/a/src",
"outDir": "<fixture-dir>/parse/valid/configDir/a/build"
}
}
9 changes: 5 additions & 4 deletions packages/tsconfck/tests/snapshots/parse/valid/configDir/a/tsconfig.json.parse.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@
"../tsconfig.base.json"
],
"include": [
"<fixture-dir>/parse/valid/configDir/**/*"
"<fixture-dir>/parse/valid/configDir/a/**/*"
],
"exclude": [
"<fixture-dir>/parse/valid/configDir/src/**/*.spec.ts"
"<fixture-dir>/parse/valid/configDir/a/src/**/*.spec.ts"
],
"compilerOptions": {
"paths": {
"$src": [
"<fixture-dir>/parse/valid/configDir/src/**/*"
"<fixture-dir>/parse/valid/configDir/a/src/**/*"
]
},
"outDir": "<fixture-dir>/parse/valid/configDir/build"
"baseUrl": "<fixture-dir>/parse/valid/configDir/a/src",
"outDir": "<fixture-dir>/parse/valid/configDir/a/build"
}
}
1 change: 1 addition & 0 deletions packages/tsconfck/tests/snapshots/parse/valid/configDir/b/tsconfig.json.parse-native.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"<fixture-dir>/parse/valid/configDir/b/src/**/*"
]
},
"baseUrl": "<fixture-dir>/parse/valid/configDir/b/src",
"outDir": "<fixture-dir>/parse/valid/configDir/b/build"
}
}
9 changes: 5 additions & 4 deletions packages/tsconfck/tests/snapshots/parse/valid/configDir/b/tsconfig.json.parse.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@
"../tsconfig.base.json"
],
"include": [
"<fixture-dir>/parse/valid/configDir/**/*"
"<fixture-dir>/parse/valid/configDir/b/**/*"
],
"exclude": [
"<fixture-dir>/parse/valid/configDir/src/**/*.spec.ts"
"<fixture-dir>/parse/valid/configDir/b/src/**/*.spec.ts"
],
"compilerOptions": {
"paths": {
"$src": [
"<fixture-dir>/parse/valid/configDir/src/**/*"
"<fixture-dir>/parse/valid/configDir/b/src/**/*"
]
},
"outDir": "<fixture-dir>/parse/valid/configDir/build"
"baseUrl": "<fixture-dir>/parse/valid/configDir/b/src",
"outDir": "<fixture-dir>/parse/valid/configDir/b/build"
}
}
2 changes: 1 addition & 1 deletion packages/tsconfck/tests/util/expect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { expect } from 'vitest';
import { fixtures, snapName } from './fixture-paths.js';

const fixtureDirRegex = new RegExp(
fixtures.replace(/[.*+?^${}()|[\]]/g, '\\$&').replace(/[/\\]/g, '[/\\\\]'),
fixtures.replace(/[.*+?^${}()|[\]\\]/g, '\\$&').replace(/(\/|\\\\)/g, '[/\\\\]'),
'g'
);
function normalizeSnapshot(str) {
Expand Down
4 changes: 4 additions & 0 deletions packages/tsconfck/tests/util/features.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import ts from 'typescript';

const [major, minor] = ts.version.split('.', 3).map((n) => Number(n));
export const FEAT_$CONFIGDIR = major > 5 || (major === 5 && minor >= 5);
2 changes: 1 addition & 1 deletion packages/tsconfck/types/index.d.ts.map
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@
null,
null
],
"mappings": ";;;;;;;;iBAUsBA,IAAIA;;;;;;;;iBCYJC,OAAOA;;;;;;;iBCTbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC2BJC,KAAKA;cA4VdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC5VTC,WAAWA;cAkOpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WC5PpBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;;;;;;;WAetBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
"mappings": ";;;;;;;;iBAUsBA,IAAIA;;;;;;;;iBCYJC,OAAOA;;;;;;;iBCTbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC2BJC,KAAKA;cA6VdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC7VTC,WAAWA;cAkOpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WC5PpBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;;;;;;;WAetBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
}