Skip to content

refactor(@angular/build): provide a default for the application index option #29995

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
merged 1 commit into from
Apr 2, 2025
Merged

refactor(@angular/build): provide a default for the application index option #29995

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
2 changes: 1 addition & 1 deletion goldens/public-api/angular/build/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export type ApplicationBuilderOptions = {
fileReplacements?: FileReplacement[];
i18nDuplicateTranslation?: I18NTranslation;
i18nMissingTranslation?: I18NTranslation;
index: IndexUnion;
index?: IndexUnion;
inlineStyleLanguage?: InlineStyleLanguage;
loader?: {
[key: string]: any;
Expand Down
12 changes: 7 additions & 5 deletions packages/angular/build/src/builders/application/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,11 +332,16 @@ export async function normalizeOptions(
let indexHtmlOptions;
// index can never have a value of `true` but in the schema it's of type `boolean`.
if (typeof options.index !== 'boolean') {
let indexInput: string;
let indexOutput: string;
// The output file will be created within the configured output path
if (typeof options.index === 'string') {
indexOutput = options.index;
indexInput = indexOutput = path.join(workspaceRoot, options.index);
} else if (typeof options.index === 'undefined') {
indexInput = path.join(projectSourceRoot, 'index.html');
indexOutput = 'index.html';
} else {
indexInput = path.join(workspaceRoot, options.index.input);
indexOutput = options.index.output || 'index.html';
}

Expand All @@ -356,10 +361,7 @@ export async function normalizeOptions(
: indexBaseName;

indexHtmlOptions = {
input: path.join(
workspaceRoot,
typeof options.index === 'string' ? options.index : options.index.input,
),
input: indexInput,
output: indexOutput,
insertionOrder: [
['polyfills', true],
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/build/src/builders/application/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,7 +616,7 @@
}
},
"additionalProperties": false,
"required": ["index", "browser", "tsConfig"],
"required": ["browser", "tsConfig"],
"definitions": {
"assetPattern": {
"oneOf": [
Expand Down
17 changes: 17 additions & 0 deletions packages/angular/build/src/builders/application/tests/options/index_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,23 @@ describeBuilder(buildApplication, APPLICATION_BUILDER_INFO, (harness) => {
harness.expectFile('dist/browser/index.html').content.toContain('TEST_123');
});

it('should use the the index.html file within the project source root when not present', async () => {
harness.useTarget('build', {
...BASE_OPTIONS,
index: undefined,
});

await harness.writeFile(
'src/index.html',
'<html><head><title>TEST_123</title></head><body></body>',
);

const { result } = await harness.executeOnce();

expect(result?.success).toBe(true);
harness.expectFile('dist/browser/index.html').content.toContain('TEST_123');
});

// TODO: Build needs to be fixed to not throw an unhandled exception for this case
xit('should fail build when a string path to non-existent file', async () => {
harness.useTarget('build', {
Expand Down