@mondaydotcomorg/z2h-cli 0.1.0 → 0.1.1

package/src/templates/workspace/yarnrc.yml

@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+npmAuthToken: '${NPM_TOKEN}'
+
+npmRegistryServer: 'https://registry.npmjs.org/'
+
+yarnPath: .yarn/releases/yarn-4.5.1.cjs

package/src/types.ts

@@ -17,12 +17,15 @@ export interface ConsumerPkg {
 }
 
 // ─────────── Shadow pkg (generated by CLI, lives at .zth/package.json) ───
+// Runtime deps come from the workspace root via yarn's workspace hoisting.
+// `devDependencies` declares the toolchain the shadow directly executes
+// (trident-toolkit) so yarn wires its bin onto the shadow's script PATH.
+// No federation `shared` config in this stack, so no peerDependencies.
 export interface ShadowPkg {
   name: string;
   version: string;
   private: true;
   scripts: Record<string, string>;
-  peerDependencies: Record<string, string>;
   devDependencies: Record<string, string>;
 }
 

package/src/util/__tests__/templates.test.ts

@@ -0,0 +1,27 @@
+import { describe, it, expect } from 'vitest';
+import { renderTemplate } from '../templates';
+
+describe('renderTemplate', () => {
+  it('substitutes a single placeholder', () => {
+    expect(renderTemplate('hello __NAME__', { __NAME__: 'world' })).toBe('hello world');
+  });
+
+  it('substitutes the same placeholder multiple times', () => {
+    const out = renderTemplate('__X__ + __X__ = double __X__', { __X__: 'a' });
+    expect(out).toBe('a + a = double a');
+  });
+
+  it('substitutes multiple distinct placeholders', () => {
+    const out = renderTemplate('__A__/__B__', { __A__: 'foo', __B__: 'bar' });
+    expect(out).toBe('foo/bar');
+  });
+
+  it('leaves unknown placeholders alone', () => {
+    expect(renderTemplate('__X__ __Y__', { __X__: 'set' })).toBe('set __Y__');
+  });
+
+  it('escapes regex-special chars in placeholder values', () => {
+    // A value containing $1, &, etc. should be inserted literally.
+    expect(renderTemplate('val=__V__', { __V__: '$1 & co' })).toBe('val=$1 & co');
+  });
+});

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

@@ -0,0 +1,35 @@
+import path from 'node:path';
+import { describe, it, expect } from 'vitest';
+import { pathExists, readFile } from 'fs-extra';
+import { getTemplatesDir } from '../templates';
+
+describe('workspace templates ship with the package', () => {
+  const expected = [
+    'workspace/package.json.tmpl',
+    'workspace/gitignore',
+    'workspace/yarnrc.yml',
+    'workspace/nvmrc',
+    'workspace/npmrc',
+    'workspace/README.md',
+    'workspace/yarn-releases/yarn-4.5.1.cjs',
+  ];
+
+  for (const rel of expected) {
+    it(`includes ${rel}`, async () => {
+      const full = path.join(getTemplatesDir(), rel);
+      expect(await pathExists(full), full).toBe(true);
+    });
+  }
+
+  it('workspace package template carries the z2hWorkspace marker and the ["*", "*/.zth"] glob', async () => {
+    const raw = await readFile(path.join(getTemplatesDir(), 'workspace', 'package.json.tmpl'), 'utf8');
+    expect(raw).toMatch(/"z2hWorkspace"\s*:\s*true/);
+    expect(raw).toMatch(/"\*"/);
+    expect(raw).toMatch(/"\*\/\.zth"/);
+  });
+
+  it('workspace yarnrc points yarnPath at the bundled berry release', async () => {
+    const raw = await readFile(path.join(getTemplatesDir(), 'workspace', 'yarnrc.yml'), 'utf8');
+    expect(raw).toMatch(/yarnPath:\s*\.yarn\/releases\/yarn-4\.5\.1\.cjs/);
+  });
+});

package/src/util/__tests__/workspace.test.ts

@@ -0,0 +1,65 @@
+import path from 'node:path';
+import os from 'node:os';
+import { mkdtemp, rm, writeJson, ensureDir } from 'fs-extra';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { getWorkspaceHome, isZ2hWorkspace, assertWorkspace } from '../workspace';
+
+describe('workspace util', () => {
+  let tmp: string;
+  const originalEnv = process.env.Z2H_WORKSPACE_HOME;
+
+  beforeEach(async () => {
+    tmp = await mkdtemp(path.join(os.tmpdir(), 'z2h-ws-'));
+    process.env.Z2H_WORKSPACE_HOME = tmp;
+  });
+
+  afterEach(async () => {
+    if (originalEnv === undefined) {
+      delete process.env.Z2H_WORKSPACE_HOME;
+    } else {
+      process.env.Z2H_WORKSPACE_HOME = originalEnv;
+    }
+    await rm(tmp, { recursive: true, force: true });
+  });
+
+  it('getWorkspaceHome respects the env override', () => {
+    expect(getWorkspaceHome()).toBe(tmp);
+  });
+
+  it('getWorkspaceHome falls back to ~/zth-projects when no env override', () => {
+    delete process.env.Z2H_WORKSPACE_HOME;
+    expect(getWorkspaceHome()).toBe(path.join(os.homedir(), 'zth-projects'));
+  });
+
+  it('isZ2hWorkspace returns false when there is no package.json', async () => {
+    expect(await isZ2hWorkspace(tmp)).toBe(false);
+  });
+
+  it('isZ2hWorkspace returns false when package.json lacks the marker', async () => {
+    await writeJson(path.join(tmp, 'package.json'), { name: 'something', private: true });
+    expect(await isZ2hWorkspace(tmp)).toBe(false);
+  });
+
+  it('isZ2hWorkspace returns true when package.json has z2hWorkspace: true', async () => {
+    await writeJson(path.join(tmp, 'package.json'), {
+      name: '@mondaydotcomorg/zth-projects-workspace',
+      private: true,
+      z2hWorkspace: true,
+    });
+    expect(await isZ2hWorkspace(tmp)).toBe(true);
+  });
+
+  it('assertWorkspace throws a helpful error when marker is missing', async () => {
+    await ensureDir(tmp);
+    await expect(assertWorkspace()).rejects.toThrow(/create-workspace/);
+  });
+
+  it('assertWorkspace resolves and returns the path when marker is present', async () => {
+    await writeJson(path.join(tmp, 'package.json'), {
+      name: '@mondaydotcomorg/zth-projects-workspace',
+      private: true,
+      z2hWorkspace: true,
+    });
+    await expect(assertWorkspace()).resolves.toBe(tmp);
+  });
+});

