feat(sdk/testing): change axe-core from a dependency to a peer dependency (#746)

Author: Blackbaud-SteveBrush

libs/components/packages/src/schematics/migrations/migration-collection.json

@@ -10,6 +10,11 @@
       "factory": "./update-7/add-autonumeric-dependency",
       "description": "Add autonumeric as a dependency since @skyux/autonumeric@7 references autonumeric as a peer."
     },
+    "add-axe-core-dependency": {
+      "version": "7.0.0-beta.0",
+      "factory": "./update-7/add-axe-core-dependency",
+      "description": "Add axe-core as a dependency since @skyux-sdk/testing@7 references axe-core as a peer."
+    },
     "add-moment-dependency": {
       "version": "7.0.0-beta.0",
       "factory": "./update-7/add-moment-dependency",

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

@@ -0,0 +1,54 @@
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+
+import { join } from 'path';
+
+import { createTestApp } from '../../testing/scaffold';
+
+describe('Migrations > Add axe-core as a dependency', () => {
+  const runner = new SchematicTestRunner(
+    'migrations',
+    join(__dirname, '../migration-collection.json')
+  );
+
+  async function setupTest() {
+    const tree = await createTestApp(runner, {
+      projectName: 'my-app',
+    });
+
+    return {
+      runSchematic: () =>
+        runner
+          .runSchematicAsync('add-axe-core-dependency', {}, tree)
+          .toPromise(),
+      tree,
+    };
+  }
+
+  it('should add axe-core as a dependency if @skyux-sdk/testing installed', async () => {
+    const { runSchematic, tree } = await setupTest();
+
+    tree.overwrite(
+      '/package.json',
+      '{"devDependencies": { "@skyux-sdk/testing": "7.0.0"}}'
+    );
+
+    await runSchematic();
+
+    expect(tree.readJson('/package.json')).toEqual({
+      devDependencies: {
+        '@skyux-sdk/testing': '7.0.0',
+        'axe-core': '3.5.6',
+      },
+    });
+  });
+
+  it('should not add axe-core as a dependency if @skyux-sdk/testing not installed', async () => {
+    const { runSchematic, tree } = await setupTest();
+
+    tree.overwrite('/package.json', '{}');
+
+    await runSchematic();
+
+    expect(tree.readJson('/package.json')).toEqual({});
+  });
+});

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

@@ -0,0 +1,33 @@
+import { Rule } from '@angular-devkit/schematics';
+import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+import {
+  NodeDependencyType,
+  addPackageJsonDependency,
+} from '@schematics/angular/utility/dependencies';
+
+import { readRequiredFile } from '../../utility/tree';
+
+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,
+      });
+    }
+  };
+}

libs/sdk/testing/package.json

@@ -19,10 +19,10 @@
     "@angular/common": "^14.2.0",
     "@angular/core": "^14.2.0",
     "@angular/platform-browser": "^14.2.0",
-    "@skyux/i18n": "0.0.0-PLACEHOLDER"
+    "@skyux/i18n": "0.0.0-PLACEHOLDER",
+    "axe-core": "^3.5.6 || ^4.5.0"
   },
   "dependencies": {
-    "axe-core": "3.5.6",
     "tslib": "^2.3.1"
   }
 }