Skip to content

Commit

Permalink
feat(@schematics/angular): add migration to update the workspace config
Browse files Browse the repository at this point in the history
With this change we add a migration to update the workspace configuration to version 13 by removed deprecated options and builders.
  • Loading branch information
alan-agius4 authored and filipesilva committed Aug 3, 2021
1 parent 20e48a3 commit 268a03b
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 1 deletion.
Expand Up @@ -134,6 +134,11 @@
"version": "13.0.0",
"factory": "./update-13/schematic-options",
"description": "Remove no longer valid Angular schematic options from `angular.json`."
},
"update-angular-config-v13": {
"version": "13.0.0",
"factory": "./update-13/update-angular-config",
"description": "Remove deprecated options from 'angular.json' that are no longer present in v13."
}
}
}
@@ -0,0 +1,35 @@
/**
* @license
* Copyright Google LLC 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 { Rule } from '@angular-devkit/schematics';
import { allTargetOptions, updateWorkspace } from '../../utility/workspace';

export default function (): Rule {
return updateWorkspace((workspace) => {
for (const [, project] of workspace.projects) {
for (const [name, target] of project.targets) {
// Delete removed tslint builder
if (target.builder === '@angular-devkit/build-angular:tslint') {
project.targets.delete(name);
continue;
}

if (!target.builder.startsWith('@angular-devkit/build-angular')) {
continue;
}

// Only interested in Angular Devkit builders
for (const [, options] of allTargetOptions(target)) {
delete options.extractCss;
delete options.servePathDefaultWarning;
delete options.hmrWarning;
}
}
}
});
}
@@ -0,0 +1,95 @@
/**
* @license
* Copyright Google LLC 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 { JsonObject } from '@angular-devkit/core';
import { EmptyTree } from '@angular-devkit/schematics';
import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
import {
BuilderTarget,
Builders,
ProjectType,
WorkspaceSchema,
} from '../../utility/workspace-models';

function getBuildTarget(tree: UnitTestTree): BuilderTarget<Builders.Browser, JsonObject> {
return JSON.parse(tree.readContent('/angular.json')).projects.app.architect.build;
}

function createWorkSpaceConfig(tree: UnitTestTree) {
const angularConfig: WorkspaceSchema = {
version: 1,
projects: {
app: {
root: '',
sourceRoot: 'src',
projectType: ProjectType.Application,
prefix: 'app',
architect: {
lint: {
builder: '@angular-devkit/build-angular:tslint',
},
build: {
builder: Builders.Browser,
options: {
scripts: [{ lazy: true, name: 'bundle-1.js' }],
extractCss: false,
sourceMaps: true,
buildOptimizer: false,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any,
configurations: {
one: {
aot: true,
},
two: {
extractCss: true,
aot: true,
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any,
},
},
},
},
};

tree.create('/angular.json', JSON.stringify(angularConfig, undefined, 2));
}

const schematicName = 'update-angular-config-v13';

describe(`Migration to update 'angular.json'. ${schematicName}`, () => {
const schematicRunner = new SchematicTestRunner(
'migrations',
require.resolve('../migration-collection.json'),
);

let tree: UnitTestTree;
beforeEach(() => {
tree = new UnitTestTree(new EmptyTree());
createWorkSpaceConfig(tree);
});

it(`should remove 'extractCss'`, async () => {
const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise();
const { options, configurations } = getBuildTarget(newTree);

expect(options.extractCss).toBeUndefined();
expect(configurations).toBeDefined();
expect(configurations?.one.extractCss).toBeUndefined();
expect(configurations?.two.extractCss).toBeUndefined();
});

it(`should remove tslint builder`, async () => {
const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise();

const { build, lint } = JSON.parse(newTree.readContent('/angular.json')).projects.app.architect;
expect(build).toBeDefined();
expect(lint).toBeUndefined();
});
});
1 change: 0 additions & 1 deletion packages/schematics/angular/utility/workspace-models.ts
Expand Up @@ -49,7 +49,6 @@ export interface BrowserBuilderOptions extends BrowserBuilderBaseOptions {
optimization?: boolean;
outputHashing?: OutputHashing;
resourcesOutputPath?: string;
extractCss?: boolean;
namedChunks?: boolean;
aot?: boolean;
extractLicenses?: boolean;
Expand Down

0 comments on commit 268a03b

Please sign in to comment.