forked from angular/angular-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommand-runner.ts
More file actions
241 lines (208 loc) · 6.78 KB
/
Copy pathcommand-runner.ts
File metadata and controls
241 lines (208 loc) · 6.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/**
* @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 {
JsonParseMode,
analytics,
isJsonObject,
json,
logging,
schema,
strings,
tags,
} from '@angular-devkit/core';
import * as debug from 'debug';
import { readFileSync } from 'fs';
import { dirname, join, resolve } from 'path';
import { findUp } from '../utilities/find-up';
import { parseJsonSchemaToCommandDescription } from '../utilities/json-schema';
import { UniversalAnalytics, getGlobalAnalytics, getSharedAnalytics } from './analytics';
import { Command } from './command';
import {
CommandDescription,
CommandDescriptionMap,
CommandWorkspace,
} from './interface';
import * as parser from './parser';
const analyticsDebug = debug('ng:analytics:commands');
export interface CommandMapOptions {
[key: string]: string;
}
/**
* Create the analytics instance.
* @private
*/
async function _createAnalytics(): Promise<analytics.Analytics> {
const config = getGlobalAnalytics();
const maybeSharedAnalytics = getSharedAnalytics();
if (config && maybeSharedAnalytics) {
return new analytics.MultiAnalytics([config, maybeSharedAnalytics]);
} else if (config) {
return config;
} else if (maybeSharedAnalytics) {
return maybeSharedAnalytics;
} else {
return new analytics.NoopAnalytics();
}
}
/**
* Run a command.
* @param args Raw unparsed arguments.
* @param logger The logger to use.
* @param workspace Workspace information.
* @param commands The map of supported commands.
* @param options Additional options.
*/
export async function runCommand(
args: string[],
logger: logging.Logger,
workspace: CommandWorkspace,
commands?: CommandMapOptions,
options: { analytics?: analytics.Analytics } = {},
): Promise<number | void> {
if (commands === undefined) {
const commandMapPath = findUp('commands.json', __dirname);
if (commandMapPath === null) {
throw new Error('Unable to find command map.');
}
const cliDir = dirname(commandMapPath);
const commandsText = readFileSync(commandMapPath).toString('utf-8');
const commandJson = json.parseJson(
commandsText,
JsonParseMode.Loose,
{ path: commandMapPath },
);
if (!isJsonObject(commandJson)) {
throw Error('Invalid command.json');
}
commands = {};
for (const commandName of Object.keys(commandJson)) {
const commandValue = commandJson[commandName];
if (typeof commandValue == 'string') {
commands[commandName] = resolve(cliDir, commandValue);
}
}
}
// This registry is exclusively used for flattening schemas, and not for validating.
const registry = new schema.CoreSchemaRegistry([]);
registry.registerUriHandler((uri: string) => {
if (uri.startsWith('ng-cli://')) {
const content = readFileSync(join(__dirname, '..', uri.substr('ng-cli://'.length)), 'utf-8');
return Promise.resolve(JSON.parse(content));
} else {
return null;
}
});
// Normalize the commandMap
const commandMap: CommandDescriptionMap = {};
for (const name of Object.keys(commands)) {
const schemaPath = commands[name];
const schemaContent = readFileSync(schemaPath, 'utf-8');
const schema = json.parseJson(schemaContent, JsonParseMode.Loose, { path: schemaPath });
if (!isJsonObject(schema)) {
throw new Error('Invalid command JSON loaded from ' + JSON.stringify(schemaPath));
}
commandMap[name] =
await parseJsonSchemaToCommandDescription(name, schemaPath, registry, schema);
}
let commandName: string | undefined = undefined;
for (let i = 0; i < args.length; i++) {
const arg = args[i];
if (arg in commandMap) {
commandName = arg;
args.splice(i, 1);
break;
} else if (!arg.startsWith('-')) {
commandName = arg;
args.splice(i, 1);
break;
}
}
// if no commands were found, use `help`.
if (commandName === undefined) {
if (args.length === 1 && args[0] === '--version') {
commandName = 'version';
} else {
commandName = 'help';
}
}
let description: CommandDescription | null = null;
if (commandName !== undefined) {
if (commandMap[commandName]) {
description = commandMap[commandName];
} else {
Object.keys(commandMap).forEach(name => {
const commandDescription = commandMap[name];
const aliases = commandDescription.aliases;
let found = false;
if (aliases) {
if (aliases.some(alias => alias === commandName)) {
found = true;
}
}
if (found) {
if (description) {
throw new Error('Found multiple commands with the same alias.');
}
commandName = name;
description = commandDescription;
}
});
}
}
if (!commandName) {
logger.error(tags.stripIndent`
We could not find a command from the arguments and the help command seems to be disabled.
This is an issue with the CLI itself. If you see this comment, please report it and
provide your repository.
`);
return 1;
}
if (!description) {
const commandsDistance = {} as { [name: string]: number };
const name = commandName;
const allCommands = Object.keys(commandMap).sort((a, b) => {
if (!(a in commandsDistance)) {
commandsDistance[a] = strings.levenshtein(a, name);
}
if (!(b in commandsDistance)) {
commandsDistance[b] = strings.levenshtein(b, name);
}
return commandsDistance[a] - commandsDistance[b];
});
logger.error(tags.stripIndent`
The specified command ("${commandName}") is invalid. For a list of available options,
run "ng help".
Did you mean "${allCommands[0]}"?
`);
return 1;
}
try {
const parsedOptions = parser.parseArguments(args, description.options, logger);
Command.setCommandMap(commandMap);
const analytics = options.analytics || await _createAnalytics();
const context = { workspace, analytics };
const command = new description.impl(context, description, logger);
// Flush on an interval (if the event loop is waiting).
let analyticsFlushPromise = Promise.resolve();
setInterval(() => {
analyticsFlushPromise = analyticsFlushPromise.then(() => analytics.flush());
}, 1000);
const result = await command.validateAndRun(parsedOptions);
// Flush one last time.
await analyticsFlushPromise.then(() => analytics.flush());
return result;
} catch (e) {
if (e instanceof parser.ParseArgumentException) {
logger.fatal('Cannot parse arguments. See below for the reasons.');
logger.fatal(' ' + e.comments.join('\n '));
return 1;
} else {
throw e;
}
}
}