mirror of
https://github.com/angular/angular-cli.git
synced 2025-05-16 18:43:42 +08:00
82ec1af4e1
Currently, we don't register all available commands. For instance, when the CLI is ran inside a workspace the `new` command is not registered. Thus, this will cause a confusing error message when `ng new` is ran inside a workspace. Example: ``` $ ng new Error: Unknown command. Did you mean e? ``` With this commit we change this by registering all the commands and valid the command scope during the command building phase which is only triggered once the command is invoked but prior to the execution phase.
112 lines
3.5 KiB
TypeScript
112 lines
3.5 KiB
TypeScript
/**
|
|
* @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 { Argv } from 'yargs';
|
|
import {
|
|
CommandModuleImplementation,
|
|
CommandScope,
|
|
Options,
|
|
OtherOptions,
|
|
} from '../../command-builder/command-module';
|
|
import {
|
|
DEFAULT_SCHEMATICS_COLLECTION,
|
|
SchematicsCommandArgs,
|
|
SchematicsCommandModule,
|
|
} from '../../command-builder/schematics-command-module';
|
|
import { VERSION } from '../../utilities/version';
|
|
|
|
interface NewCommandArgs extends SchematicsCommandArgs {
|
|
collection?: string;
|
|
}
|
|
|
|
export class NewCommandModule
|
|
extends SchematicsCommandModule
|
|
implements CommandModuleImplementation<NewCommandArgs>
|
|
{
|
|
private readonly schematicName = 'ng-new';
|
|
override scope = CommandScope.Out;
|
|
protected override allowPrivateSchematics = true;
|
|
|
|
command = 'new [name]';
|
|
aliases = 'n';
|
|
describe = 'Creates a new Angular workspace.';
|
|
longDescriptionPath?: string | undefined;
|
|
|
|
override async builder(argv: Argv): Promise<Argv<NewCommandArgs>> {
|
|
const localYargs = (await super.builder(argv)).option('collection', {
|
|
alias: 'c',
|
|
describe: 'A collection of schematics to use in generating the initial application.',
|
|
type: 'string',
|
|
});
|
|
|
|
const {
|
|
options: { collectionNameFromArgs },
|
|
} = this.context.args;
|
|
|
|
const collectionName =
|
|
typeof collectionNameFromArgs === 'string'
|
|
? collectionNameFromArgs
|
|
: await this.getCollectionFromConfig();
|
|
|
|
const workflow = await this.getOrCreateWorkflowForBuilder(collectionName);
|
|
const collection = workflow.engine.createCollection(collectionName);
|
|
const options = await this.getSchematicOptions(collection, this.schematicName, workflow);
|
|
|
|
return this.addSchemaOptionsToCommand(localYargs, options);
|
|
}
|
|
|
|
async run(options: Options<NewCommandArgs> & OtherOptions): Promise<number | void> {
|
|
// Register the version of the CLI in the registry.
|
|
const collectionName = options.collection ?? (await this.getCollectionFromConfig());
|
|
const { dryRun, force, interactive, defaults, collection, ...schematicOptions } = options;
|
|
const workflow = await this.getOrCreateWorkflowForExecution(collectionName, {
|
|
dryRun,
|
|
force,
|
|
interactive,
|
|
defaults,
|
|
});
|
|
workflow.registry.addSmartDefaultProvider('ng-cli-version', () => VERSION.full);
|
|
|
|
// Compatibility check for NPM 7
|
|
if (
|
|
collectionName === '@schematics/angular' &&
|
|
!schematicOptions.skipInstall &&
|
|
(schematicOptions.packageManager === undefined || schematicOptions.packageManager === 'npm')
|
|
) {
|
|
this.context.packageManager.ensureCompatibility();
|
|
}
|
|
|
|
return this.runSchematic({
|
|
collectionName,
|
|
schematicName: this.schematicName,
|
|
schematicOptions,
|
|
executionOptions: {
|
|
dryRun,
|
|
force,
|
|
interactive,
|
|
defaults,
|
|
},
|
|
});
|
|
}
|
|
|
|
/** Find a collection from config that has an `ng-new` schematic. */
|
|
private async getCollectionFromConfig(): Promise<string> {
|
|
for (const collectionName of await this.getSchematicCollections()) {
|
|
const workflow = this.getOrCreateWorkflowForBuilder(collectionName);
|
|
const collection = workflow.engine.createCollection(collectionName);
|
|
const schematicsInCollection = collection.description.schematics;
|
|
|
|
if (Object.keys(schematicsInCollection).includes(this.schematicName)) {
|
|
return collectionName;
|
|
}
|
|
}
|
|
|
|
return DEFAULT_SCHEMATICS_COLLECTION;
|
|
}
|
|
}
|