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.

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

feat(@angular-devkit/build-angular): set document locale with i18n #15718

Merged
merged 1 commit into from
Oct 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export interface IndexHtmlWebpackPluginOptions {
moduleEntrypoints: string[];
postTransform?: IndexHtmlTransform;
crossOrigin?: CrossOriginValue;
lang?: string;
}

function readFile(filename: string, compilation: compilation.Compilation): Promise<string> {
Expand Down Expand Up @@ -100,6 +101,7 @@ export class IndexHtmlWebpackPlugin {
loadOutputFile,
moduleFiles,
entrypoints: this._options.entrypoints,
lang: this._options.lang,
});

if (this._options.postTransform) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export interface AugmentIndexHtmlOptions {
loadOutputFile: LoadOutputFileFunctionType;
/** Used to sort the inseration of files in the HTML file */
entrypoints: string[];
/** Used to set the document default locale */
lang?: string;
}

export interface FileInfo {
Expand All @@ -56,6 +58,7 @@ export interface FileInfo {
* after processing several configurations in order to build different sets of
* bundles for differential serving.
*/
// tslint:disable-next-line: no-big-function
export async function augmentIndexHtml(params: AugmentIndexHtmlOptions): Promise<string> {
const { loadOutputFile, files, noModuleFiles = [], moduleFiles = [], entrypoints } = params;

Expand Down Expand Up @@ -91,8 +94,10 @@ export async function augmentIndexHtml(params: AugmentIndexHtmlOptions): Promise
const document = parse5.parse(params.inputContent, { treeAdapter, locationInfo: true });
let headElement;
let bodyElement;
let htmlElement;
for (const docChild of document.childNodes) {
if (docChild.tagName === 'html') {
htmlElement = docChild;
for (const htmlChild of docChild.childNodes) {
if (htmlChild.tagName === 'head') {
headElement = htmlChild;
Expand Down Expand Up @@ -241,6 +246,33 @@ export async function augmentIndexHtml(params: AugmentIndexHtmlOptions): Promise

indexSource.insert(styleInsertionPoint, parse5.serialize(styleElements, { treeAdapter }));

// Adjust document locale if specified
if (typeof params.lang == 'string') {

const htmlFragment = treeAdapter.createDocumentFragment();

let langAttribute;
for (const attribute of htmlElement.attrs) {
if (attribute.name === 'lang') {
langAttribute = attribute;
}
}
if (langAttribute) {
langAttribute.value = params.lang;
} else {
htmlElement.attrs.push({ name: 'lang', value: params.lang });
}
// we want only openning tag
htmlElement.childNodes = [];

treeAdapter.appendChild(htmlFragment, htmlElement);
indexSource.replace(
htmlElement.__location.startTag.startOffset,
htmlElement.__location.startTag.endOffset - 1,
parse5.serialize(htmlFragment, { treeAdapter }).replace('</html>', ''),
);
}

return indexSource.source();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,21 @@ describe('augment-index-html', () => {
`);
});

it('should add lang attribute', async () => {
const source = augmentIndexHtml({
...indexGeneratorOptions,
lang: 'fr',
});

const html = await source;
expect(html).toEqual(oneLineHtml`
<html lang="fr">
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface WriteIndexHtmlOptions {
styles?: ExtraEntryPoint[];
postTransform?: IndexHtmlTransform;
crossOrigin?: CrossOriginValue;
lang?: string;
}

export type IndexHtmlTransform = (content: string) => Promise<string>;
Expand All @@ -49,6 +50,7 @@ export function writeIndexHtml({
styles = [],
postTransform,
crossOrigin,
lang,
}: WriteIndexHtmlOptions): Observable<void> {
return host.read(indexPath).pipe(
map(content => stripBom(virtualFs.fileBufferToString(content))),
Expand All @@ -70,6 +72,7 @@ export function writeIndexHtml({
.pipe(map(data => virtualFs.fileBufferToString(data)))
.toPromise();
},
lang: lang,
}),
),
switchMap(content => (postTransform ? postTransform(content) : of(content))),
Expand Down
1 change: 1 addition & 0 deletions packages/angular_devkit/build_angular/src/browser/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,7 @@ export function buildWebpackBrowser(
styles: options.styles,
postTransform: transforms.indexHtml,
crossOrigin: options.crossOrigin,
lang: options.i18nLocale,
})
.pipe(
map(() => ({ success: true })),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ export function serveWebpackBrowser(
noModuleEntrypoints: ['polyfills-es5'],
postTransform: transforms.indexHtml,
crossOrigin: browserOptions.crossOrigin,
lang: browserOptions.i18nLocale,
}),
);
}
Expand Down
2 changes: 2 additions & 0 deletions tests/legacy-cli/e2e/tests/i18n/build-locale.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ export default function () {
.then(() => expectFileToMatch('dist/test-project/main-es5.js', /angular_common_locales_fr/))
.then(() => expectFileToMatch('dist/test-project/main-es2015.js', /registerLocaleData/))
.then(() => expectFileToMatch('dist/test-project/main-es2015.js', /angular_common_locales_fr/))
.then(() => expectFileToMatch('dist/test-project/index.html', /lang="fr"/))
.then(() => rimraf('dist'))
.then(() => ng('build', '--aot', '--i18n-locale=fr_FR'))
.then(() => expectFileToMatch('dist/test-project/main-es2015.js', /registerLocaleData/))
.then(() => expectFileToMatch('dist/test-project/main-es2015.js', /angular_common_locales_fr/))
.then(() => expectFileToMatch('dist/test-project/main-es5.js', /registerLocaleData/))
.then(() => expectFileToMatch('dist/test-project/main-es5.js', /angular_common_locales_fr/))
.then(() => expectFileToMatch('dist/test-project/index.html', /lang="fr_FR"/))
.then(() => rimraf('dist'));
}