Skip to content

Commit 8d000d1

Browse files
clydinangular-robot[bot]
clydin
authored and
angular-robot[bot]
committed
feat(@schematics/angular): add environments generation schematic
A schematic has been added that will allow the generation of environment files for all existing configurations within a project. The `fileReplacements` option will also be setup to allow the replacement of the appropriate environment file. Environment files themselves do not provide any special behavior beyond that of other application TypeScript files and rely on the `fileReplacements` option for build-time behavior. The schematic will skip generating environment files for configurations that already have an appropriately named environment file. The `fileReplacements` option addition will also be skipped if an appropriate entry is already present.
1 parent 1ef7885 commit 8d000d1

File tree

4 files changed

+344
-0
lines changed

4 files changed

+344
-0
lines changed

‎packages/schematics/angular/collection.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,11 @@
115115
"factory": "./web-worker",
116116
"schema": "./web-worker/schema.json",
117117
"description": "Create a Web Worker."
118+
},
119+
"environments": {
120+
"factory": "./environments",
121+
"schema": "./environments/schema.json",
122+
"description": "Generate project environment files."
118123
}
119124
}
120125
}

‎packages/schematics/angular/environments/index.ts‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
/**
2+
* @license
3+
* Copyright Google LLC All Rights Reserved.
4+
*
5+
* Use of this source code is governed by an MIT-style license that can be
6+
* found in the LICENSE file at https://angular.io/license
7+
*/
8+
9+
import { Rule, SchematicsException, chain } from '@angular-devkit/schematics';
10+
import { AngularBuilder, TargetDefinition, updateWorkspace } from '@schematics/angular/utility';
11+
import { posix as path } from 'path';
12+
import { Schema as EnvironmentOptions } from './schema';
13+
14+
const ENVIRONMENTS_DIRECTORY = 'environments';
15+
const ENVIRONMENT_FILE_CONTENT = 'export const environment = {};\n';
16+
17+
export default function (options: EnvironmentOptions): Rule {
18+
return updateWorkspace((workspace) => {
19+
const project = workspace.projects.get(options.project);
20+
if (!project) {
21+
throw new SchematicsException(`Project name "${options.project}" doesn't not exist.`);
22+
}
23+
24+
const type = project.extensions['projectType'];
25+
if (type !== 'application') {
26+
return log(
27+
'error',
28+
'Only application project types are support by this schematic.' + type
29+
? ` Project "${options.project}" has a "projectType" of "${type}".`
30+
: ` Project "${options.project}" has no "projectType" defined.`,
31+
);
32+
}
33+
34+
const buildTarget = project.targets.get('build');
35+
if (!buildTarget) {
36+
return log(
37+
'error',
38+
`No "build" target found for project "${options.project}".` +
39+
' A "build" target is required to generate environment files.',
40+
);
41+
}
42+
43+
const serverTarget = project.targets.get('server');
44+
45+
const sourceRoot = project.sourceRoot ?? path.join(project.root, 'src');
46+
47+
// The generator needs to be iterated prior to returning to ensure all workspace changes that occur
48+
// within the generator are present for `updateWorkspace` when it writes the workspace file.
49+
return chain([
50+
...generateConfigurationEnvironments(buildTarget, serverTarget, sourceRoot, options.project),
51+
]);
52+
});
53+
}
54+
55+
function createIfMissing(path: string): Rule {
56+
return (tree, context) => {
57+
if (tree.exists(path)) {
58+
context.logger.info(`Skipping creation of already existing environment file "${path}".`);
59+
} else {
60+
tree.create(path, ENVIRONMENT_FILE_CONTENT);
61+
}
62+
};
63+
}
64+
65+
function log(type: 'info' | 'warn' | 'error', text: string): Rule {
66+
return (_, context) => context.logger[type](text);
67+
}
68+
69+
function* generateConfigurationEnvironments(
70+
buildTarget: TargetDefinition,
71+
serverTarget: TargetDefinition | undefined,
72+
sourceRoot: string,
73+
projectName: string,
74+
): Iterable<Rule> {
75+
if (!buildTarget.builder.startsWith(AngularBuilder.Browser)) {
76+
yield log(
77+
'warn',
78+
`"build" target found for project "${projectName}" has a third-party builder "${buildTarget.builder}".` +
79+
' The generated project options may not be compatible with this builder.',
80+
);
81+
}
82+
83+
if (serverTarget && !serverTarget.builder.startsWith(AngularBuilder.Server)) {
84+
yield log(
85+
'warn',
86+
`"server" target found for project "${projectName}" has a third-party builder "${buildTarget.builder}".` +
87+
' The generated project options may not be compatible with this builder.',
88+
);
89+
}
90+
91+
// Create default environment file
92+
const defaultFilePath = path.join(sourceRoot, ENVIRONMENTS_DIRECTORY, 'environment.ts');
93+
yield createIfMissing(defaultFilePath);
94+
95+
const configurationEntries = [
96+
...Object.entries(buildTarget.configurations ?? {}),
97+
...Object.entries(serverTarget?.configurations ?? {}),
98+
];
99+
100+
const addedFiles = new Set<string>();
101+
for (const [name, configurationOptions] of configurationEntries) {
102+
if (!configurationOptions) {
103+
// Invalid configuration
104+
continue;
105+
}
106+
107+
// Default configuration will use the default environment file
108+
if (name === buildTarget.defaultConfiguration) {
109+
continue;
110+
}
111+
112+
const configurationFilePath = path.join(
113+
sourceRoot,
114+
ENVIRONMENTS_DIRECTORY,
115+
`environment.${name}.ts`,
116+
);
117+
118+
// Add file replacement option entry for the configuration environment file
119+
const replacements = (configurationOptions['fileReplacements'] ??= []) as {
120+
replace: string;
121+
with: string;
122+
}[];
123+
const existing = replacements.find((value) => value.replace === defaultFilePath);
124+
if (existing) {
125+
if (existing.with === configurationFilePath) {
126+
yield log(
127+
'info',
128+
`Skipping addition of already existing file replacements option for "${defaultFilePath}" to "${configurationFilePath}".`,
129+
);
130+
} else {
131+
yield log(
132+
'warn',
133+
`Configuration "${name}" has a file replacements option for "${defaultFilePath}" but with a different replacement.` +
134+
` Expected "${configurationFilePath}" but found "${existing.with}". This may result in unexpected build behavior.`,
135+
);
136+
}
137+
} else {
138+
replacements.push({ replace: defaultFilePath, with: configurationFilePath });
139+
}
140+
141+
// Create configuration specific environment file if not already added
142+
if (!addedFiles.has(configurationFilePath)) {
143+
addedFiles.add(configurationFilePath);
144+
yield createIfMissing(configurationFilePath);
145+
}
146+
}
147+
}