package/src/util/s3/upload.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
-import { readFile } from 'fs-extra';
 import { readdir } from 'node:fs/promises';
+import { readFile } from 'fs-extra';
 import { lookup as lookupMime } from 'mime-types';
 import pMap from 'p-map';
 import { PutObjectCommand } from '@aws-sdk/client-s3';

package/src/util/templates.ts

@@ -0,0 +1,37 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * Substitute `__PLACEHOLDER__` tokens in `content` with values from `vars`.
+ * Values are inserted literally — no regex special-char interpretation —
+ * which matters for content like `$1` or `&` that could otherwise be
+ * captured by `String.prototype.replace`.
+ */
+export function renderTemplate(content: string, vars: Record<string, string>): string {
+  let out = content;
+  for (const [key, value] of Object.entries(vars)) {
+    // Use split+join (literal pattern) to avoid regex interpretation of
+    // special chars in `value`.
+    out = out.split(key).join(value);
+  }
+  return out;
+}
+
+/**
+ * Absolute path to the bundled `templates/` directory under `src/`.
+ *
+ * The CLI's `package.json` `files` array ships `src/` (so `src/templates/`
+ * lands in published packages). The build emits `.ts` files to `dist/`,
+ * but raw template assets (`.tmpl`, `.md`, `gitignore`, `.json`) live only
+ * under `src/templates/`. Resolving here keeps a single source of truth
+ * for both:
+ *   - dev (vitest, tsx)             → `<pkg>/src/util/`     +  ../../src/templates  → `<pkg>/src/templates`
+ *   - published install (dist/util) → `<pkg>/dist/util/`    +  ../../src/templates  → `<pkg>/src/templates`
+ */
+export function getTemplatesDir(): string {
+  const here = path.dirname(fileURLToPath(import.meta.url));
+  return path.resolve(here, '..', '..', 'src', 'templates');
+}
+
+export type AppTemplate = 'default' | 'html-embed';
+export const APP_TEMPLATES: AppTemplate[] = ['default', 'html-embed'];

package/src/util/workspace.ts

@@ -0,0 +1,52 @@
+import path from 'node:path';
+import os from 'node:os';
+import { pathExists, readJson } from 'fs-extra';
+
+export const WORKSPACE_DIR_NAME = 'zth-projects';
+export const WORKSPACE_MARKER_FIELD = 'z2hWorkspace';
+
+/**
+ * The Z2H workspace home is hardcoded to `~/zth-projects/` for users.
+ * Tests override via the `Z2H_WORKSPACE_HOME` env var so they can use a
+ * tmp dir without touching the user's real home.
+ */
+export function getWorkspaceHome(): string {
+  return process.env.Z2H_WORKSPACE_HOME ?? path.join(os.homedir(), WORKSPACE_DIR_NAME);
+}
+
+interface WorkspacePkg {
+  [WORKSPACE_MARKER_FIELD]?: boolean;
+}
+
+/**
+ * Returns true iff `<dir>/package.json` exists and has `"z2hWorkspace": true`.
+ * Any read or parse error returns false (defensive — callers route to a
+ * helpful message via assertWorkspace).
+ */
+export async function isZ2hWorkspace(dir: string): Promise<boolean> {
+  const pkgPath = path.join(dir, 'package.json');
+  if (!(await pathExists(pkgPath))) {
+    return false;
+  }
+  try {
+    const pkg = (await readJson(pkgPath)) as WorkspacePkg;
+    return pkg[WORKSPACE_MARKER_FIELD] === true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Resolves to the workspace home path if the marker is present; otherwise
+ * throws an Error pointing the user at `z2h-cli create-workspace`.
+ */
+export async function assertWorkspace(): Promise<string> {
+  const home = getWorkspaceHome();
+  if (await isZ2hWorkspace(home)) {
+    return home;
+  }
+  throw new Error(
+    `No Z2H workspace at ${home}. Run "z2h-cli create-workspace" first ` +
+      `(or set Z2H_WORKSPACE_HOME if you keep the workspace elsewhere).`
+  );
+}