Function removeDependency

packages/schematics/angular/utility/dependency.ts:237–284

(
  name: string,
  options: {
    /**
     * 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 removing the dependency.
     * Defaults to {@link InstallBehavior.Auto}.
     */
    install?: InstallBehavior;
  } = {},
)

 * @returns A Schematics {@link Rule}
 */
export function removeDependency(
  name: string,
  options: {
    /**
     * 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 removing the dependency.
     * Defaults to {@link InstallBehavior.Auto}.
     */
    install?: InstallBehavior;
  } = {},
): Rule {
  const { packageJsonPath = '/package.json', install = InstallBehavior.Auto } = options;

  return (tree, context) => {
    const manifest = tree.readJson(packageJsonPath) as MinimalPackageManifest;
    let wasRemoved = false;

    for (const type of [DependencyType.Default, DependencyType.Dev, DependencyType.Peer]) {
      const dependencySection = manifest[type];
      if (dependencySection?.[name]) {
        delete dependencySection[name];
        wasRemoved = true;
      }
    }

    if (wasRemoved) {
      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);
      }
    }
  };
}