@mondaydotcomorg/z2h-cli 0.4.0 → 0.5.0

package/src/migrations/auto-migrate.ts

@@ -0,0 +1,214 @@
+import path from 'node:path';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+import { pathExists, readJson, writeJson, writeFile } from 'fs-extra';
+import { execa } from 'execa';
+import semver from 'semver';
+import { info, warn } from '../util/logger';
+import { getWorkspaceHome, isZ2hWorkspace } from '../util/workspace';
+
+const STATE_FILE = '.z2h-migrations-state.json';
+const NX_JSON_CONTENT = '{\n  "extends": "@mondaydotcomorg/trident-monorepo/presets/nx.json"\n}\n';
+
+interface MigrationState {
+  lastMigratedVersion: string;
+}
+
+interface MigrationEntry {
+  version: string;
+  description: string;
+  migrate: string;
+}
+
+interface MigrationsJson {
+  migrations: Record<string, MigrationEntry>;
+}
+
+// ─── Helpers ───
+
+async function readState(workspaceHome: string): Promise<MigrationState | null> {
+  const statePath = path.join(workspaceHome, STATE_FILE);
+  if (!(await pathExists(statePath))) {
+    return null;
+  }
+  try {
+    return (await readJson(statePath)) as MigrationState;
+  } catch {
+    return null;
+  }
+}
+
+async function writeState(workspaceHome: string, state: MigrationState): Promise<void> {
+  const statePath = path.join(workspaceHome, STATE_FILE);
+  await writeJson(statePath, state, { spaces: 2 });
+}
+
+async function yarnInstall(workspaceHome: string, context: string): Promise<boolean> {
+  info(`${context} — running yarn install...`);
+  try {
+    await execa('yarn', ['install'], { cwd: workspaceHome, stdio: 'pipe' });
+    return true;
+  } catch (err) {
+    const stderr = (err as { stderr?: string }).stderr || (err as Error).message;
+    warn(`yarn install failed: ${stderr}`);
+    return false;
+  }
+}
+
+async function getLatestTrientMonorepoVersion(): Promise<string> {
+  try {
+    const { stdout } = await execa('npm', ['view', '@mondaydotcomorg/trident-monorepo', 'version']);
+    return `^${stdout.trim()}`;
+  } catch {
+    return '*';
+  }
+}
+
+// ─── Workspace bootstrap ───
+
+function isNxAvailable(workspaceHome: string): boolean {
+  try {
+    const wsRequire = createRequire(path.join(workspaceHome, 'package.json'));
+    wsRequire.resolve('nx/src/generators/tree');
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function ensureWorkspaceNx(workspaceHome: string): Promise<boolean> {
+  const nxJsonPath = path.join(workspaceHome, 'nx.json');
+  const pkgPath = path.join(workspaceHome, 'package.json');
+
+  if (!(await pathExists(nxJsonPath))) {
+    await writeFile(nxJsonPath, NX_JSON_CONTENT);
+    info('added nx.json to workspace');
+  }
+
+  const pkg = (await readJson(pkgPath)) as {
+    devDependencies?: Record<string, string>;
+    scripts?: Record<string, string>;
+  };
+
+  if (!pkg.devDependencies?.['@mondaydotcomorg/trident-monorepo']) {
+    pkg.devDependencies = pkg.devDependencies ?? {};
+    pkg.devDependencies['@mondaydotcomorg/trident-monorepo'] = await getLatestTrientMonorepoVersion();
+  }
+
+  if (!pkg.scripts?.nx) {
+    pkg.scripts = pkg.scripts ?? {};
+    pkg.scripts.nx = 'nx';
+  }
+
+  await writeJson(pkgPath, pkg, { spaces: 2 });
+
+  // Only install if NX isn't already importable from the workspace
+  if (!isNxAvailable(workspaceHome)) {
+    const ok = await yarnInstall(workspaceHome, 'NX not found, installing');
+    if (!ok) {
+      warn('workspace migrations require NX. Fix the install error and run "z2h-cli migrate" to retry.');
+      return false;
+    }
+  }
+
+  return true;
+}
+
+// ─── Main ───
+
+export async function autoMigrate(cliVersion: string, dryRun = false): Promise<void> {
+  const workspaceHome = getWorkspaceHome();
+  if (!(await isZ2hWorkspace(workspaceHome))) {
+    warn('no Z2H workspace found');
+    return;
+  }
+
+  const state = await readState(workspaceHome);
+  const lastVersion = state?.lastMigratedVersion ?? '0.0.0';
+
+  if (!semver.gt(cliVersion, lastVersion)) {
+    info('workspace is up to date — no migrations pending');
+    return;
+  }
+
+  info(`migrating workspace from v${lastVersion} → v${cliVersion}...`);
+
+  // migrations.json is at the package root — two dirs up from dist/migrations/
+  const thisDir = path.dirname(fileURLToPath(import.meta.url));
+  const migrationsJsonPath = path.resolve(thisDir, '..', '..', 'migrations.json');
+
+  if (!(await pathExists(migrationsJsonPath))) {
+    warn('migrations.json not found — skipping migrations');
+    return;
+  }
+
+  const migrationsJson = (await readJson(migrationsJsonPath)) as MigrationsJson;
+
+  // Filter to pending migrations (version > lastVersion AND <= cliVersion)
+  const pending = Object.entries(migrationsJson.migrations)
+    .filter(([, entry]) => semver.gt(entry.version, lastVersion) && semver.lte(entry.version, cliVersion))
+    .sort(([, a], [, b]) => semver.compare(a.version, b.version));
+
+  if (dryRun) {
+    info(`${pending.length} pending migration(s) (dry-run — no changes will be applied):`);
+    for (const [, entry] of pending) {
+      info(`  - ${entry.description} (v${entry.version})`);
+    }
+    return;
+  }
+
+  if (pending.length === 0) {
+    await writeState(workspaceHome, { lastMigratedVersion: cliVersion });
+    return;
+  }
+
+  const nxReady = await ensureWorkspaceNx(workspaceHome);
+  if (!nxReady) {
+    return;
+  }
+
+  info(`applying ${pending.length} workspace migration(s)...`);
+
+  // Resolve NX from the workspace's node_modules (not from CLI's own deps)
+  const wsRequire = createRequire(path.join(workspaceHome, 'package.json'));
+  const { FsTree, flushChanges } = wsRequire('nx/src/generators/tree') as {
+    FsTree: new (root: string, isVerbose: boolean) => import('@nx/devkit').Tree & {
+      listChanges(): { type: string; path: string }[];
+    };
+    flushChanges: (root: string, changes: { type: string; path: string; content?: Buffer | null }[]) => void;
+  };
+
+  let needsInstall = false;
+
+  for (const [name, entry] of pending) {
+    const tree = new FsTree(workspaceHome, false);
+    try {
+      const factoryPath = path.resolve(path.dirname(migrationsJsonPath), entry.migrate);
+      const mod = require(factoryPath);
+      const fn = mod.default || mod;
+      fn(tree);
+
+      const changes = tree.listChanges();
+      if (changes.length > 0) {
+        if (changes.some(c => c.path.endsWith('package.json'))) {
+          needsInstall = true;
+        }
+        flushChanges(workspaceHome, changes);
+        info(`  ✓ ${entry.description}`);
+      } else {
+        info(`  ○ ${entry.description} (no changes needed)`);
+      }
+    } catch (err) {
+      warn(`  ✗ migration "${name}" failed: ${(err as Error).message}`);
+      warn('    skipping remaining migrations. Run "z2h-cli migrate" to retry.');
+      return;
+    }
+  }
+
+  if (needsInstall) {
+    await yarnInstall(workspaceHome, 'package.json changed');
+  }
+
+  await writeState(workspaceHome, { lastMigratedVersion: cliVersion });
+  info('workspace migrations complete.');
+}

package/src/shadow/prepare.ts

@@ -3,7 +3,6 @@ import { info } from '../util/logger';
 import { cleanAppName } from '../util/app-name';
 import { resolveConsumerPaths } from './paths';
 import { ensureGitignore } from './gitignore';
-import { ensureYarnRc } from './yarnrc';
 import { ensureConsumerPkg } from './consumer-pkg';
 import { scaffoldShadow } from './scaffold';
 import { readMetadata, writeMetadata } from './metadata';
@@ -33,7 +32,6 @@ export async function prepareShadow(): Promise<PreparedShadow> {
   }
 
   await ensureGitignore(paths.consumerDir);
-  await ensureYarnRc(paths.consumerDir);
   await ensureDir(paths.shadowDir);
 
   const metadata = await resolvePortAndMetadata(paths, appName);

package/src/templates/app/package.json.tmpl

@@ -3,11 +3,8 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "z2h-cli build",
     "start": "z2h-cli dev",
+    "build": "z2h-cli build",
     "deploy": "z2h-cli deploy"
-  },
-  "devDependencies": {
-    "@mondaydotcomorg/z2h-cli": "*"
   }
 }

