Alan Agius 1de6d71edd feat(@schematics/angular): production builds by default
With this change we do several changes to the `angular.json` configuration for `build` , `server` and `app-shell` targets so that these are `production` by default.

- build, server and app-shell targets are configured to run production by default.
- We add a new configuration named `development` to run the mentioned builder targets in development. Ex: `ng build --configuration development`.
- When adding `universal` or `app-shell`, we generate the full set of configurations as per the `buiid` target. Previously, we only generated the `production` configuration.
- We added a helper script in `package.json` to run build in watch mode. `npm run watch` which is a shortcut for `ng build --watch --configuration development`
2021-03-10 08:16:38 -06:00

267 lines
13 KiB
TypeScript

/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { EmptyTree } from '@angular-devkit/schematics';
import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
import { latestVersions } from '../../utility/latest-versions';
import { WorkspaceTargets } from '../../utility/workspace-models';
// tslint:disable-next-line: no-any
function getWorkspaceTargets(tree: UnitTestTree): any {
return JSON.parse(tree.readContent(workspacePath))
.projects['migration-test'].architect;
}
function updateWorkspaceTargets(tree: UnitTestTree, workspaceTargets: WorkspaceTargets) {
const config = JSON.parse(tree.readContent(workspacePath));
config.projects['migration-test'].architect = workspaceTargets;
tree.overwrite(workspacePath, JSON.stringify(config, undefined, 2));
}
const workspacePath = '/angular.json';
// tslint:disable:no-big-function
describe('Migration to version 9', () => {
describe('Migrate workspace config', () => {
const schematicRunner = new SchematicTestRunner(
'migrations',
require.resolve('../migration-collection.json'),
);
let tree: UnitTestTree;
beforeEach(async () => {
tree = new UnitTestTree(new EmptyTree());
tree = await schematicRunner
.runExternalSchematicAsync(
require.resolve('../../collection.json'),
'ng-new',
{
name: 'migration-test',
version: '1.2.3',
directory: '.',
},
tree,
)
.toPromise();
tree.overwrite('angular.json', tree.readContent('angular.json').replace(/development/g, 'production'));
});
describe('i18n configuration', () => {
function getI18NConfig(localId: string): object {
return {
outputPath: `dist/my-project/${localId}/`,
i18nFile: `src/locale/messages.${localId}.xlf`,
i18nFormat: 'xlf',
i18nLocale: localId,
};
}
describe('when i18n builder options are set', () => {
it(`should add '@angular/localize' as a dependency`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const { dependencies } = JSON.parse(tree2.readContent('/package.json'));
expect(dependencies['@angular/localize']).toBe(latestVersions.Angular);
});
it(`should add 'localize' option in configuration`, async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.localize).toEqual(['fr']);
expect(config.configurations.de.localize).toEqual(['de']);
});
it('should remove deprecated i18n options', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.i18nFormat).toBeUndefined();
expect(config.options.i18nFile).toBeUndefined();
expect(config.options.i18nLocale).toBeUndefined();
expect(config.configurations.de.i18nFormat).toBeUndefined();
expect(config.configurations.de.i18nFile).toBeUndefined();
expect(config.configurations.de.i18nLocale).toBeUndefined();
});
it('should remove baseHref option when used with i18n options and no main base href', async () => {
let config = getWorkspaceTargets(tree);
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.fr.baseHref).toBeUndefined();
expect(config.configurations.de.baseHref).toBeUndefined();
});
it('should remove outputPath option when used with i18n options and contains locale code', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.outputPath = 'dist';
config.build.configurations.fr = { ...getI18NConfig('fr'), outputPath: 'dist/fr' };
config.build.configurations.de = { ...getI18NConfig('de'), outputPath: '/dist/de/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.fr.outputPath).toBe('dist');
expect(config.configurations.de.outputPath).toBe('/dist');
});
it('should keep old i18n options except format when output path is not supported', async () => {
let config = getWorkspaceTargets(tree);
config.build.options.outputPath = 'dist';
config.build.configurations.fr = { ...getI18NConfig('fr'), outputPath: 'dist/abc' };
config.build.configurations.de = { ...getI18NConfig('de'), outputPath: '/dist/123' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.fr.outputPath).toBe('dist/abc');
expect(config.configurations.fr.i18nFormat).toBeUndefined();
expect(config.configurations.fr.i18nFile).toBeDefined();
expect(config.configurations.fr.i18nLocale).toBe('fr');
expect(config.configurations.de.outputPath).toBe('/dist/123');
expect(config.configurations.de.i18nFormat).toBeUndefined();
expect(config.configurations.de.i18nFile).toBeDefined();
expect(config.configurations.de.i18nLocale).toBe('de');
});
it('should keep baseHref option when not used with i18n options', async () => {
let config = getWorkspaceTargets(tree);
config.build.options = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
config.build.configurations.staging = { baseHref: '/de/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.configurations.staging.baseHref).toBe('/de/');
});
it('should keep baseHref options when used with i18n options and main baseHref option', async () => {
let config = getWorkspaceTargets(tree);
config.build.options = { baseHref: '/my-app/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/de/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2).build;
expect(config.options.baseHref).toBe('/my-app/');
expect(config.configurations.de.baseHref).toBe('/');
});
it('should remove deprecated extract-i18n options', async () => {
let config = getWorkspaceTargets(tree);
config['extract-i18n'].options.i18nFormat = 'xmb';
config['extract-i18n'].options.i18nLocale = 'en-GB';
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
config = getWorkspaceTargets(tree2)['extract-i18n'];
expect(config.options.i18nFormat).toBeUndefined();
expect(config.options.i18nLocale).toBeUndefined();
expect(config.options.format).toBe('xmb');
});
it(`should add i18n 'sourceLocale' project config when 'extract-i18n' 'i18nLocale' is defined`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options.aot = false;
config.build.options = getI18NConfig('fr');
config['extract-i18n'].options.i18nLocale = 'en-GB';
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBe('en-GB');
expect(projectConfig.i18n.locales).toBeDefined();
});
it(`should add i18n 'locales' project config`, async () => {
const config = getWorkspaceTargets(tree);
config.build.configurations.fr = getI18NConfig('fr');
config.build.configurations.de = getI18NConfig('de');
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '' },
fr: { translation: 'src/locale/messages.fr.xlf', baseHref: '' },
});
});
it(`should add i18n 'locales' project config when using baseHref options`, async () => {
const config = getWorkspaceTargets(tree);
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '/abc/' },
fr: 'src/locale/messages.fr.xlf',
});
});
it(`should add i18n 'locales' project config when using baseHref options and main base href`, async () => {
const config = getWorkspaceTargets(tree);
config.build.options = { baseHref: '/my-app/' };
config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
updateWorkspaceTargets(tree, config);
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n.sourceLocale).toBeUndefined();
expect(projectConfig.i18n.locales).toEqual({
de: { translation: 'src/locale/messages.de.xlf', baseHref: '/abc/' },
fr: 'src/locale/messages.fr.xlf',
});
});
});
describe('when i18n builder options are not set', () => {
it(`should not add 'localize' option`, async () => {
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const config = getWorkspaceTargets(tree2).build;
expect(config.options.localize).toBeUndefined();
expect(config.configurations.production.localize).toBeUndefined();
});
it('should not add i18n project config', async () => {
const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
expect(projectConfig.i18n).toBeUndefined();
});
});
});
});
});