mirror of https://github.com/abpframework/abp
parent
3047e0b008
commit
0a8b53fcae
@ -1,5 +1,5 @@
|
||||
**DISCLAIMER**
|
||||
|
||||
This directory is a direct copy of https://github.com/angular/angular-cli/tree/d091bb0c7b76a73e1b7d4b5690c532c68452b1d6 and is used under terms and permissions by the MIT license granted by Google, Inc.
|
||||
This directory is a direct copy of https://github.com/angular/angular-cli/tree/c5ef701639755d5b390e64287963ee35faab2cd4/packages/schematics/angular/utility and is used under terms and permissions by the MIT license granted by Google, LLC.
|
||||
|
||||
All credits go to Angular team for building these utilities.
|
||||
|
@ -0,0 +1,173 @@
|
||||
/**
|
||||
* @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 { Rule, SchematicContext } from '@angular-devkit/schematics';
|
||||
import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
|
||||
import * as path from 'path';
|
||||
|
||||
const installTasks = new WeakMap<SchematicContext, Set<string>>();
|
||||
|
||||
interface MinimalPackageManifest {
|
||||
dependencies?: Record<string, string>;
|
||||
devDependencies?: Record<string, string>;
|
||||
peerDependencies?: Record<string, string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* An enum used to specify the type of a dependency found within a package manifest
|
||||
* file (`package.json`).
|
||||
*/
|
||||
export enum DependencyType {
|
||||
Default = 'dependencies',
|
||||
Dev = 'devDependencies',
|
||||
Peer = 'peerDependencies',
|
||||
}
|
||||
|
||||
/**
|
||||
* An enum used to specify the dependency installation behavior for the {@link addDependency}
|
||||
* schematics rule. The installation behavior affects if and when {@link NodePackageInstallTask}
|
||||
* will be scheduled when using the rule.
|
||||
*/
|
||||
export enum InstallBehavior {
|
||||
/**
|
||||
* No installation will occur as a result of the rule when specified.
|
||||
*
|
||||
* NOTE: This does not prevent other rules from scheduling a {@link NodePackageInstallTask}
|
||||
* which may install the dependency.
|
||||
*/
|
||||
None,
|
||||
/**
|
||||
* Automatically determine the need to schedule a {@link NodePackageInstallTask} based on
|
||||
* previous usage of the {@link addDependency} within the schematic.
|
||||
*/
|
||||
Auto,
|
||||
/**
|
||||
* Always schedule a {@link NodePackageInstallTask} when the rule is executed.
|
||||
*/
|
||||
Always,
|
||||
}
|
||||
|
||||
/**
|
||||
* An enum used to specify the existing dependency behavior for the {@link addDependency}
|
||||
* schematics rule. The existing behavior affects whether the named dependency will be added
|
||||
* to the `package.json` when the dependency is already present with a differing specifier.
|
||||
*/
|
||||
export enum ExistingBehavior {
|
||||
/**
|
||||
* The dependency will not be added or otherwise changed if it already exists.
|
||||
*/
|
||||
Skip,
|
||||
/**
|
||||
* The dependency's existing specifier will be replaced with the specifier provided in the
|
||||
* {@link addDependency} call. A warning will also be shown during schematic execution to
|
||||
* notify the user of the replacement.
|
||||
*/
|
||||
Replace,
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a package as a dependency to a `package.json`. By default the `package.json` located
|
||||
* at the schematic's root will be used. The `manifestPath` option can be used to explicitly specify
|
||||
* a `package.json` in different location. The type of the dependency can also be specified instead
|
||||
* of the default of the `dependencies` section by using the `type` option for either `devDependencies`
|
||||
* or `peerDependencies`.
|
||||
*
|
||||
* When using this rule, {@link NodePackageInstallTask} does not need to be included directly by
|
||||
* a schematic. A package manager install task will be automatically scheduled as needed.
|
||||
*
|
||||
* @param name The name of the package to add.
|
||||
* @param specifier The package specifier for the package to add. Typically a SemVer range.
|
||||
* @param options An optional object that can contain the `type` of the dependency
|
||||
* and/or a path (`packageJsonPath`) of a manifest file (`package.json`) to modify.
|
||||
* @returns A Schematics {@link Rule}
|
||||
*/
|
||||
export function addDependency(
|
||||
name: string,
|
||||
specifier: string,
|
||||
options: {
|
||||
/**
|
||||
* The type of the dependency determines the section of the `package.json` to which the
|
||||
* dependency will be added. Defaults to {@link DependencyType.Default} (`dependencies`).
|
||||
*/
|
||||
type?: DependencyType;
|
||||
/**
|
||||
* The path of the package manifest file (`package.json`) that will be modified.
|
||||
* Defaults to `/package.json`.
|
||||
*/
|
||||
packageJsonPath?: string;
|
||||
/**
|
||||
* The dependency installation behavior to use to determine whether a
|
||||
* {@link NodePackageInstallTask} should be scheduled after adding the dependency.
|
||||
* Defaults to {@link InstallBehavior.Auto}.
|
||||
*/
|
||||
install?: InstallBehavior;
|
||||
/**
|
||||
* The behavior to use when the dependency already exists within the `package.json`.
|
||||
* Defaults to {@link ExistingBehavior.Replace}.
|
||||
*/
|
||||
existing?: ExistingBehavior;
|
||||
} = {},
|
||||
): Rule {
|
||||
const {
|
||||
type = DependencyType.Default,
|
||||
packageJsonPath = '/package.json',
|
||||
install = InstallBehavior.Auto,
|
||||
existing = ExistingBehavior.Replace,
|
||||
} = options;
|
||||
|
||||
return (tree, context) => {
|
||||
const manifest = tree.readJson(packageJsonPath) as MinimalPackageManifest;
|
||||
const dependencySection = manifest[type];
|
||||
|
||||
if (!dependencySection) {
|
||||
// Section is not present. The dependency can be added to a new object literal for the section.
|
||||
manifest[type] = { [name]: specifier };
|
||||
} else {
|
||||
const existingSpecifier = dependencySection[name];
|
||||
|
||||
if (existingSpecifier === specifier) {
|
||||
// Already present with same specifier
|
||||
return;
|
||||
}
|
||||
|
||||
if (existingSpecifier) {
|
||||
// Already present but different specifier
|
||||
|
||||
if (existing === ExistingBehavior.Skip) {
|
||||
return;
|
||||
}
|
||||
|
||||
// ExistingBehavior.Replace is the only other behavior currently
|
||||
context.logger.warn(
|
||||
`Package dependency "${name}" already exists with a different specifier. ` +
|
||||
`"${existingSpecifier}" will be replaced with "${specifier}".`,
|
||||
);
|
||||
}
|
||||
|
||||
// Add new dependency in alphabetical order
|
||||
const entries = Object.entries(dependencySection);
|
||||
entries.push([name, specifier]);
|
||||
entries.sort((a, b) => a[0].localeCompare(b[0]));
|
||||
manifest[type] = Object.fromEntries(entries);
|
||||
}
|
||||
|
||||
tree.overwrite(packageJsonPath, JSON.stringify(manifest, null, 2));
|
||||
|
||||
const installPaths = installTasks.get(context) ?? new Set<string>();
|
||||
if (
|
||||
install === InstallBehavior.Always ||
|
||||
(install === InstallBehavior.Auto && !installPaths.has(packageJsonPath))
|
||||
) {
|
||||
context.addTask(
|
||||
new NodePackageInstallTask({ workingDirectory: path.dirname(packageJsonPath) }),
|
||||
);
|
||||
installPaths.add(packageJsonPath);
|
||||
installTasks.set(context, installPaths);
|
||||
}
|
||||
};
|
||||
}
|
@ -1,20 +1,23 @@
|
||||
{
|
||||
"description": "Package versions used by schematics in @schematics/angular.",
|
||||
"comment": "This file is needed so that depedencies are synced by Renovate.",
|
||||
"comment": "This file is needed so that dependencies are synced by Renovate.",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"@types/jasmine": "~3.10.0",
|
||||
"@types/node": "^12.11.1",
|
||||
"jasmine-core": "~4.0.0",
|
||||
"@types/jasmine": "~4.0.0",
|
||||
"@types/node": "^14.15.0",
|
||||
"jasmine-core": "~4.3.0",
|
||||
"jasmine-spec-reporter": "~7.0.0",
|
||||
"karma-chrome-launcher": "~3.1.0",
|
||||
"karma-coverage": "~2.1.0",
|
||||
"karma-jasmine-html-reporter": "~1.7.0",
|
||||
"karma-jasmine": "~4.0.0",
|
||||
"karma": "~6.3.0",
|
||||
"ng-packagr": "^13.0.0",
|
||||
"rxjs": "~6.6.7",
|
||||
"karma-coverage": "~2.2.0",
|
||||
"karma-jasmine-html-reporter": "~2.0.0",
|
||||
"karma-jasmine": "~5.1.0",
|
||||
"karma": "~6.4.0",
|
||||
"ng-packagr": "^14.2.0",
|
||||
"protractor": "~7.0.0",
|
||||
"rxjs": "~7.5.0",
|
||||
"tslib": "^2.3.0",
|
||||
"typescript": "~4.6.2",
|
||||
"ts-node": "~10.9.0",
|
||||
"typescript": "~4.7.2",
|
||||
"zone.js": "~0.11.4"
|
||||
}
|
||||
}
|
||||
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in new issue