-
Notifications
You must be signed in to change notification settings - Fork 12k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(@schematics/angular): add migration to replace deprecated options
- Loading branch information
1 parent
197e96b
commit e61f2e6
Showing
3 changed files
with
205 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
packages/schematics/angular/migrations/update-11/update-angular-config.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
/** | ||
* @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 { JsonArray, isJsonArray, isJsonObject, workspaces } from '@angular-devkit/core'; | ||
import { Rule } from '@angular-devkit/schematics'; | ||
import { updateWorkspace } from '../../utility/workspace'; | ||
|
||
export default function (): Rule { | ||
return updateWorkspace(workspace => { | ||
|
||
const optionsToRemove: Record<string, undefined> = { | ||
extractCss: undefined, | ||
tsconfigFileName: undefined, | ||
}; | ||
|
||
for (const [, project] of workspace.projects) { | ||
for (const [, target] of project.targets) { | ||
// Only interested in Angular Devkit builders | ||
if (!target?.builder.startsWith('@angular-devkit/build-angular')) { | ||
continue; | ||
} | ||
|
||
// Check options | ||
if (target.options) { | ||
target.options = { | ||
...updateLazyScriptsStyleOption(target.options), | ||
...optionsToRemove, | ||
}; | ||
} | ||
|
||
// Go through each configuration entry | ||
if (!target.configurations) { | ||
continue; | ||
} | ||
|
||
for (const configurationName of Object.keys(target.configurations)) { | ||
target.configurations[configurationName] = { | ||
...updateLazyScriptsStyleOption(target.configurations[configurationName]), | ||
...optionsToRemove, | ||
}; | ||
} | ||
} | ||
} | ||
}); | ||
} | ||
|
||
type TargetOptions = workspaces.TargetDefinition['options']; | ||
|
||
function updateLazyScriptsStyleOption(options: TargetOptions): TargetOptions { | ||
function visitor(options: NonNullable<TargetOptions>, type: 'scripts' | 'styles'): JsonArray | undefined { | ||
// tslint:disable-next-line: no-non-null-assertion | ||
if (!options[type] || !isJsonArray(options[type]!)) { | ||
return undefined; | ||
} | ||
const entries = []; | ||
for (const entry of options[type] as JsonArray) { | ||
if (isJsonObject(entry) && 'lazy' in entry) { | ||
entries.push({ | ||
...entry, | ||
inject: !entry.lazy, | ||
lazy: undefined, | ||
}); | ||
} else { | ||
entries.push(entry); | ||
} | ||
} | ||
|
||
return entries as JsonArray; | ||
} | ||
|
||
if (!options) { | ||
return undefined; | ||
} | ||
|
||
return { | ||
...options, | ||
styles: visitor(options, 'styles'), | ||
scripts: visitor(options, 'scripts'), | ||
}; | ||
} |
115 changes: 115 additions & 0 deletions
115
packages/schematics/angular/migrations/update-11/update-angular-config_spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
/** | ||
* @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 { 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: { | ||
build: { | ||
builder: Builders.Browser, | ||
options: { | ||
scripts: [ | ||
{ lazy: true, name: 'bundle-1.js' }, | ||
], | ||
extractCss: false, | ||
sourceMaps: true, | ||
buildOptimizer: false, | ||
// tslint:disable-next-line:no-any | ||
} as any, | ||
configurations: { | ||
one: { | ||
aot: true, | ||
scripts: [ | ||
{ lazy: true, name: 'bundle-1.js' }, | ||
{ lazy: false, name: 'bundle-2.js' }, | ||
{ inject: true, name: 'bundle-3.js' }, | ||
'bundle-4.js', | ||
], | ||
styles: [ | ||
{ lazy: true, name: 'bundle-1.css' }, | ||
{ lazy: false, name: 'bundle-2.css' }, | ||
{ inject: true, name: 'bundle-3.css' }, | ||
'bundle-3.css', | ||
], | ||
}, | ||
two: { | ||
extractCss: true, | ||
aot: true, | ||
}, | ||
// tslint:disable-next-line:no-any | ||
} as any, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
||
tree.create('/angular.json', JSON.stringify(angularConfig, undefined, 2)); | ||
} | ||
|
||
const schematicName = 'update-angular-config-v11'; | ||
|
||
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 replace 'lazy' with 'inject'`, async () => { | ||
const newTree = await schematicRunner.runSchematicAsync(schematicName, {}, tree).toPromise(); | ||
const { options, configurations } = getBuildTarget(newTree); | ||
|
||
expect(configurations?.one.scripts).toEqual([ | ||
{ inject: false, name: 'bundle-1.js' }, | ||
{ inject: true, name: 'bundle-2.js' }, | ||
{ inject: true, name: 'bundle-3.js' }, | ||
'bundle-4.js', | ||
]); | ||
|
||
expect(configurations?.one.styles).toEqual([ | ||
{ inject: false, name: 'bundle-1.css' }, | ||
{ inject: true, name: 'bundle-2.css' }, | ||
{ inject: true, name: 'bundle-3.css' }, | ||
'bundle-3.css', | ||
]); | ||
|
||
expect(options.scripts).toEqual([ | ||
{ inject: false, name: 'bundle-1.js' }, | ||
]); | ||
}); | ||
}); |