fix(components/packages): remove package before installing it to prevent duplicates (#839)

Author: Blackbaud-SteveBrush

libs/components/packages/src/schematics/migrations/update-7/add-autonumeric-dependency.spec.ts

@@ -51,4 +51,33 @@ describe('Migrations > Add autonumeric as a dependency', () => {
 
     expect(tree.readJson('/package.json')).toEqual({});
   });
+
+  it('should force-install autonumeric in dependencies', async () => {
+    const { runSchematic, tree } = await setupTest();
+
+    // Add autonumeric to both dependencies and devDependencies.
+    tree.overwrite(
+      '/package.json',
+      JSON.stringify({
+        dependencies: {
+          '@skyux/autonumeric': '*',
+          autonumeric: '*',
+        },
+        devDependencies: {
+          autonumeric: '*',
+        },
+      })
+    );
+
+    await runSchematic();
+
+    // The version listed in devDependencies should be removed.
+    expect(tree.readJson('/package.json')).toEqual({
+      dependencies: {
+        '@skyux/autonumeric': '*',
+        autonumeric: '4.6.0',
+      },
+      devDependencies: {},
+    });
+  });
 });

libs/components/packages/src/schematics/migrations/update-7/add-autonumeric-dependency.ts

@@ -1,33 +1,10 @@
 import { Rule } from '@angular-devkit/schematics';
-import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
-import {
-  NodeDependencyType,
-  addPackageJsonDependency,
-} from '@schematics/angular/utility/dependencies';
+import { NodeDependencyType } from '@schematics/angular/utility/dependencies';
 
-import { readRequiredFile } from '../../utility/tree';
+import { ensurePeersInstalled } from '../../rules/ensure-peers-installed';
 
 export default function (): Rule {
-  return async (tree, context) => {
-    const packageJson: {
-      dependencies?: Record<string, string>;
-      devDependencies?: Record<string, string>;
-    } = JSON.parse(readRequiredFile(tree, '/package.json'));
-
-    const dependencies: Record<string, string> = {
-      ...(packageJson.dependencies || {}),
-      ...(packageJson.devDependencies || {}),
-    };
-
-    if (dependencies['@skyux/autonumeric']) {
-      context.addTask(new NodePackageInstallTask());
-
-      addPackageJsonDependency(tree, {
-        type: NodeDependencyType.Default,
-        name: 'autonumeric',
-        version: '4.6.0',
-        overwrite: false,
-      });
-    }
-  };
+  return ensurePeersInstalled('@skyux/autonumeric', [
+    { name: 'autonumeric', version: '4.6.0', type: NodeDependencyType.Default },
+  ]);
 }

libs/components/packages/src/schematics/migrations/update-7/add-axe-core-dependency.ts

@@ -1,33 +1,10 @@
 import { Rule } from '@angular-devkit/schematics';
-import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
-import {
-  NodeDependencyType,
-  addPackageJsonDependency,
-} from '@schematics/angular/utility/dependencies';
+import { NodeDependencyType } from '@schematics/angular/utility/dependencies';
 
-import { readRequiredFile } from '../../utility/tree';
+import { ensurePeersInstalled } from '../../rules/ensure-peers-installed';
 
 export default function (): Rule {
-  return async (tree, context) => {
-    const packageJson: {
-      dependencies?: Record<string, string>;
-      devDependencies?: Record<string, string>;
-    } = JSON.parse(readRequiredFile(tree, '/package.json'));
-
-    const dependencies: Record<string, string> = {
-      ...(packageJson.dependencies || {}),
-      ...(packageJson.devDependencies || {}),
-    };
-
-    if (dependencies['@skyux-sdk/testing']) {
-      context.addTask(new NodePackageInstallTask());
-
-      addPackageJsonDependency(tree, {
-        type: NodeDependencyType.Dev,
-        name: 'axe-core',
-        version: '3.5.6',
-        overwrite: false,
-      });
-    }
-  };
+  return ensurePeersInstalled('@skyux-sdk/testing', [
+    { name: 'axe-core', version: '3.5.6', type: NodeDependencyType.Dev },
+  ]);
 }

libs/components/packages/src/schematics/migrations/update-7/add-moment-dependency.ts

@@ -1,33 +1,10 @@
 import { Rule } from '@angular-devkit/schematics';
-import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
-import {
-  NodeDependencyType,
-  addPackageJsonDependency,
-} from '@schematics/angular/utility/dependencies';
+import { NodeDependencyType } from '@schematics/angular/utility/dependencies';
 
-import { readRequiredFile } from '../../utility/tree';
+import { ensurePeersInstalled } from '../../rules/ensure-peers-installed';
 
 export default function (): Rule {
-  return async (tree, context) => {
-    const packageJson: {
-      dependencies?: Record<string, string>;
-      devDependencies?: Record<string, string>;
-    } = JSON.parse(readRequiredFile(tree, '/package.json'));
-
-    const dependencies: Record<string, string> = {
-      ...(packageJson.dependencies || {}),
-      ...(packageJson.devDependencies || {}),
-    };
-
-    if (dependencies['@skyux/datetime']) {
-      context.addTask(new NodePackageInstallTask());
-
-      addPackageJsonDependency(tree, {
-        type: NodeDependencyType.Default,
-        name: 'moment',
-        version: '2.29.4',
-        overwrite: false,
-      });
-    }
-  };
+  return ensurePeersInstalled('@skyux/datetime', [
+    { name: 'moment', version: '2.29.4', type: NodeDependencyType.Default },
+  ]);
 }

libs/components/packages/src/schematics/rules/ensure-peers-installed.ts

@@ -0,0 +1,56 @@
+import { Rule } from '@angular-devkit/schematics';
+import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+import {
+  NodeDependencyType,
+  addPackageJsonDependency,
+  removePackageJsonDependency,
+} from '@schematics/angular/utility/dependencies';
+
+import { readRequiredFile } from '../utility/tree';
+
+type PackageDetails = {
+  name: string;
+  version: string;
+  type: NodeDependencyType;
+};
+
+function installPackages(packages: PackageDetails[]): Rule {
+  return (tree, context) => {
+    for (const details of packages) {
+      // Remove the package (if it exists) so we can ensure it's added to the appropriate section.
+      removePackageJsonDependency(tree, details.name, '/package.json');
+      addPackageJsonDependency(tree, {
+        type: details.type,
+        name: details.name,
+        version: details.version,
+      });
+    }
+
+    context.addTask(new NodePackageInstallTask());
+  };
+}
+
+/**
+ * Ensures peer dependencies for a given package are installed on the client's workspace.
+ * If the client does not use the target package, this function is skipped.
+ * @param targetPackageName The name of the package that has peer dependencies.
+ * @param peers The target package's peer dependencies to install on the client's workspace.
+ */
+export function ensurePeersInstalled(
+  targetPackageName: string,
+  peers: PackageDetails[]
+): Rule {
+  return (tree) => {
+    const packageJson: {
+      dependencies?: Record<string, string>;
+      devDependencies?: Record<string, string>;
+    } = JSON.parse(readRequiredFile(tree, '/package.json'));
+
+    const dependencies: Record<string, string> = {
+      ...(packageJson.dependencies || {}),
+      ...(packageJson.devDependencies || {}),
+    };
+
+    return dependencies[targetPackageName] ? installPackages(peers) : undefined;
+  };
+}