package/src/templates/workspace/nx.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@mondaydotcomorg/trident-monorepo/presets/nx.json"
+}

package/src/templates/workspace/package.json.tmpl

@@ -4,6 +4,9 @@
   "private": true,
   "z2hWorkspace": true,
   "workspaces": ["*", "*/.zth"],
+  "scripts": {
+    "nx": "nx"
+  },
   "dependencies": {
     "@mondaydotcomorg/trident-runtime": "^1.24.1",
     "@vibe/core": "^4.0.1",
@@ -14,8 +17,8 @@
   "devDependencies": {
     "@mondaydotcomorg/bigbrain-types": "^0.3.4",
     "@mondaydotcomorg/mf-api-types": "^0.1.1",
+    "@mondaydotcomorg/trident-monorepo": "^0.38.8",
     "@mondaydotcomorg/trident-toolkit": "^2.9.25",
-    "@mondaydotcomorg/z2h-cli": "__Z2H_CLI_VERSION__",
     "@types/react": "^18.0.14",
     "@types/react-dom": "^18.0.5",
     "typescript": "^5.7.2"

package/src/util/__tests__/workspace-templates-shipped.test.ts

@@ -8,6 +8,7 @@ describe('workspace templates ship with the package', () => {
     'workspace/package.json.tmpl',
     'workspace/gitignore',
     'workspace/yarnrc.yml',
+    'workspace/nx.json',
     'workspace/nvmrc',
     'workspace/npmrc',
     'workspace/README.md',

package/dist/esm/shadow/yarnrc.d.ts

@@ -1,10 +0,0 @@
-/**
- * Ensure the consumer has a `.yarnrc.yml` that pins `nodeLinker: node-modules`.
- *
- * Yarn 4 defaults to PnP, which trident-toolkit's webpack pipeline doesn't
- * support cleanly (webpack expects a flat node_modules). We force the
- * classic linker so installs produce a real `node_modules/`. Idempotent —
- * leaves any other settings the user added alone.
- */
-export declare function ensureYarnRc(consumerDir: string): Promise<void>;
-//# sourceMappingURL=yarnrc.d.ts.map

package/dist/esm/shadow/yarnrc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"yarnrc.d.ts","sourceRoot":"","sources":["../../../src/shadow/yarnrc.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AAEH,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAerE"}

package/dist/esm/shadow/yarnrc.mjs

@@ -1,27 +0,0 @@
-import path from 'node:path';
-import { pathExists, writeFile, readFile } from 'fs-extra';
-import { YARNRC_LINES } from '../constants.mjs';
-
-/**
- * Ensure the consumer has a `.yarnrc.yml` that pins `nodeLinker: node-modules`.
- *
- * Yarn 4 defaults to PnP, which trident-toolkit's webpack pipeline doesn't
- * support cleanly (webpack expects a flat node_modules). We force the
- * classic linker so installs produce a real `node_modules/`. Idempotent —
- * leaves any other settings the user added alone.
- */
-async function ensureYarnRc(consumerDir) {
-    const yarnrcPath = path.join(consumerDir, '.yarnrc.yml');
-    if (!(await pathExists(yarnrcPath))) {
-        await writeFile(yarnrcPath, YARNRC_LINES.join('\n\n') + '\n');
-        return;
-    }
-    const body = await readFile(yarnrcPath, 'utf8');
-    if (/^\s*nodeLinker\s*:/m.test(body)) {
-        return;
-    }
-    const prefix = body.length && !body.endsWith('\n') ? '\n' : '';
-    await writeFile(yarnrcPath, body + prefix + 'nodeLinker: node-modules\n');
-}
-
-export { ensureYarnRc };

package/dist/shadow/yarnrc.d.ts

@@ -1,10 +0,0 @@
-/**
- * Ensure the consumer has a `.yarnrc.yml` that pins `nodeLinker: node-modules`.
- *
- * Yarn 4 defaults to PnP, which trident-toolkit's webpack pipeline doesn't
- * support cleanly (webpack expects a flat node_modules). We force the
- * classic linker so installs produce a real `node_modules/`. Idempotent —
- * leaves any other settings the user added alone.
- */
-export declare function ensureYarnRc(consumerDir: string): Promise<void>;
-//# sourceMappingURL=yarnrc.d.ts.map

package/dist/shadow/yarnrc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"yarnrc.d.ts","sourceRoot":"","sources":["../../src/shadow/yarnrc.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AAEH,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAerE"}

package/dist/shadow/yarnrc.js

@@ -1,33 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const path = require('node:path');
-const fsExtra = require('fs-extra');
-const constants = require('../constants.js');
-
-const _interopDefault = e => e && e.__esModule ? e : { default: e };
-
-const path__default = /*#__PURE__*/_interopDefault(path);
-
-/**
- * Ensure the consumer has a `.yarnrc.yml` that pins `nodeLinker: node-modules`.
- *
- * Yarn 4 defaults to PnP, which trident-toolkit's webpack pipeline doesn't
- * support cleanly (webpack expects a flat node_modules). We force the
- * classic linker so installs produce a real `node_modules/`. Idempotent —
- * leaves any other settings the user added alone.
- */
-async function ensureYarnRc(consumerDir) {
-    const yarnrcPath = path__default.default.join(consumerDir, '.yarnrc.yml');
-    if (!(await fsExtra.pathExists(yarnrcPath))) {
-        await fsExtra.writeFile(yarnrcPath, constants.YARNRC_LINES.join('\n\n') + '\n');
-        return;
-    }
-    const body = await fsExtra.readFile(yarnrcPath, 'utf8');
-    if (/^\s*nodeLinker\s*:/m.test(body)) {
-        return;
-    }
-    const prefix = body.length && !body.endsWith('\n') ? '\n' : '';
-    await fsExtra.writeFile(yarnrcPath, body + prefix + 'nodeLinker: node-modules\n');
-}
-
-exports.ensureYarnRc = ensureYarnRc;

package/src/shadow/yarnrc.ts

@@ -1,29 +0,0 @@
-import path from 'node:path';
-import { pathExists, readFile, writeFile } from 'fs-extra';
-import { YARNRC_LINES } from '../constants';
-
-/**
- * Ensure the consumer has a `.yarnrc.yml` that pins `nodeLinker: node-modules`.
- *
- * Yarn 4 defaults to PnP, which trident-toolkit's webpack pipeline doesn't
- * support cleanly (webpack expects a flat node_modules). We force the
- * classic linker so installs produce a real `node_modules/`. Idempotent —
- * leaves any other settings the user added alone.
- */
-
-export async function ensureYarnRc(consumerDir: string): Promise<void> {
-  const yarnrcPath = path.join(consumerDir, '.yarnrc.yml');
-
-  if (!(await pathExists(yarnrcPath))) {
-    await writeFile(yarnrcPath, YARNRC_LINES.join('\n\n') + '\n');
-    return;
-  }
-
-  const body = await readFile(yarnrcPath, 'utf8');
-  if (/^\s*nodeLinker\s*:/m.test(body)) {
-    return;
-  }
-
-  const prefix = body.length && !body.endsWith('\n') ? '\n' : '';
-  await writeFile(yarnrcPath, body + prefix + 'nodeLinker: node-modules\n');
-}