Skip to content

Support extending multiple config files #838

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

Merged
NullVoxPopuli merged 1 commit into from
Mar 25, 2025
Merged

Support extending multiple config files #838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
83 changes: 82 additions & 1 deletion packages/core/__tests__/config/load-config.test.ts
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@NullVoxPopuli NullVoxPopuli Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens in these new tests without the fix implemented?

I don't really understand why the expects are what they are. I would have expected an assertion of a value being present in the resolved config that is defined in the extended configs?

Why assert with normalize path?

Thank you!

Copy link
Copy Markdown
Contributor Author

@mogstad mogstad Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the fix they would throw an exception.

I agree the expects are a bit weird, I just continued using the existing pattern. Let me see if I can improve it.

Copy link
Copy Markdown
Contributor Author

@mogstad mogstad Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Invoked the loadConfigInput directly, but kept the existing setup there as well, to ensure the root dir is correctly.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as os from 'node:os';
import { describe, beforeEach, afterEach, test, expect, vi } from 'vitest';
import { loadConfig } from '../../src/config/index.js';
import { normalizePath } from '../../src/config/config.js';
import { require } from '../../src/config/loader.js';
import { findTypeScript, loadConfigInput, require } from '../../src/config/loader.js';

describe('Config: loadConfig', () => {
const testDir = `${os.tmpdir()}/glint-config-test-load-config-${process.pid}`;
Expand Down Expand Up @@ -51,6 +51,87 @@ describe('Config: loadConfig', () => {
expect(config.environment.getConfiguredTemplateTags()).toEqual({ test: {} });
});

test('recursively extends config', () => {
fs.mkdirSync(`${testDir}/deeply/nested/directory`, { recursive: true });
fs.mkdirSync(`${testDir}/other`, { recursive: true });

fs.writeFileSync(
`${testDir}/tsconfig.json`,
JSON.stringify({
extends: './other/tsconfig.json',
glint: {
environment: '../local-env',
},
}),
);
fs.writeFileSync(
`${testDir}/other/tsconfig.json`,
JSON.stringify({
glint: {
environment: 'kaboom',
},
}),
);

fs.writeFileSync(
`${testDir}/deeply/tsconfig.json`,
JSON.stringify({
extends: '../tsconfig.json',
}),
);

let ts = findTypeScript(`${testDir}/deeply`);
if (!ts) {
expect.fail('TypeScript not found');
}
let glintConfig = loadConfigInput(ts, `${testDir}/deeply/tsconfig.json`);
expect(glintConfig).toEqual({ environment: '../local-env' });

let config = loadConfig(`${testDir}/deeply/nested/directory`);
expect(config.rootDir).toBe(normalizePath(`${testDir}/deeply`));
});

test('extends multiple parents', () => {
fs.mkdirSync(`${testDir}/deeply/nested/directory`, { recursive: true });
fs.mkdirSync(`${testDir}/other`, { recursive: true });

fs.writeFileSync(
`${testDir}/tsconfig.json`,
JSON.stringify({
glint: {
environment: 'kaboom',
checkStandaloneTemplates: true,
},
}),
);
fs.writeFileSync(
`${testDir}/other/tsconfig.json`,
JSON.stringify({
glint: {
environment: '../local-env',
},
}),
);

fs.writeFileSync(
`${testDir}/deeply/tsconfig.json`,
JSON.stringify({
extends: ['../tsconfig.json', '../other/tsconfig.json'],
}),
);

let ts = findTypeScript(`${testDir}/deeply`);
if (!ts) {
expect.fail('TypeScript not found');
}
let glintConfig = loadConfigInput(ts, `${testDir}/deeply/tsconfig.json`);
expect(glintConfig).toEqual({ environment: '../local-env', checkStandaloneTemplates: true });

let config = loadConfig(`${testDir}/deeply/nested/directory`);
expect(config.rootDir).toBe(normalizePath(`${testDir}/deeply`));
expect(config.environment.names).toEqual(['../local-env']);
});

test('locates config in package', () => {
const directory = `${testDir}/package-glint-config`;
const nodeModulePackageDir = `${directory}/node_modules/@package1`;
Expand Down
47 changes: 27 additions & 20 deletions packages/core/src/config/loader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,36 +67,43 @@ function tryResolve<T>(load: () => T): T | null {
}
}

function loadConfigInput(ts: TypeScript, entryPath: string): GlintConfigInput | null {
let fullGlintConfig: Record<string, unknown> = {};
let currentPath: string | undefined = entryPath;
function parseConfigInput(
ts: TypeScript,
entryPath: string,
currentPath: string,
fullGlintConfig: Record<string, unknown>,
): Record<string, unknown> {
let currentContents: any = ts.readConfigFile(currentPath, ts.sys.readFile).config;
let currentGlintConfig = currentContents.glint ?? {};

while (currentPath) {
let currentContents: any = ts.readConfigFile(currentPath, ts.sys.readFile).config;
let currentGlintConfig = currentContents.glint ?? {};

assert(
currentPath === entryPath || !currentGlintConfig.transform,
'Glint `transform` options may not be specified in extended config.',
);

fullGlintConfig = { ...currentGlintConfig, ...fullGlintConfig };
assert(
currentPath === entryPath || !currentGlintConfig.transform,
'Glint `transform` options may not be specified in extended config.',
);

if (currentContents.extends) {
currentPath = path.resolve(path.dirname(currentPath), currentContents.extends);
if (!fs.existsSync(currentPath)) {
if (currentContents.extends) {
let paths: string[] = Array.isArray(currentContents.extends)
? currentContents.extends
: [currentContents.extends];
for (let extendPath of paths) {
let currentExtendPath = path.resolve(path.dirname(currentPath), extendPath);
if (!fs.existsSync(currentExtendPath)) {
try {
currentPath = require.resolve(currentContents.extends);
currentExtendPath = require.resolve(currentContents.extends);
} catch {
// suppress the exception thrown by require.resolve for those scenarios where the file does not exist
}
}
} else {
currentPath = undefined;

fullGlintConfig = parseConfigInput(ts, entryPath, currentExtendPath, fullGlintConfig);
}
}

return validateConfigInput(fullGlintConfig);
return { ...fullGlintConfig, ...currentGlintConfig };
}

export function loadConfigInput(ts: TypeScript, entryPath: string): GlintConfigInput | null {
return validateConfigInput(parseConfigInput(ts, entryPath, entryPath, {}));
}

function findNearestConfigFile(ts: TypeScript, searchFrom: string): string {
Expand Down
Loading