‎packages/schematics/angular/environments/index_spec.ts‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
/**
2+
* @license
3+
* Copyright Google LLC All Rights Reserved.
4+
*
5+
* Use of this source code is governed by an MIT-style license that can be
6+
* found in the LICENSE file at https://angular.io/license
7+
*/
8+
9+
import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
10+
import { Schema as ApplicationOptions } from '../application/schema';
11+
import { Schema as WorkspaceOptions } from '../workspace/schema';
12+
import { Schema as EnvironmentOptions } from './schema';
13+
14+
describe('Application Schematic', () => {
15+
const schematicRunner = new SchematicTestRunner(
16+
'@schematics/angular',
17+
require.resolve('../collection.json'),
18+
);
19+
20+
const workspaceOptions: WorkspaceOptions = {
21+
name: 'workspace',
22+
newProjectRoot: 'projects',
23+
version: '15.0.0',
24+
};
25+
26+
const defaultOptions: EnvironmentOptions = {
27+
project: 'foo',
28+
};
29+
30+
const defaultAppOptions: ApplicationOptions = {
31+
name: 'foo',
32+
inlineStyle: true,
33+
inlineTemplate: true,
34+
routing: false,
35+
skipPackageJson: false,
36+
minimal: true,
37+
};
38+
39+
let applicationTree: UnitTestTree;
40+
const messages: string[] = [];
41+
schematicRunner.logger.subscribe((x) => messages.push(x.message));
42+
43+
function runEnvironmentsSchematic(): Promise<UnitTestTree> {
44+
return schematicRunner.runSchematic('environments', defaultOptions, applicationTree);
45+
}
46+
47+
beforeEach(async () => {
48+
messages.length = 0;
49+
const workspaceTree = await schematicRunner.runSchematic('workspace', workspaceOptions);
50+
applicationTree = await schematicRunner.runSchematic(
51+
'application',
52+
defaultAppOptions,
53+
workspaceTree,
54+
);
55+
});
56+
57+
it('should create a default environment typescript file', async () => {
58+
const tree = await runEnvironmentsSchematic();
59+
expect(tree.readText('projects/foo/src/environments/environment.ts')).toEqual(
60+
'export const environment = {};\n',
61+
);
62+
});
63+
64+
it('should create a development configuration environment typescript file', async () => {
65+
const tree = await runEnvironmentsSchematic();
66+
expect(tree.readText('projects/foo/src/environments/environment.development.ts')).toEqual(
67+
'export const environment = {};\n',
68+
);
69+
});
70+
71+
it('should create environment typescript files for additional configurations', async () => {
72+
const initialWorkspace = JSON.parse(applicationTree.readContent('/angular.json'));
73+
initialWorkspace.projects.foo.architect.build.configurations.staging = {};
74+
applicationTree.overwrite('/angular.json', JSON.stringify(initialWorkspace));
75+
76+
const tree = await runEnvironmentsSchematic();
77+
expect(tree.readText('projects/foo/src/environments/environment.development.ts')).toEqual(
78+
'export const environment = {};\n',
79+
);
80+
81+
expect(tree.readText('projects/foo/src/environments/environment.staging.ts')).toEqual(
82+
'export const environment = {};\n',
83+
);
84+
});
85+
86+
it('should update the angular.json file replacements option for the development configuration', async () => {
87+
const tree = await runEnvironmentsSchematic();
88+
const workspace = JSON.parse(tree.readContent('/angular.json'));
89+
90+
const developmentConfiguration =
91+
workspace.projects.foo.architect.build.configurations.development;
92+
expect(developmentConfiguration).toEqual(
93+
jasmine.objectContaining({
94+
fileReplacements: [
95+
{
96+
replace: 'projects/foo/src/environments/environment.ts',
97+
with: 'projects/foo/src/environments/environment.development.ts',
98+
},
99+
],
100+
}),
101+
);
102+
});
103+
104+
it('should update the angular.json file replacements option for additional configurations', async () => {
105+
const initialWorkspace = JSON.parse(applicationTree.readContent('/angular.json'));
106+
initialWorkspace.projects.foo.architect.build.configurations.staging = {};
107+
applicationTree.overwrite('/angular.json', JSON.stringify(initialWorkspace));
108+
109+
const tree = await runEnvironmentsSchematic();
110+
const workspace = JSON.parse(tree.readContent('/angular.json'));
111+
112+
const developmentConfiguration =
113+
workspace.projects.foo.architect.build.configurations.development;
114+
expect(developmentConfiguration).toEqual(
115+
jasmine.objectContaining({
116+
fileReplacements: [
117+
{
118+
replace: 'projects/foo/src/environments/environment.ts',
119+
with: 'projects/foo/src/environments/environment.development.ts',
120+
},
121+
],
122+
}),
123+
);
124+
125+
const stagingConfiguration = workspace.projects.foo.architect.build.configurations.staging;
126+
expect(stagingConfiguration).toEqual(
127+
jasmine.objectContaining({
128+
fileReplacements: [
129+
{
130+
replace: 'projects/foo/src/environments/environment.ts',
131+
with: 'projects/foo/src/environments/environment.staging.ts',
132+
},
133+
],
134+
}),
135+
);
136+
});
137+
138+
it('should update the angular.json file replacements option for server configurations', async () => {
139+
await schematicRunner.runSchematic(
140+
'universal',
141+
{ project: 'foo', skipInstall: true },
142+
applicationTree,
143+
);
144+
145+
const tree = await runEnvironmentsSchematic();
146+
const workspace = JSON.parse(tree.readContent('/angular.json'));
147+
148+
const developmentConfiguration =
149+
workspace.projects.foo.architect.build.configurations.development;
150+
expect(developmentConfiguration).toEqual(
151+
jasmine.objectContaining({
152+
fileReplacements: [
153+
{
154+
replace: 'projects/foo/src/environments/environment.ts',
155+
with: 'projects/foo/src/environments/environment.development.ts',
156+
},
157+
],
158+
}),
159+
);
160+
161+
const serverDevelopmentConfiguration =
162+
workspace.projects.foo.architect.server.configurations.development;
163+
expect(serverDevelopmentConfiguration).toEqual(
164+
jasmine.objectContaining({
165+
fileReplacements: [
166+
{
167+
replace: 'projects/foo/src/environments/environment.ts',
168+
with: 'projects/foo/src/environments/environment.development.ts',
169+
},
170+
],
171+
}),
172+
);
173+
});
174+
});

‎packages/schematics/angular/environments/schema.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema",
3+
"$id": "SchematicsAngularEnvironment",
4+
"title": "Angular Environments Options Schema",
5+
"type": "object",
6+
"additionalProperties": false,
7+
"description": "Generates and configures environment files for a project.",
8+
"properties": {
9+
"project": {
10+
"type": "string",
11+
"description": "The name of the project.",
12+
"$default": {
13+
"$source": "projectName"
14+
}
15+
}
16+
},
17+
"required": ["project"]
18+
}

0 commit comments

Comments
 (0)