daff sync command

Author: joannalauu

tools/schematics/bin/daff.spec.ts

@@ -0,0 +1,84 @@
+import { syncProjects } from './daff';
+
+const buildAngularJson = (projectName: string) => ({
+  version: 1,
+  projects: {
+    [projectName]: {
+      architect: {
+        build: {
+          configurations: {
+            production: {},
+          },
+        },
+      },
+    },
+  },
+});
+
+describe('syncProjects', () => {
+  const projectName = 'app';
+
+  it('writes the magento condition derived from daff.json', () => {
+    const angular = buildAngularJson(projectName);
+    const daff = { projects: { [projectName]: { drivers: { magento: '2.4.5' }}}};
+
+    syncProjects(daff, angular);
+
+    expect(
+      angular.projects[projectName].architect.build.configurations.production,
+    ).toEqual(<any>{ conditions: ['magento-2.4.5']});
+  });
+
+  it('overwrites an existing conditions array', () => {
+    const angular = buildAngularJson(projectName);
+    (<any>angular.projects[projectName].architect.build.configurations.production).conditions = [
+      'magento-2.4.1',
+      'some-other-condition',
+    ];
+    const daff = { projects: { [projectName]: { drivers: { magento: '2.4.5' }}}};
+
+    syncProjects(daff, angular);
+
+    const conditions = (<any>angular.projects[projectName].architect.build.configurations.production).conditions;
+    expect(conditions).toEqual(['magento-2.4.5']);
+  });
+
+  it('throws when a project is missing a driver version', () => {
+    const angular = buildAngularJson(projectName);
+    const daff = { projects: { [projectName]: { drivers: {}}}};
+
+    expect(() => syncProjects(daff, angular)).toThrowError(
+      /missing a driver version/,
+    );
+  });
+
+  it('throws when the project is absent from angular.json', () => {
+    const angular = buildAngularJson('other');
+    const daff = { projects: { [projectName]: { drivers: { magento: '2.4.5' }}}};
+
+    expect(() => syncProjects(daff, angular)).toThrowError(
+      /not found in angular.json/,
+    );
+  });
+
+  it('creates intermediate architect/build/configurations objects when missing', () => {
+    const angular = { projects: { [projectName]: {}}};
+    const daff = { projects: { [projectName]: { drivers: { magento: '2.4.5' }}}};
+
+    syncProjects(daff, angular);
+
+    expect(
+      (<any>angular).projects[projectName].architect.build.configurations.production.conditions,
+    ).toEqual(['magento-2.4.5']);
+  });
+
+  it('is a no-op when daff.json has no projects', () => {
+    const angular = buildAngularJson(projectName);
+    const daff = {};
+
+    expect(() => syncProjects(daff, angular)).not.toThrow();
+    expect(
+      (<any>angular.projects[projectName].architect.build.configurations.production).conditions,
+    ).toBeUndefined();
+  });
+});

tools/schematics/bin/daff.ts

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+import * as fs from 'fs';
+import * as path from 'path';
+
+export interface DaffJson {
+  projects?: Record<string, { drivers?: { magento?: string } }>;
+}
+
+export const syncProjects = (daff: DaffJson, angular: any): any => {
+  for (const [projectName, cfg] of Object.entries(daff.projects ?? {})) {
+    const version = cfg.drivers?.magento;
+    if (!version) {
+      throw new Error(
+        `Project '${projectName}' in daff.json is missing a driver version; cannot sync.`,
+      );
+    }
+
+    const project = angular.projects?.[projectName];
+    if (!project) {
+      throw new Error(`Project '${projectName}' not found in angular.json.`);
+    }
+
+    project.architect ??= {};
+    project.architect.build ??= {};
+    project.architect.build.configurations ??= {};
+    project.architect.build.configurations.production ??= {};
+    project.architect.build.configurations.production.conditions = [`magento-${version}`];
+  }
+
+  return angular;
+};
+
+const main = (): void => {
+  const [, , cmd] = process.argv;
+  if (cmd !== 'sync') {
+    console.error('Usage: daff sync');
+    process.exit(1);
+  }
+
+  const cwd = process.cwd();
+  const daffPath = path.join(cwd, 'daff.json');
+  const ngPath = path.join(cwd, 'angular.json');
+
+  if (!fs.existsSync(daffPath)) {
+    console.error(`daff.json not found at ${daffPath}`);
+    process.exit(1);
+  }
+  if (!fs.existsSync(ngPath)) {
+    console.error(`angular.json not found at ${ngPath}`);
+    process.exit(1);
+  }
+
+  const daff = <DaffJson>JSON.parse(fs.readFileSync(daffPath, 'utf-8'));
+  const angular = JSON.parse(fs.readFileSync(ngPath, 'utf-8'));
+
+  try {
+    syncProjects(daff, angular);
+  } catch (e) {
+    console.error((<Error>e).message);
+    process.exit(1);
+  }
+
+  fs.writeFileSync(ngPath, JSON.stringify(angular, null, 2) + '\n');
+  console.warn('angular.json updated.');
+};
+
+if (require.main === module) {
+  main();
+}

tools/schematics/package.json

@@ -13,6 +13,9 @@
   "author": "Daffodil Team",
   "license": "MIT",
   "schematics": "./collection.json",
+  "bin": {
+    "daff": "./bin/daff.js"
+  },
   "ng-add": {
     "save": "dependencies"
   },