Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-17 19:13:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: make the cli testable

Browse Source
This commit is contained in:
Alan Agius 2018-09-14 09:34:53 +02:00 committed by Hans
parent 1753b6affb
commit 40129ccebd
1 changed files with 218 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

243
packages/angular_devkit/schematics_cli/bin/schematics.ts
View File

@ -17,7 +17,7 @@ import {
terminal, terminal,
virtualFs, virtualFs,
} from '@angular-devkit/core'; } from '@angular-devkit/core';
import { NodeJsSyncHost, createConsoleLogger } from '@angular-devkit/core/node'; import { NodeJsSyncHost, ProcessOutput, createConsoleLogger } from '@angular-devkit/core/node';
import { import {
DryRunEvent, DryRunEvent,
SchematicEngine, SchematicEngine,
@ -31,42 +31,6 @@ import {
import * as minimist from 'minimist'; import * as minimist from 'minimist';
/**
* Show usage of the CLI tool, and exit the process.
*/
function usage(exitCode = 0): never {
logger.info(tags.stripIndent`
schematics [CollectionName:]SchematicName [options, ...]
By default, if the collection name is not specified, use the internal collection provided
by the Schematics CLI.
Options:
--debug Debug mode. This is true by default if the collection is a relative
path (in that case, turn off with --debug=false).
--allowPrivate Allow private schematics to be run from the command line. Default to
false.
--dry-run Do not output anything, but instead just show what actions would be
performed. Default to true if debug is also true.
--force Force overwriting files that would otherwise be an error.
--list-schematics List all schematics from the collection, by name. A collection name
should be suffixed by a colon. Example: '@schematics/schematics:'.
--verbose Show more information.
--help Show this message.
Any additional option is passed to the Schematics depending on
`);
return process.exit(exitCode);
}
/** /**
* Parse the name of schematic passed in argument, and return a {collection, schematic} named * Parse the name of schematic passed in argument, and return a {collection, schematic} named
* tuple. The user can pass in `collection-name:schematic-name`, and this function will either * tuple. The user can pass in `collection-name:schematic-name`, and this function will either
@ -81,7 +45,7 @@ function usage(exitCode = 0): never {
* @param str The argument to parse. * @param str The argument to parse.
* @return {{collection: string, schematic: (string)}} * @return {{collection: string, schematic: (string)}}
*/ */
function parseSchematicName(str: string | null): { collection: string, schematic: string | null} { function parseSchematicName(str: string | null): { collection: string, schematic: string | null } {
let collection = '@schematics/schematics'; let collection = '@schematics/schematics';
let schematic = str; let schematic = str;
@ -93,8 +57,20 @@ function parseSchematicName(str: string | null): { collection: string, schematic
} }
/** Parse the command line. */ export interface MainOptions {
const booleanArgs = [ args: string[];
stdout?: ProcessOutput;
stderr?: ProcessOutput;
}
export async function main({
args,
stdout = process.stdout,
stderr = process.stderr,
}: MainOptions): Promise<0 | 1> {
/** Parse the command line. */
const booleanArgs = [
'allowPrivate', 'allowPrivate',
'debug', 'debug',
'dry-run', 'dry-run',
@ -102,33 +78,35 @@ const booleanArgs = [
'help', 'help',
'list-schematics', 'list-schematics',
'verbose', 'verbose',
]; ];
const argv = minimist(process.argv.slice(2), { const argv = minimist(args, {
boolean: booleanArgs, boolean: booleanArgs,
default: { default: {
'debug': null, 'debug': null,
'dry-run': null, 'dry-run': null,
}, },
'--': true, '--': true,
}); });
/** Create the DevKit Logger used through the CLI. */ /** Create the DevKit Logger used through the CLI. */
const logger = createConsoleLogger(argv['verbose']); const logger = createConsoleLogger(argv['verbose'], stdout, stderr);
if (argv.help) { if (argv.help) {
usage(); logger.info(getUsage());
}
/** Get the collection an schematic name from the first argument. */ return 0;
const { }
/** Get the collection an schematic name from the first argument. */
const {
collection: collectionName, collection: collectionName,
schematic: schematicName, schematic: schematicName,
} = parseSchematicName(argv._.shift() || null); } = parseSchematicName(argv._.shift() || null);
const isLocalCollection = collectionName.startsWith('.') || collectionName.startsWith('/'); const isLocalCollection = collectionName.startsWith('.') || collectionName.startsWith('/');
/** If the user wants to list schematics, we simply show all the schematic names. */ /** If the user wants to list schematics, we simply show all the schematic names. */
if (argv['list-schematics']) { if (argv['list-schematics']) {
const engineHost = isLocalCollection const engineHost = isLocalCollection
? new FileSystemEngineHost(normalize(process.cwd())) ? new FileSystemEngineHost(normalize(process.cwd()))
: new NodeModulesEngineHost(); : new NodeModulesEngineHost();
@ -137,36 +115,37 @@ if (argv['list-schematics']) {
const collection = engine.createCollection(collectionName); const collection = engine.createCollection(collectionName);
logger.info(engine.listSchematicNames(collection).join('\n')); logger.info(engine.listSchematicNames(collection).join('\n'));
process.exit(0); return 0;
} }
if (!schematicName) { if (!schematicName) {
usage(1); logger.info(getUsage());
throw 0; // TypeScript doesn't know that process.exit() never returns.
}
/** Gather the arguments for later use. */ return 1;
const debug: boolean = argv.debug === null ? isLocalCollection : argv.debug; }
const dryRun: boolean = argv['dry-run'] === null ? debug : argv['dry-run'];
const force = argv['force'];
const allowPrivate = argv['allowPrivate'];
/** Create a Virtual FS Host scoped to where the process is being run. **/ /** Gather the arguments for later use. */
const fsHost = new virtualFs.ScopedHost(new NodeJsSyncHost(), normalize(process.cwd())); const debug: boolean = argv.debug === null ? isLocalCollection : argv.debug;
const dryRun: boolean = argv['dry-run'] === null ? debug : argv['dry-run'];
const force = argv['force'];
const allowPrivate = argv['allowPrivate'];
/** Create the workflow that will be executed with this run. */ /** Create a Virtual FS Host scoped to where the process is being run. **/
const workflow = new NodeWorkflow(fsHost, { force, dryRun }); const fsHost = new virtualFs.ScopedHost(new NodeJsSyncHost(), normalize(process.cwd()));
// Indicate to the user when nothing has been done. This is automatically set to off when there's /** Create the workflow that will be executed with this run. */
// a new DryRunEvent. const workflow = new NodeWorkflow(fsHost, { force, dryRun });
let nothingDone = true;
// Logging queue that receives all the messages to show the users. This only get shown when no // Indicate to the user when nothing has been done. This is automatically set to off when there's
// errors happened. // a new DryRunEvent.
let loggingQueue: string[] = []; let nothingDone = true;
let error = false;
/** // Logging queue that receives all the messages to show the users. This only get shown when no
// errors happened.
let loggingQueue: string[] = [];
let error = false;
/**
* Logs out dry run events. * Logs out dry run events.
* *
* All events will always be executed here, in order of discovery. That means that an error would * All events will always be executed here, in order of discovery. That means that an error would
@ -176,7 +155,7 @@ let error = false;
* *
* This is a simple way to only show errors when an error occur. * This is a simple way to only show errors when an error occur.
*/ */
workflow.reporter.subscribe((event: DryRunEvent) => { workflow.reporter.subscribe((event: DryRunEvent) => {
nothingDone = false; nothingDone = false;
switch (event.kind) { switch (event.kind) {
@ -203,13 +182,13 @@ workflow.reporter.subscribe((event: DryRunEvent) => {
loggingQueue.push(`${terminal.blue('RENAME')} ${event.path} => ${event.to}`); loggingQueue.push(`${terminal.blue('RENAME')} ${event.path} => ${event.to}`);
break; break;
} }
}); });
/** /**
* Listen to lifecycle events of the workflow to flush the logs between each phases. * Listen to lifecycle events of the workflow to flush the logs between each phases.
*/ */
workflow.lifeCycle.subscribe(event => { workflow.lifeCycle.subscribe(event => {
if (event.kind == 'workflow-end' || event.kind == 'post-tasks-start') { if (event.kind == 'workflow-end' || event.kind == 'post-tasks-start') {
if (!error) { if (!error) {
// Flush the log queue and clean the error state. // Flush the log queue and clean the error state.
@ -219,38 +198,38 @@ workflow.lifeCycle.subscribe(event => {
loggingQueue = []; loggingQueue = [];
error = false; error = false;
} }
}); });
/** /**
* Remove every options from argv that we support in schematics itself. * Remove every options from argv that we support in schematics itself.
*/ */
const args = Object.assign({}, argv); const parsedArgs = Object.assign({}, argv);
delete args['--']; delete parsedArgs['--'];
for (const key of booleanArgs) { for (const key of booleanArgs) {
delete args[key]; delete parsedArgs[key];
} }
/** /**
* Add options from `--` to args. * Add options from `--` to args.
*/ */
const argv2 = minimist(argv['--']); const argv2 = minimist(argv['--']);
for (const key of Object.keys(argv2)) { for (const key of Object.keys(argv2)) {
args[key] = argv2[key]; parsedArgs[key] = argv2[key];
} }
// Pass the rest of the arguments as the smart default "argv". Then delete it. // Pass the rest of the arguments as the smart default "argv". Then delete it.
workflow.registry.addSmartDefaultProvider('argv', (schema: JsonObject) => { workflow.registry.addSmartDefaultProvider('argv', (schema: JsonObject) => {
if ('index' in schema) { if ('index' in schema) {
return argv._[Number(schema['index'])]; return argv._[Number(schema['index'])];
} else { } else {
return argv._; return argv._;
} }
}); });
delete args._; delete parsedArgs._;
/** /**
* Execute the workflow, which will report the dry run events, run the tasks, and complete * Execute the workflow, which will report the dry run events, run the tasks, and complete
* after all is done. * after all is done.
* *
@ -258,17 +237,24 @@ delete args._;
* step of the workflow failed (sink or task), with details included, and will only complete * step of the workflow failed (sink or task), with details included, and will only complete
* when everything is done. * when everything is done.
*/ */
workflow.execute({ try {
await workflow.execute({
collection: collectionName, collection: collectionName,
schematic: schematicName, schematic: schematicName,
options: args, options: parsedArgs,
allowPrivate: allowPrivate, allowPrivate: allowPrivate,
debug: debug, debug: debug,
logger: logger, logger: logger,
}) })
.subscribe({ .toPromise();
error(err: Error) {
// In case the workflow was not successful, show an appropriate error message. if (nothingDone) {
logger.info('Nothing to be done.');
}
return 0;
} catch (err) {
if (err instanceof UnsuccessfulWorkflowExecution) { if (err instanceof UnsuccessfulWorkflowExecution) {
// "See above" because we already printed the error. // "See above" because we already printed the error.
logger.fatal('The Schematic workflow failed. See above.'); logger.fatal('The Schematic workflow failed. See above.');
@ -278,11 +264,46 @@ workflow.execute({
logger.fatal(err.stack || err.message); logger.fatal(err.stack || err.message);
} }
process.exit(1); return 1;
},
complete() {
if (nothingDone) {
logger.info('Nothing to be done.');
} }
}, }
});
/**
* Get usage of the CLI tool.
*/
function getUsage(): string {
return tags.stripIndent`
schematics [CollectionName:]SchematicName [options, ...]
By default, if the collection name is not specified, use the internal collection provided
by the Schematics CLI.
Options:
--debug Debug mode. This is true by default if the collection is a relative
path (in that case, turn off with --debug=false).
--allowPrivate Allow private schematics to be run from the command line. Default to
false.
--dry-run Do not output anything, but instead just show what actions would be
performed. Default to true if debug is also true.
--force Force overwriting files that would otherwise be an error.
--list-schematics List all schematics from the collection, by name. A collection name
should be suffixed by a colon. Example: '@schematics/schematics:'.
--verbose Show more information.
--help Show this message.
Any additional option is passed to the Schematics depending on
`;
}
if (require.main === module) {
const args = process.argv.slice(2);
main({ args })
.then(exitCode => process.exitCode = exitCode)
.catch(e => { throw (e); });
}