Changing front

This commit is contained in:
2023-01-16 17:49:38 +01:00
parent 0b8a93b256
commit 4fe4be7730
48586 changed files with 4725790 additions and 17464 deletions
+21
View File
@@ -0,0 +1,21 @@
The MIT License
Copyright (c) 2017 Google, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+5
View File
@@ -0,0 +1,5 @@
# Angular CLI - The CLI tool for Angular.
The sources for this package are in the [Angular CLI](https://github.com/angular/angular-cli) repository. Please file issues and pull requests against that repository.
Usage information and reference details can be found in repository [README](../../../README.md) file.
+21
View File
@@ -0,0 +1,21 @@
/**
* @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
*/
/**
* @fileoverview
*
* This file is used to bootstrap the CLI process by dynamically importing the main initialization code.
* This is done to allow the main bin file (`ng`) to remain CommonJS so that older versions of Node.js
* can be checked and validated prior to the execution of the CLI. This separate bootstrap file is
* needed to allow the use of a dynamic import expression without crashing older versions of Node.js that
* do not support dynamic import expressions and would otherwise throw a syntax error. This bootstrap file
* is required from the main bin file only after the Node.js version is determined to be in the supported
* range.
*/
import('../lib/init.js');
+66
View File
@@ -0,0 +1,66 @@
#!/usr/bin/env node
/**
* @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
*/
/* eslint-disable no-console */
/* eslint-disable import/no-unassigned-import */
'use strict';
// Provide a title to the process in `ps`.
// Due to an obscure Mac bug, do not start this title with any symbol.
try {
process.title = 'ng ' + Array.from(process.argv).slice(2).join(' ');
} catch (_) {
// If an error happened above, use the most basic title.
process.title = 'ng';
}
const rawCommandName = process.argv[2];
if (rawCommandName === '--get-yargs-completions' || rawCommandName === 'completion') {
// Skip Node.js supported checks when running ng completion.
// A warning at this stage could cause a broken source action (`source <(ng completion script)`) when in the shell init script.
require('./bootstrap');
return;
}
// This node version check ensures that extremely old versions of node are not used.
// These may not support ES2015 features such as const/let/async/await/etc.
// These would then crash with a hard to diagnose error message.
var version = process.versions.node.split('.').map((part) => Number(part));
if (version[0] % 2 === 1) {
// Allow new odd numbered releases with a warning (currently v17+)
console.warn(
'Node.js version ' +
process.version +
' detected.\n' +
'Odd numbered Node.js versions will not enter LTS status and should not be used for production.' +
' For more information, please see https://nodejs.org/en/about/releases/.',
);
require('./bootstrap');
} else if (
version[0] < 14 ||
(version[0] === 14 && version[1] < 20) ||
(version[0] === 16 && version[1] < 13) ||
(version[0] === 18 && version[1] < 10)
) {
// Error and exit if less than 14.20, 16.13 or 18.10
console.error(
'Node.js version ' +
process.version +
' detected.\n' +
'The Angular CLI requires a minimum Node.js version of either v14.20, v16.13 or v18.10.\n\n' +
'Please update your Node.js version or visit https://nodejs.org/ for additional instructions.\n',
);
process.exitCode = 3;
} else {
require('./bootstrap');
}
+3
View File
@@ -0,0 +1,3 @@
{
"type": "commonjs"
}
+11
View File
@@ -0,0 +1,11 @@
/**
* @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
*/
export { VERSION } from '../../src/utilities/version';
export default function (options: {
cliArgs: string[];
}): Promise<number>;
+107
View File
@@ -0,0 +1,107 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.VERSION = void 0;
const core_1 = require("@angular-devkit/core");
const util_1 = require("util");
const command_module_1 = require("../../src/command-builder/command-module");
const command_runner_1 = require("../../src/command-builder/command-runner");
const color_1 = require("../../src/utilities/color");
const environment_options_1 = require("../../src/utilities/environment-options");
const log_file_1 = require("../../src/utilities/log-file");
var version_1 = require("../../src/utilities/version");
Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_1.VERSION; } });
const MIN_NODEJS_VERISON = [14, 15];
/* eslint-disable no-console */
async function default_1(options) {
// This node version check ensures that the requirements of the project instance of the CLI are met
const [major, minor] = process.versions.node.split('.').map((part) => Number(part));
if (major < MIN_NODEJS_VERISON[0] ||
(major === MIN_NODEJS_VERISON[0] && minor < MIN_NODEJS_VERISON[1])) {
process.stderr.write(`Node.js version ${process.version} detected.\n` +
`The Angular CLI requires a minimum of v${MIN_NODEJS_VERISON[0]}.${MIN_NODEJS_VERISON[1]}.\n\n` +
'Please update your Node.js version or visit https://nodejs.org/ for additional instructions.\n');
return 3;
}
const colorLevels = {
info: (s) => s,
debug: (s) => s,
warn: (s) => color_1.colors.bold.yellow(s),
error: (s) => color_1.colors.bold.red(s),
fatal: (s) => color_1.colors.bold.red(s),
};
const logger = new core_1.logging.IndentLogger('cli-main-logger');
const logInfo = console.log;
const logError = console.error;
const loggerFinished = logger.forEach((entry) => {
if (!environment_options_1.ngDebug && entry.level === 'debug') {
return;
}
const color = color_1.colors.enabled ? colorLevels[entry.level] : color_1.removeColor;
const message = color(entry.message);
switch (entry.level) {
case 'warn':
case 'fatal':
case 'error':
logError(message);
break;
default:
logInfo(message);
break;
}
});
// Redirect console to logger
console.info = console.log = function (...args) {
logger.info((0, util_1.format)(...args));
};
console.warn = function (...args) {
logger.warn((0, util_1.format)(...args));
};
console.error = function (...args) {
logger.error((0, util_1.format)(...args));
};
try {
return await (0, command_runner_1.runCommand)(options.cliArgs, logger);
}
catch (err) {
if (err instanceof command_module_1.CommandModuleError) {
logger.fatal(`Error: ${err.message}`);
}
else if (err instanceof Error) {
try {
const logPath = (0, log_file_1.writeErrorToLogFile)(err);
logger.fatal(`An unhandled exception occurred: ${err.message}\n` +
`See "${logPath}" for further details.`);
}
catch (e) {
logger.fatal(`An unhandled exception occurred: ${err.message}\n` +
`Fatal error writing debug log file: ${e}`);
if (err.stack) {
logger.fatal(err.stack);
}
}
return 127;
}
else if (typeof err === 'string') {
logger.fatal(err);
}
else if (typeof err === 'number') {
// Log nothing.
}
else {
logger.fatal(`An unexpected error occurred: ${err}`);
}
return 1;
}
finally {
logger.complete();
await loggerFinished;
}
}
exports.default = default_1;
File diff suppressed because it is too large Load Diff
+721
View File
@@ -0,0 +1,721 @@
export interface Schema {
$schema?: string;
cli?: CliOptions;
/**
* Default project name used in commands.
* @deprecated The project to use will be determined from the current working directory.
*/
defaultProject?: string;
/**
* Path where new projects will be created.
*/
newProjectRoot?: string;
projects?: Projects;
schematics?: SchematicOptions;
version: number;
}
export interface CliOptions {
/**
* Share pseudonymous usage data with the Angular Team at Google.
*/
analytics?: Analytics;
/**
* Control disk cache.
*/
cache?: Cache;
/**
* The default schematics collection to use.
*/
defaultCollection?: string;
/**
* Specify which package manager tool to use.
*/
packageManager?: PackageManager;
/**
* The list of schematic collections to use.
*/
schematicCollections?: string[];
/**
* Control CLI specific console warnings
*/
warnings?: Warnings;
}
/**
* Share pseudonymous usage data with the Angular Team at Google.
*/
export declare type Analytics = boolean | string;
/**
* Control disk cache.
*/
export interface Cache {
/**
* Configure whether disk caching is enabled.
*/
enabled?: boolean;
/**
* Configure in which environment disk cache is enabled.
*/
environment?: Environment;
/**
* Cache base path.
*/
path?: string;
}
/**
* Configure in which environment disk cache is enabled.
*/
export declare enum Environment {
All = "all",
Ci = "ci",
Local = "local"
}
/**
* Specify which package manager tool to use.
*
* The package manager used to install dependencies.
*/
export declare enum PackageManager {
Cnpm = "cnpm",
Npm = "npm",
Pnpm = "pnpm",
Yarn = "yarn"
}
/**
* Control CLI specific console warnings
*/
export interface Warnings {
/**
* Show a warning when the global version is newer than the local one.
*/
versionMismatch?: boolean;
}
export interface Projects {
}
export interface SchematicOptions {
"@schematics/angular:application"?: AngularApplicationOptionsSchema;
"@schematics/angular:class"?: AngularClassOptionsSchema;
"@schematics/angular:component"?: AngularComponentOptionsSchema;
"@schematics/angular:directive"?: AngularDirectiveOptionsSchema;
"@schematics/angular:enum"?: AngularEnumOptionsSchema;
"@schematics/angular:guard"?: AngularGuardOptionsSchema;
"@schematics/angular:interceptor"?: AngularInterceptorOptionsSchema;
"@schematics/angular:interface"?: AngularInterfaceOptionsSchema;
"@schematics/angular:library"?: LibraryOptionsSchema;
"@schematics/angular:ng-new"?: AngularNgNewOptionsSchema;
"@schematics/angular:pipe"?: AngularPipeOptionsSchema;
"@schematics/angular:resolver"?: AngularResolverOptionsSchema;
"@schematics/angular:service"?: AngularServiceOptionsSchema;
"@schematics/angular:web-worker"?: AngularWebWorkerOptionsSchema;
}
/**
* Generates a new basic application definition in the "projects" subfolder of the workspace.
*/
export interface AngularApplicationOptionsSchema {
/**
* Include styles inline in the root component.ts file. Only CSS styles can be included
* inline. Default is false, meaning that an external styles file is created and referenced
* in the root component.ts file.
*/
inlineStyle?: boolean;
/**
* Include template inline in the root component.ts file. Default is false, meaning that an
* external template file is created and referenced in the root component.ts file.
*/
inlineTemplate?: boolean;
/**
* Create a bare-bones project without any testing frameworks. (Use for learning purposes
* only.)
*/
minimal?: boolean;
/**
* The name of the new application.
*/
name: string;
/**
* A prefix to apply to generated selectors.
*/
prefix?: string;
/**
* The root directory of the new application.
*/
projectRoot?: string;
/**
* Create a routing NgModule.
*/
routing?: boolean;
/**
* Skip installing dependency packages.
*/
skipInstall?: boolean;
/**
* Do not add dependencies to the "package.json" file.
*/
skipPackageJson?: boolean;
/**
* Do not create "spec.ts" test files for the application.
*/
skipTests?: boolean;
/**
* Creates an application with stricter bundle budgets settings.
*/
strict?: boolean;
/**
* The file extension or preprocessor to use for style files.
*/
style?: SchematicsAngularApplicationStyle;
/**
* The view encapsulation strategy to use in the new application.
*/
viewEncapsulation?: ViewEncapsulation;
}
/**
* The file extension or preprocessor to use for style files.
*/
export declare enum SchematicsAngularApplicationStyle {
Css = "css",
Less = "less",
Sass = "sass",
Scss = "scss"
}
/**
* The view encapsulation strategy to use in the new application.
*
* The view encapsulation strategy to use in the new component.
*
* The view encapsulation strategy to use in the initial project.
*/
export declare enum ViewEncapsulation {
Emulated = "Emulated",
None = "None",
ShadowDom = "ShadowDom"
}
/**
* Creates a new, generic class definition in the given or default project.
*/
export interface AngularClassOptionsSchema {
/**
* The name of the new class.
*/
name: string;
/**
* The path at which to create the class, relative to the workspace root.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not create "spec.ts" test files for the new class.
*/
skipTests?: boolean;
/**
* Adds a developer-defined type to the filename, in the format "name.type.ts".
*/
type?: string;
}
/**
* Creates a new, generic component definition in the given or default project.
*/
export interface AngularComponentOptionsSchema {
/**
* The change detection strategy to use in the new component.
*/
changeDetection?: ChangeDetection;
/**
* Specifies if the style will contain `:host { display: block; }`.
*/
displayBlock?: boolean;
/**
* The declaring NgModule exports this component.
*/
export?: boolean;
/**
* Create the new files at the top level of the current project.
*/
flat?: boolean;
/**
* Include styles inline in the component.ts file. Only CSS styles can be included inline.
* By default, an external styles file is created and referenced in the component.ts file.
*/
inlineStyle?: boolean;
/**
* Include template inline in the component.ts file. By default, an external template file
* is created and referenced in the component.ts file.
*/
inlineTemplate?: boolean;
/**
* The declaring NgModule.
*/
module?: string;
/**
* The name of the component.
*/
name: string;
/**
* The path at which to create the component file, relative to the current workspace.
* Default is a folder with the same name as the component in the project root.
*/
path?: string;
/**
* The prefix to apply to the generated component selector.
*/
prefix?: string;
/**
* The name of the project.
*/
project: string;
/**
* The HTML selector to use for this component.
*/
selector?: string;
/**
* Do not import this component into the owning NgModule.
*/
skipImport?: boolean;
/**
* Specifies if the component should have a selector or not.
*/
skipSelector?: boolean;
/**
* Do not create "spec.ts" test files for the new component.
*/
skipTests?: boolean;
/**
* Whether the generated component is standalone.
*/
standalone?: boolean;
/**
* The file extension or preprocessor to use for style files, or 'none' to skip generating
* the style file.
*/
style?: SchematicsAngularComponentStyle;
/**
* Adds a developer-defined type to the filename, in the format "name.type.ts".
*/
type?: string;
/**
* The view encapsulation strategy to use in the new component.
*/
viewEncapsulation?: ViewEncapsulation;
}
/**
* The change detection strategy to use in the new component.
*/
export declare enum ChangeDetection {
Default = "Default",
OnPush = "OnPush"
}
/**
* The file extension or preprocessor to use for style files, or 'none' to skip generating
* the style file.
*/
export declare enum SchematicsAngularComponentStyle {
Css = "css",
Less = "less",
None = "none",
Sass = "sass",
Scss = "scss"
}
/**
* Creates a new, generic directive definition in the given or default project.
*/
export interface AngularDirectiveOptionsSchema {
/**
* The declaring NgModule exports this directive.
*/
export?: boolean;
/**
* When true (the default), creates the new files at the top level of the current project.
*/
flat?: boolean;
/**
* The declaring NgModule.
*/
module?: string;
/**
* The name of the new directive.
*/
name: string;
/**
* The path at which to create the interface that defines the directive, relative to the
* workspace root.
*/
path?: string;
/**
* A prefix to apply to generated selectors.
*/
prefix?: string;
/**
* The name of the project.
*/
project: string;
/**
* The HTML selector to use for this directive.
*/
selector?: string;
/**
* Do not import this directive into the owning NgModule.
*/
skipImport?: boolean;
/**
* Do not create "spec.ts" test files for the new class.
*/
skipTests?: boolean;
/**
* Whether the generated directive is standalone.
*/
standalone?: boolean;
}
/**
* Generates a new, generic enum definition for the given or default project.
*/
export interface AngularEnumOptionsSchema {
/**
* The name of the enum.
*/
name: string;
/**
* The path at which to create the enum definition, relative to the current workspace.
*/
path?: string;
/**
* The name of the project in which to create the enum. Default is the configured default
* project for the workspace.
*/
project: string;
/**
* Adds a developer-defined type to the filename, in the format "name.type.ts".
*/
type?: string;
}
/**
* Generates a new, generic route guard definition in the given or default project.
*/
export interface AngularGuardOptionsSchema {
/**
* When true (the default), creates the new files at the top level of the current project.
*/
flat?: boolean;
/**
* Specifies which interfaces to implement.
*/
implements?: Implement[];
/**
* The name of the new route guard.
*/
name: string;
/**
* The path at which to create the interface that defines the guard, relative to the current
* workspace.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not create "spec.ts" test files for the new guard.
*/
skipTests?: boolean;
}
export declare enum Implement {
CanActivate = "CanActivate",
CanActivateChild = "CanActivateChild",
CanDeactivate = "CanDeactivate",
CanLoad = "CanLoad",
CanMatch = "CanMatch"
}
/**
* Creates a new, generic interceptor definition in the given or default project.
*/
export interface AngularInterceptorOptionsSchema {
/**
* When true (the default), creates files at the top level of the project.
*/
flat?: boolean;
/**
* The name of the interceptor.
*/
name: string;
/**
* The path at which to create the interceptor, relative to the workspace root.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not create "spec.ts" test files for the new interceptor.
*/
skipTests?: boolean;
}
/**
* Creates a new, generic interface definition in the given or default project.
*/
export interface AngularInterfaceOptionsSchema {
/**
* The name of the interface.
*/
name: string;
/**
* The path at which to create the interface, relative to the workspace root.
*/
path?: string;
/**
* A prefix to apply to generated selectors.
*/
prefix?: string;
/**
* The name of the project.
*/
project: string;
/**
* Adds a developer-defined type to the filename, in the format "name.type.ts".
*/
type?: string;
}
/**
* Creates a new, generic library project in the current workspace.
*/
export interface LibraryOptionsSchema {
/**
* The path at which to create the library's public API file, relative to the workspace root.
*/
entryFile?: string;
/**
* The name of the library.
*/
name: string;
/**
* A prefix to apply to generated selectors.
*/
prefix?: string;
/**
* The root directory of the new library.
*/
projectRoot?: string;
/**
* Do not install dependency packages.
*/
skipInstall?: boolean;
/**
* Do not add dependencies to the "package.json" file.
*/
skipPackageJson?: boolean;
/**
* Do not update "tsconfig.json" to add a path mapping for the new library. The path mapping
* is needed to use the library in an app, but can be disabled here to simplify development.
*/
skipTsConfig?: boolean;
}
/**
* Creates a new project by combining the workspace and application schematics.
*/
export interface AngularNgNewOptionsSchema {
/**
* Initial git repository commit information.
*/
commit?: CommitUnion;
/**
* Create a new initial application project in the 'src' folder of the new workspace. When
* false, creates an empty workspace with no initial application. You can then use the
* generate application command so that all applications are created in the projects folder.
*/
createApplication?: boolean;
/**
* The directory name to create the workspace in.
*/
directory?: string;
/**
* Include styles inline in the component TS file. By default, an external styles file is
* created and referenced in the component TypeScript file.
*/
inlineStyle?: boolean;
/**
* Include template inline in the component TS file. By default, an external template file
* is created and referenced in the component TypeScript file.
*/
inlineTemplate?: boolean;
/**
* Link the CLI to the global version (internal development only).
*/
linkCli?: boolean;
/**
* Create a workspace without any testing frameworks. (Use for learning purposes only.)
*/
minimal?: boolean;
/**
* The name of the new workspace and initial project.
*/
name: string;
/**
* The path where new projects will be created, relative to the new workspace root.
*/
newProjectRoot?: string;
/**
* The package manager used to install dependencies.
*/
packageManager?: PackageManager;
/**
* The prefix to apply to generated selectors for the initial project.
*/
prefix?: string;
/**
* Generate a routing module for the initial project.
*/
routing?: boolean;
/**
* Do not initialize a git repository.
*/
skipGit?: boolean;
/**
* Do not install dependency packages.
*/
skipInstall?: boolean;
/**
* Do not generate "spec.ts" test files for the new project.
*/
skipTests?: boolean;
/**
* Creates a workspace with stricter type checking and stricter bundle budgets settings.
* This setting helps improve maintainability and catch bugs ahead of time. For more
* information, see https://angular.io/guide/strict-mode
*/
strict?: boolean;
/**
* The file extension or preprocessor to use for style files.
*/
style?: SchematicsAngularApplicationStyle;
/**
* The version of the Angular CLI to use.
*/
version: string;
/**
* The view encapsulation strategy to use in the initial project.
*/
viewEncapsulation?: ViewEncapsulation;
}
/**
* Initial git repository commit information.
*/
export declare type CommitUnion = boolean | CommitObject;
export interface CommitObject {
email: string;
message?: string;
name: string;
}
/**
* Creates a new, generic pipe definition in the given or default project.
*/
export interface AngularPipeOptionsSchema {
/**
* The declaring NgModule exports this pipe.
*/
export?: boolean;
/**
* When true (the default) creates files at the top level of the project.
*/
flat?: boolean;
/**
* The declaring NgModule.
*/
module?: string;
/**
* The name of the pipe.
*/
name: string;
/**
* The path at which to create the pipe, relative to the workspace root.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not import this pipe into the owning NgModule.
*/
skipImport?: boolean;
/**
* Do not create "spec.ts" test files for the new pipe.
*/
skipTests?: boolean;
/**
* Whether the generated pipe is standalone.
*/
standalone?: boolean;
}
/**
* Generates a new, generic resolver definition in the given or default project.
*/
export interface AngularResolverOptionsSchema {
/**
* When true (the default), creates the new files at the top level of the current project.
*/
flat?: boolean;
/**
* The name of the new resolver.
*/
name: string;
/**
* The path at which to create the interface that defines the resolver, relative to the
* current workspace.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not create "spec.ts" test files for the new resolver.
*/
skipTests?: boolean;
}
/**
* Creates a new, generic service definition in the given or default project.
*/
export interface AngularServiceOptionsSchema {
/**
* When true (the default), creates files at the top level of the project.
*/
flat?: boolean;
/**
* The name of the service.
*/
name: string;
/**
* The path at which to create the service, relative to the workspace root.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Do not create "spec.ts" test files for the new service.
*/
skipTests?: boolean;
}
/**
* Creates a new, generic web worker definition in the given or default project.
*/
export interface AngularWebWorkerOptionsSchema {
/**
* The name of the worker.
*/
name: string;
/**
* The path at which to create the worker file, relative to the current workspace.
*/
path?: string;
/**
* The name of the project.
*/
project: string;
/**
* Add a worker creation snippet in a sibling file of the same name.
*/
snippet?: boolean;
}
+77
View File
@@ -0,0 +1,77 @@
"use strict";
// THIS FILE IS AUTOMATICALLY GENERATED. TO UPDATE THIS FILE YOU NEED TO CHANGE THE
// CORRESPONDING JSON SCHEMA FILE, THEN RUN devkit-admin build (or bazel build ...).
Object.defineProperty(exports, "__esModule", { value: true });
exports.Implement = exports.SchematicsAngularComponentStyle = exports.ChangeDetection = exports.ViewEncapsulation = exports.SchematicsAngularApplicationStyle = exports.PackageManager = exports.Environment = void 0;
/**
* Configure in which environment disk cache is enabled.
*/
var Environment;
(function (Environment) {
Environment["All"] = "all";
Environment["Ci"] = "ci";
Environment["Local"] = "local";
})(Environment = exports.Environment || (exports.Environment = {}));
/**
* Specify which package manager tool to use.
*
* The package manager used to install dependencies.
*/
var PackageManager;
(function (PackageManager) {
PackageManager["Cnpm"] = "cnpm";
PackageManager["Npm"] = "npm";
PackageManager["Pnpm"] = "pnpm";
PackageManager["Yarn"] = "yarn";
})(PackageManager = exports.PackageManager || (exports.PackageManager = {}));
/**
* The file extension or preprocessor to use for style files.
*/
var SchematicsAngularApplicationStyle;
(function (SchematicsAngularApplicationStyle) {
SchematicsAngularApplicationStyle["Css"] = "css";
SchematicsAngularApplicationStyle["Less"] = "less";
SchematicsAngularApplicationStyle["Sass"] = "sass";
SchematicsAngularApplicationStyle["Scss"] = "scss";
})(SchematicsAngularApplicationStyle = exports.SchematicsAngularApplicationStyle || (exports.SchematicsAngularApplicationStyle = {}));
/**
* The view encapsulation strategy to use in the new application.
*
* The view encapsulation strategy to use in the new component.
*
* The view encapsulation strategy to use in the initial project.
*/
var ViewEncapsulation;
(function (ViewEncapsulation) {
ViewEncapsulation["Emulated"] = "Emulated";
ViewEncapsulation["None"] = "None";
ViewEncapsulation["ShadowDom"] = "ShadowDom";
})(ViewEncapsulation = exports.ViewEncapsulation || (exports.ViewEncapsulation = {}));
/**
* The change detection strategy to use in the new component.
*/
var ChangeDetection;
(function (ChangeDetection) {
ChangeDetection["Default"] = "Default";
ChangeDetection["OnPush"] = "OnPush";
})(ChangeDetection = exports.ChangeDetection || (exports.ChangeDetection = {}));
/**
* The file extension or preprocessor to use for style files, or 'none' to skip generating
* the style file.
*/
var SchematicsAngularComponentStyle;
(function (SchematicsAngularComponentStyle) {
SchematicsAngularComponentStyle["Css"] = "css";
SchematicsAngularComponentStyle["Less"] = "less";
SchematicsAngularComponentStyle["None"] = "none";
SchematicsAngularComponentStyle["Sass"] = "sass";
SchematicsAngularComponentStyle["Scss"] = "scss";
})(SchematicsAngularComponentStyle = exports.SchematicsAngularComponentStyle || (exports.SchematicsAngularComponentStyle = {}));
var Implement;
(function (Implement) {
Implement["CanActivate"] = "CanActivate";
Implement["CanActivateChild"] = "CanActivateChild";
Implement["CanDeactivate"] = "CanDeactivate";
Implement["CanLoad"] = "CanLoad";
Implement["CanMatch"] = "CanMatch";
})(Implement = exports.Implement || (exports.Implement = {}));
+8
View File
@@ -0,0 +1,8 @@
/**
* @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 'symbol-observable';
+153
View File
@@ -0,0 +1,153 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
require("symbol-observable");
// symbol polyfill must go first
const fs_1 = require("fs");
const module_1 = require("module");
const path = __importStar(require("path"));
const semver_1 = require("semver");
const color_1 = require("../src/utilities/color");
const config_1 = require("../src/utilities/config");
const environment_options_1 = require("../src/utilities/environment-options");
const version_1 = require("../src/utilities/version");
/**
* Angular CLI versions prior to v14 may not exit correctly if not forcibly exited
* via `process.exit()`. When bootstrapping, `forceExit` will be set to `true`
* if the local CLI version is less than v14 to prevent the CLI from hanging on
* exit in those cases.
*/
let forceExit = false;
(async () => {
var _a;
/**
* Disable Browserslist old data warning as otherwise with every release we'd need to update this dependency
* which is cumbersome considering we pin versions and the warning is not user actionable.
* `Browserslist: caniuse-lite is outdated. Please run next command `npm update`
* See: https://github.com/browserslist/browserslist/blob/819c4337456996d19db6ba953014579329e9c6e1/node.js#L324
*/
process.env.BROWSERSLIST_IGNORE_OLD_DATA = '1';
const rawCommandName = process.argv[2];
/**
* Disable CLI version mismatch checks and forces usage of the invoked CLI
* instead of invoking the local installed version.
*
* When running `ng new` always favor the global version. As in some
* cases orphan `node_modules` would cause the non global CLI to be used.
* @see: https://github.com/angular/angular-cli/issues/14603
*/
if (environment_options_1.disableVersionCheck || rawCommandName === 'new') {
return (await Promise.resolve().then(() => __importStar(require('./cli')))).default;
}
let cli;
try {
// No error implies a projectLocalCli, which will load whatever
// version of ng-cli you have installed in a local package.json
const cwdRequire = (0, module_1.createRequire)(process.cwd() + '/');
const projectLocalCli = cwdRequire.resolve('@angular/cli');
cli = await Promise.resolve().then(() => __importStar(require(projectLocalCli)));
const globalVersion = new semver_1.SemVer(version_1.VERSION.full);
// Older versions might not have the VERSION export
let localVersion = (_a = cli.VERSION) === null || _a === void 0 ? void 0 : _a.full;
if (!localVersion) {
try {
const localPackageJson = await fs_1.promises.readFile(path.join(path.dirname(projectLocalCli), '../../package.json'), 'utf-8');
localVersion = JSON.parse(localPackageJson).version;
}
catch (error) {
// eslint-disable-next-line no-console
console.error('Version mismatch check skipped. Unable to retrieve local version: ' + error);
}
}
// Ensure older versions of the CLI fully exit
if ((0, semver_1.major)(localVersion) < 14) {
forceExit = true;
// Versions prior to 14 didn't implement completion command.
if (rawCommandName === 'completion') {
return null;
}
}
let isGlobalGreater = false;
try {
isGlobalGreater = !!localVersion && globalVersion.compare(localVersion) > 0;
}
catch (error) {
// eslint-disable-next-line no-console
console.error('Version mismatch check skipped. Unable to compare local version: ' + error);
}
// When using the completion command, don't show the warning as otherwise this will break completion.
if (isGlobalGreater &&
rawCommandName !== '--get-yargs-completions' &&
rawCommandName !== 'completion') {
// If using the update command and the global version is greater, use the newer update command
// This allows improvements in update to be used in older versions that do not have bootstrapping
if (rawCommandName === 'update' &&
cli.VERSION &&
cli.VERSION.major - globalVersion.major <= 1) {
cli = await Promise.resolve().then(() => __importStar(require('./cli')));
}
else if (await (0, config_1.isWarningEnabled)('versionMismatch')) {
// Otherwise, use local version and warn if global is newer than local
const warning = `Your global Angular CLI version (${globalVersion}) is greater than your local ` +
`version (${localVersion}). The local Angular CLI version is used.\n\n` +
'To disable this warning use "ng config -g cli.warnings.versionMismatch false".';
// eslint-disable-next-line no-console
console.error(color_1.colors.yellow(warning));
}
}
}
catch {
// If there is an error, resolve could not find the ng-cli
// library from a package.json. Instead, include it from a relative
// path to this script file (which is likely a globally installed
// npm package). Most common cause for hitting this is `ng new`
cli = await Promise.resolve().then(() => __importStar(require('./cli')));
}
if ('default' in cli) {
cli = cli['default'];
}
return cli;
})()
.then((cli) => cli === null || cli === void 0 ? void 0 : cli({
cliArgs: process.argv.slice(2),
}))
.then((exitCode = 0) => {
if (forceExit) {
process.exit(exitCode);
}
process.exitCode = exitCode;
})
.catch((err) => {
// eslint-disable-next-line no-console
console.error('Unknown error: ' + err.toString());
process.exit(127);
});
+63
View File
@@ -0,0 +1,63 @@
{
"name": "@angular/cli",
"version": "15.0.4",
"description": "CLI tool for Angular",
"main": "lib/cli/index.js",
"bin": {
"ng": "./bin/ng.js"
},
"keywords": [
"angular",
"Angular CLI",
"devkit",
"sdk",
"Angular DevKit",
"angular-cli"
],
"repository": {
"type": "git",
"url": "https://github.com/angular/angular-cli.git"
},
"author": "Angular Authors",
"license": "MIT",
"bugs": {
"url": "https://github.com/angular/angular-cli/issues"
},
"homepage": "https://github.com/angular/angular-cli",
"dependencies": {
"@angular-devkit/architect": "0.1500.4",
"@angular-devkit/core": "15.0.4",
"@angular-devkit/schematics": "15.0.4",
"@schematics/angular": "15.0.4",
"@yarnpkg/lockfile": "1.1.0",
"ansi-colors": "4.1.3",
"ini": "3.0.1",
"inquirer": "8.2.4",
"jsonc-parser": "3.2.0",
"npm-package-arg": "9.1.2",
"npm-pick-manifest": "8.0.1",
"open": "8.4.0",
"ora": "5.4.1",
"pacote": "15.0.6",
"resolve": "1.22.1",
"semver": "7.3.8",
"symbol-observable": "4.0.0",
"yargs": "17.6.2"
},
"ng-update": {
"migrations": "@schematics/angular/migrations/migration-collection.json",
"packageGroup": {
"@angular/cli": "15.0.4",
"@angular-devkit/architect": "0.1500.4",
"@angular-devkit/build-angular": "15.0.4",
"@angular-devkit/build-webpack": "0.1500.4",
"@angular-devkit/core": "15.0.4",
"@angular-devkit/schematics": "15.0.4"
}
},
"engines": {
"node": "^14.20.0 || ^16.13.0 || >=18.10.0",
"npm": "^6.11.0 || ^7.5.6 || >=8.0.0",
"yarn": ">= 1.13.0"
}
}
@@ -0,0 +1,32 @@
/**
* @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 type { CommandContext } from '../command-builder/command-module';
import { EventCustomDimension, EventCustomMetric, PrimitiveTypes } from './analytics-parameters';
export declare class AnalyticsCollector {
private context;
private trackingEventsQueue;
private readonly requestParameterStringified;
private readonly userParameters;
constructor(context: CommandContext, userId: string);
reportWorkspaceInfoEvent(parameters: Partial<Record<EventCustomMetric, string | boolean | number | undefined>>): void;
reportRebuildRunEvent(parameters: Partial<Record<EventCustomMetric & EventCustomDimension, string | boolean | number | undefined>>): void;
reportBuildRunEvent(parameters: Partial<Record<EventCustomMetric & EventCustomDimension, string | boolean | number | undefined>>): void;
reportArchitectRunEvent(parameters: Partial<Record<EventCustomDimension, PrimitiveTypes>>): void;
reportSchematicRunEvent(parameters: Partial<Record<EventCustomDimension, PrimitiveTypes>>): void;
reportCommandRunEvent(command: string): void;
private event;
/**
* Flush on an interval (if the event loop is waiting).
*
* @returns a method that when called will terminate the periodic
* flush and call flush one last time.
*/
periodFlush(): () => Promise<void>;
flush(): Promise<void>;
private send;
}
@@ -0,0 +1,173 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.AnalyticsCollector = void 0;
const crypto_1 = require("crypto");
const https = __importStar(require("https"));
const os = __importStar(require("os"));
const querystring = __importStar(require("querystring"));
const environment_options_1 = require("../utilities/environment-options");
const error_1 = require("../utilities/error");
const version_1 = require("../utilities/version");
const analytics_parameters_1 = require("./analytics-parameters");
const TRACKING_ID_PROD = 'G-VETNJBW8L4';
const TRACKING_ID_STAGING = 'G-TBMPRL1BTM';
class AnalyticsCollector {
constructor(context, userId) {
this.context = context;
const requestParameters = {
[analytics_parameters_1.RequestParameter.ProtocolVersion]: 2,
[analytics_parameters_1.RequestParameter.ClientId]: userId,
[analytics_parameters_1.RequestParameter.UserId]: userId,
[analytics_parameters_1.RequestParameter.TrackingId]: /^\d+\.\d+\.\d+$/.test(version_1.VERSION.full) && version_1.VERSION.full !== '0.0.0'
? TRACKING_ID_PROD
: TRACKING_ID_STAGING,
// Built-in user properties
[analytics_parameters_1.RequestParameter.SessionId]: (0, crypto_1.randomUUID)(),
[analytics_parameters_1.RequestParameter.UserAgentArchitecture]: os.arch(),
[analytics_parameters_1.RequestParameter.UserAgentPlatform]: os.platform(),
[analytics_parameters_1.RequestParameter.UserAgentPlatformVersion]: os.version(),
// Set undefined to disable debug view.
[analytics_parameters_1.RequestParameter.DebugView]: environment_options_1.ngDebug ? 1 : undefined,
};
this.requestParameterStringified = querystring.stringify(requestParameters);
// Remove the `v` at the beginning.
const nodeVersion = process.version.substring(1);
const packageManagerVersion = context.packageManager.version;
this.userParameters = {
// While architecture is being collect by GA as UserAgentArchitecture.
// It doesn't look like there is a way to query this. Therefore we collect this as a custom user dimension too.
[analytics_parameters_1.UserCustomDimension.OsArchitecture]: os.arch(),
// While User ID is being collected by GA, this is not visible in reports/for filtering.
[analytics_parameters_1.UserCustomDimension.UserId]: userId,
[analytics_parameters_1.UserCustomDimension.NodeVersion]: nodeVersion,
[analytics_parameters_1.UserCustomDimension.NodeMajorVersion]: +nodeVersion.split('.', 1)[0],
[analytics_parameters_1.UserCustomDimension.PackageManager]: context.packageManager.name,
[analytics_parameters_1.UserCustomDimension.PackageManagerVersion]: packageManagerVersion,
[analytics_parameters_1.UserCustomDimension.PackageManagerMajorVersion]: packageManagerVersion
? +packageManagerVersion.split('.', 1)[0]
: undefined,
[analytics_parameters_1.UserCustomDimension.AngularCLIVersion]: version_1.VERSION.full,
[analytics_parameters_1.UserCustomDimension.AngularCLIMajorVersion]: version_1.VERSION.major,
};
}
reportWorkspaceInfoEvent(parameters) {
this.event('workspace_info', parameters);
}
reportRebuildRunEvent(parameters) {
this.event('run_rebuild', parameters);
}
reportBuildRunEvent(parameters) {
this.event('run_build', parameters);
}
reportArchitectRunEvent(parameters) {
this.event('run_architect', parameters);
}
reportSchematicRunEvent(parameters) {
this.event('run_schematic', parameters);
}
reportCommandRunEvent(command) {
this.event('run_command', { [analytics_parameters_1.EventCustomDimension.Command]: command });
}
event(eventName, parameters) {
var _a;
(_a = this.trackingEventsQueue) !== null && _a !== void 0 ? _a : (this.trackingEventsQueue = []);
this.trackingEventsQueue.push({
...this.userParameters,
...parameters,
'en': eventName,
});
}
/**
* Flush on an interval (if the event loop is waiting).
*
* @returns a method that when called will terminate the periodic
* flush and call flush one last time.
*/
periodFlush() {
let analyticsFlushPromise = Promise.resolve();
const analyticsFlushInterval = setInterval(() => {
var _a;
if ((_a = this.trackingEventsQueue) === null || _a === void 0 ? void 0 : _a.length) {
analyticsFlushPromise = analyticsFlushPromise.then(() => this.flush());
}
}, 4000);
return () => {
clearInterval(analyticsFlushInterval);
// Flush one last time.
return analyticsFlushPromise.then(() => this.flush());
};
}
async flush() {
const pendingTrackingEvents = this.trackingEventsQueue;
this.context.logger.debug(`Analytics flush size. ${pendingTrackingEvents === null || pendingTrackingEvents === void 0 ? void 0 : pendingTrackingEvents.length}.`);
if (!(pendingTrackingEvents === null || pendingTrackingEvents === void 0 ? void 0 : pendingTrackingEvents.length)) {
return;
}
// The below is needed so that if flush is called multiple times,
// we don't report the same event multiple times.
this.trackingEventsQueue = undefined;
try {
await this.send(pendingTrackingEvents);
}
catch (error) {
// Failure to report analytics shouldn't crash the CLI.
(0, error_1.assertIsError)(error);
this.context.logger.debug(`Send analytics error. ${error.message}.`);
}
}
async send(data) {
// Temporarily disable sending analytics.
if (true) {
return Promise.resolve();
}
return new Promise((resolve, reject) => {
const request = https.request({
host: 'www.google-analytics.com',
method: 'POST',
path: '/g/collect?' + this.requestParameterStringified,
}, (response) => {
if (response.statusCode !== 200 && response.statusCode !== 204) {
reject(new Error(`Analytics reporting failed with status code: ${response.statusCode}.`));
}
else {
resolve();
}
});
request.on('error', reject);
const queryParameters = data.map((p) => querystring.stringify(p)).join('\n');
request.write(queryParameters);
request.end();
});
}
}
exports.AnalyticsCollector = AnalyticsCollector;
@@ -0,0 +1,99 @@
/**
* @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
*/
export declare type PrimitiveTypes = string | number | boolean;
/**
* GA built-in request parameters
* @see https://www.thyngster.com/ga4-measurement-protocol-cheatsheet
* @see http://go/depot/google3/analytics/container_tag/templates/common/gold/mpv2_schema.js
*/
export declare enum RequestParameter {
ClientId = "cid",
DebugView = "_dbg",
GtmVersion = "gtm",
Language = "ul",
NewToSite = "_nsi",
NonInteraction = "ni",
PageLocation = "dl",
PageTitle = "dt",
ProtocolVersion = "v",
SessionEngaged = "seg",
SessionId = "sid",
SessionNumber = "sct",
SessionStart = "_ss",
TrackingId = "tid",
TrafficType = "tt",
UserAgentArchitecture = "uaa",
UserAgentBitness = "uab",
UserAgentFullVersionList = "uafvl",
UserAgentMobile = "uamb",
UserAgentModel = "uam",
UserAgentPlatform = "uap",
UserAgentPlatformVersion = "uapv",
UserId = "uid"
}
/**
* User scoped custom dimensions.
* @notes
* - User custom dimensions limit is 25.
* - `up.*` string type.
* - `upn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
export declare enum UserCustomDimension {
UserId = "up.ng_user_id",
OsArchitecture = "up.ng_os_architecture",
NodeVersion = "up.ng_node_version",
NodeMajorVersion = "upn.ng_node_major_version",
AngularCLIVersion = "up.ng_cli_version",
AngularCLIMajorVersion = "upn.ng_cli_major_version",
PackageManager = "up.ng_package_manager",
PackageManagerVersion = "up.ng_pkg_manager_version",
PackageManagerMajorVersion = "upn.ng_pkg_manager_major_v"
}
/**
* Event scoped custom dimensions.
* @notes
* - Event custom dimensions limit is 50.
* - `ep.*` string type.
* - `epn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
export declare enum EventCustomDimension {
Command = "ep.ng_command",
SchematicCollectionName = "ep.ng_schematic_collection_name",
SchematicName = "ep.ng_schematic_name",
Standalone = "ep.ng_standalone",
Style = "ep.ng_style",
Routing = "ep.ng_routing",
InlineTemplate = "ep.ng_inline_template",
InlineStyle = "ep.ng_inline_style",
BuilderTarget = "ep.ng_builder_target",
Aot = "ep.ng_aot",
Optimization = "ep.ng_optimization"
}
/**
* Event scoped custom mertics.
* @notes
* - Event scoped custom mertics limit is 50.
* - `ep.*` string type.
* - `epn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
export declare enum EventCustomMetric {
AllChunksCount = "epn.ng_all_chunks_count",
LazyChunksCount = "epn.ng_lazy_chunks_count",
InitialChunksCount = "epn.ng_initial_chunks_count",
ChangedChunksCount = "epn.ng_changed_chunks_count",
DurationInMs = "epn.ng_duration_ms",
CssSizeInBytes = "epn.ng_css_size_bytes",
JsSizeInBytes = "epn.ng_js_size_bytes",
NgComponentCount = "epn.ng_component_count",
AllProjectsCount = "epn.all_projects_count",
LibraryProjectsCount = "epn.libs_projects_count",
ApplicationProjectsCount = "epn.apps_projects_count"
}
@@ -0,0 +1,105 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.EventCustomMetric = exports.EventCustomDimension = exports.UserCustomDimension = exports.RequestParameter = void 0;
/**
* GA built-in request parameters
* @see https://www.thyngster.com/ga4-measurement-protocol-cheatsheet
* @see http://go/depot/google3/analytics/container_tag/templates/common/gold/mpv2_schema.js
*/
var RequestParameter;
(function (RequestParameter) {
RequestParameter["ClientId"] = "cid";
RequestParameter["DebugView"] = "_dbg";
RequestParameter["GtmVersion"] = "gtm";
RequestParameter["Language"] = "ul";
RequestParameter["NewToSite"] = "_nsi";
RequestParameter["NonInteraction"] = "ni";
RequestParameter["PageLocation"] = "dl";
RequestParameter["PageTitle"] = "dt";
RequestParameter["ProtocolVersion"] = "v";
RequestParameter["SessionEngaged"] = "seg";
RequestParameter["SessionId"] = "sid";
RequestParameter["SessionNumber"] = "sct";
RequestParameter["SessionStart"] = "_ss";
RequestParameter["TrackingId"] = "tid";
RequestParameter["TrafficType"] = "tt";
RequestParameter["UserAgentArchitecture"] = "uaa";
RequestParameter["UserAgentBitness"] = "uab";
RequestParameter["UserAgentFullVersionList"] = "uafvl";
RequestParameter["UserAgentMobile"] = "uamb";
RequestParameter["UserAgentModel"] = "uam";
RequestParameter["UserAgentPlatform"] = "uap";
RequestParameter["UserAgentPlatformVersion"] = "uapv";
RequestParameter["UserId"] = "uid";
})(RequestParameter = exports.RequestParameter || (exports.RequestParameter = {}));
/**
* User scoped custom dimensions.
* @notes
* - User custom dimensions limit is 25.
* - `up.*` string type.
* - `upn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
var UserCustomDimension;
(function (UserCustomDimension) {
UserCustomDimension["UserId"] = "up.ng_user_id";
UserCustomDimension["OsArchitecture"] = "up.ng_os_architecture";
UserCustomDimension["NodeVersion"] = "up.ng_node_version";
UserCustomDimension["NodeMajorVersion"] = "upn.ng_node_major_version";
UserCustomDimension["AngularCLIVersion"] = "up.ng_cli_version";
UserCustomDimension["AngularCLIMajorVersion"] = "upn.ng_cli_major_version";
UserCustomDimension["PackageManager"] = "up.ng_package_manager";
UserCustomDimension["PackageManagerVersion"] = "up.ng_pkg_manager_version";
UserCustomDimension["PackageManagerMajorVersion"] = "upn.ng_pkg_manager_major_v";
})(UserCustomDimension = exports.UserCustomDimension || (exports.UserCustomDimension = {}));
/**
* Event scoped custom dimensions.
* @notes
* - Event custom dimensions limit is 50.
* - `ep.*` string type.
* - `epn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
var EventCustomDimension;
(function (EventCustomDimension) {
EventCustomDimension["Command"] = "ep.ng_command";
EventCustomDimension["SchematicCollectionName"] = "ep.ng_schematic_collection_name";
EventCustomDimension["SchematicName"] = "ep.ng_schematic_name";
EventCustomDimension["Standalone"] = "ep.ng_standalone";
EventCustomDimension["Style"] = "ep.ng_style";
EventCustomDimension["Routing"] = "ep.ng_routing";
EventCustomDimension["InlineTemplate"] = "ep.ng_inline_template";
EventCustomDimension["InlineStyle"] = "ep.ng_inline_style";
EventCustomDimension["BuilderTarget"] = "ep.ng_builder_target";
EventCustomDimension["Aot"] = "ep.ng_aot";
EventCustomDimension["Optimization"] = "ep.ng_optimization";
})(EventCustomDimension = exports.EventCustomDimension || (exports.EventCustomDimension = {}));
/**
* Event scoped custom mertics.
* @notes
* - Event scoped custom mertics limit is 50.
* - `ep.*` string type.
* - `epn.*` number type.
* @see https://support.google.com/analytics/answer/10075209?hl=en
*/
var EventCustomMetric;
(function (EventCustomMetric) {
EventCustomMetric["AllChunksCount"] = "epn.ng_all_chunks_count";
EventCustomMetric["LazyChunksCount"] = "epn.ng_lazy_chunks_count";
EventCustomMetric["InitialChunksCount"] = "epn.ng_initial_chunks_count";
EventCustomMetric["ChangedChunksCount"] = "epn.ng_changed_chunks_count";
EventCustomMetric["DurationInMs"] = "epn.ng_duration_ms";
EventCustomMetric["CssSizeInBytes"] = "epn.ng_css_size_bytes";
EventCustomMetric["JsSizeInBytes"] = "epn.ng_js_size_bytes";
EventCustomMetric["NgComponentCount"] = "epn.ng_component_count";
EventCustomMetric["AllProjectsCount"] = "epn.all_projects_count";
EventCustomMetric["LibraryProjectsCount"] = "epn.libs_projects_count";
EventCustomMetric["ApplicationProjectsCount"] = "epn.apps_projects_count";
})(EventCustomMetric = exports.EventCustomMetric || (exports.EventCustomMetric = {}));
+27
View File
@@ -0,0 +1,27 @@
/**
* @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 type { CommandContext } from '../command-builder/command-module';
/**
* This is the ultimate safelist for checking if a package name is safe to report to analytics.
*/
export declare const analyticsPackageSafelist: (string | RegExp)[];
export declare function isPackageNameSafeForAnalytics(name: string): boolean;
/**
* Set analytics settings. This does not work if the user is not inside a project.
* @param global Which config to use. "global" for user-level, and "local" for project-level.
* @param value Either a user ID, true to generate a new User ID, or false to disable analytics.
*/
export declare function setAnalyticsConfig(global: boolean, value: string | boolean): Promise<void>;
/**
* Prompt the user for usage gathering permission.
* @param force Whether to ask regardless of whether or not the user is using an interactive shell.
* @return Whether or not the user was shown a prompt.
*/
export declare function promptAnalytics(context: CommandContext, global: boolean, force?: boolean): Promise<boolean>;
export declare function getAnalyticsUserId(context: CommandContext, skipPrompt?: boolean): Promise<string | undefined>;
export declare function getAnalyticsInfoString(context: CommandContext): Promise<string>;
+216
View File
@@ -0,0 +1,216 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getAnalyticsInfoString = exports.getAnalyticsUserId = exports.promptAnalytics = exports.setAnalyticsConfig = exports.isPackageNameSafeForAnalytics = exports.analyticsPackageSafelist = void 0;
const core_1 = require("@angular-devkit/core");
const crypto_1 = require("crypto");
const color_1 = require("../utilities/color");
const config_1 = require("../utilities/config");
const environment_options_1 = require("../utilities/environment-options");
const tty_1 = require("../utilities/tty");
/* eslint-disable no-console */
/**
* This is the ultimate safelist for checking if a package name is safe to report to analytics.
*/
exports.analyticsPackageSafelist = [
/^@angular\//,
/^@angular-devkit\//,
/^@nguniversal\//,
'@schematics/angular',
];
function isPackageNameSafeForAnalytics(name) {
return exports.analyticsPackageSafelist.some((pattern) => {
if (typeof pattern == 'string') {
return pattern === name;
}
else {
return pattern.test(name);
}
});
}
exports.isPackageNameSafeForAnalytics = isPackageNameSafeForAnalytics;
/**
* Set analytics settings. This does not work if the user is not inside a project.
* @param global Which config to use. "global" for user-level, and "local" for project-level.
* @param value Either a user ID, true to generate a new User ID, or false to disable analytics.
*/
async function setAnalyticsConfig(global, value) {
var _a;
var _b;
const level = global ? 'global' : 'local';
const workspace = await (0, config_1.getWorkspace)(level);
if (!workspace) {
throw new Error(`Could not find ${level} workspace.`);
}
const cli = ((_a = (_b = workspace.extensions)['cli']) !== null && _a !== void 0 ? _a : (_b['cli'] = {}));
if (!workspace || !core_1.json.isJsonObject(cli)) {
throw new Error(`Invalid config found at ${workspace.filePath}. CLI should be an object.`);
}
cli.analytics = value === true ? (0, crypto_1.randomUUID)() : value;
await workspace.save();
}
exports.setAnalyticsConfig = setAnalyticsConfig;
/**
* Prompt the user for usage gathering permission.
* @param force Whether to ask regardless of whether or not the user is using an interactive shell.
* @return Whether or not the user was shown a prompt.
*/
async function promptAnalytics(context, global, force = false) {
const level = global ? 'global' : 'local';
const workspace = await (0, config_1.getWorkspace)(level);
if (!workspace) {
throw new Error(`Could not find a ${level} workspace. Are you in a project?`);
}
if (force || (0, tty_1.isTTY)()) {
const { prompt } = await Promise.resolve().then(() => __importStar(require('inquirer')));
const answers = await prompt([
{
type: 'confirm',
name: 'analytics',
message: core_1.tags.stripIndents `
Would you like to share pseudonymous usage data about this project with the Angular Team
at Google under Google's Privacy Policy at https://policies.google.com/privacy. For more
details and how to change this setting, see https://angular.io/analytics.
`,
default: false,
},
]);
await setAnalyticsConfig(global, answers.analytics);
if (answers.analytics) {
console.log('');
console.log(core_1.tags.stripIndent `
Thank you for sharing pseudonymous usage data. Should you change your mind, the following
command will disable this feature entirely:
${color_1.colors.yellow(`ng analytics disable${global ? ' --global' : ''}`)}
`);
console.log('');
}
process.stderr.write(await getAnalyticsInfoString(context));
return true;
}
return false;
}
exports.promptAnalytics = promptAnalytics;
/**
* Get the analytics user id.
*
* @returns
* - `string` user id.
* - `false` when disabled.
* - `undefined` when not configured.
*/
async function getAnalyticsUserIdForLevel(level) {
var _a;
if (environment_options_1.analyticsDisabled) {
return false;
}
const workspace = await (0, config_1.getWorkspace)(level);
const analyticsConfig = (_a = workspace === null || workspace === void 0 ? void 0 : workspace.getCli()) === null || _a === void 0 ? void 0 : _a['analytics'];
if (analyticsConfig === false) {
return false;
}
else if (analyticsConfig === undefined || analyticsConfig === null) {
return undefined;
}
else {
if (typeof analyticsConfig == 'string') {
return analyticsConfig;
}
else if (typeof analyticsConfig == 'object' && typeof analyticsConfig['uid'] == 'string') {
return analyticsConfig['uid'];
}
return undefined;
}
}
async function getAnalyticsUserId(context, skipPrompt = false) {
const { workspace } = context;
// Global config takes precedence over local config only for the disabled check.
// IE:
// global: disabled & local: enabled = disabled
// global: id: 123 & local: id: 456 = 456
// check global
const globalConfig = await getAnalyticsUserIdForLevel('global');
if (globalConfig === false) {
return undefined;
}
// Not disabled globally, check locally or not set globally and command is run outside of workspace example: `ng new`
if (workspace || globalConfig === undefined) {
const level = workspace ? 'local' : 'global';
let localOrGlobalConfig = await getAnalyticsUserIdForLevel(level);
if (localOrGlobalConfig === undefined) {
if (!skipPrompt) {
// config is unset, prompt user.
// TODO: This should honor the `no-interactive` option.
// It is currently not an `ng` option but rather only an option for specific commands.
// The concept of `ng`-wide options are needed to cleanly handle this.
await promptAnalytics(context, !workspace /** global */);
localOrGlobalConfig = await getAnalyticsUserIdForLevel(level);
}
}
if (localOrGlobalConfig === false) {
return undefined;
}
else if (typeof localOrGlobalConfig === 'string') {
return localOrGlobalConfig;
}
}
return globalConfig;
}
exports.getAnalyticsUserId = getAnalyticsUserId;
function analyticsConfigValueToHumanFormat(value) {
if (value === false) {
return 'disabled';
}
else if (typeof value === 'string' || value === true) {
return 'enabled';
}
else {
return 'not set';
}
}
async function getAnalyticsInfoString(context) {
var _a, _b;
const analyticsInstance = await getAnalyticsUserId(context, true /** skipPrompt */);
const { globalConfiguration, workspace: localWorkspace } = context;
const globalSetting = (_a = globalConfiguration === null || globalConfiguration === void 0 ? void 0 : globalConfiguration.getCli()) === null || _a === void 0 ? void 0 : _a['analytics'];
const localSetting = (_b = localWorkspace === null || localWorkspace === void 0 ? void 0 : localWorkspace.getCli()) === null || _b === void 0 ? void 0 : _b['analytics'];
return (core_1.tags.stripIndents `
Global setting: ${analyticsConfigValueToHumanFormat(globalSetting)}
Local setting: ${localWorkspace
? analyticsConfigValueToHumanFormat(localSetting)
: 'No local workspace configuration file.'}
Effective status: ${analyticsInstance ? 'enabled' : 'disabled'}
` + '\n');
}
exports.getAnalyticsInfoString = getAnalyticsInfoString;
@@ -0,0 +1,30 @@
/**
* @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 { Architect, Target } from '@angular-devkit/architect';
import { WorkspaceNodeModulesArchitectHost } from '@angular-devkit/architect/node';
import { CommandModule, CommandModuleImplementation, CommandScope, OtherOptions } from './command-module';
import { Option } from './utilities/json-schema';
export interface MissingTargetChoice {
name: string;
value: string;
}
export declare abstract class ArchitectBaseCommandModule<T extends object> extends CommandModule<T> implements CommandModuleImplementation<T> {
scope: CommandScope;
protected readonly missingTargetChoices: MissingTargetChoice[] | undefined;
protected runSingleTarget(target: Target, options: OtherOptions): Promise<number>;
private builderStatsToAnalyticsParameters;
private _architectHost;
protected getArchitectHost(): WorkspaceNodeModulesArchitectHost;
private _architect;
protected getArchitect(): Architect;
protected getArchitectTargetOptions(target: Target): Promise<Option[]>;
private warnOnMissingNodeModules;
protected getArchitectTarget(): string;
protected onMissingTarget(defaultMessage: string): Promise<1>;
private getMissingTargetPackageToInstall;
}
@@ -0,0 +1,210 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ArchitectBaseCommandModule = void 0;
const architect_1 = require("@angular-devkit/architect");
const node_1 = require("@angular-devkit/architect/node");
const core_1 = require("@angular-devkit/core");
const child_process_1 = require("child_process");
const fs_1 = require("fs");
const path_1 = require("path");
const analytics_1 = require("../analytics/analytics");
const analytics_parameters_1 = require("../analytics/analytics-parameters");
const error_1 = require("../utilities/error");
const prompt_1 = require("../utilities/prompt");
const tty_1 = require("../utilities/tty");
const command_module_1 = require("./command-module");
const json_schema_1 = require("./utilities/json-schema");
class ArchitectBaseCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.scope = command_module_1.CommandScope.In;
}
async runSingleTarget(target, options) {
const architectHost = await this.getArchitectHost();
let builderName;
try {
builderName = await architectHost.getBuilderNameForTarget(target);
}
catch (e) {
(0, error_1.assertIsError)(e);
return this.onMissingTarget(e.message);
}
const { logger } = this.context;
const run = await this.getArchitect().scheduleTarget(target, options, {
logger,
});
const analytics = (0, analytics_1.isPackageNameSafeForAnalytics)(builderName)
? await this.getAnalytics()
: undefined;
let outputSubscription;
if (analytics) {
analytics.reportArchitectRunEvent({
[analytics_parameters_1.EventCustomDimension.BuilderTarget]: builderName,
});
let firstRun = true;
outputSubscription = run.output.subscribe(({ stats }) => {
const parameters = this.builderStatsToAnalyticsParameters(stats, builderName);
if (!parameters) {
return;
}
if (firstRun) {
firstRun = false;
analytics.reportBuildRunEvent(parameters);
}
else {
analytics.reportRebuildRunEvent(parameters);
}
});
}
try {
const { error, success } = await run.output.toPromise();
if (error) {
logger.error(error);
}
return success ? 0 : 1;
}
finally {
await run.stop();
outputSubscription === null || outputSubscription === void 0 ? void 0 : outputSubscription.unsubscribe();
}
}
builderStatsToAnalyticsParameters(stats, builderName) {
if (!stats || typeof stats !== 'object' || !('durationInMs' in stats)) {
return undefined;
}
const { optimization, allChunksCount, aot, lazyChunksCount, initialChunksCount, durationInMs, changedChunksCount, cssSizeInBytes, jsSizeInBytes, ngComponentCount, } = stats;
return {
[analytics_parameters_1.EventCustomDimension.BuilderTarget]: builderName,
[analytics_parameters_1.EventCustomDimension.Aot]: aot,
[analytics_parameters_1.EventCustomDimension.Optimization]: optimization,
[analytics_parameters_1.EventCustomMetric.AllChunksCount]: allChunksCount,
[analytics_parameters_1.EventCustomMetric.LazyChunksCount]: lazyChunksCount,
[analytics_parameters_1.EventCustomMetric.InitialChunksCount]: initialChunksCount,
[analytics_parameters_1.EventCustomMetric.ChangedChunksCount]: changedChunksCount,
[analytics_parameters_1.EventCustomMetric.DurationInMs]: durationInMs,
[analytics_parameters_1.EventCustomMetric.JsSizeInBytes]: jsSizeInBytes,
[analytics_parameters_1.EventCustomMetric.CssSizeInBytes]: cssSizeInBytes,
[analytics_parameters_1.EventCustomMetric.NgComponentCount]: ngComponentCount,
};
}
getArchitectHost() {
if (this._architectHost) {
return this._architectHost;
}
const workspace = this.getWorkspaceOrThrow();
return (this._architectHost = new node_1.WorkspaceNodeModulesArchitectHost(workspace, workspace.basePath));
}
getArchitect() {
if (this._architect) {
return this._architect;
}
const registry = new core_1.json.schema.CoreSchemaRegistry();
registry.addPostTransform(core_1.json.schema.transforms.addUndefinedDefaults);
registry.useXDeprecatedProvider((msg) => this.context.logger.warn(msg));
const architectHost = this.getArchitectHost();
return (this._architect = new architect_1.Architect(architectHost, registry));
}
async getArchitectTargetOptions(target) {
const architectHost = this.getArchitectHost();
let builderConf;
try {
builderConf = await architectHost.getBuilderNameForTarget(target);
}
catch {
return [];
}
let builderDesc;
try {
builderDesc = await architectHost.resolveBuilder(builderConf);
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'MODULE_NOT_FOUND') {
this.warnOnMissingNodeModules();
throw new command_module_1.CommandModuleError(`Could not find the '${builderConf}' builder's node package.`);
}
throw e;
}
return (0, json_schema_1.parseJsonSchemaToOptions)(new core_1.json.schema.CoreSchemaRegistry(), builderDesc.optionSchema, true);
}
warnOnMissingNodeModules() {
var _a;
const basePath = (_a = this.context.workspace) === null || _a === void 0 ? void 0 : _a.basePath;
if (!basePath) {
return;
}
// Check for a `node_modules` directory (npm, yarn non-PnP, etc.)
if ((0, fs_1.existsSync)((0, path_1.resolve)(basePath, 'node_modules'))) {
return;
}
// Check for yarn PnP files
if ((0, fs_1.existsSync)((0, path_1.resolve)(basePath, '.pnp.js')) ||
(0, fs_1.existsSync)((0, path_1.resolve)(basePath, '.pnp.cjs')) ||
(0, fs_1.existsSync)((0, path_1.resolve)(basePath, '.pnp.mjs'))) {
return;
}
this.context.logger.warn(`Node packages may not be installed. Try installing with '${this.context.packageManager.name} install'.`);
}
getArchitectTarget() {
return this.commandName;
}
async onMissingTarget(defaultMessage) {
const { logger } = this.context;
const choices = this.missingTargetChoices;
if (!(choices === null || choices === void 0 ? void 0 : choices.length)) {
logger.error(defaultMessage);
return 1;
}
const missingTargetMessage = `Cannot find "${this.getArchitectTarget()}" target for the specified project.\n` +
`You can add a package that implements these capabilities.\n\n` +
`For example:\n` +
choices.map(({ name, value }) => ` ${name}: ng add ${value}`).join('\n') +
'\n';
if ((0, tty_1.isTTY)()) {
// Use prompts to ask the user if they'd like to install a package.
logger.warn(missingTargetMessage);
const packageToInstall = await this.getMissingTargetPackageToInstall(choices);
if (packageToInstall) {
// Example run: `ng add @angular-eslint/schematics`.
const binPath = (0, path_1.resolve)(__dirname, '../../bin/ng.js');
const { error } = (0, child_process_1.spawnSync)(process.execPath, [binPath, 'add', packageToInstall], {
stdio: 'inherit',
});
if (error) {
throw error;
}
}
}
else {
// Non TTY display error message.
logger.error(missingTargetMessage);
}
return 1;
}
async getMissingTargetPackageToInstall(choices) {
if (choices.length === 1) {
// Single choice
const { name, value } = choices[0];
if (await (0, prompt_1.askConfirmation)(`Would you like to add ${name} now?`, true, false)) {
return value;
}
return null;
}
// Multiple choice
return (0, prompt_1.askQuestion)(`Would you like to add a package with "${this.getArchitectTarget()}" capabilities now?`, [
{
name: 'No',
value: null,
},
...choices,
], 0, null);
}
}
exports.ArchitectBaseCommandModule = ArchitectBaseCommandModule;
@@ -0,0 +1,25 @@
/**
* @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 { ArchitectBaseCommandModule } from './architect-base-command-module';
import { CommandModuleImplementation, Options, OtherOptions } from './command-module';
export interface ArchitectCommandArgs {
configuration?: string;
project?: string;
}
export declare abstract class ArchitectCommandModule extends ArchitectBaseCommandModule<ArchitectCommandArgs> implements CommandModuleImplementation<ArchitectCommandArgs> {
abstract readonly multiTarget: boolean;
builder(argv: Argv): Promise<Argv<ArchitectCommandArgs>>;
run(options: Options<ArchitectCommandArgs> & OtherOptions): Promise<number | void>;
private getArchitectProject;
private getProjectNamesByTarget;
/** @returns a sorted list of project names to be used for auto completion. */
private getProjectChoices;
/** @returns a sorted list of configuration names to be used for auto completion. */
private getConfigurationChoices;
}
@@ -0,0 +1,148 @@
"use strict";
/**
* @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
*/
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ArchitectCommandModule = void 0;
const config_1 = require("../utilities/config");
const memoize_1 = require("../utilities/memoize");
const architect_base_command_module_1 = require("./architect-base-command-module");
const command_module_1 = require("./command-module");
class ArchitectCommandModule extends architect_base_command_module_1.ArchitectBaseCommandModule {
async builder(argv) {
const project = this.getArchitectProject();
const { jsonHelp, getYargsCompletions, help } = this.context.args.options;
const localYargs = argv
.positional('project', {
describe: 'The name of the project to build. Can be an application or a library.',
type: 'string',
// Hide choices from JSON help so that we don't display them in AIO.
choices: jsonHelp ? undefined : this.getProjectChoices(),
})
.option('configuration', {
describe: `One or more named builder configurations as a comma-separated ` +
`list as specified in the "configurations" section in angular.json.\n` +
`The builder uses the named configurations to run the given target.\n` +
`For more information, see https://angular.io/guide/workspace-config#alternate-build-configurations.`,
alias: 'c',
type: 'string',
// Show only in when using --help and auto completion because otherwise comma seperated configuration values will be invalid.
// Also, hide choices from JSON help so that we don't display them in AIO.
choices: (getYargsCompletions || help) && !jsonHelp && project
? this.getConfigurationChoices(project)
: undefined,
})
.strict();
if (!project) {
return localYargs;
}
const target = this.getArchitectTarget();
const schemaOptions = await this.getArchitectTargetOptions({
project,
target,
});
return this.addSchemaOptionsToCommand(localYargs, schemaOptions);
}
async run(options) {
const target = this.getArchitectTarget();
const { configuration = '', project, ...architectOptions } = options;
if (!project) {
// This runs each target sequentially.
// Running them in parallel would jumble the log messages.
let result = 0;
const projectNames = this.getProjectNamesByTarget(target);
if (!projectNames) {
return this.onMissingTarget('Cannot determine project or target for command.');
}
for (const project of projectNames) {
result |= await this.runSingleTarget({ configuration, target, project }, architectOptions);
}
return result;
}
else {
return await this.runSingleTarget({ configuration, target, project }, architectOptions);
}
}
getArchitectProject() {
const { options, positional } = this.context.args;
const [, projectName] = positional;
if (projectName) {
return projectName;
}
// Yargs allows positional args to be used as flags.
if (typeof options['project'] === 'string') {
return options['project'];
}
const target = this.getArchitectTarget();
const projectFromTarget = this.getProjectNamesByTarget(target);
return (projectFromTarget === null || projectFromTarget === void 0 ? void 0 : projectFromTarget.length) ? projectFromTarget[0] : undefined;
}
getProjectNamesByTarget(target) {
const workspace = this.getWorkspaceOrThrow();
const allProjectsForTargetName = [];
for (const [name, project] of workspace.projects) {
if (project.targets.has(target)) {
allProjectsForTargetName.push(name);
}
}
if (allProjectsForTargetName.length === 0) {
return undefined;
}
if (this.multiTarget) {
// For multi target commands, we always list all projects that have the target.
return allProjectsForTargetName;
}
else {
if (allProjectsForTargetName.length === 1) {
return allProjectsForTargetName;
}
const maybeProject = (0, config_1.getProjectByCwd)(workspace);
if (maybeProject) {
return allProjectsForTargetName.includes(maybeProject) ? [maybeProject] : undefined;
}
const { getYargsCompletions, help } = this.context.args.options;
if (!getYargsCompletions && !help) {
// Only issue the below error when not in help / completion mode.
throw new command_module_1.CommandModuleError('Cannot determine project for command.\n' +
'This is a multi-project workspace and more than one project supports this command. ' +
`Run "ng ${this.command}" to execute the command for a specific project or change the current ` +
'working directory to a project directory.\n\n' +
`Available projects are:\n${allProjectsForTargetName
.sort()
.map((p) => `- ${p}`)
.join('\n')}`);
}
}
return undefined;
}
/** @returns a sorted list of project names to be used for auto completion. */
getProjectChoices() {
const { workspace } = this.context;
return workspace ? [...workspace.projects.keys()].sort() : undefined;
}
/** @returns a sorted list of configuration names to be used for auto completion. */
getConfigurationChoices(project) {
var _a, _b;
const projectDefinition = (_a = this.context.workspace) === null || _a === void 0 ? void 0 : _a.projects.get(project);
if (!projectDefinition) {
return undefined;
}
const target = this.getArchitectTarget();
const configurations = (_b = projectDefinition.targets.get(target)) === null || _b === void 0 ? void 0 : _b.configurations;
return configurations ? Object.keys(configurations).sort() : undefined;
}
}
__decorate([
memoize_1.memoize
], ArchitectCommandModule.prototype, "getProjectNamesByTarget", null);
exports.ArchitectCommandModule = ArchitectCommandModule;
@@ -0,0 +1,101 @@
/**
* @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 { logging } from '@angular-devkit/core';
import { ArgumentsCamelCase, Argv, CamelCaseKey, CommandModule as YargsCommandModule } from 'yargs';
import { AnalyticsCollector } from '../analytics/analytics-collector';
import { EventCustomDimension, EventCustomMetric } from '../analytics/analytics-parameters';
import { AngularWorkspace } from '../utilities/config';
import { PackageManagerUtils } from '../utilities/package-manager';
import { Option } from './utilities/json-schema';
export declare type Options<T> = {
[key in keyof T as CamelCaseKey<key>]: T[key];
};
export declare enum CommandScope {
/** Command can only run inside an Angular workspace. */
In = 0,
/** Command can only run outside an Angular workspace. */
Out = 1,
/** Command can run inside and outside an Angular workspace. */
Both = 2
}
export interface CommandContext {
currentDirectory: string;
root: string;
workspace?: AngularWorkspace;
globalConfiguration: AngularWorkspace;
logger: logging.Logger;
packageManager: PackageManagerUtils;
/** Arguments parsed in free-from without parser configuration. */
args: {
positional: string[];
options: {
help: boolean;
jsonHelp: boolean;
getYargsCompletions: boolean;
} & Record<string, unknown>;
};
}
export declare type OtherOptions = Record<string, unknown>;
export interface CommandModuleImplementation<T extends {} = {}> extends Omit<YargsCommandModule<{}, T>, 'builder' | 'handler'> {
/** Scope in which the command can be executed in. */
scope: CommandScope;
/** Path used to load the long description for the command in JSON help text. */
longDescriptionPath?: string;
/** Object declaring the options the command accepts, or a function accepting and returning a yargs instance. */
builder(argv: Argv): Promise<Argv<T>> | Argv<T>;
/** A function which will be passed the parsed argv. */
run(options: Options<T> & OtherOptions): Promise<number | void> | number | void;
}
export interface FullDescribe {
describe?: string;
longDescription?: string;
longDescriptionRelativePath?: string;
}
export declare abstract class CommandModule<T extends {} = {}> implements CommandModuleImplementation<T> {
protected readonly context: CommandContext;
abstract readonly command: string;
abstract readonly describe: string | false;
abstract readonly longDescriptionPath?: string;
protected readonly shouldReportAnalytics: boolean;
readonly scope: CommandScope;
private readonly optionsWithAnalytics;
constructor(context: CommandContext);
/**
* Description object which contains the long command descroption.
* This is used to generate JSON help wich is used in AIO.
*
* `false` will result in a hidden command.
*/
get fullDescribe(): FullDescribe | false;
protected get commandName(): string;
abstract builder(argv: Argv): Promise<Argv<T>> | Argv<T>;
abstract run(options: Options<T> & OtherOptions): Promise<number | void> | number | void;
handler(args: ArgumentsCamelCase<T> & OtherOptions): Promise<void>;
protected getAnalytics(): Promise<AnalyticsCollector | undefined>;
/**
* Adds schema options to a command also this keeps track of options that are required for analytics.
* **Note:** This method should be called from the command bundler method.
*/
protected addSchemaOptionsToCommand<T>(localYargs: Argv<T>, options: Option[]): Argv<T>;
protected getWorkspaceOrThrow(): AngularWorkspace;
/**
* Flush on an interval (if the event loop is waiting).
*
* @returns a method that when called will terminate the periodic
* flush and call flush one last time.
*/
protected getAnalyticsParameters(options: (Options<T> & OtherOptions) | OtherOptions): Partial<Record<EventCustomDimension | EventCustomMetric, string | boolean | number>>;
private reportCommandRunAnalytics;
private reportWorkspaceInfoAnalytics;
}
/**
* Creates an known command module error.
* This is used so during executation we can filter between known validation error and real non handled errors.
*/
export declare class CommandModuleError extends Error {
}
@@ -0,0 +1,271 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CommandModuleError = exports.CommandModule = exports.CommandScope = void 0;
const core_1 = require("@angular-devkit/core");
const fs_1 = require("fs");
const path = __importStar(require("path"));
const yargs_1 = __importDefault(require("yargs"));
const helpers_1 = require("yargs/helpers");
const analytics_1 = require("../analytics/analytics");
const analytics_collector_1 = require("../analytics/analytics-collector");
const analytics_parameters_1 = require("../analytics/analytics-parameters");
const completion_1 = require("../utilities/completion");
const memoize_1 = require("../utilities/memoize");
var CommandScope;
(function (CommandScope) {
/** Command can only run inside an Angular workspace. */
CommandScope[CommandScope["In"] = 0] = "In";
/** Command can only run outside an Angular workspace. */
CommandScope[CommandScope["Out"] = 1] = "Out";
/** Command can run inside and outside an Angular workspace. */
CommandScope[CommandScope["Both"] = 2] = "Both";
})(CommandScope = exports.CommandScope || (exports.CommandScope = {}));
class CommandModule {
constructor(context) {
this.context = context;
this.shouldReportAnalytics = true;
this.scope = CommandScope.Both;
this.optionsWithAnalytics = new Map();
}
/**
* Description object which contains the long command descroption.
* This is used to generate JSON help wich is used in AIO.
*
* `false` will result in a hidden command.
*/
get fullDescribe() {
return this.describe === false
? false
: {
describe: this.describe,
...(this.longDescriptionPath
? {
longDescriptionRelativePath: path
.relative(path.join(__dirname, '../../../../'), this.longDescriptionPath)
.replace(/\\/g, path.posix.sep),
longDescription: (0, fs_1.readFileSync)(this.longDescriptionPath, 'utf8').replace(/\r\n/g, '\n'),
}
: {}),
};
}
get commandName() {
return this.command.split(' ', 1)[0];
}
async handler(args) {
const { _, $0, ...options } = args;
// Camelize options as yargs will return the object in kebab-case when camel casing is disabled.
const camelCasedOptions = {};
for (const [key, value] of Object.entries(options)) {
camelCasedOptions[helpers_1.Parser.camelCase(key)] = value;
}
// Set up autocompletion if appropriate.
const autocompletionExitCode = await (0, completion_1.considerSettingUpAutocompletion)(this.commandName, this.context.logger);
if (autocompletionExitCode !== undefined) {
process.exitCode = autocompletionExitCode;
return;
}
// Gather and report analytics.
const analytics = await this.getAnalytics();
const stopPeriodicFlushes = analytics && analytics.periodFlush();
let exitCode;
try {
if (analytics) {
this.reportCommandRunAnalytics(analytics);
this.reportWorkspaceInfoAnalytics(analytics);
}
exitCode = await this.run(camelCasedOptions);
}
catch (e) {
if (e instanceof core_1.schema.SchemaValidationException) {
this.context.logger.fatal(`Error: ${e.message}`);
exitCode = 1;
}
else {
throw e;
}
}
finally {
await (stopPeriodicFlushes === null || stopPeriodicFlushes === void 0 ? void 0 : stopPeriodicFlushes());
if (typeof exitCode === 'number' && exitCode > 0) {
process.exitCode = exitCode;
}
}
}
async getAnalytics() {
if (!this.shouldReportAnalytics) {
return undefined;
}
const userId = await (0, analytics_1.getAnalyticsUserId)(this.context,
// Don't prompt for `ng update` and `ng analytics` commands.
['update', 'analytics'].includes(this.commandName));
return userId ? new analytics_collector_1.AnalyticsCollector(this.context, userId) : undefined;
}
/**
* Adds schema options to a command also this keeps track of options that are required for analytics.
* **Note:** This method should be called from the command bundler method.
*/
addSchemaOptionsToCommand(localYargs, options) {
const booleanOptionsWithNoPrefix = new Set();
for (const option of options) {
const { default: defaultVal, positional, deprecated, description, alias, userAnalytics, type, hidden, name, choices, } = option;
const sharedOptions = {
alias,
hidden,
description,
deprecated,
choices,
// This should only be done when `--help` is used otherwise default will override options set in angular.json.
...(this.context.args.options.help ? { default: defaultVal } : {}),
};
let dashedName = core_1.strings.dasherize(name);
// Handle options which have been defined in the schema with `no` prefix.
if (type === 'boolean' && dashedName.startsWith('no-')) {
dashedName = dashedName.slice(3);
booleanOptionsWithNoPrefix.add(dashedName);
}
if (positional === undefined) {
localYargs = localYargs.option(dashedName, {
type,
...sharedOptions,
});
}
else {
localYargs = localYargs.positional(dashedName, {
type: type === 'array' || type === 'count' ? 'string' : type,
...sharedOptions,
});
}
// Record option of analytics.
if (userAnalytics !== undefined) {
this.optionsWithAnalytics.set(name, userAnalytics);
}
}
// Handle options which have been defined in the schema with `no` prefix.
if (booleanOptionsWithNoPrefix.size) {
localYargs.middleware((options) => {
for (const key of booleanOptionsWithNoPrefix) {
if (key in options) {
options[`no-${key}`] = !options[key];
delete options[key];
}
}
}, false);
}
return localYargs;
}
getWorkspaceOrThrow() {
const { workspace } = this.context;
if (!workspace) {
throw new CommandModuleError('A workspace is required for this command.');
}
return workspace;
}
/**
* Flush on an interval (if the event loop is waiting).
*
* @returns a method that when called will terminate the periodic
* flush and call flush one last time.
*/
getAnalyticsParameters(options) {
const parameters = {};
const validEventCustomDimensionAndMetrics = new Set([
...Object.values(analytics_parameters_1.EventCustomDimension),
...Object.values(analytics_parameters_1.EventCustomMetric),
]);
for (const [name, ua] of this.optionsWithAnalytics) {
const value = options[name];
if ((typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') &&
validEventCustomDimensionAndMetrics.has(ua)) {
parameters[ua] = value;
}
}
return parameters;
}
reportCommandRunAnalytics(analytics) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const internalMethods = yargs_1.default.getInternalMethods();
// $0 generate component [name] -> generate_component
// $0 add <collection> -> add
const fullCommand = internalMethods.getUsageInstance().getUsage()[0][0]
.split(' ')
.filter((x) => {
const code = x.charCodeAt(0);
return code >= 97 && code <= 122;
})
.join('_');
analytics.reportCommandRunEvent(fullCommand);
}
reportWorkspaceInfoAnalytics(analytics) {
const { workspace } = this.context;
if (!workspace) {
return;
}
let applicationProjectsCount = 0;
let librariesProjectsCount = 0;
for (const project of workspace.projects.values()) {
switch (project.extensions['projectType']) {
case 'application':
applicationProjectsCount++;
break;
case 'library':
librariesProjectsCount++;
break;
}
}
analytics.reportWorkspaceInfoEvent({
[analytics_parameters_1.EventCustomMetric.AllProjectsCount]: librariesProjectsCount + applicationProjectsCount,
[analytics_parameters_1.EventCustomMetric.ApplicationProjectsCount]: applicationProjectsCount,
[analytics_parameters_1.EventCustomMetric.LibraryProjectsCount]: librariesProjectsCount,
});
}
}
__decorate([
memoize_1.memoize
], CommandModule.prototype, "getAnalytics", null);
exports.CommandModule = CommandModule;
/**
* Creates an known command module error.
* This is used so during executation we can filter between known validation error and real non handled errors.
*/
class CommandModuleError extends Error {
}
exports.CommandModuleError = CommandModuleError;
@@ -0,0 +1,9 @@
/**
* @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 { logging } from '@angular-devkit/core';
export declare function runCommand(args: string[], logger: logging.Logger): Promise<number>;
@@ -0,0 +1,159 @@
"use strict";
/**
* @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
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.runCommand = void 0;
const yargs_1 = __importDefault(require("yargs"));
const helpers_1 = require("yargs/helpers");
const cli_1 = require("../commands/add/cli");
const cli_2 = require("../commands/analytics/cli");
const cli_3 = require("../commands/build/cli");
const cli_4 = require("../commands/cache/cli");
const cli_5 = require("../commands/completion/cli");
const cli_6 = require("../commands/config/cli");
const cli_7 = require("../commands/deploy/cli");
const cli_8 = require("../commands/doc/cli");
const cli_9 = require("../commands/e2e/cli");
const cli_10 = require("../commands/extract-i18n/cli");
const cli_11 = require("../commands/generate/cli");
const cli_12 = require("../commands/lint/cli");
const cli_13 = require("../commands/make-this-awesome/cli");
const cli_14 = require("../commands/new/cli");
const cli_15 = require("../commands/run/cli");
const cli_16 = require("../commands/serve/cli");
const cli_17 = require("../commands/test/cli");
const cli_18 = require("../commands/update/cli");
const cli_19 = require("../commands/version/cli");
const color_1 = require("../utilities/color");
const config_1 = require("../utilities/config");
const error_1 = require("../utilities/error");
const package_manager_1 = require("../utilities/package-manager");
const command_module_1 = require("./command-module");
const command_1 = require("./utilities/command");
const json_help_1 = require("./utilities/json-help");
const normalize_options_middleware_1 = require("./utilities/normalize-options-middleware");
const COMMANDS = [
cli_19.VersionCommandModule,
cli_8.DocCommandModule,
cli_13.AwesomeCommandModule,
cli_6.ConfigCommandModule,
cli_2.AnalyticsCommandModule,
cli_1.AddCommandModule,
cli_11.GenerateCommandModule,
cli_3.BuildCommandModule,
cli_9.E2eCommandModule,
cli_17.TestCommandModule,
cli_16.ServeCommandModule,
cli_10.ExtractI18nCommandModule,
cli_7.DeployCommandModule,
cli_12.LintCommandModule,
cli_14.NewCommandModule,
cli_18.UpdateCommandModule,
cli_15.RunCommandModule,
cli_4.CacheCommandModule,
cli_5.CompletionCommandModule,
].sort(); // Will be sorted by class name.
const yargsParser = helpers_1.Parser;
async function runCommand(args, logger) {
var _a, _b;
const { $0, _, help = false, jsonHelp = false, getYargsCompletions = false, ...rest } = yargsParser(args, {
boolean: ['help', 'json-help', 'get-yargs-completions'],
alias: { 'collection': 'c' },
});
// When `getYargsCompletions` is true the scriptName 'ng' at index 0 is not removed.
const positional = getYargsCompletions ? _.slice(1) : _;
let workspace;
let globalConfiguration;
try {
[workspace, globalConfiguration] = await Promise.all([
(0, config_1.getWorkspace)('local'),
(0, config_1.getWorkspace)('global'),
]);
}
catch (e) {
(0, error_1.assertIsError)(e);
logger.fatal(e.message);
return 1;
}
const root = (_a = workspace === null || workspace === void 0 ? void 0 : workspace.basePath) !== null && _a !== void 0 ? _a : process.cwd();
const context = {
globalConfiguration,
workspace,
logger,
currentDirectory: process.cwd(),
root,
packageManager: new package_manager_1.PackageManagerUtils({ globalConfiguration, workspace, root }),
args: {
positional: positional.map((v) => v.toString()),
options: {
help,
jsonHelp,
getYargsCompletions,
...rest,
},
},
};
let localYargs = (0, yargs_1.default)(args);
for (const CommandModule of COMMANDS) {
localYargs = (0, command_1.addCommandModuleToYargs)(localYargs, CommandModule, context);
}
if (jsonHelp) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const usageInstance = localYargs.getInternalMethods().getUsageInstance();
usageInstance.help = () => (0, json_help_1.jsonHelpUsage)();
}
await localYargs
.scriptName('ng')
// https://github.com/yargs/yargs/blob/main/docs/advanced.md#customizing-yargs-parser
.parserConfiguration({
'populate--': true,
'unknown-options-as-args': false,
'dot-notation': false,
'boolean-negation': true,
'strip-aliased': true,
'strip-dashed': true,
'camel-case-expansion': false,
})
.option('json-help', {
describe: 'Show help in JSON format.',
implies: ['help'],
hidden: true,
type: 'boolean',
})
.help('help', 'Shows a help message for this command in the console.')
// A complete list of strings can be found: https://github.com/yargs/yargs/blob/main/locales/en.json
.updateStrings({
'Commands:': color_1.colors.cyan('Commands:'),
'Options:': color_1.colors.cyan('Options:'),
'Positionals:': color_1.colors.cyan('Arguments:'),
'deprecated': color_1.colors.yellow('deprecated'),
'deprecated: %s': color_1.colors.yellow('deprecated:') + ' %s',
'Did you mean %s?': 'Unknown command. Did you mean %s?',
})
.epilogue('For more information, see https://angular.io/cli/.\n')
.demandCommand(1, command_1.demandCommandFailureMessage)
.recommendCommands()
.middleware(normalize_options_middleware_1.normalizeOptionsMiddleware)
.version(false)
.showHelpOnFail(false)
.strict()
.fail((msg, err) => {
throw msg
? // Validation failed example: `Unknown argument:`
new command_module_1.CommandModuleError(msg)
: // Unknown exception, re-throw.
err;
})
.wrap(yargs_1.default.terminalWidth())
.parseAsync();
return (_b = process.exitCode) !== null && _b !== void 0 ? _b : 0;
}
exports.runCommand = runCommand;
@@ -0,0 +1,42 @@
/**
* @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 { Collection } from '@angular-devkit/schematics';
import { FileSystemCollectionDescription, FileSystemSchematicDescription, NodeWorkflow } from '@angular-devkit/schematics/tools';
import { Argv } from 'yargs';
import { CommandModule, CommandModuleImplementation, CommandScope, Options, OtherOptions } from './command-module';
import { Option } from './utilities/json-schema';
export declare const DEFAULT_SCHEMATICS_COLLECTION = "@schematics/angular";
export interface SchematicsCommandArgs {
interactive: boolean;
force: boolean;
'dry-run': boolean;
defaults: boolean;
}
export interface SchematicsExecutionOptions extends Options<SchematicsCommandArgs> {
packageRegistry?: string;
}
export declare abstract class SchematicsCommandModule extends CommandModule<SchematicsCommandArgs> implements CommandModuleImplementation<SchematicsCommandArgs> {
scope: CommandScope;
protected readonly allowPrivateSchematics: boolean;
builder(argv: Argv): Promise<Argv<SchematicsCommandArgs>>;
/** Get schematic schema options.*/
protected getSchematicOptions(collection: Collection<FileSystemCollectionDescription, FileSystemSchematicDescription>, schematicName: string, workflow: NodeWorkflow): Promise<Option[]>;
protected getOrCreateWorkflowForBuilder(collectionName: string): NodeWorkflow;
protected getOrCreateWorkflowForExecution(collectionName: string, options: SchematicsExecutionOptions): Promise<NodeWorkflow>;
protected getSchematicCollections(): Promise<Set<string>>;
protected parseSchematicInfo(schematic: string | undefined): [collectionName: string | undefined, schematicName: string | undefined];
protected runSchematic(options: {
executionOptions: SchematicsExecutionOptions;
schematicOptions: OtherOptions;
collectionName: string;
schematicName: string;
}): Promise<number>;
private defaultProjectDeprecationWarningShown;
private getProjectName;
private getResolvePaths;
}
@@ -0,0 +1,345 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SchematicsCommandModule = exports.DEFAULT_SCHEMATICS_COLLECTION = void 0;
const core_1 = require("@angular-devkit/core");
const schematics_1 = require("@angular-devkit/schematics");
const tools_1 = require("@angular-devkit/schematics/tools");
const path_1 = require("path");
const analytics_1 = require("../analytics/analytics");
const analytics_parameters_1 = require("../analytics/analytics-parameters");
const config_1 = require("../utilities/config");
const error_1 = require("../utilities/error");
const memoize_1 = require("../utilities/memoize");
const tty_1 = require("../utilities/tty");
const command_module_1 = require("./command-module");
const json_schema_1 = require("./utilities/json-schema");
const schematic_engine_host_1 = require("./utilities/schematic-engine-host");
const schematic_workflow_1 = require("./utilities/schematic-workflow");
exports.DEFAULT_SCHEMATICS_COLLECTION = '@schematics/angular';
class SchematicsCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.scope = command_module_1.CommandScope.In;
this.allowPrivateSchematics = false;
this.defaultProjectDeprecationWarningShown = false;
}
async builder(argv) {
return argv
.option('interactive', {
describe: 'Enable interactive input prompts.',
type: 'boolean',
default: true,
})
.option('dry-run', {
describe: 'Run through and reports activity without writing out results.',
type: 'boolean',
default: false,
})
.option('defaults', {
describe: 'Disable interactive input prompts for options with a default.',
type: 'boolean',
default: false,
})
.option('force', {
describe: 'Force overwriting of existing files.',
type: 'boolean',
default: false,
})
.strict();
}
/** Get schematic schema options.*/
async getSchematicOptions(collection, schematicName, workflow) {
const schematic = collection.createSchematic(schematicName, true);
const { schemaJson } = schematic.description;
if (!schemaJson) {
return [];
}
return (0, json_schema_1.parseJsonSchemaToOptions)(workflow.registry, schemaJson);
}
getOrCreateWorkflowForBuilder(collectionName) {
return new tools_1.NodeWorkflow(this.context.root, {
resolvePaths: this.getResolvePaths(collectionName),
engineHostCreator: (options) => new schematic_engine_host_1.SchematicEngineHost(options.resolvePaths),
});
}
async getOrCreateWorkflowForExecution(collectionName, options) {
const { logger, root, packageManager } = this.context;
const { force, dryRun, packageRegistry } = options;
const workflow = new tools_1.NodeWorkflow(root, {
force,
dryRun,
packageManager: packageManager.name,
// A schema registry is required to allow customizing addUndefinedDefaults
registry: new core_1.schema.CoreSchemaRegistry(schematics_1.formats.standardFormats),
packageRegistry,
resolvePaths: this.getResolvePaths(collectionName),
schemaValidation: true,
optionTransforms: [
// Add configuration file defaults
async (schematic, current) => {
const projectName = typeof (current === null || current === void 0 ? void 0 : current.project) === 'string' ? current.project : this.getProjectName();
return {
...(await (0, config_1.getSchematicDefaults)(schematic.collection.name, schematic.name, projectName)),
...current,
};
},
],
engineHostCreator: (options) => new schematic_engine_host_1.SchematicEngineHost(options.resolvePaths),
});
workflow.registry.addPostTransform(core_1.schema.transforms.addUndefinedDefaults);
workflow.registry.useXDeprecatedProvider((msg) => logger.warn(msg));
workflow.registry.addSmartDefaultProvider('projectName', () => this.getProjectName());
const workingDir = (0, core_1.normalize)((0, path_1.relative)(this.context.root, process.cwd()));
workflow.registry.addSmartDefaultProvider('workingDirectory', () => workingDir === '' ? undefined : workingDir);
let shouldReportAnalytics = true;
workflow.engineHost.registerOptionsTransform(async (schematic, options) => {
// Report analytics
if (shouldReportAnalytics) {
shouldReportAnalytics = false;
const { collection: { name: collectionName }, name: schematicName, } = schematic;
const analytics = (0, analytics_1.isPackageNameSafeForAnalytics)(collectionName)
? await this.getAnalytics()
: undefined;
analytics === null || analytics === void 0 ? void 0 : analytics.reportSchematicRunEvent({
[analytics_parameters_1.EventCustomDimension.SchematicCollectionName]: collectionName,
[analytics_parameters_1.EventCustomDimension.SchematicName]: schematicName,
...this.getAnalyticsParameters(options),
});
}
return options;
});
if (options.interactive !== false && (0, tty_1.isTTY)()) {
workflow.registry.usePromptProvider(async (definitions) => {
const questions = definitions
.filter((definition) => !options.defaults || definition.default === undefined)
.map((definition) => {
var _a;
const question = {
name: definition.id,
message: definition.message,
default: definition.default,
};
const validator = definition.validator;
if (validator) {
question.validate = (input) => validator(input);
// Filter allows transformation of the value prior to validation
question.filter = async (input) => {
for (const type of definition.propertyTypes) {
let value;
switch (type) {
case 'string':
value = String(input);
break;
case 'integer':
case 'number':
value = Number(input);
break;
default:
value = input;
break;
}
// Can be a string if validation fails
const isValid = (await validator(value)) === true;
if (isValid) {
return value;
}
}
return input;
};
}
switch (definition.type) {
case 'confirmation':
question.type = 'confirm';
break;
case 'list':
question.type = definition.multiselect ? 'checkbox' : 'list';
question.choices = (_a = definition.items) === null || _a === void 0 ? void 0 : _a.map((item) => {
return typeof item == 'string'
? item
: {
name: item.label,
value: item.value,
};
});
break;
default:
question.type = definition.type;
break;
}
return question;
});
if (questions.length) {
const { prompt } = await Promise.resolve().then(() => __importStar(require('inquirer')));
return prompt(questions);
}
else {
return {};
}
});
}
return workflow;
}
async getSchematicCollections() {
var _a;
// Resolve relative collections from the location of `angular.json`
const resolveRelativeCollection = (collectionName) => collectionName.charAt(0) === '.'
? (0, path_1.resolve)(this.context.root, collectionName)
: collectionName;
const getSchematicCollections = (configSection) => {
if (!configSection) {
return undefined;
}
const { schematicCollections, defaultCollection } = configSection;
if (Array.isArray(schematicCollections)) {
return new Set(schematicCollections.map((c) => resolveRelativeCollection(c)));
}
else if (typeof defaultCollection === 'string') {
return new Set([resolveRelativeCollection(defaultCollection)]);
}
return undefined;
};
const { workspace, globalConfiguration } = this.context;
if (workspace) {
const project = (0, config_1.getProjectByCwd)(workspace);
if (project) {
const value = getSchematicCollections(workspace.getProjectCli(project));
if (value) {
return value;
}
}
}
const value = (_a = getSchematicCollections(workspace === null || workspace === void 0 ? void 0 : workspace.getCli())) !== null && _a !== void 0 ? _a : getSchematicCollections(globalConfiguration.getCli());
if (value) {
return value;
}
return new Set([exports.DEFAULT_SCHEMATICS_COLLECTION]);
}
parseSchematicInfo(schematic) {
if (schematic === null || schematic === void 0 ? void 0 : schematic.includes(':')) {
const [collectionName, schematicName] = schematic.split(':', 2);
return [collectionName, schematicName];
}
return [undefined, schematic];
}
async runSchematic(options) {
const { logger } = this.context;
const { schematicOptions, executionOptions, collectionName, schematicName } = options;
const workflow = await this.getOrCreateWorkflowForExecution(collectionName, executionOptions);
if (!schematicName) {
throw new Error('schematicName cannot be undefined.');
}
const { unsubscribe, files } = (0, schematic_workflow_1.subscribeToWorkflow)(workflow, logger);
try {
await workflow
.execute({
collection: collectionName,
schematic: schematicName,
options: schematicOptions,
logger,
allowPrivate: this.allowPrivateSchematics,
})
.toPromise();
if (!files.size) {
logger.info('Nothing to be done.');
}
if (executionOptions.dryRun) {
logger.warn(`\nNOTE: The "--dry-run" option means no changes were made.`);
}
}
catch (err) {
// In case the workflow was not successful, show an appropriate error message.
if (err instanceof schematics_1.UnsuccessfulWorkflowExecution) {
// "See above" because we already printed the error.
logger.fatal('The Schematic workflow failed. See above.');
}
else {
(0, error_1.assertIsError)(err);
logger.fatal(err.message);
}
return 1;
}
finally {
unsubscribe();
}
return 0;
}
getProjectName() {
const { workspace, logger } = this.context;
if (!workspace) {
return undefined;
}
const projectName = (0, config_1.getProjectByCwd)(workspace);
if (projectName) {
return projectName;
}
const defaultProjectName = workspace.extensions['defaultProject'];
if (typeof defaultProjectName === 'string' && defaultProjectName) {
if (!this.defaultProjectDeprecationWarningShown) {
logger.warn(core_1.tags.oneLine `
DEPRECATED: The 'defaultProject' workspace option has been deprecated.
The project to use will be determined from the current working directory.
`);
this.defaultProjectDeprecationWarningShown = true;
}
return defaultProjectName;
}
return undefined;
}
getResolvePaths(collectionName) {
const { workspace, root } = this.context;
return workspace
? // Workspace
collectionName === exports.DEFAULT_SCHEMATICS_COLLECTION
? // Favor __dirname for @schematics/angular to use the build-in version
[__dirname, process.cwd(), root]
: [process.cwd(), root, __dirname]
: // Global
[__dirname, process.cwd()];
}
}
__decorate([
memoize_1.memoize
], SchematicsCommandModule.prototype, "getOrCreateWorkflowForBuilder", null);
__decorate([
memoize_1.memoize
], SchematicsCommandModule.prototype, "getOrCreateWorkflowForExecution", null);
__decorate([
memoize_1.memoize
], SchematicsCommandModule.prototype, "getSchematicCollections", null);
exports.SchematicsCommandModule = SchematicsCommandModule;
@@ -0,0 +1,13 @@
/**
* @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 { CommandContext, CommandModule, CommandModuleImplementation } from '../command-module';
export declare const demandCommandFailureMessage = "You need to specify a command before moving on. Use '--help' to view the available commands.";
export declare function addCommandModuleToYargs<T extends object, U extends Partial<CommandModuleImplementation> & {
new (context: CommandContext): Partial<CommandModuleImplementation> & CommandModule;
}>(localYargs: Argv<T>, commandModule: U, context: CommandContext): Argv<T>;
@@ -0,0 +1,38 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.addCommandModuleToYargs = exports.demandCommandFailureMessage = void 0;
const command_module_1 = require("../command-module");
exports.demandCommandFailureMessage = `You need to specify a command before moving on. Use '--help' to view the available commands.`;
function addCommandModuleToYargs(localYargs, commandModule, context) {
const cmd = new commandModule(context);
const { args: { options: { jsonHelp }, }, workspace, } = context;
const describe = jsonHelp ? cmd.fullDescribe : cmd.describe;
return localYargs.command({
command: cmd.command,
aliases: cmd.aliases,
describe:
// We cannot add custom fields in help, such as long command description which is used in AIO.
// Therefore, we get around this by adding a complex object as a string which we later parse when generating the help files.
typeof describe === 'object' ? JSON.stringify(describe) : describe,
deprecated: cmd.deprecated,
builder: (argv) => {
// Skip scope validation when running with '--json-help' since it's easier to generate the output for all commands this way.
const isInvalidScope = !jsonHelp &&
((cmd.scope === command_module_1.CommandScope.In && !workspace) ||
(cmd.scope === command_module_1.CommandScope.Out && workspace));
if (isInvalidScope) {
throw new command_module_1.CommandModuleError(`This command is not available when running the Angular CLI ${workspace ? 'inside' : 'outside'} a workspace.`);
}
return cmd.builder(argv);
},
handler: (args) => cmd.handler(args),
});
}
exports.addCommandModuleToYargs = addCommandModuleToYargs;
@@ -0,0 +1,36 @@
/**
* @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
*/
interface JsonHelpOption {
name: string;
type?: string;
deprecated: boolean | string;
aliases?: string[];
default?: string;
required?: boolean;
positional?: number;
enum?: string[];
description?: string;
}
interface JsonHelpDescription {
shortDescription?: string;
longDescription?: string;
longDescriptionRelativePath?: string;
}
interface JsonHelpSubcommand extends JsonHelpDescription {
name: string;
aliases: string[];
deprecated: string | boolean;
}
export interface JsonHelp extends JsonHelpDescription {
name: string;
command: string;
options: JsonHelpOption[];
subcommands?: JsonHelpSubcommand[];
}
export declare function jsonHelpUsage(): string;
export {};
@@ -0,0 +1,94 @@
"use strict";
/**
* @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
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.jsonHelpUsage = void 0;
const yargs_1 = __importDefault(require("yargs"));
const yargsDefaultCommandRegExp = /^\$0|\*/;
function jsonHelpUsage() {
var _a, _b, _c, _d, _e;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const localYargs = yargs_1.default;
const { deprecatedOptions, alias: aliases, array, string, boolean, number, choices, demandedOptions, default: defaultVal, hiddenOptions = [], } = localYargs.getOptions();
const internalMethods = localYargs.getInternalMethods();
const usageInstance = internalMethods.getUsageInstance();
const context = internalMethods.getContext();
const descriptions = usageInstance.getDescriptions();
const groups = localYargs.getGroups();
const positional = groups[usageInstance.getPositionalGroupName()];
const hidden = new Set(hiddenOptions);
const normalizeOptions = [];
const allAliases = new Set([...Object.values(aliases).flat()]);
for (const [names, type] of [
[array, 'array'],
[string, 'string'],
[boolean, 'boolean'],
[number, 'number'],
]) {
for (const name of names) {
if (allAliases.has(name) || hidden.has(name)) {
// Ignore hidden, aliases and already visited option.
continue;
}
const positionalIndex = (_a = positional === null || positional === void 0 ? void 0 : positional.indexOf(name)) !== null && _a !== void 0 ? _a : -1;
const alias = aliases[name];
normalizeOptions.push({
name,
type,
deprecated: deprecatedOptions[name],
aliases: (alias === null || alias === void 0 ? void 0 : alias.length) > 0 ? alias : undefined,
default: defaultVal[name],
required: demandedOptions[name],
enum: choices[name],
description: (_b = descriptions[name]) === null || _b === void 0 ? void 0 : _b.replace('__yargsString__:', ''),
positional: positionalIndex >= 0 ? positionalIndex : undefined,
});
}
}
// https://github.com/yargs/yargs/blob/00e4ebbe3acd438e73fdb101e75b4f879eb6d345/lib/usage.ts#L124
const subcommands = usageInstance.getCommands()
.map(([name, rawDescription, isDefault, aliases, deprecated]) => ({
name: name.split(' ', 1)[0].replace(yargsDefaultCommandRegExp, ''),
command: name.replace(yargsDefaultCommandRegExp, ''),
default: isDefault || undefined,
...parseDescription(rawDescription),
aliases,
deprecated,
}))
.sort((a, b) => a.name.localeCompare(b.name));
const [command, rawDescription] = (_c = usageInstance.getUsage()[0]) !== null && _c !== void 0 ? _c : [];
const defaultSubCommand = (_e = (_d = subcommands.find((x) => x.default)) === null || _d === void 0 ? void 0 : _d.command) !== null && _e !== void 0 ? _e : '';
const otherSubcommands = subcommands.filter((s) => !s.default);
const output = {
name: [...context.commands].pop(),
command: `${command === null || command === void 0 ? void 0 : command.replace(yargsDefaultCommandRegExp, localYargs['$0'])}${defaultSubCommand}`,
...parseDescription(rawDescription),
options: normalizeOptions.sort((a, b) => a.name.localeCompare(b.name)),
subcommands: otherSubcommands.length ? otherSubcommands : undefined,
};
return JSON.stringify(output, undefined, 2);
}
exports.jsonHelpUsage = jsonHelpUsage;
function parseDescription(rawDescription) {
try {
const { longDescription, describe: shortDescription, longDescriptionRelativePath, } = JSON.parse(rawDescription);
return {
shortDescription,
longDescriptionRelativePath,
longDescription,
};
}
catch {
return {
shortDescription: rawDescription,
};
}
}
@@ -0,0 +1,40 @@
/**
* @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 { json } from '@angular-devkit/core';
import yargs from 'yargs';
/**
* An option description.
*/
export interface Option extends yargs.Options {
/**
* The name of the option.
*/
name: string;
/**
* Whether this option is required or not.
*/
required?: boolean;
/**
* Format field of this option.
*/
format?: string;
/**
* Whether this option should be hidden from the help output. It will still show up in JSON help.
*/
hidden?: boolean;
/**
* If this option can be used as an argument, the position of the argument. Otherwise omitted.
*/
positional?: number;
/**
* Whether or not to report this option to the Angular Team, and which custom field to use.
* If this is falsey, do not report this option.
*/
userAnalytics?: string;
}
export declare function parseJsonSchemaToOptions(registry: json.schema.SchemaRegistry, schema: json.JsonObject, interactive?: boolean): Promise<Option[]>;
@@ -0,0 +1,144 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.parseJsonSchemaToOptions = void 0;
const core_1 = require("@angular-devkit/core");
async function parseJsonSchemaToOptions(registry, schema, interactive = true) {
const options = [];
function visitor(current, pointer, parentSchema) {
if (!parentSchema) {
// Ignore root.
return;
}
else if (pointer.split(/\/(?:properties|items|definitions)\//g).length > 2) {
// Ignore subitems (objects or arrays).
return;
}
else if (core_1.json.isJsonArray(current)) {
return;
}
if (pointer.indexOf('/not/') != -1) {
// We don't support anyOf/not.
throw new Error('The "not" keyword is not supported in JSON Schema.');
}
const ptr = core_1.json.schema.parseJsonPointer(pointer);
const name = ptr[ptr.length - 1];
if (ptr[ptr.length - 2] != 'properties') {
// Skip any non-property items.
return;
}
const typeSet = core_1.json.schema.getTypesOfSchema(current);
if (typeSet.size == 0) {
throw new Error('Cannot find type of schema.');
}
// We only support number, string or boolean (or array of those), so remove everything else.
const types = [...typeSet].filter((x) => {
switch (x) {
case 'boolean':
case 'number':
case 'string':
return true;
case 'array':
// Only include arrays if they're boolean, string or number.
if (core_1.json.isJsonObject(current.items) &&
typeof current.items.type == 'string' &&
['boolean', 'number', 'string'].includes(current.items.type)) {
return true;
}
return false;
default:
return false;
}
});
if (types.length == 0) {
// This means it's not usable on the command line. e.g. an Object.
return;
}
// Only keep enum values we support (booleans, numbers and strings).
const enumValues = ((core_1.json.isJsonArray(current.enum) && current.enum) || []).filter((x) => {
switch (typeof x) {
case 'boolean':
case 'number':
case 'string':
return true;
default:
return false;
}
});
let defaultValue = undefined;
if (current.default !== undefined) {
switch (types[0]) {
case 'string':
if (typeof current.default == 'string') {
defaultValue = current.default;
}
break;
case 'number':
if (typeof current.default == 'number') {
defaultValue = current.default;
}
break;
case 'boolean':
if (typeof current.default == 'boolean') {
defaultValue = current.default;
}
break;
}
}
const type = types[0];
const $default = current.$default;
const $defaultIndex = core_1.json.isJsonObject($default) && $default['$source'] == 'argv' ? $default['index'] : undefined;
const positional = typeof $defaultIndex == 'number' ? $defaultIndex : undefined;
let required = core_1.json.isJsonArray(schema.required) ? schema.required.includes(name) : false;
if (required && interactive && current['x-prompt']) {
required = false;
}
const alias = core_1.json.isJsonArray(current.aliases)
? [...current.aliases].map((x) => '' + x)
: current.alias
? ['' + current.alias]
: [];
const format = typeof current.format == 'string' ? current.format : undefined;
const visible = current.visible === undefined || current.visible === true;
const hidden = !!current.hidden || !visible;
const xUserAnalytics = current['x-user-analytics'];
const userAnalytics = typeof xUserAnalytics === 'string' ? xUserAnalytics : undefined;
// Deprecated is set only if it's true or a string.
const xDeprecated = current['x-deprecated'];
const deprecated = xDeprecated === true || typeof xDeprecated === 'string' ? xDeprecated : undefined;
const option = {
name,
description: '' + (current.description === undefined ? '' : current.description),
type,
default: defaultValue,
choices: enumValues.length ? enumValues : undefined,
required,
alias,
format,
hidden,
userAnalytics,
deprecated,
positional,
};
options.push(option);
}
const flattenedSchema = await registry.flatten(schema).toPromise();
core_1.json.schema.visitJsonSchema(flattenedSchema, visitor);
// Sort by positional and name.
return options.sort((a, b) => {
if (a.positional) {
return b.positional ? a.positional - b.positional : a.name.localeCompare(b.name);
}
else if (b.positional) {
return -1;
}
return a.name.localeCompare(b.name);
});
}
exports.parseJsonSchemaToOptions = parseJsonSchemaToOptions;
@@ -0,0 +1,18 @@
/**
* @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 * as yargs from 'yargs';
/**
* A Yargs middleware that normalizes non Array options when the argument has been provided multiple times.
*
* By default, when an option is non array and it is provided multiple times in the command line, yargs
* will not override it's value but instead it will be changed to an array unless `duplicate-arguments-array` is disabled.
* But this option also have an effect on real array options which isn't desired.
*
* See: https://github.com/yargs/yargs-parser/pull/163#issuecomment-516566614
*/
export declare function normalizeOptionsMiddleware(args: yargs.Arguments): void;
@@ -0,0 +1,59 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.normalizeOptionsMiddleware = void 0;
const yargs = __importStar(require("yargs"));
/**
* A Yargs middleware that normalizes non Array options when the argument has been provided multiple times.
*
* By default, when an option is non array and it is provided multiple times in the command line, yargs
* will not override it's value but instead it will be changed to an array unless `duplicate-arguments-array` is disabled.
* But this option also have an effect on real array options which isn't desired.
*
* See: https://github.com/yargs/yargs-parser/pull/163#issuecomment-516566614
*/
function normalizeOptionsMiddleware(args) {
// `getOptions` is not included in the types even though it's public API.
// https://github.com/yargs/yargs/issues/2098
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const { array } = yargs.getOptions();
const arrayOptions = new Set(array);
for (const [key, value] of Object.entries(args)) {
if (key !== '_' && Array.isArray(value) && !arrayOptions.has(key)) {
const newValue = value.pop();
// eslint-disable-next-line no-console
console.warn(`Option '${key}' has been specified multiple times. The value '${newValue}' will be used.`);
args[key] = newValue;
}
}
}
exports.normalizeOptionsMiddleware = normalizeOptionsMiddleware;
@@ -0,0 +1,15 @@
/**
* @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 { RuleFactory } from '@angular-devkit/schematics';
import { FileSystemCollectionDesc, NodeModulesEngineHost } from '@angular-devkit/schematics/tools';
export declare class SchematicEngineHost extends NodeModulesEngineHost {
protected _resolveReferenceString(refString: string, parentPath: string, collectionDescription?: FileSystemCollectionDesc): {
ref: RuleFactory<{}>;
path: string;
} | null;
}
@@ -0,0 +1,187 @@
"use strict";
/**
* @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
*/
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.SchematicEngineHost = void 0;
const schematics_1 = require("@angular-devkit/schematics");
const tools_1 = require("@angular-devkit/schematics/tools");
const fs_1 = require("fs");
const jsonc_parser_1 = require("jsonc-parser");
const module_1 = require("module");
const path_1 = require("path");
const vm_1 = require("vm");
const error_1 = require("../../utilities/error");
/**
* Environment variable to control schematic package redirection
*/
const schematicRedirectVariable = (_a = process.env['NG_SCHEMATIC_REDIRECT']) === null || _a === void 0 ? void 0 : _a.toLowerCase();
function shouldWrapSchematic(schematicFile, schematicEncapsulation) {
// Check environment variable if present
switch (schematicRedirectVariable) {
case '0':
case 'false':
case 'off':
case 'none':
return false;
case 'all':
return true;
}
const normalizedSchematicFile = schematicFile.replace(/\\/g, '/');
// Never wrap the internal update schematic when executed directly
// It communicates with the update command via `global`
// But we still want to redirect schematics located in `@angular/cli/node_modules`.
if (normalizedSchematicFile.includes('node_modules/@angular/cli/') &&
!normalizedSchematicFile.includes('node_modules/@angular/cli/node_modules/')) {
return false;
}
// Check for first-party Angular schematic packages
// Angular schematics are safe to use in the wrapped VM context
if (/\/node_modules\/@(?:angular|schematics|nguniversal)\//.test(normalizedSchematicFile)) {
return true;
}
// Otherwise use the value of the schematic collection's encapsulation option (current default of false)
return schematicEncapsulation;
}
class SchematicEngineHost extends tools_1.NodeModulesEngineHost {
_resolveReferenceString(refString, parentPath, collectionDescription) {
const [path, name] = refString.split('#', 2);
// Mimic behavior of ExportStringRef class used in default behavior
const fullPath = path[0] === '.' ? (0, path_1.resolve)(parentPath !== null && parentPath !== void 0 ? parentPath : process.cwd(), path) : path;
const referenceRequire = (0, module_1.createRequire)(__filename);
const schematicFile = referenceRequire.resolve(fullPath, { paths: [parentPath] });
if (shouldWrapSchematic(schematicFile, !!(collectionDescription === null || collectionDescription === void 0 ? void 0 : collectionDescription.encapsulation))) {
const schematicPath = (0, path_1.dirname)(schematicFile);
const moduleCache = new Map();
const factoryInitializer = wrap(schematicFile, schematicPath, moduleCache, name || 'default');
const factory = factoryInitializer();
if (!factory || typeof factory !== 'function') {
return null;
}
return { ref: factory, path: schematicPath };
}
// All other schematics use default behavior
return super._resolveReferenceString(refString, parentPath, collectionDescription);
}
}
exports.SchematicEngineHost = SchematicEngineHost;
/**
* Minimal shim modules for legacy deep imports of `@schematics/angular`
*/
const legacyModules = {
'@schematics/angular/utility/config': {
getWorkspace(host) {
const path = '/.angular.json';
const data = host.read(path);
if (!data) {
throw new schematics_1.SchematicsException(`Could not find (${path})`);
}
return (0, jsonc_parser_1.parse)(data.toString(), [], { allowTrailingComma: true });
},
},
'@schematics/angular/utility/project': {
buildDefaultPath(project) {
const root = project.sourceRoot ? `/${project.sourceRoot}/` : `/${project.root}/src/`;
return `${root}${project.projectType === 'application' ? 'app' : 'lib'}`;
},
},
};
/**
* Wrap a JavaScript file in a VM context to allow specific Angular dependencies to be redirected.
* This VM setup is ONLY intended to redirect dependencies.
*
* @param schematicFile A JavaScript schematic file path that should be wrapped.
* @param schematicDirectory A directory that will be used as the location of the JavaScript file.
* @param moduleCache A map to use for caching repeat module usage and proper `instanceof` support.
* @param exportName An optional name of a specific export to return. Otherwise, return all exports.
*/
function wrap(schematicFile, schematicDirectory, moduleCache, exportName) {
const hostRequire = (0, module_1.createRequire)(__filename);
const schematicRequire = (0, module_1.createRequire)(schematicFile);
const customRequire = function (id) {
if (legacyModules[id]) {
// Provide compatibility modules for older versions of @angular/cdk
return legacyModules[id];
}
else if (id.startsWith('schematics:')) {
// Schematics built-in modules use the `schematics` scheme (similar to the Node.js `node` scheme)
const builtinId = id.slice(11);
const builtinModule = loadBuiltinModule(builtinId);
if (!builtinModule) {
throw new Error(`Unknown schematics built-in module '${id}' requested from schematic '${schematicFile}'`);
}
return builtinModule;
}
else if (id.startsWith('@angular-devkit/') || id.startsWith('@schematics/')) {
// Files should not redirect `@angular/core` and instead use the direct
// dependency if available. This allows old major version migrations to continue to function
// even though the latest major version may have breaking changes in `@angular/core`.
if (id.startsWith('@angular-devkit/core')) {
try {
return schematicRequire(id);
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code !== 'MODULE_NOT_FOUND') {
throw e;
}
}
}
// Resolve from inside the `@angular/cli` project
return hostRequire(id);
}
else if (id.startsWith('.') || id.startsWith('@angular/cdk')) {
// Wrap relative files inside the schematic collection
// Also wrap `@angular/cdk`, it contains helper utilities that import core schematic packages
// Resolve from the original file
const modulePath = schematicRequire.resolve(id);
// Use cached module if available
const cachedModule = moduleCache.get(modulePath);
if (cachedModule) {
return cachedModule;
}
// Do not wrap vendored third-party packages or JSON files
if (!/[/\\]node_modules[/\\]@schematics[/\\]angular[/\\]third_party[/\\]/.test(modulePath) &&
!modulePath.endsWith('.json')) {
// Wrap module and save in cache
const wrappedModule = wrap(modulePath, (0, path_1.dirname)(modulePath), moduleCache)();
moduleCache.set(modulePath, wrappedModule);
return wrappedModule;
}
}
// All others are required directly from the original file
return schematicRequire(id);
};
// Setup a wrapper function to capture the module's exports
const schematicCode = (0, fs_1.readFileSync)(schematicFile, 'utf8');
// `module` is required due to @angular/localize ng-add being in UMD format
const headerCode = '(function() {\nvar exports = {};\nvar module = { exports };\n';
const footerCode = exportName
? `\nreturn module.exports['${exportName}'];});`
: '\nreturn module.exports;});';
const script = new vm_1.Script(headerCode + schematicCode + footerCode, {
filename: schematicFile,
lineOffset: 3,
});
const context = {
__dirname: schematicDirectory,
__filename: schematicFile,
Buffer,
console,
process,
get global() {
return this;
},
require: customRequire,
};
const exportsFactory = script.runInNewContext(context);
return exportsFactory;
}
function loadBuiltinModule(id) {
return undefined;
}
@@ -0,0 +1,14 @@
/**
* @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 { logging } from '@angular-devkit/core';
import { NodeWorkflow } from '@angular-devkit/schematics/tools';
export declare function subscribeToWorkflow(workflow: NodeWorkflow, logger: logging.LoggerApi): {
files: Set<string>;
error: boolean;
unsubscribe: () => void;
};
@@ -0,0 +1,68 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.subscribeToWorkflow = void 0;
const core_1 = require("@angular-devkit/core");
const color_1 = require("../../utilities/color");
function subscribeToWorkflow(workflow, logger) {
const files = new Set();
let error = false;
let logs = [];
const reporterSubscription = workflow.reporter.subscribe((event) => {
// Strip leading slash to prevent confusion.
const eventPath = event.path.charAt(0) === '/' ? event.path.substring(1) : event.path;
switch (event.kind) {
case 'error':
error = true;
const desc = event.description == 'alreadyExist' ? 'already exists' : 'does not exist';
logger.error(`ERROR! ${eventPath} ${desc}.`);
break;
case 'update':
logs.push(core_1.tags.oneLine `
${color_1.colors.cyan('UPDATE')} ${eventPath} (${event.content.length} bytes)
`);
files.add(eventPath);
break;
case 'create':
logs.push(core_1.tags.oneLine `
${color_1.colors.green('CREATE')} ${eventPath} (${event.content.length} bytes)
`);
files.add(eventPath);
break;
case 'delete':
logs.push(`${color_1.colors.yellow('DELETE')} ${eventPath}`);
files.add(eventPath);
break;
case 'rename':
const eventToPath = event.to.charAt(0) === '/' ? event.to.substring(1) : event.to;
logs.push(`${color_1.colors.blue('RENAME')} ${eventPath} => ${eventToPath}`);
files.add(eventPath);
break;
}
});
const lifecycleSubscription = workflow.lifeCycle.subscribe((event) => {
if (event.kind == 'end' || event.kind == 'post-tasks-start') {
if (!error) {
// Output the logging queue, no error happened.
logs.forEach((log) => logger.info(log));
}
logs = [];
error = false;
}
});
return {
files,
error,
unsubscribe: () => {
reporterSubscription.unsubscribe();
lifecycleSubscription.unsubscribe();
},
};
}
exports.subscribeToWorkflow = subscribeToWorkflow;
+33
View File
@@ -0,0 +1,33 @@
/**
* @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, Options, OtherOptions } from '../../command-builder/command-module';
import { SchematicsCommandArgs, SchematicsCommandModule } from '../../command-builder/schematics-command-module';
interface AddCommandArgs extends SchematicsCommandArgs {
collection: string;
verbose?: boolean;
registry?: string;
'skip-confirmation'?: boolean;
}
export declare class AddCommandModule extends SchematicsCommandModule implements CommandModuleImplementation<AddCommandArgs> {
command: string;
describe: string;
longDescriptionPath: string;
protected allowPrivateSchematics: boolean;
private readonly schematicName;
private rootRequire;
builder(argv: Argv): Promise<Argv<AddCommandArgs>>;
run(options: Options<AddCommandArgs> & OtherOptions): Promise<number | void>;
private isProjectVersionValid;
private getCollectionName;
private isPackageInstalled;
private executeSchematic;
private findProjectVersion;
private hasMismatchedPeer;
}
export {};
+368
View File
@@ -0,0 +1,368 @@
"use strict";
/**
* @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
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.AddCommandModule = void 0;
const core_1 = require("@angular-devkit/core");
const tools_1 = require("@angular-devkit/schematics/tools");
const module_1 = require("module");
const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
const path_1 = require("path");
const semver_1 = require("semver");
const workspace_schema_1 = require("../../../lib/config/workspace-schema");
const schematics_command_module_1 = require("../../command-builder/schematics-command-module");
const color_1 = require("../../utilities/color");
const error_1 = require("../../utilities/error");
const package_metadata_1 = require("../../utilities/package-metadata");
const prompt_1 = require("../../utilities/prompt");
const spinner_1 = require("../../utilities/spinner");
const tty_1 = require("../../utilities/tty");
const version_1 = require("../../utilities/version");
/**
* The set of packages that should have certain versions excluded from consideration
* when attempting to find a compatible version for a package.
* The key is a package name and the value is a SemVer range of versions to exclude.
*/
const packageVersionExclusions = {
// @angular/localize@9.x and earlier versions as well as @angular/localize@10.0 prereleases do not have peer dependencies setup.
'@angular/localize': '<10.0.0',
// @angular/material@7.x versions have unbounded peer dependency ranges (>=7.0.0).
'@angular/material': '7.x',
};
class AddCommandModule extends schematics_command_module_1.SchematicsCommandModule {
constructor() {
super(...arguments);
this.command = 'add <collection>';
this.describe = 'Adds support for an external library to your project.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
this.allowPrivateSchematics = true;
this.schematicName = 'ng-add';
this.rootRequire = (0, module_1.createRequire)(this.context.root + '/');
}
async builder(argv) {
const localYargs = (await super.builder(argv))
.positional('collection', {
description: 'The package to be added.',
type: 'string',
demandOption: true,
})
.option('registry', { description: 'The NPM registry to use.', type: 'string' })
.option('verbose', {
description: 'Display additional details about internal operations during execution.',
type: 'boolean',
default: false,
})
.option('skip-confirmation', {
description: 'Skip asking a confirmation prompt before installing and executing the package. ' +
'Ensure package name is correct prior to using this option.',
type: 'boolean',
default: false,
})
// Prior to downloading we don't know the full schema and therefore we cannot be strict on the options.
// Possibly in the future update the logic to use the following syntax:
// `ng add @angular/localize -- --package-options`.
.strict(false);
const collectionName = await this.getCollectionName();
const workflow = await this.getOrCreateWorkflowForBuilder(collectionName);
try {
const collection = workflow.engine.createCollection(collectionName);
const options = await this.getSchematicOptions(collection, this.schematicName, workflow);
return this.addSchemaOptionsToCommand(localYargs, options);
}
catch (error) {
// During `ng add` prior to the downloading of the package
// we are not able to resolve and create a collection.
// Or when the the collection value is a path to a tarball.
}
return localYargs;
}
// eslint-disable-next-line max-lines-per-function
async run(options) {
var _a;
const { logger, packageManager } = this.context;
const { verbose, registry, collection, skipConfirmation } = options;
packageManager.ensureCompatibility();
let packageIdentifier;
try {
packageIdentifier = (0, npm_package_arg_1.default)(collection);
}
catch (e) {
(0, error_1.assertIsError)(e);
logger.error(e.message);
return 1;
}
if (packageIdentifier.name &&
packageIdentifier.registry &&
this.isPackageInstalled(packageIdentifier.name)) {
const validVersion = await this.isProjectVersionValid(packageIdentifier);
if (validVersion) {
// Already installed so just run schematic
logger.info('Skipping installation: Package already installed');
return this.executeSchematic({ ...options, collection: packageIdentifier.name });
}
}
const spinner = new spinner_1.Spinner();
spinner.start('Determining package manager...');
const usingYarn = packageManager.name === workspace_schema_1.PackageManager.Yarn;
spinner.info(`Using package manager: ${color_1.colors.grey(packageManager.name)}`);
if (packageIdentifier.name && packageIdentifier.type === 'tag' && !packageIdentifier.rawSpec) {
// only package name provided; search for viable version
// plus special cases for packages that did not have peer deps setup
spinner.start('Searching for compatible package version...');
let packageMetadata;
try {
packageMetadata = await (0, package_metadata_1.fetchPackageMetadata)(packageIdentifier.name, logger, {
registry,
usingYarn,
verbose,
});
}
catch (e) {
(0, error_1.assertIsError)(e);
spinner.fail(`Unable to load package information from registry: ${e.message}`);
return 1;
}
// Start with the version tagged as `latest` if it exists
const latestManifest = packageMetadata.tags['latest'];
if (latestManifest) {
packageIdentifier = npm_package_arg_1.default.resolve(latestManifest.name, latestManifest.version);
}
// Adjust the version based on name and peer dependencies
if ((latestManifest === null || latestManifest === void 0 ? void 0 : latestManifest.peerDependencies) &&
Object.keys(latestManifest.peerDependencies).length === 0) {
spinner.succeed(`Found compatible package version: ${color_1.colors.grey(packageIdentifier.toString())}.`);
}
else if (!latestManifest || (await this.hasMismatchedPeer(latestManifest))) {
// 'latest' is invalid so search for most recent matching package
// Allow prelease versions if the CLI itself is a prerelease
const allowPrereleases = (0, semver_1.prerelease)(version_1.VERSION.full);
const versionExclusions = packageVersionExclusions[packageMetadata.name];
const versionManifests = Object.values(packageMetadata.versions).filter((value) => {
// Prerelease versions are not stable and should not be considered by default
if (!allowPrereleases && (0, semver_1.prerelease)(value.version)) {
return false;
}
// Deprecated versions should not be used or considered
if (value.deprecated) {
return false;
}
// Excluded package versions should not be considered
if (versionExclusions &&
(0, semver_1.satisfies)(value.version, versionExclusions, { includePrerelease: true })) {
return false;
}
return true;
});
// Sort in reverse SemVer order so that the newest compatible version is chosen
versionManifests.sort((a, b) => (0, semver_1.compare)(b.version, a.version, true));
let newIdentifier;
for (const versionManifest of versionManifests) {
if (!(await this.hasMismatchedPeer(versionManifest))) {
newIdentifier = npm_package_arg_1.default.resolve(versionManifest.name, versionManifest.version);
break;
}
}
if (!newIdentifier) {
spinner.warn("Unable to find compatible package. Using 'latest' tag.");
}
else {
packageIdentifier = newIdentifier;
spinner.succeed(`Found compatible package version: ${color_1.colors.grey(packageIdentifier.toString())}.`);
}
}
else {
spinner.succeed(`Found compatible package version: ${color_1.colors.grey(packageIdentifier.toString())}.`);
}
}
let collectionName = packageIdentifier.name;
let savePackage;
try {
spinner.start('Loading package information from registry...');
const manifest = await (0, package_metadata_1.fetchPackageManifest)(packageIdentifier.toString(), logger, {
registry,
verbose,
usingYarn,
});
savePackage = (_a = manifest['ng-add']) === null || _a === void 0 ? void 0 : _a.save;
collectionName = manifest.name;
if (await this.hasMismatchedPeer(manifest)) {
spinner.warn('Package has unmet peer dependencies. Adding the package may not succeed.');
}
else {
spinner.succeed(`Package information loaded.`);
}
}
catch (e) {
(0, error_1.assertIsError)(e);
spinner.fail(`Unable to fetch package information for '${packageIdentifier}': ${e.message}`);
return 1;
}
if (!skipConfirmation) {
const confirmationResponse = await (0, prompt_1.askConfirmation)(`\nThe package ${color_1.colors.blue(packageIdentifier.raw)} will be installed and executed.\n` +
'Would you like to proceed?', true, false);
if (!confirmationResponse) {
if (!(0, tty_1.isTTY)()) {
logger.error('No terminal detected. ' +
`'--skip-confirmation' can be used to bypass installation confirmation. ` +
`Ensure package name is correct prior to '--skip-confirmation' option usage.`);
}
logger.error('Command aborted.');
return 1;
}
}
if (savePackage === false) {
// Temporary packages are located in a different directory
// Hence we need to resolve them using the temp path
const { success, tempNodeModules } = await packageManager.installTemp(packageIdentifier.raw, registry ? [`--registry="${registry}"`] : undefined);
const tempRequire = (0, module_1.createRequire)(tempNodeModules + '/');
const resolvedCollectionPath = tempRequire.resolve((0, path_1.join)(collectionName, 'package.json'));
if (!success) {
return 1;
}
collectionName = (0, path_1.dirname)(resolvedCollectionPath);
}
else {
const success = await packageManager.install(packageIdentifier.raw, savePackage, registry ? [`--registry="${registry}"`] : undefined);
if (!success) {
return 1;
}
}
return this.executeSchematic({ ...options, collection: collectionName });
}
async isProjectVersionValid(packageIdentifier) {
if (!packageIdentifier.name) {
return false;
}
let validVersion = false;
const installedVersion = await this.findProjectVersion(packageIdentifier.name);
if (installedVersion) {
if (packageIdentifier.type === 'range' && packageIdentifier.fetchSpec) {
validVersion = (0, semver_1.satisfies)(installedVersion, packageIdentifier.fetchSpec);
}
else if (packageIdentifier.type === 'version') {
const v1 = (0, semver_1.valid)(packageIdentifier.fetchSpec);
const v2 = (0, semver_1.valid)(installedVersion);
validVersion = v1 !== null && v1 === v2;
}
else if (!packageIdentifier.rawSpec) {
validVersion = true;
}
}
return validVersion;
}
async getCollectionName() {
const [, collectionName] = this.context.args.positional;
return collectionName;
}
isPackageInstalled(name) {
try {
this.rootRequire.resolve((0, path_1.join)(name, 'package.json'));
return true;
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code !== 'MODULE_NOT_FOUND') {
throw e;
}
}
return false;
}
async executeSchematic(options) {
try {
const { verbose, skipConfirmation, interactive, force, dryRun, registry, defaults, collection: collectionName, ...schematicOptions } = options;
return await this.runSchematic({
schematicOptions,
schematicName: this.schematicName,
collectionName,
executionOptions: {
interactive,
force,
dryRun,
defaults,
packageRegistry: registry,
},
});
}
catch (e) {
if (e instanceof tools_1.NodePackageDoesNotSupportSchematics) {
this.context.logger.error(core_1.tags.oneLine `
The package that you are trying to add does not support schematics. You can try using
a different version of the package or contact the package author to add ng-add support.
`);
return 1;
}
throw e;
}
}
async findProjectVersion(name) {
var _a, _b;
const { logger, root } = this.context;
let installedPackage;
try {
installedPackage = this.rootRequire.resolve((0, path_1.join)(name, 'package.json'));
}
catch { }
if (installedPackage) {
try {
const installed = await (0, package_metadata_1.fetchPackageManifest)((0, path_1.dirname)(installedPackage), logger);
return installed.version;
}
catch { }
}
let projectManifest;
try {
projectManifest = await (0, package_metadata_1.fetchPackageManifest)(root, logger);
}
catch { }
if (projectManifest) {
const version = ((_a = projectManifest.dependencies) === null || _a === void 0 ? void 0 : _a[name]) || ((_b = projectManifest.devDependencies) === null || _b === void 0 ? void 0 : _b[name]);
if (version) {
return version;
}
}
return null;
}
async hasMismatchedPeer(manifest) {
for (const peer in manifest.peerDependencies) {
let peerIdentifier;
try {
peerIdentifier = npm_package_arg_1.default.resolve(peer, manifest.peerDependencies[peer]);
}
catch {
this.context.logger.warn(`Invalid peer dependency ${peer} found in package.`);
continue;
}
if (peerIdentifier.type === 'version' || peerIdentifier.type === 'range') {
try {
const version = await this.findProjectVersion(peer);
if (!version) {
continue;
}
const options = { includePrerelease: true };
if (!(0, semver_1.intersects)(version, peerIdentifier.rawSpec, options) &&
!(0, semver_1.satisfies)(version, peerIdentifier.rawSpec, options)) {
return true;
}
}
catch {
// Not found or invalid so ignore
continue;
}
}
else {
// type === 'tag' | 'file' | 'directory' | 'remote' | 'git'
// Cannot accurately compare these as the tag/location may have changed since install
}
}
return false;
}
}
exports.AddCommandModule = AddCommandModule;
@@ -0,0 +1,7 @@
Adds the npm package for a published library to your workspace, and configures
the project in the current working directory to use that library, as specified by the library's schematic.
For example, adding `@angular/pwa` configures your project for PWA support:
```bash
ng add @angular/pwa
```
+16
View File
@@ -0,0 +1,16 @@
/**
* @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 { CommandModule, CommandModuleImplementation, Options } from '../../command-builder/command-module';
export declare class AnalyticsCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath: string;
builder(localYargs: Argv): Argv;
run(_options: Options<{}>): void;
}
+37
View File
@@ -0,0 +1,37 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.AnalyticsCommandModule = void 0;
const node_path_1 = require("node:path");
const command_module_1 = require("../../command-builder/command-module");
const command_1 = require("../../command-builder/utilities/command");
const cli_1 = require("./info/cli");
const cli_2 = require("./settings/cli");
class AnalyticsCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'analytics';
this.describe = 'Configures the gathering of Angular CLI usage metrics.';
this.longDescriptionPath = (0, node_path_1.join)(__dirname, 'long-description.md');
}
builder(localYargs) {
const subcommands = [
cli_1.AnalyticsInfoCommandModule,
cli_2.AnalyticsDisableModule,
cli_2.AnalyticsEnableModule,
cli_2.AnalyticsPromptModule,
].sort(); // sort by class name.
for (const module of subcommands) {
localYargs = (0, command_1.addCommandModuleToYargs)(localYargs, module, this.context);
}
return localYargs.demandCommand(1, command_1.demandCommandFailureMessage).strict();
}
run(_options) { }
}
exports.AnalyticsCommandModule = AnalyticsCommandModule;
@@ -0,0 +1,16 @@
/**
* @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 { CommandModule, CommandModuleImplementation, Options } from '../../../command-builder/command-module';
export declare class AnalyticsInfoCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath?: string;
builder(localYargs: Argv): Argv;
run(_options: Options<{}>): Promise<void>;
}
+26
View File
@@ -0,0 +1,26 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.AnalyticsInfoCommandModule = void 0;
const analytics_1 = require("../../../analytics/analytics");
const command_module_1 = require("../../../command-builder/command-module");
class AnalyticsInfoCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'info';
this.describe = 'Prints analytics gathering and reporting configuration in the console.';
}
builder(localYargs) {
return localYargs.strict();
}
async run(_options) {
this.context.logger.info(await (0, analytics_1.getAnalyticsInfoString)(this.context));
}
}
exports.AnalyticsInfoCommandModule = AnalyticsInfoCommandModule;
@@ -0,0 +1,20 @@
You can help the Angular Team to prioritize features and improvements by permitting the Angular team to send command-line command usage statistics to Google.
The Angular Team does not collect usage statistics unless you explicitly opt in. When installing the Angular CLI you are prompted to allow global collection of usage statistics.
If you say no or skip the prompt, no data is collected.
### What is collected?
Usage analytics include the commands and selected flags for each execution.
Usage analytics may include the following information:
- Your operating system \(macOS, Linux distribution, Windows\) and its version.
- Package manager name and version \(local version only\).
- Node.js version \(local version only\).
- Angular CLI version \(local version only\).
- Command name that was run.
- Workspace information, the number of application and library projects.
- For schematics commands \(add, generate and new\), the schematic collection and name and a list of selected flags.
- For build commands \(build, serve\), the builder name, the number and size of bundles \(initial and lazy\), compilation units, the time it took to build and rebuild, and basic Angular-specific API usage.
Only Angular owned and developed schematics and builders are reported.
Third-party schematics and builders do not send data to the Angular Team.
@@ -0,0 +1,35 @@
/**
* @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 { CommandModule, CommandModuleImplementation, Options } from '../../../command-builder/command-module';
interface AnalyticsCommandArgs {
global: boolean;
}
declare abstract class AnalyticsSettingModule extends CommandModule<AnalyticsCommandArgs> implements CommandModuleImplementation<AnalyticsCommandArgs> {
longDescriptionPath?: string;
builder(localYargs: Argv): Argv<AnalyticsCommandArgs>;
abstract run({ global }: Options<AnalyticsCommandArgs>): Promise<void>;
}
export declare class AnalyticsDisableModule extends AnalyticsSettingModule implements CommandModuleImplementation<AnalyticsCommandArgs> {
command: string;
aliases: string;
describe: string;
run({ global }: Options<AnalyticsCommandArgs>): Promise<void>;
}
export declare class AnalyticsEnableModule extends AnalyticsSettingModule implements CommandModuleImplementation<AnalyticsCommandArgs> {
command: string;
aliases: string;
describe: string;
run({ global }: Options<AnalyticsCommandArgs>): Promise<void>;
}
export declare class AnalyticsPromptModule extends AnalyticsSettingModule implements CommandModuleImplementation<AnalyticsCommandArgs> {
command: string;
describe: string;
run({ global }: Options<AnalyticsCommandArgs>): Promise<void>;
}
export {};
@@ -0,0 +1,61 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.AnalyticsPromptModule = exports.AnalyticsEnableModule = exports.AnalyticsDisableModule = void 0;
const analytics_1 = require("../../../analytics/analytics");
const command_module_1 = require("../../../command-builder/command-module");
class AnalyticsSettingModule extends command_module_1.CommandModule {
builder(localYargs) {
return localYargs
.option('global', {
description: `Configure analytics gathering and reporting globally in the caller's home directory.`,
alias: ['g'],
type: 'boolean',
default: false,
})
.strict();
}
}
class AnalyticsDisableModule extends AnalyticsSettingModule {
constructor() {
super(...arguments);
this.command = 'disable';
this.aliases = 'off';
this.describe = 'Disables analytics gathering and reporting for the user.';
}
async run({ global }) {
await (0, analytics_1.setAnalyticsConfig)(global, false);
process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)(this.context));
}
}
exports.AnalyticsDisableModule = AnalyticsDisableModule;
class AnalyticsEnableModule extends AnalyticsSettingModule {
constructor() {
super(...arguments);
this.command = 'enable';
this.aliases = 'on';
this.describe = 'Enables analytics gathering and reporting for the user.';
}
async run({ global }) {
await (0, analytics_1.setAnalyticsConfig)(global, true);
process.stderr.write(await (0, analytics_1.getAnalyticsInfoString)(this.context));
}
}
exports.AnalyticsEnableModule = AnalyticsEnableModule;
class AnalyticsPromptModule extends AnalyticsSettingModule {
constructor() {
super(...arguments);
this.command = 'prompt';
this.describe = 'Prompts the user to set the analytics gathering status interactively.';
}
async run({ global }) {
await (0, analytics_1.promptAnalytics)(this.context, global, true);
}
}
exports.AnalyticsPromptModule = AnalyticsPromptModule;
+16
View File
@@ -0,0 +1,16 @@
/**
* @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 { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class BuildCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
multiTarget: boolean;
command: string;
aliases: string[];
describe: string;
longDescriptionPath: string;
}
+23
View File
@@ -0,0 +1,23 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.BuildCommandModule = void 0;
const path_1 = require("path");
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class BuildCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.multiTarget = false;
this.command = 'build [project]';
this.aliases = ['b'];
this.describe = 'Compiles an Angular application or library into an output directory named dist/ at the given output path.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
}
exports.BuildCommandModule = BuildCommandModule;
@@ -0,0 +1,18 @@
The command can be used to build a project of type "application" or "library".
When used to build a library, a different builder is invoked, and only the `ts-config`, `configuration`, and `watch` options are applied.
All other options apply only to building applications.
The application builder uses the [webpack](https://webpack.js.org/) build tool, with default configuration options specified in the workspace configuration file (`angular.json`) or with a named alternative configuration.
A "development" configuration is created by default when you use the CLI to create the project, and you can use that configuration by specifying the `--configuration development`.
The configuration options generally correspond to the command options.
You can override individual configuration defaults by specifying the corresponding options on the command line.
The command can accept option names given in either dash-case or camelCase.
Note that in the configuration file, you must specify names in camelCase.
Some additional options can only be set through the configuration file,
either by direct editing or with the `ng config` command.
These include `assets`, `styles`, and `scripts` objects that provide runtime-global resources to include in the project.
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.
For further details, see [Workspace Configuration](guide/workspace-config).
+17
View File
@@ -0,0 +1,17 @@
/**
* @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 { CommandModule, CommandModuleImplementation, CommandScope } from '../../../command-builder/command-module';
export declare class CacheCleanModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath: string | undefined;
scope: CommandScope;
builder(localYargs: Argv): Argv;
run(): Promise<void>;
}
+33
View File
@@ -0,0 +1,33 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CacheCleanModule = void 0;
const fs_1 = require("fs");
const command_module_1 = require("../../../command-builder/command-module");
const utilities_1 = require("../utilities");
class CacheCleanModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'clean';
this.describe = 'Deletes persistent disk cache from disk.';
this.scope = command_module_1.CommandScope.In;
}
builder(localYargs) {
return localYargs.strict();
}
run() {
const { path } = (0, utilities_1.getCacheConfig)(this.context.workspace);
return fs_1.promises.rm(path, {
force: true,
recursive: true,
maxRetries: 3,
});
}
}
exports.CacheCleanModule = CacheCleanModule;
+17
View File
@@ -0,0 +1,17 @@
/**
* @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 { CommandModule, CommandModuleImplementation, CommandScope, Options } from '../../command-builder/command-module';
export declare class CacheCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath: string;
scope: CommandScope;
builder(localYargs: Argv): Argv;
run(_options: Options<{}>): void;
}
+39
View File
@@ -0,0 +1,39 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CacheCommandModule = void 0;
const path_1 = require("path");
const command_module_1 = require("../../command-builder/command-module");
const command_1 = require("../../command-builder/utilities/command");
const cli_1 = require("./clean/cli");
const cli_2 = require("./info/cli");
const cli_3 = require("./settings/cli");
class CacheCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'cache';
this.describe = 'Configure persistent disk cache and retrieve cache statistics.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
this.scope = command_module_1.CommandScope.In;
}
builder(localYargs) {
const subcommands = [
cli_3.CacheEnableModule,
cli_3.CacheDisableModule,
cli_1.CacheCleanModule,
cli_2.CacheInfoCommandModule,
].sort();
for (const module of subcommands) {
localYargs = (0, command_1.addCommandModuleToYargs)(localYargs, module, this.context);
}
return localYargs.demandCommand(1, command_1.demandCommandFailureMessage).strict();
}
run(_options) { }
}
exports.CacheCommandModule = CacheCommandModule;
+20
View File
@@ -0,0 +1,20 @@
/**
* @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 { CommandModule, CommandModuleImplementation, CommandScope } from '../../../command-builder/command-module';
export declare class CacheInfoCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath?: string | undefined;
scope: CommandScope;
builder(localYargs: Argv): Argv;
run(): Promise<void>;
private getSizeOfDirectory;
private formatSize;
private effectiveEnabledStatus;
}
+83
View File
@@ -0,0 +1,83 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CacheInfoCommandModule = void 0;
const core_1 = require("@angular-devkit/core");
const fs_1 = require("fs");
const path_1 = require("path");
const command_module_1 = require("../../../command-builder/command-module");
const environment_options_1 = require("../../../utilities/environment-options");
const utilities_1 = require("../utilities");
class CacheInfoCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'info';
this.describe = 'Prints persistent disk cache configuration and statistics in the console.';
this.scope = command_module_1.CommandScope.In;
}
builder(localYargs) {
return localYargs.strict();
}
async run() {
const { path, environment, enabled } = (0, utilities_1.getCacheConfig)(this.context.workspace);
this.context.logger.info(core_1.tags.stripIndents `
Enabled: ${enabled ? 'yes' : 'no'}
Environment: ${environment}
Path: ${path}
Size on disk: ${await this.getSizeOfDirectory(path)}
Effective status on current machine: ${this.effectiveEnabledStatus() ? 'enabled' : 'disabled'}
`);
}
async getSizeOfDirectory(path) {
const directoriesStack = [path];
let size = 0;
while (directoriesStack.length) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const dirPath = directoriesStack.pop();
let entries = [];
try {
entries = await fs_1.promises.readdir(dirPath);
}
catch { }
for (const entry of entries) {
const entryPath = (0, path_1.join)(dirPath, entry);
const stats = await fs_1.promises.stat(entryPath);
if (stats.isDirectory()) {
directoriesStack.push(entryPath);
}
size += stats.size;
}
}
return this.formatSize(size);
}
formatSize(size) {
if (size <= 0) {
return '0 bytes';
}
const abbreviations = ['bytes', 'kB', 'MB', 'GB'];
const index = Math.floor(Math.log(size) / Math.log(1024));
const roundedSize = size / Math.pow(1024, index);
// bytes don't have a fraction
const fractionDigits = index === 0 ? 0 : 2;
return `${roundedSize.toFixed(fractionDigits)} ${abbreviations[index]}`;
}
effectiveEnabledStatus() {
const { enabled, environment } = (0, utilities_1.getCacheConfig)(this.context.workspace);
if (enabled) {
switch (environment) {
case 'ci':
return environment_options_1.isCI;
case 'local':
return !environment_options_1.isCI;
}
}
return enabled;
}
}
exports.CacheInfoCommandModule = CacheInfoCommandModule;
@@ -0,0 +1,53 @@
Angular CLI saves a number of cachable operations on disk by default.
When you re-run the same build, the build system restores the state of the previous build and re-uses previously performed operations, which decreases the time taken to build and test your applications and libraries.
To amend the default cache settings, add the `cli.cache` object to your [Workspace Configuration](guide/workspace-config).
The object goes under `cli.cache` at the top level of the file, outside the `projects` sections.
```jsonc
{
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
"version": 1,
"cli": {
"cache": {
// ...
}
},
"projects": {}
}
```
For more information, see [cache options](guide/workspace-config#cache-options).
### Cache environments
By default, disk cache is only enabled for local environments. The value of environment can be one of the following:
- `all` - allows disk cache on all machines.
- `local` - allows disk cache only on development machines.
- `ci` - allows disk cache only on continuous integration (CI) systems.
To change the environment setting to `all`, run the following command:
```bash
ng config cli.cache.environment all
```
For more information, see `environment` in [cache options](guide/workspace-config#cache-options).
<div class="alert is-helpful">
The Angular CLI checks for the presence and value of the `CI` environment variable to determine in which environment it is running.
</div>
### Cache path
By default, `.angular/cache` is used as a base directory to store cache results.
To change this path to `.cache/ng`, run the following command:
```bash
ng config cli.cache.path ".cache/ng"
```
@@ -0,0 +1,27 @@
/**
* @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 { CommandModule, CommandModuleImplementation, CommandScope } from '../../../command-builder/command-module';
export declare class CacheDisableModule extends CommandModule implements CommandModuleImplementation {
command: string;
aliases: string;
describe: string;
longDescriptionPath: string | undefined;
scope: CommandScope;
builder(localYargs: Argv): Argv;
run(): Promise<void>;
}
export declare class CacheEnableModule extends CommandModule implements CommandModuleImplementation {
command: string;
aliases: string;
describe: string;
longDescriptionPath: string | undefined;
scope: CommandScope;
builder(localYargs: Argv): Argv;
run(): Promise<void>;
}
+44
View File
@@ -0,0 +1,44 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CacheEnableModule = exports.CacheDisableModule = void 0;
const command_module_1 = require("../../../command-builder/command-module");
const utilities_1 = require("../utilities");
class CacheDisableModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'disable';
this.aliases = 'off';
this.describe = 'Disables persistent disk cache for all projects in the workspace.';
this.scope = command_module_1.CommandScope.In;
}
builder(localYargs) {
return localYargs;
}
run() {
return (0, utilities_1.updateCacheConfig)(this.getWorkspaceOrThrow(), 'enabled', false);
}
}
exports.CacheDisableModule = CacheDisableModule;
class CacheEnableModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'enable';
this.aliases = 'on';
this.describe = 'Enables disk cache for all projects in the workspace.';
this.scope = command_module_1.CommandScope.In;
}
builder(localYargs) {
return localYargs;
}
run() {
return (0, utilities_1.updateCacheConfig)(this.getWorkspaceOrThrow(), 'enabled', true);
}
}
exports.CacheEnableModule = CacheEnableModule;
+11
View File
@@ -0,0 +1,11 @@
/**
* @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 { Cache } from '../../../lib/config/workspace-schema';
import { AngularWorkspace } from '../../utilities/config';
export declare function updateCacheConfig<K extends keyof Cache>(workspace: AngularWorkspace, key: K, value: Cache[K]): Promise<void>;
export declare function getCacheConfig(workspace: AngularWorkspace | undefined): Required<Cache>;
+49
View File
@@ -0,0 +1,49 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.getCacheConfig = exports.updateCacheConfig = void 0;
const core_1 = require("@angular-devkit/core");
const path_1 = require("path");
const workspace_schema_1 = require("../../../lib/config/workspace-schema");
function updateCacheConfig(workspace, key, value) {
var _a, _b;
var _c;
const cli = ((_a = (_c = workspace.extensions)['cli']) !== null && _a !== void 0 ? _a : (_c['cli'] = {}));
const cache = ((_b = cli['cache']) !== null && _b !== void 0 ? _b : (cli['cache'] = {}));
cache[key] = value;
return workspace.save();
}
exports.updateCacheConfig = updateCacheConfig;
function getCacheConfig(workspace) {
if (!workspace) {
throw new Error(`Cannot retrieve cache configuration as workspace is not defined.`);
}
const defaultSettings = {
path: (0, path_1.resolve)(workspace.basePath, '.angular/cache'),
environment: workspace_schema_1.Environment.Local,
enabled: true,
};
const cliSetting = workspace.extensions['cli'];
if (!cliSetting || !(0, core_1.isJsonObject)(cliSetting)) {
return defaultSettings;
}
const cacheSettings = cliSetting['cache'];
if (!(0, core_1.isJsonObject)(cacheSettings)) {
return defaultSettings;
}
const { path = defaultSettings.path, environment = defaultSettings.environment, enabled = defaultSettings.enabled,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} = cacheSettings;
return {
path: (0, path_1.resolve)(workspace.basePath, path),
environment,
enabled,
};
}
exports.getCacheConfig = getCacheConfig;
+16
View File
@@ -0,0 +1,16 @@
/**
* @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 { CommandModule, CommandModuleImplementation } from '../../command-builder/command-module';
export declare class CompletionCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: string;
longDescriptionPath: string;
builder(localYargs: Argv): Argv;
run(): Promise<number>;
}
+70
View File
@@ -0,0 +1,70 @@
"use strict";
/**
* @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
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CompletionCommandModule = void 0;
const path_1 = require("path");
const yargs_1 = __importDefault(require("yargs"));
const command_module_1 = require("../../command-builder/command-module");
const command_1 = require("../../command-builder/utilities/command");
const color_1 = require("../../utilities/color");
const completion_1 = require("../../utilities/completion");
const error_1 = require("../../utilities/error");
class CompletionCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'completion';
this.describe = 'Set up Angular CLI autocompletion for your terminal.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
builder(localYargs) {
return (0, command_1.addCommandModuleToYargs)(localYargs, CompletionScriptCommandModule, this.context);
}
async run() {
let rcFile;
try {
rcFile = await (0, completion_1.initializeAutocomplete)();
}
catch (err) {
(0, error_1.assertIsError)(err);
this.context.logger.error(err.message);
return 1;
}
this.context.logger.info(`
Appended \`source <(ng completion script)\` to \`${rcFile}\`. Restart your terminal or run the following to autocomplete \`ng\` commands:
${color_1.colors.yellow('source <(ng completion script)')}
`.trim());
if ((await (0, completion_1.hasGlobalCliInstall)()) === false) {
this.context.logger.warn('Setup completed successfully, but there does not seem to be a global install of the' +
' Angular CLI. For autocompletion to work, the CLI will need to be on your `$PATH`, which' +
' is typically done with the `-g` flag in `npm install -g @angular/cli`.' +
'\n\n' +
'For more information, see https://angular.io/cli/completion#global-install');
}
return 0;
}
}
exports.CompletionCommandModule = CompletionCommandModule;
class CompletionScriptCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'script';
this.describe = 'Generate a bash and zsh real-time type-ahead autocompletion script.';
this.longDescriptionPath = undefined;
}
builder(localYargs) {
return localYargs;
}
run() {
yargs_1.default.showCompletionScript();
}
}
@@ -0,0 +1,67 @@
Setting up autocompletion configures your terminal, so pressing the `<TAB>` key while in the middle
of typing will display various commands and options available to you. This makes it very easy to
discover and use CLI commands without lots of memorization.
![A demo of Angular CLI autocompletion in a terminal. The user types several partial `ng` commands,
using autocompletion to finish several arguments and list contextual options.
](generated/images/guide/cli/completion.gif)
## Automated setup
The CLI should prompt and ask to set up autocompletion for you the first time you use it (v14+).
Simply answer "Yes" and the CLI will take care of the rest.
```
$ ng serve
? Would you like to enable autocompletion? This will set up your terminal so pressing TAB while typing Angular CLI commands will show possible options and autocomplete arguments. (Enabling autocompletion will modify configuration files in your home directory.) Yes
Appended `source <(ng completion script)` to `/home/my-username/.bashrc`. Restart your terminal or run:
source <(ng completion script)
to autocomplete `ng` commands.
# Serve output...
```
If you already refused the prompt, it won't ask again. But you can run `ng completion` to
do the same thing automatically.
This modifies your terminal environment to load Angular CLI autocompletion, but can't update your
current terminal session. Either restart it or run `source <(ng completion script)` directly to
enable autocompletion in your current session.
Test it out by typing `ng ser<TAB>` and it should autocomplete to `ng serve`. Ambiguous arguments
will show all possible options and their documentation, such as `ng generate <TAB>`.
## Manual setup
Some users may have highly customized terminal setups, possibly with configuration files checked
into source control with an opinionated structure. `ng completion` only ever appends Angular's setup
to an existing configuration file for your current shell, or creates one if none exists. If you want
more control over exactly where this configuration lives, you can manually set it up by having your
shell run at startup:
```bash
source <(ng completion script)
```
This is equivalent to what `ng completion` will automatically set up, and gives power users more
flexibility in their environments when desired.
## Platform support
Angular CLI supports autocompletion for the Bash and Zsh shells on MacOS and Linux operating
systems. On Windows, Git Bash and [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/)
using Bash or Zsh are supported.
## Global install
Autocompletion works by configuring your terminal to invoke the Angular CLI on startup to load the
setup script. This means the terminal must be able to find and execute the Angular CLI, typically
through a global install that places the binary on the user's `$PATH`. If you get
`command not found: ng`, make sure the CLI is installed globally which you can do with the `-g`
flag:
```bash
npm install -g @angular/cli
```
+24
View File
@@ -0,0 +1,24 @@
/**
* @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 { CommandModule, CommandModuleImplementation, Options } from '../../command-builder/command-module';
interface ConfigCommandArgs {
'json-path'?: string;
value?: string;
global?: boolean;
}
export declare class ConfigCommandModule extends CommandModule<ConfigCommandArgs> implements CommandModuleImplementation<ConfigCommandArgs> {
command: string;
describe: string;
longDescriptionPath: string;
builder(localYargs: Argv): Argv<ConfigCommandArgs>;
run(options: Options<ConfigCommandArgs>): Promise<number | void>;
private get;
private set;
}
export {};
+154
View File
@@ -0,0 +1,154 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConfigCommandModule = void 0;
const crypto_1 = require("crypto");
const path_1 = require("path");
const command_module_1 = require("../../command-builder/command-module");
const config_1 = require("../../utilities/config");
const json_file_1 = require("../../utilities/json-file");
class ConfigCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'config [json-path] [value]';
this.describe = 'Retrieves or sets Angular configuration values in the angular.json file for the workspace.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
builder(localYargs) {
return localYargs
.positional('json-path', {
description: `The configuration key to set or query, in JSON path format. ` +
`For example: "a[3].foo.bar[2]". If no new value is provided, returns the current value of this key.`,
type: 'string',
})
.positional('value', {
description: 'If provided, a new value for the given configuration key.',
type: 'string',
})
.option('global', {
description: `Access the global configuration in the caller's home directory.`,
alias: ['g'],
type: 'boolean',
default: false,
})
.strict();
}
async run(options) {
const level = options.global ? 'global' : 'local';
const [config] = await (0, config_1.getWorkspaceRaw)(level);
if (options.value == undefined) {
if (!config) {
this.context.logger.error('No config found.');
return 1;
}
return this.get(config, options);
}
else {
return this.set(options);
}
}
get(jsonFile, options) {
const { logger } = this.context;
const value = options.jsonPath
? jsonFile.get(parseJsonPath(options.jsonPath))
: jsonFile.content;
if (value === undefined) {
logger.error('Value cannot be found.');
return 1;
}
else if (typeof value === 'string') {
logger.info(value);
}
else {
logger.info(JSON.stringify(value, null, 2));
}
return 0;
}
async set(options) {
var _a, _b;
if (!((_a = options.jsonPath) === null || _a === void 0 ? void 0 : _a.trim())) {
throw new command_module_1.CommandModuleError('Invalid Path.');
}
const [config, configPath] = await (0, config_1.getWorkspaceRaw)(options.global ? 'global' : 'local');
const { logger } = this.context;
if (!config || !configPath) {
throw new command_module_1.CommandModuleError('Confguration file cannot be found.');
}
const normalizeUUIDValue = (v) => (v === '' ? (0, crypto_1.randomUUID)() : `${v}`);
const value = options.jsonPath === 'cli.analyticsSharing.uuid'
? normalizeUUIDValue(options.value)
: options.value;
const modified = config.modify(parseJsonPath(options.jsonPath), normalizeValue(value));
if (!modified) {
logger.error('Value cannot be found.');
return 1;
}
await (0, config_1.validateWorkspace)((0, json_file_1.parseJson)(config.content), (_b = options.global) !== null && _b !== void 0 ? _b : false);
config.save();
return 0;
}
}
exports.ConfigCommandModule = ConfigCommandModule;
/**
* Splits a JSON path string into fragments. Fragments can be used to get the value referenced
* by the path. For example, a path of "a[3].foo.bar[2]" would give you a fragment array of
* ["a", 3, "foo", "bar", 2].
* @param path The JSON string to parse.
* @returns {(string|number)[]} The fragments for the string.
* @private
*/
function parseJsonPath(path) {
const fragments = (path || '').split(/\./g);
const result = [];
while (fragments.length > 0) {
const fragment = fragments.shift();
if (fragment == undefined) {
break;
}
const match = fragment.match(/([^[]+)((\[.*\])*)/);
if (!match) {
throw new command_module_1.CommandModuleError('Invalid JSON path.');
}
result.push(match[1]);
if (match[2]) {
const indices = match[2]
.slice(1, -1)
.split('][')
.map((x) => (/^\d$/.test(x) ? +x : x.replace(/"|'/g, '')));
result.push(...indices);
}
}
return result.filter((fragment) => fragment != null);
}
function normalizeValue(value) {
const valueString = `${value}`.trim();
switch (valueString) {
case 'true':
return true;
case 'false':
return false;
case 'null':
return null;
case 'undefined':
return undefined;
}
if (isFinite(+valueString)) {
return +valueString;
}
try {
// We use `JSON.parse` instead of `parseJson` because the latter will parse UUIDs
// and convert them into a numberic entities.
// Example: 73b61974-182c-48e4-b4c6-30ddf08c5c98 -> 73.
// These values should never contain comments, therefore using `JSON.parse` is safe.
return JSON.parse(valueString);
}
catch {
return value;
}
}
@@ -0,0 +1,13 @@
A workspace has a single CLI configuration file, `angular.json`, at the top level.
The `projects` object contains a configuration object for each project in the workspace.
You can edit the configuration directly in a code editor,
or indirectly on the command line using this command.
The configurable property names match command option names,
except that in the configuration file, all names must use camelCase,
while on the command line options can be given dash-case.
For further details, see [Workspace Configuration](guide/workspace-config).
For configuration of CLI usage analytics, see [ng analytics](cli/analytics).
+17
View File
@@ -0,0 +1,17 @@
/**
* @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 { MissingTargetChoice } from '../../command-builder/architect-base-command-module';
import { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class DeployCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
missingTargetChoices: MissingTargetChoice[];
multiTarget: boolean;
command: string;
longDescriptionPath: string;
describe: string;
}
+45
View File
@@ -0,0 +1,45 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.DeployCommandModule = void 0;
const path_1 = require("path");
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class DeployCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
// The below choices should be kept in sync with the list in https://angular.io/guide/deployment
this.missingTargetChoices = [
{
name: 'Amazon S3',
value: '@jefiozie/ngx-aws-deploy',
},
{
name: 'Firebase',
value: '@angular/fire',
},
{
name: 'Netlify',
value: '@netlify-builder/deploy',
},
{
name: 'NPM',
value: 'ngx-deploy-npm',
},
{
name: 'GitHub Pages',
value: 'angular-cli-ghpages',
},
];
this.multiTarget = false;
this.command = 'deploy [project]';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
this.describe = 'Invokes the deploy builder for a specified project or for the default project in the workspace.';
}
}
exports.DeployCommandModule = DeployCommandModule;
@@ -0,0 +1,22 @@
The command takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.
When a project name is not supplied, executes the `deploy` builder for the default project.
To use the `ng deploy` command, use `ng add` to add a package that implements deployment capabilities to your favorite platform.
Adding the package automatically updates your workspace configuration, adding a deployment
[CLI builder](guide/cli-builder).
For example:
```json
"projects": {
"my-project": {
...
"architect": {
...
"deploy": {
"builder": "@angular/fire:deploy",
"options": {}
}
}
}
}
```
+23
View File
@@ -0,0 +1,23 @@
/**
* @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 { CommandModule, CommandModuleImplementation, Options } from '../../command-builder/command-module';
interface DocCommandArgs {
keyword: string;
search?: boolean;
version?: string;
}
export declare class DocCommandModule extends CommandModule<DocCommandArgs> implements CommandModuleImplementation<DocCommandArgs> {
command: string;
aliases: string[];
describe: string;
longDescriptionPath?: string;
builder(localYargs: Argv): Argv<DocCommandArgs>;
run(options: Options<DocCommandArgs>): Promise<number | void>;
}
export {};
+100
View File
@@ -0,0 +1,100 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DocCommandModule = void 0;
const open_1 = __importDefault(require("open"));
const command_module_1 = require("../../command-builder/command-module");
class DocCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'doc <keyword>';
this.aliases = ['d'];
this.describe = 'Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.';
}
builder(localYargs) {
return localYargs
.positional('keyword', {
description: 'The keyword to search for, as provided in the search bar in angular.io.',
type: 'string',
demandOption: true,
})
.option('search', {
description: `Search all of angular.io. Otherwise, searches only API reference documentation.`,
alias: ['s'],
type: 'boolean',
default: false,
})
.option('version', {
description: 'Contains the version of Angular to use for the documentation. ' +
'If not provided, the command uses your current Angular core version.',
type: 'string',
})
.strict();
}
async run(options) {
let domain = 'angular.io';
if (options.version) {
// version can either be a string containing "next"
if (options.version === 'next') {
domain = 'next.angular.io';
}
else if (options.version === 'rc') {
domain = 'rc.angular.io';
// or a number where version must be a valid Angular version (i.e. not 0, 1 or 3)
}
else if (!isNaN(+options.version) && ![0, 1, 3].includes(+options.version)) {
domain = `v${options.version}.angular.io`;
}
else {
this.context.logger.error('Version should either be a number (2, 4, 5, 6...), "rc" or "next"');
return 1;
}
}
else {
// we try to get the current Angular version of the project
// and use it if we can find it
try {
/* eslint-disable-next-line import/no-extraneous-dependencies */
const currentNgVersion = (await Promise.resolve().then(() => __importStar(require('@angular/core')))).VERSION.major;
domain = `v${currentNgVersion}.angular.io`;
}
catch { }
}
await (0, open_1.default)(options.search
? `https://${domain}/docs?search=${options.keyword}`
: `https://${domain}/api?query=${options.keyword}`);
}
}
exports.DocCommandModule = DocCommandModule;
+18
View File
@@ -0,0 +1,18 @@
/**
* @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 { MissingTargetChoice } from '../../command-builder/architect-base-command-module';
import { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class E2eCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
missingTargetChoices: MissingTargetChoice[];
multiTarget: boolean;
command: string;
aliases: string[];
describe: string;
longDescriptionPath?: string;
}
+35
View File
@@ -0,0 +1,35 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.E2eCommandModule = void 0;
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class E2eCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.missingTargetChoices = [
{
name: 'Cypress',
value: '@cypress/schematic',
},
{
name: 'Nightwatch',
value: '@nightwatch/schematics',
},
{
name: 'WebdriverIO',
value: '@wdio/schematics',
},
];
this.multiTarget = true;
this.command = 'e2e [project]';
this.aliases = ['e'];
this.describe = 'Builds and serves an Angular application, then runs end-to-end tests.';
}
}
exports.E2eCommandModule = E2eCommandModule;
+15
View File
@@ -0,0 +1,15 @@
/**
* @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 { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class ExtractI18nCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
multiTarget: boolean;
command: string;
describe: string;
longDescriptionPath?: string | undefined;
}
+20
View File
@@ -0,0 +1,20 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExtractI18nCommandModule = void 0;
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class ExtractI18nCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.multiTarget = false;
this.command = 'extract-i18n [project]';
this.describe = 'Extracts i18n messages from source code.';
}
}
exports.ExtractI18nCommandModule = ExtractI18nCommandModule;
+39
View File
@@ -0,0 +1,39 @@
/**
* @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, Options, OtherOptions } from '../../command-builder/command-module';
import { SchematicsCommandArgs, SchematicsCommandModule } from '../../command-builder/schematics-command-module';
interface GenerateCommandArgs extends SchematicsCommandArgs {
schematic?: string;
}
export declare class GenerateCommandModule extends SchematicsCommandModule implements CommandModuleImplementation<GenerateCommandArgs> {
command: string;
aliases: string;
describe: string;
longDescriptionPath?: string | undefined;
builder(argv: Argv): Promise<Argv<GenerateCommandArgs>>;
run(options: Options<GenerateCommandArgs> & OtherOptions): Promise<number | void>;
private getCollectionNames;
/**
* Generate a command string to be passed to the command builder.
*
* @example `component [name]` or `@schematics/angular:component [name]`.
*/
private generateCommandString;
/**
* Get schematics that can to be registered as subcommands.
*/
private getSchematics;
/**
* Get schematics that should to be registered as subcommands.
*
* @returns a sorted list of schematic that needs to be registered as subcommands.
*/
private getSchematicsToRegister;
}
export {};
+145
View File
@@ -0,0 +1,145 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.GenerateCommandModule = void 0;
const core_1 = require("@angular-devkit/core");
const command_module_1 = require("../../command-builder/command-module");
const schematics_command_module_1 = require("../../command-builder/schematics-command-module");
const command_1 = require("../../command-builder/utilities/command");
class GenerateCommandModule extends schematics_command_module_1.SchematicsCommandModule {
constructor() {
super(...arguments);
this.command = 'generate';
this.aliases = 'g';
this.describe = 'Generates and/or modifies files based on a schematic.';
}
async builder(argv) {
let localYargs = (await super.builder(argv)).command({
command: '$0 <schematic>',
describe: 'Run the provided schematic.',
builder: (localYargs) => localYargs
.positional('schematic', {
describe: 'The [collection:schematic] to run.',
type: 'string',
demandOption: true,
})
.strict(),
handler: (options) => this.handler(options),
});
for (const [schematicName, collectionName] of await this.getSchematicsToRegister()) {
const workflow = this.getOrCreateWorkflowForBuilder(collectionName);
const collection = workflow.engine.createCollection(collectionName);
const { description: { schemaJson, aliases: schematicAliases, hidden: schematicHidden, description: schematicDescription, }, } = collection.createSchematic(schematicName, true);
if (!schemaJson) {
continue;
}
const { 'x-deprecated': xDeprecated, description = schematicDescription, aliases = schematicAliases, hidden = schematicHidden, } = schemaJson;
const options = await this.getSchematicOptions(collection, schematicName, workflow);
localYargs = localYargs.command({
command: await this.generateCommandString(collectionName, schematicName, options),
// When 'describe' is set to false, it results in a hidden command.
describe: hidden === true ? false : typeof description === 'string' ? description : '',
deprecated: xDeprecated === true || typeof xDeprecated === 'string' ? xDeprecated : false,
aliases: Array.isArray(aliases) ? aliases : undefined,
builder: (localYargs) => this.addSchemaOptionsToCommand(localYargs, options).strict(),
handler: (options) => this.handler({ ...options, schematic: `${collectionName}:${schematicName}` }),
});
}
return localYargs.demandCommand(1, command_1.demandCommandFailureMessage);
}
async run(options) {
const { dryRun, schematic, defaults, force, interactive, ...schematicOptions } = options;
const [collectionName, schematicName] = this.parseSchematicInfo(schematic);
if (!collectionName || !schematicName) {
throw new command_module_1.CommandModuleError('A collection and schematic is required during execution.');
}
return this.runSchematic({
collectionName,
schematicName,
schematicOptions,
executionOptions: {
dryRun,
defaults,
force,
interactive,
},
});
}
async getCollectionNames() {
const [collectionName] = this.parseSchematicInfo(
// positional = [generate, component] or [generate]
this.context.args.positional[1]);
return collectionName ? [collectionName] : [...(await this.getSchematicCollections())];
}
/**
* Generate a command string to be passed to the command builder.
*
* @example `component [name]` or `@schematics/angular:component [name]`.
*/
async generateCommandString(collectionName, schematicName, options) {
const [collectionNameFromArgs] = this.parseSchematicInfo(
// positional = [generate, component] or [generate]
this.context.args.positional[1]);
const dasherizedSchematicName = core_1.strings.dasherize(schematicName);
const schematicCollectionsFromConfig = await this.getSchematicCollections();
const collectionNames = await this.getCollectionNames();
// Only add the collection name as part of the command when it's not a known
// schematics collection or when it has been provided via the CLI.
// Ex:`ng generate @schematics/angular:component`
const commandName = !!collectionNameFromArgs ||
!collectionNames.some((c) => schematicCollectionsFromConfig.has(c))
? collectionName + ':' + dasherizedSchematicName
: dasherizedSchematicName;
const positionalArgs = options
.filter((o) => o.positional !== undefined)
.map((o) => {
const label = `${core_1.strings.dasherize(o.name)}${o.type === 'array' ? ' ..' : ''}`;
return o.required ? `<${label}>` : `[${label}]`;
})
.join(' ');
return `${commandName}${positionalArgs ? ' ' + positionalArgs : ''}`;
}
/**
* Get schematics that can to be registered as subcommands.
*/
async *getSchematics() {
const seenNames = new Set();
for (const collectionName of await this.getCollectionNames()) {
const workflow = this.getOrCreateWorkflowForBuilder(collectionName);
const collection = workflow.engine.createCollection(collectionName);
for (const schematicName of collection.listSchematicNames(true /** includeHidden */)) {
// If a schematic with this same name is already registered skip.
if (!seenNames.has(schematicName)) {
seenNames.add(schematicName);
yield { schematicName, collectionName };
}
}
}
}
/**
* Get schematics that should to be registered as subcommands.
*
* @returns a sorted list of schematic that needs to be registered as subcommands.
*/
async getSchematicsToRegister() {
const schematicsToRegister = [];
const [, schematicNameFromArgs] = this.parseSchematicInfo(
// positional = [generate, component] or [generate]
this.context.args.positional[1]);
for await (const { schematicName, collectionName } of this.getSchematics()) {
if (schematicName === schematicNameFromArgs) {
return [[schematicName, collectionName]];
}
schematicsToRegister.push([schematicName, collectionName]);
}
// Didn't find the schematic or no schematic name was provided Ex: `ng generate --help`.
return schematicsToRegister.sort(([nameA], [nameB]) => nameA.localeCompare(nameB, undefined, { sensitivity: 'accent' }));
}
}
exports.GenerateCommandModule = GenerateCommandModule;
+17
View File
@@ -0,0 +1,17 @@
/**
* @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 { MissingTargetChoice } from '../../command-builder/architect-base-command-module';
import { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class LintCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
missingTargetChoices: MissingTargetChoice[];
multiTarget: boolean;
command: string;
longDescriptionPath: string;
describe: string;
}
+28
View File
@@ -0,0 +1,28 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.LintCommandModule = void 0;
const path_1 = require("path");
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class LintCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.missingTargetChoices = [
{
name: 'ESLint',
value: '@angular-eslint/schematics',
},
];
this.multiTarget = true;
this.command = 'lint [project]';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
this.describe = 'Runs linting tools on Angular application code in a given project folder.';
}
}
exports.LintCommandModule = LintCommandModule;
@@ -0,0 +1,20 @@
The command takes an optional project name, as specified in the `projects` section of the `angular.json` workspace configuration file.
When a project name is not supplied, executes the `lint` builder for all projects.
To use the `ng lint` command, use `ng add` to add a package that implements linting capabilities. Adding the package automatically updates your workspace configuration, adding a lint [CLI builder](guide/cli-builder).
For example:
```json
"projects": {
"my-project": {
...
"architect": {
...
"lint": {
"builder": "@angular-eslint/builder:lint",
"options": {}
}
}
}
}
```
@@ -0,0 +1,17 @@
/**
* @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 { CommandModule, CommandModuleImplementation } from '../../command-builder/command-module';
export declare class AwesomeCommandModule extends CommandModule implements CommandModuleImplementation {
command: string;
describe: false;
deprecated: boolean;
longDescriptionPath?: string | undefined;
builder(localYargs: Argv): Argv;
run(): void;
}
@@ -0,0 +1,38 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.AwesomeCommandModule = void 0;
const command_module_1 = require("../../command-builder/command-module");
const color_1 = require("../../utilities/color");
class AwesomeCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.command = 'make-this-awesome';
this.describe = false;
this.deprecated = false;
}
builder(localYargs) {
return localYargs;
}
run() {
const pickOne = (of) => of[Math.floor(Math.random() * of.length)];
const phrase = pickOne([
`You're on it, there's nothing for me to do!`,
`Let's take a look... nope, it's all good!`,
`You're doing fine.`,
`You're already doing great.`,
`Nothing to do; already awesome. Exiting.`,
`Error 418: As Awesome As Can Get.`,
`I spy with my little eye a great developer!`,
`Noop... already awesome.`,
]);
this.context.logger.info(color_1.colors.green(phrase));
}
}
exports.AwesomeCommandModule = AwesomeCommandModule;
+27
View File
@@ -0,0 +1,27 @@
/**
* @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 { SchematicsCommandArgs, SchematicsCommandModule } from '../../command-builder/schematics-command-module';
interface NewCommandArgs extends SchematicsCommandArgs {
collection?: string;
}
export declare class NewCommandModule extends SchematicsCommandModule implements CommandModuleImplementation<NewCommandArgs> {
private readonly schematicName;
scope: CommandScope;
protected allowPrivateSchematics: boolean;
command: string;
aliases: string;
describe: string;
longDescriptionPath?: string | undefined;
builder(argv: Argv): Promise<Argv<NewCommandArgs>>;
run(options: Options<NewCommandArgs> & OtherOptions): Promise<number | void>;
/** Find a collection from config that has an `ng-new` schematic. */
private getCollectionFromConfig;
}
export {};
+82
View File
@@ -0,0 +1,82 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.NewCommandModule = void 0;
const command_module_1 = require("../../command-builder/command-module");
const schematics_command_module_1 = require("../../command-builder/schematics-command-module");
const version_1 = require("../../utilities/version");
class NewCommandModule extends schematics_command_module_1.SchematicsCommandModule {
constructor() {
super(...arguments);
this.schematicName = 'ng-new';
this.scope = command_module_1.CommandScope.Out;
this.allowPrivateSchematics = true;
this.command = 'new [name]';
this.aliases = 'n';
this.describe = 'Creates a new Angular workspace.';
}
async builder(argv) {
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: { collection: 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) {
var _a;
// Register the version of the CLI in the registry.
const collectionName = (_a = options.collection) !== null && _a !== void 0 ? _a : (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_1.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. */
async getCollectionFromConfig() {
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 schematics_command_module_1.DEFAULT_SCHEMATICS_COLLECTION;
}
}
exports.NewCommandModule = NewCommandModule;
+25
View File
@@ -0,0 +1,25 @@
/**
* @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 { Target } from '@angular-devkit/architect';
import { Argv } from 'yargs';
import { ArchitectBaseCommandModule } from '../../command-builder/architect-base-command-module';
import { CommandModuleImplementation, CommandScope, Options, OtherOptions } from '../../command-builder/command-module';
export interface RunCommandArgs {
target: string;
}
export declare class RunCommandModule extends ArchitectBaseCommandModule<RunCommandArgs> implements CommandModuleImplementation<RunCommandArgs> {
scope: CommandScope;
command: string;
describe: string;
longDescriptionPath: string;
builder(argv: Argv): Promise<Argv<RunCommandArgs>>;
run(options: Options<RunCommandArgs> & OtherOptions): Promise<number>;
protected makeTargetSpecifier(options?: Options<RunCommandArgs>): Target | undefined;
/** @returns a sorted list of target specifiers to be used for auto completion. */
private getTargetChoices;
}
+93
View File
@@ -0,0 +1,93 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunCommandModule = void 0;
const path_1 = require("path");
const architect_base_command_module_1 = require("../../command-builder/architect-base-command-module");
const command_module_1 = require("../../command-builder/command-module");
class RunCommandModule extends architect_base_command_module_1.ArchitectBaseCommandModule {
constructor() {
super(...arguments);
this.scope = command_module_1.CommandScope.In;
this.command = 'run <target>';
this.describe = 'Runs an Architect target with an optional custom builder configuration defined in your project.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
async builder(argv) {
const { jsonHelp, getYargsCompletions, help } = this.context.args.options;
const localYargs = argv
.positional('target', {
describe: 'The Architect target to run.',
type: 'string',
demandOption: true,
// Show only in when using --help and auto completion because otherwise comma seperated configuration values will be invalid.
// Also, hide choices from JSON help so that we don't display them in AIO.
choices: (getYargsCompletions || help) && !jsonHelp ? this.getTargetChoices() : undefined,
})
.middleware((args) => {
// TODO: remove in version 15.
const { configuration, target } = args;
if (typeof configuration === 'string' && target) {
const targetWithConfig = target.split(':', 2);
targetWithConfig.push(configuration);
throw new command_module_1.CommandModuleError('Unknown argument: configuration.\n' +
`Provide the configuration as part of the target 'ng run ${targetWithConfig.join(':')}'.`);
}
}, true)
.strict();
const target = this.makeTargetSpecifier();
if (!target) {
return localYargs;
}
const schemaOptions = await this.getArchitectTargetOptions(target);
return this.addSchemaOptionsToCommand(localYargs, schemaOptions);
}
async run(options) {
const target = this.makeTargetSpecifier(options);
const { target: _target, ...extraOptions } = options;
if (!target) {
throw new command_module_1.CommandModuleError('Cannot determine project or target.');
}
return this.runSingleTarget(target, extraOptions);
}
makeTargetSpecifier(options) {
var _a;
const architectTarget = (_a = options === null || options === void 0 ? void 0 : options.target) !== null && _a !== void 0 ? _a : this.context.args.positional[1];
if (!architectTarget) {
return undefined;
}
const [project = '', target = '', configuration] = architectTarget.split(':');
return {
project,
target,
configuration,
};
}
/** @returns a sorted list of target specifiers to be used for auto completion. */
getTargetChoices() {
if (!this.context.workspace) {
return;
}
const targets = [];
for (const [projectName, project] of this.context.workspace.projects) {
for (const [targetName, target] of project.targets) {
const currentTarget = `${projectName}:${targetName}`;
targets.push(currentTarget);
if (!target.configurations) {
continue;
}
for (const configName of Object.keys(target.configurations)) {
targets.push(`${currentTarget}:${configName}`);
}
}
}
return targets.sort();
}
}
exports.RunCommandModule = RunCommandModule;
@@ -0,0 +1,16 @@
Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.
The CLI commands run Architect targets such as `build`, `serve`, `test`, and `lint`.
Each named target has a default configuration, specified by an "options" object,
and an optional set of named alternate configurations in the "configurations" object.
For example, the "serve" target for a newly generated app has a predefined
alternate configuration named "production".
You can define new targets and their configuration options in the "architect" section
of the `angular.json` file.
If you do so, you can run them from the command line using the `ng run` command.
Execute the command using the following format.
```
ng run project:target[:configuration]
```
+16
View File
@@ -0,0 +1,16 @@
/**
* @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 { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class ServeCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
multiTarget: boolean;
command: string;
aliases: string[];
describe: string;
longDescriptionPath?: string | undefined;
}
+21
View File
@@ -0,0 +1,21 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ServeCommandModule = void 0;
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class ServeCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.multiTarget = false;
this.command = 'serve [project]';
this.aliases = ['s'];
this.describe = 'Builds and serves your application, rebuilding on file changes.';
}
}
exports.ServeCommandModule = ServeCommandModule;
+16
View File
@@ -0,0 +1,16 @@
/**
* @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 { ArchitectCommandModule } from '../../command-builder/architect-command-module';
import { CommandModuleImplementation } from '../../command-builder/command-module';
export declare class TestCommandModule extends ArchitectCommandModule implements CommandModuleImplementation {
multiTarget: boolean;
command: string;
aliases: string[];
describe: string;
longDescriptionPath: string;
}
+23
View File
@@ -0,0 +1,23 @@
"use strict";
/**
* @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
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.TestCommandModule = void 0;
const path_1 = require("path");
const architect_command_module_1 = require("../../command-builder/architect-command-module");
class TestCommandModule extends architect_command_module_1.ArchitectCommandModule {
constructor() {
super(...arguments);
this.multiTarget = true;
this.command = 'test [project]';
this.aliases = ['t'];
this.describe = 'Runs unit tests in a project.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
}
exports.TestCommandModule = TestCommandModule;
@@ -0,0 +1,2 @@
Takes the name of the project, as specified in the `projects` section of the `angular.json` workspace configuration file.
When a project name is not supplied, it will execute for all projects.
+56
View File
@@ -0,0 +1,56 @@
/**
* @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 { CommandModule, CommandScope, Options } from '../../command-builder/command-module';
interface UpdateCommandArgs {
packages?: string[];
force: boolean;
next: boolean;
'migrate-only'?: boolean;
name?: string;
from?: string;
to?: string;
'allow-dirty': boolean;
verbose: boolean;
'create-commits': boolean;
}
export declare class UpdateCommandModule extends CommandModule<UpdateCommandArgs> {
scope: CommandScope;
protected shouldReportAnalytics: boolean;
command: string;
describe: string;
longDescriptionPath: string;
builder(localYargs: Argv): Argv<UpdateCommandArgs>;
run(options: Options<UpdateCommandArgs>): Promise<number | void>;
private executeSchematic;
/**
* @return Whether or not the migration was performed successfully.
*/
private executeMigration;
/**
* @return Whether or not the migrations were performed successfully.
*/
private executeMigrations;
private executePackageMigrations;
private migrateOnly;
private updatePackagesAndMigrate;
/**
* @return Whether or not the commit was successful.
*/
private commit;
private checkCleanGit;
/**
* Checks if the current installed CLI version is older or newer than a compatible version.
* @returns the version to install or null when there is no update to install.
*/
private checkCLIVersion;
private getCLIUpdateRunnerVersion;
private runTempBinary;
private packageManagerForce;
}
export {};
+814
View File
@@ -0,0 +1,814 @@
"use strict";
/**
* @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
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.UpdateCommandModule = void 0;
const schematics_1 = require("@angular-devkit/schematics");
const tools_1 = require("@angular-devkit/schematics/tools");
const child_process_1 = require("child_process");
const fs_1 = require("fs");
const module_1 = require("module");
const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
const npm_pick_manifest_1 = __importDefault(require("npm-pick-manifest"));
const path = __importStar(require("path"));
const path_1 = require("path");
const semver = __importStar(require("semver"));
const workspace_schema_1 = require("../../../lib/config/workspace-schema");
const command_module_1 = require("../../command-builder/command-module");
const schematic_engine_host_1 = require("../../command-builder/utilities/schematic-engine-host");
const schematic_workflow_1 = require("../../command-builder/utilities/schematic-workflow");
const color_1 = require("../../utilities/color");
const environment_options_1 = require("../../utilities/environment-options");
const error_1 = require("../../utilities/error");
const log_file_1 = require("../../utilities/log-file");
const package_metadata_1 = require("../../utilities/package-metadata");
const package_tree_1 = require("../../utilities/package-tree");
const version_1 = require("../../utilities/version");
const ANGULAR_PACKAGES_REGEXP = /^@(?:angular|nguniversal)\//;
const UPDATE_SCHEMATIC_COLLECTION = path.join(__dirname, 'schematic/collection.json');
class UpdateCommandModule extends command_module_1.CommandModule {
constructor() {
super(...arguments);
this.scope = command_module_1.CommandScope.In;
this.shouldReportAnalytics = false;
this.command = 'update [packages..]';
this.describe = 'Updates your workspace and its dependencies. See https://update.angular.io/.';
this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
}
builder(localYargs) {
return localYargs
.positional('packages', {
description: 'The names of package(s) to update.',
type: 'string',
array: true,
})
.option('force', {
description: 'Ignore peer dependency version mismatches.',
type: 'boolean',
default: false,
})
.option('next', {
description: 'Use the prerelease version, including beta and RCs.',
type: 'boolean',
default: false,
})
.option('migrate-only', {
description: 'Only perform a migration, do not update the installed version.',
type: 'boolean',
})
.option('name', {
description: 'The name of the migration to run. ' +
`Only available with a single package being updated, and only with 'migrate-only' option.`,
type: 'string',
implies: ['migrate-only'],
conflicts: ['to', 'from'],
})
.option('from', {
description: 'Version from which to migrate from. ' +
`Only available with a single package being updated, and only with 'migrate-only'.`,
type: 'string',
implies: ['to', 'migrate-only'],
conflicts: ['name'],
})
.option('to', {
describe: 'Version up to which to apply migrations. Only available with a single package being updated, ' +
`and only with 'migrate-only' option. Requires 'from' to be specified. Default to the installed version detected.`,
type: 'string',
implies: ['from', 'migrate-only'],
conflicts: ['name'],
})
.option('allow-dirty', {
describe: 'Whether to allow updating when the repository contains modified or untracked files.',
type: 'boolean',
default: false,
})
.option('verbose', {
describe: 'Display additional details about internal operations during execution.',
type: 'boolean',
default: false,
})
.option('create-commits', {
describe: 'Create source control commits for updates and migrations.',
type: 'boolean',
alias: ['C'],
default: false,
})
.check(({ packages, 'allow-dirty': allowDirty, 'migrate-only': migrateOnly }) => {
const { logger } = this.context;
// This allows the user to easily reset any changes from the update.
if ((packages === null || packages === void 0 ? void 0 : packages.length) && !this.checkCleanGit()) {
if (allowDirty) {
logger.warn('Repository is not clean. Update changes will be mixed with pre-existing changes.');
}
else {
throw new command_module_1.CommandModuleError('Repository is not clean. Please commit or stash any changes before updating.');
}
}
if (migrateOnly) {
if ((packages === null || packages === void 0 ? void 0 : packages.length) !== 1) {
throw new command_module_1.CommandModuleError(`A single package must be specified when using the 'migrate-only' option.`);
}
}
return true;
})
.strict();
}
async run(options) {
var _a, _b, _c;
const { logger, packageManager } = this.context;
packageManager.ensureCompatibility();
// Check if the current installed CLI version is older than the latest compatible version.
// Skip when running `ng update` without a package name as this will not trigger an actual update.
if (!environment_options_1.disableVersionCheck && ((_a = options.packages) === null || _a === void 0 ? void 0 : _a.length)) {
const cliVersionToInstall = await this.checkCLIVersion(options.packages, options.verbose, options.next);
if (cliVersionToInstall) {
logger.warn('The installed Angular CLI version is outdated.\n' +
`Installing a temporary Angular CLI versioned ${cliVersionToInstall} to perform the update.`);
return this.runTempBinary(`@angular/cli@${cliVersionToInstall}`, process.argv.slice(2));
}
}
const packages = [];
for (const request of (_b = options.packages) !== null && _b !== void 0 ? _b : []) {
try {
const packageIdentifier = (0, npm_package_arg_1.default)(request);
// only registry identifiers are supported
if (!packageIdentifier.registry) {
logger.error(`Package '${request}' is not a registry package identifer.`);
return 1;
}
if (packages.some((v) => v.name === packageIdentifier.name)) {
logger.error(`Duplicate package '${packageIdentifier.name}' specified.`);
return 1;
}
if (options.migrateOnly && packageIdentifier.rawSpec) {
logger.warn('Package specifier has no effect when using "migrate-only" option.');
}
// If next option is used and no specifier supplied, use next tag
if (options.next && !packageIdentifier.rawSpec) {
packageIdentifier.fetchSpec = 'next';
}
packages.push(packageIdentifier);
}
catch (e) {
(0, error_1.assertIsError)(e);
logger.error(e.message);
return 1;
}
}
logger.info(`Using package manager: ${color_1.colors.grey(packageManager.name)}`);
logger.info('Collecting installed dependencies...');
const rootDependencies = await (0, package_tree_1.getProjectDependencies)(this.context.root);
logger.info(`Found ${rootDependencies.size} dependencies.`);
const workflow = new tools_1.NodeWorkflow(this.context.root, {
packageManager: packageManager.name,
packageManagerForce: this.packageManagerForce(options.verbose),
// __dirname -> favor @schematics/update from this package
// Otherwise, use packages from the active workspace (migrations)
resolvePaths: [__dirname, this.context.root],
schemaValidation: true,
engineHostCreator: (options) => new schematic_engine_host_1.SchematicEngineHost(options.resolvePaths),
});
if (packages.length === 0) {
// Show status
const { success } = await this.executeSchematic(workflow, UPDATE_SCHEMATIC_COLLECTION, 'update', {
force: options.force,
next: options.next,
verbose: options.verbose,
packageManager: packageManager.name,
packages: [],
});
return success ? 0 : 1;
}
return options.migrateOnly
? this.migrateOnly(workflow, ((_c = options.packages) !== null && _c !== void 0 ? _c : [])[0], rootDependencies, options)
: this.updatePackagesAndMigrate(workflow, rootDependencies, options, packages);
}
async executeSchematic(workflow, collection, schematic, options = {}) {
const { logger } = this.context;
const workflowSubscription = (0, schematic_workflow_1.subscribeToWorkflow)(workflow, logger);
// TODO: Allow passing a schematic instance directly
try {
await workflow
.execute({
collection,
schematic,
options,
logger,
})
.toPromise();
return { success: !workflowSubscription.error, files: workflowSubscription.files };
}
catch (e) {
if (e instanceof schematics_1.UnsuccessfulWorkflowExecution) {
logger.error(`${color_1.colors.symbols.cross} Migration failed. See above for further details.\n`);
}
else {
(0, error_1.assertIsError)(e);
const logPath = (0, log_file_1.writeErrorToLogFile)(e);
logger.fatal(`${color_1.colors.symbols.cross} Migration failed: ${e.message}\n` +
` See "${logPath}" for further details.\n`);
}
return { success: false, files: workflowSubscription.files };
}
finally {
workflowSubscription.unsubscribe();
}
}
/**
* @return Whether or not the migration was performed successfully.
*/
async executeMigration(workflow, packageName, collectionPath, migrationName, commit) {
const { logger } = this.context;
const collection = workflow.engine.createCollection(collectionPath);
const name = collection.listSchematicNames().find((name) => name === migrationName);
if (!name) {
logger.error(`Cannot find migration '${migrationName}' in '${packageName}'.`);
return 1;
}
logger.info(color_1.colors.cyan(`** Executing '${migrationName}' of package '${packageName}' **\n`));
const schematic = workflow.engine.createSchematic(name, collection);
return this.executePackageMigrations(workflow, [schematic.description], packageName, commit);
}
/**
* @return Whether or not the migrations were performed successfully.
*/
async executeMigrations(workflow, packageName, collectionPath, from, to, commit) {
const collection = workflow.engine.createCollection(collectionPath);
const migrationRange = new semver.Range('>' + (semver.prerelease(from) ? from.split('-')[0] + '-0' : from) + ' <=' + to.split('-')[0]);
const migrations = [];
for (const name of collection.listSchematicNames()) {
const schematic = workflow.engine.createSchematic(name, collection);
const description = schematic.description;
description.version = coerceVersionNumber(description.version);
if (!description.version) {
continue;
}
if (semver.satisfies(description.version, migrationRange, { includePrerelease: true })) {
migrations.push(description);
}
}
if (migrations.length === 0) {
return 0;
}
migrations.sort((a, b) => semver.compare(a.version, b.version) || a.name.localeCompare(b.name));
this.context.logger.info(color_1.colors.cyan(`** Executing migrations of package '${packageName}' **\n`));
return this.executePackageMigrations(workflow, migrations, packageName, commit);
}
async executePackageMigrations(workflow, migrations, packageName, commit = false) {
const { logger } = this.context;
for (const migration of migrations) {
const [title, ...description] = migration.description.split('. ');
logger.info(color_1.colors.cyan(color_1.colors.symbols.pointer) +
' ' +
color_1.colors.bold(title.endsWith('.') ? title : title + '.'));
if (description.length) {
logger.info(' ' + description.join('.\n '));
}
const result = await this.executeSchematic(workflow, migration.collection.name, migration.name);
if (!result.success) {
return 1;
}
logger.info(' Migration completed.');
// Commit migration
if (commit) {
const commitPrefix = `${packageName} migration - ${migration.name}`;
const commitMessage = migration.description
? `${commitPrefix}\n\n${migration.description}`
: commitPrefix;
const committed = this.commit(commitMessage);
if (!committed) {
// Failed to commit, something went wrong. Abort the update.
return 1;
}
}
logger.info(''); // Extra trailing newline.
}
return 0;
}
async migrateOnly(workflow, packageName, rootDependencies, options) {
const { logger } = this.context;
const packageDependency = rootDependencies.get(packageName);
let packagePath = packageDependency === null || packageDependency === void 0 ? void 0 : packageDependency.path;
let packageNode = packageDependency === null || packageDependency === void 0 ? void 0 : packageDependency.package;
if (packageDependency && !packageNode) {
logger.error('Package found in package.json but is not installed.');
return 1;
}
else if (!packageDependency) {
// Allow running migrations on transitively installed dependencies
// There can technically be nested multiple versions
// TODO: If multiple, this should find all versions and ask which one to use
const packageJson = (0, package_tree_1.findPackageJson)(this.context.root, packageName);
if (packageJson) {
packagePath = path.dirname(packageJson);
packageNode = await (0, package_tree_1.readPackageJson)(packageJson);
}
}
if (!packageNode || !packagePath) {
logger.error('Package is not installed.');
return 1;
}
const updateMetadata = packageNode['ng-update'];
let migrations = updateMetadata === null || updateMetadata === void 0 ? void 0 : updateMetadata.migrations;
if (migrations === undefined) {
logger.error('Package does not provide migrations.');
return 1;
}
else if (typeof migrations !== 'string') {
logger.error('Package contains a malformed migrations field.');
return 1;
}
else if (path.posix.isAbsolute(migrations) || path.win32.isAbsolute(migrations)) {
logger.error('Package contains an invalid migrations field. Absolute paths are not permitted.');
return 1;
}
// Normalize slashes
migrations = migrations.replace(/\\/g, '/');
if (migrations.startsWith('../')) {
logger.error('Package contains an invalid migrations field. Paths outside the package root are not permitted.');
return 1;
}
// Check if it is a package-local location
const localMigrations = path.join(packagePath, migrations);
if ((0, fs_1.existsSync)(localMigrations)) {
migrations = localMigrations;
}
else {
// Try to resolve from package location.
// This avoids issues with package hoisting.
try {
const packageRequire = (0, module_1.createRequire)(packagePath + '/');
migrations = packageRequire.resolve(migrations);
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'MODULE_NOT_FOUND') {
logger.error('Migrations for package were not found.');
}
else {
logger.error(`Unable to resolve migrations for package. [${e.message}]`);
}
return 1;
}
}
if (options.name) {
return this.executeMigration(workflow, packageName, migrations, options.name, options.createCommits);
}
const from = coerceVersionNumber(options.from);
if (!from) {
logger.error(`"from" value [${options.from}] is not a valid version.`);
return 1;
}
return this.executeMigrations(workflow, packageName, migrations, from, options.to || packageNode.version, options.createCommits);
}
// eslint-disable-next-line max-lines-per-function
async updatePackagesAndMigrate(workflow, rootDependencies, options, packages) {
var _a;
const { logger } = this.context;
const logVerbose = (message) => {
if (options.verbose) {
logger.info(message);
}
};
const requests = [];
// Validate packages actually are part of the workspace
for (const pkg of packages) {
const node = rootDependencies.get(pkg.name);
if (!(node === null || node === void 0 ? void 0 : node.package)) {
logger.error(`Package '${pkg.name}' is not a dependency.`);
return 1;
}
// If a specific version is requested and matches the installed version, skip.
if (pkg.type === 'version' && node.package.version === pkg.fetchSpec) {
logger.info(`Package '${pkg.name}' is already at '${pkg.fetchSpec}'.`);
continue;
}
requests.push({ identifier: pkg, node });
}
if (requests.length === 0) {
return 0;
}
logger.info('Fetching dependency metadata from registry...');
const packagesToUpdate = [];
for (const { identifier: requestIdentifier, node } of requests) {
const packageName = requestIdentifier.name;
let metadata;
try {
// Metadata requests are internally cached; multiple requests for same name
// does not result in additional network traffic
metadata = await (0, package_metadata_1.fetchPackageMetadata)(packageName, logger, {
verbose: options.verbose,
});
}
catch (e) {
(0, error_1.assertIsError)(e);
logger.error(`Error fetching metadata for '${packageName}': ` + e.message);
return 1;
}
// Try to find a package version based on the user requested package specifier
// registry specifier types are either version, range, or tag
let manifest;
if (requestIdentifier.type === 'version' ||
requestIdentifier.type === 'range' ||
requestIdentifier.type === 'tag') {
try {
manifest = (0, npm_pick_manifest_1.default)(metadata, requestIdentifier.fetchSpec);
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'ETARGET') {
// If not found and next was used and user did not provide a specifier, try latest.
// Package may not have a next tag.
if (requestIdentifier.type === 'tag' &&
requestIdentifier.fetchSpec === 'next' &&
!requestIdentifier.rawSpec) {
try {
manifest = (0, npm_pick_manifest_1.default)(metadata, 'latest');
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code !== 'ETARGET' && e.code !== 'ENOVERSIONS') {
throw e;
}
}
}
}
else if (e.code !== 'ENOVERSIONS') {
throw e;
}
}
}
if (!manifest) {
logger.error(`Package specified by '${requestIdentifier.raw}' does not exist within the registry.`);
return 1;
}
if (manifest.version === ((_a = node.package) === null || _a === void 0 ? void 0 : _a.version)) {
logger.info(`Package '${packageName}' is already up to date.`);
continue;
}
if (node.package && ANGULAR_PACKAGES_REGEXP.test(node.package.name)) {
const { name, version } = node.package;
const toBeInstalledMajorVersion = +manifest.version.split('.')[0];
const currentMajorVersion = +version.split('.')[0];
if (toBeInstalledMajorVersion - currentMajorVersion > 1) {
// Only allow updating a single version at a time.
if (currentMajorVersion < 6) {
// Before version 6, the major versions were not always sequential.
// Example @angular/core skipped version 3, @angular/cli skipped versions 2-5.
logger.error(`Updating multiple major versions of '${name}' at once is not supported. Please migrate each major version individually.\n` +
`For more information about the update process, see https://update.angular.io/.`);
}
else {
const nextMajorVersionFromCurrent = currentMajorVersion + 1;
logger.error(`Updating multiple major versions of '${name}' at once is not supported. Please migrate each major version individually.\n` +
`Run 'ng update ${name}@${nextMajorVersionFromCurrent}' in your workspace directory ` +
`to update to latest '${nextMajorVersionFromCurrent}.x' version of '${name}'.\n\n` +
`For more information about the update process, see https://update.angular.io/?v=${currentMajorVersion}.0-${nextMajorVersionFromCurrent}.0`);
}
return 1;
}
}
packagesToUpdate.push(requestIdentifier.toString());
}
if (packagesToUpdate.length === 0) {
return 0;
}
const { success } = await this.executeSchematic(workflow, UPDATE_SCHEMATIC_COLLECTION, 'update', {
verbose: options.verbose,
force: options.force,
next: options.next,
packageManager: this.context.packageManager.name,
packages: packagesToUpdate,
});
if (success) {
try {
await fs_1.promises.rm(path.join(this.context.root, 'node_modules'), {
force: true,
recursive: true,
maxRetries: 3,
});
}
catch { }
const installationSuccess = await this.context.packageManager.installAll(this.packageManagerForce(options.verbose) ? ['--force'] : [], this.context.root);
if (!installationSuccess) {
return 1;
}
}
if (success && options.createCommits) {
if (!this.commit(`Angular CLI update for packages - ${packagesToUpdate.join(', ')}`)) {
return 1;
}
}
// This is a temporary workaround to allow data to be passed back from the update schematic
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const migrations = global.externalMigrations;
if (success && migrations) {
const rootRequire = (0, module_1.createRequire)(this.context.root + '/');
for (const migration of migrations) {
// Resolve the package from the workspace root, as otherwise it will be resolved from the temp
// installed CLI version.
let packagePath;
logVerbose(`Resolving migration package '${migration.package}' from '${this.context.root}'...`);
try {
try {
packagePath = path.dirname(
// This may fail if the `package.json` is not exported as an entry point
rootRequire.resolve(path.join(migration.package, 'package.json')));
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'MODULE_NOT_FOUND') {
// Fallback to trying to resolve the package's main entry point
packagePath = rootRequire.resolve(migration.package);
}
else {
throw e;
}
}
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'MODULE_NOT_FOUND') {
logVerbose(e.toString());
logger.error(`Migrations for package (${migration.package}) were not found.` +
' The package could not be found in the workspace.');
}
else {
logger.error(`Unable to resolve migrations for package (${migration.package}). [${e.message}]`);
}
return 1;
}
let migrations;
// Check if it is a package-local location
const localMigrations = path.join(packagePath, migration.collection);
if ((0, fs_1.existsSync)(localMigrations)) {
migrations = localMigrations;
}
else {
// Try to resolve from package location.
// This avoids issues with package hoisting.
try {
const packageRequire = (0, module_1.createRequire)(packagePath + '/');
migrations = packageRequire.resolve(migration.collection);
}
catch (e) {
(0, error_1.assertIsError)(e);
if (e.code === 'MODULE_NOT_FOUND') {
logger.error(`Migrations for package (${migration.package}) were not found.`);
}
else {
logger.error(`Unable to resolve migrations for package (${migration.package}). [${e.message}]`);
}
return 1;
}
}
const result = await this.executeMigrations(workflow, migration.package, migrations, migration.from, migration.to, options.createCommits);
// A non-zero value is a failure for the package's migrations
if (result !== 0) {
return result;
}
}
}
return success ? 0 : 1;
}
/**
* @return Whether or not the commit was successful.
*/
commit(message) {
const { logger } = this.context;
// Check if a commit is needed.
let commitNeeded;
try {
commitNeeded = hasChangesToCommit();
}
catch (err) {
logger.error(` Failed to read Git tree:\n${err.stderr}`);
return false;
}
if (!commitNeeded) {
logger.info(' No changes to commit after migration.');
return true;
}
// Commit changes and abort on error.
try {
createCommit(message);
}
catch (err) {
logger.error(`Failed to commit update (${message}):\n${err.stderr}`);
return false;
}
// Notify user of the commit.
const hash = findCurrentGitSha();
const shortMessage = message.split('\n')[0];
if (hash) {
logger.info(` Committed migration step (${getShortHash(hash)}): ${shortMessage}.`);
}
else {
// Commit was successful, but reading the hash was not. Something weird happened,
// but nothing that would stop the update. Just log the weirdness and continue.
logger.info(` Committed migration step: ${shortMessage}.`);
logger.warn(' Failed to look up hash of most recent commit, continuing anyways.');
}
return true;
}
checkCleanGit() {
try {
const topLevel = (0, child_process_1.execSync)('git rev-parse --show-toplevel', {
encoding: 'utf8',
stdio: 'pipe',
});
const result = (0, child_process_1.execSync)('git status --porcelain', { encoding: 'utf8', stdio: 'pipe' });
if (result.trim().length === 0) {
return true;
}
// Only files inside the workspace root are relevant
for (const entry of result.split('\n')) {
const relativeEntry = path.relative(path.resolve(this.context.root), path.resolve(topLevel.trim(), entry.slice(3).trim()));
if (!relativeEntry.startsWith('..') && !path.isAbsolute(relativeEntry)) {
return false;
}
}
}
catch { }
return true;
}
/**
* Checks if the current installed CLI version is older or newer than a compatible version.
* @returns the version to install or null when there is no update to install.
*/
async checkCLIVersion(packagesToUpdate, verbose = false, next = false) {
const { version } = await (0, package_metadata_1.fetchPackageManifest)(`@angular/cli@${this.getCLIUpdateRunnerVersion(packagesToUpdate, next)}`, this.context.logger, {
verbose,
usingYarn: this.context.packageManager.name === workspace_schema_1.PackageManager.Yarn,
});
return version_1.VERSION.full === version ? null : version;
}
getCLIUpdateRunnerVersion(packagesToUpdate, next) {
var _a, _b;
if (next) {
return 'next';
}
const updatingAngularPackage = packagesToUpdate === null || packagesToUpdate === void 0 ? void 0 : packagesToUpdate.find((r) => ANGULAR_PACKAGES_REGEXP.test(r));
if (updatingAngularPackage) {
// If we are updating any Angular package we can update the CLI to the target version because
// migrations for @angular/core@13 can be executed using Angular/cli@13.
// This is same behaviour as `npx @angular/cli@13 update @angular/core@13`.
// `@angular/cli@13` -> ['', 'angular/cli', '13']
// `@angular/cli` -> ['', 'angular/cli']
const tempVersion = coerceVersionNumber(updatingAngularPackage.split('@')[2]);
return (_b = (_a = semver.parse(tempVersion)) === null || _a === void 0 ? void 0 : _a.major) !== null && _b !== void 0 ? _b : 'latest';
}
// When not updating an Angular package we cannot determine which schematic runtime the migration should to be executed in.
// Typically, we can assume that the `@angular/cli` was updated previously.
// Example: Angular official packages are typically updated prior to NGRX etc...
// Therefore, we only update to the latest patch version of the installed major version of the Angular CLI.
// This is important because we might end up in a scenario where locally Angular v12 is installed, updating NGRX from 11 to 12.
// We end up using Angular ClI v13 to run the migrations if we run the migrations using the CLI installed major version + 1 logic.
return version_1.VERSION.major;
}
async runTempBinary(packageName, args = []) {
const { success, tempNodeModules } = await this.context.packageManager.installTemp(packageName);
if (!success) {
return 1;
}
// Remove version/tag etc... from package name
// Ex: @angular/cli@latest -> @angular/cli
const packageNameNoVersion = packageName.substring(0, packageName.lastIndexOf('@'));
const pkgLocation = (0, path_1.join)(tempNodeModules, packageNameNoVersion);
const packageJsonPath = (0, path_1.join)(pkgLocation, 'package.json');
// Get a binary location for this package
let binPath;
if ((0, fs_1.existsSync)(packageJsonPath)) {
const content = await fs_1.promises.readFile(packageJsonPath, 'utf-8');
if (content) {
const { bin = {} } = JSON.parse(content);
const binKeys = Object.keys(bin);
if (binKeys.length) {
binPath = (0, path_1.resolve)(pkgLocation, bin[binKeys[0]]);
}
}
}
if (!binPath) {
throw new Error(`Cannot locate bin for temporary package: ${packageNameNoVersion}.`);
}
const { status, error } = (0, child_process_1.spawnSync)(process.execPath, [binPath, ...args], {
stdio: 'inherit',
env: {
...process.env,
NG_DISABLE_VERSION_CHECK: 'true',
NG_CLI_ANALYTICS: 'false',
},
});
if (status === null && error) {
throw error;
}
return status !== null && status !== void 0 ? status : 0;
}
packageManagerForce(verbose) {
// npm 7+ can fail due to it incorrectly resolving peer dependencies that have valid SemVer
// ranges during an update. Update will set correct versions of dependencies within the
// package.json file. The force option is set to workaround these errors.
// Example error:
// npm ERR! Conflicting peer dependency: @angular/compiler-cli@14.0.0-rc.0
// npm ERR! node_modules/@angular/compiler-cli
// npm ERR! peer @angular/compiler-cli@"^14.0.0 || ^14.0.0-rc" from @angular-devkit/build-angular@14.0.0-rc.0
// npm ERR! node_modules/@angular-devkit/build-angular
// npm ERR! dev @angular-devkit/build-angular@"~14.0.0-rc.0" from the root project
if (this.context.packageManager.name === workspace_schema_1.PackageManager.Npm &&
this.context.packageManager.version &&
semver.gte(this.context.packageManager.version, '7.0.0')) {
if (verbose) {
this.context.logger.info('NPM 7+ detected -- enabling force option for package installation');
}
return true;
}
return false;
}
}
exports.UpdateCommandModule = UpdateCommandModule;
/**
* @return Whether or not the working directory has Git changes to commit.
*/
function hasChangesToCommit() {
// List all modified files not covered by .gitignore.
// If any files are returned, then there must be something to commit.
return (0, child_process_1.execSync)('git ls-files -m -d -o --exclude-standard').toString() !== '';
}
/**
* Precondition: Must have pending changes to commit, they do not need to be staged.
* Postcondition: The Git working tree is committed and the repo is clean.
* @param message The commit message to use.
*/
function createCommit(message) {
// Stage entire working tree for commit.
(0, child_process_1.execSync)('git add -A', { encoding: 'utf8', stdio: 'pipe' });
// Commit with the message passed via stdin to avoid bash escaping issues.
(0, child_process_1.execSync)('git commit --no-verify -F -', { encoding: 'utf8', stdio: 'pipe', input: message });
}
/**
* @return The Git SHA hash of the HEAD commit. Returns null if unable to retrieve the hash.
*/
function findCurrentGitSha() {
try {
return (0, child_process_1.execSync)('git rev-parse HEAD', { encoding: 'utf8', stdio: 'pipe' }).trim();
}
catch {
return null;
}
}
function getShortHash(commitHash) {
return commitHash.slice(0, 9);
}
function coerceVersionNumber(version) {
var _a;
if (!version) {
return undefined;
}
if (!/^\d{1,30}\.\d{1,30}\.\d{1,30}/.test(version)) {
const match = version.match(/^\d{1,30}(\.\d{1,30})*/);
if (!match) {
return undefined;
}
if (!match[1]) {
version = version.substring(0, match[0].length) + '.0.0' + version.substring(match[0].length);
}
else if (!match[2]) {
version = version.substring(0, match[0].length) + '.0' + version.substring(match[0].length);
}
else {
return undefined;
}
}
return (_a = semver.valid(version)) !== null && _a !== void 0 ? _a : undefined;
}
@@ -0,0 +1,22 @@
Perform a basic update to the current stable release of the core framework and CLI by running the following command.
```
ng update @angular/cli @angular/core
```
To update to the next beta or pre-release version, use the `--next` option.
To update from one major version to another, use the format
```
ng update @angular/cli@^<major_version> @angular/core@^<major_version>
```
We recommend that you always update to the latest patch version, as it contains fixes we released since the initial major release.
For example, use the following command to take the latest 10.x.x version and use that to update.
```
ng update @angular/cli@^10 @angular/core@^10
```
For detailed information and guidance on updating your application, see the interactive [Angular Update Guide](https://update.angular.io/).

Some files were not shown because too many files have changed in this diff Show More