@cogitato/kit-cli 0.0.0-stage → 0.2.0

package/dist/workspace.js

@@ -0,0 +1,119 @@
+import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { validateProject } from "@cogitato/contract";
+import { KitError } from "./errors.js";
+import { exportFlows } from "./export-flows.js";
+import { createScreen } from "./scaffold.js";
+import { parseSource } from "./issue.js";
+import { LAYOUT, PROTOTYPE_NAME, WORKSPACE_LAYOUT, listPrototypes, projectIn, readContract, } from "./project.js";
+import { checkCssFile } from "./rules/css.js";
+import { checkTsxFile, duplicateKitIds } from "./rules/tsx.js";
+import { sortIssues, validate } from "./validate.js";
+// Work across every prototype in a workspace.
+/** Every .css and .tsx file in the shared kit, workspace-relative, sorted. */
+function kitFiles(ws) {
+    const out = [];
+    const walk = (dir) => {
+        if (!existsSync(dir))
+            return;
+        for (const name of readdirSync(dir)) {
+            if (name === "node_modules" || name.startsWith("."))
+                continue;
+            const path = join(dir, name);
+            if (statSync(path).isDirectory())
+                walk(path);
+            else if (/\.(tsx|css)$/.test(name) && !name.endsWith(".d.ts"))
+                out.push(ws.rel(path));
+        }
+    };
+    walk(ws.abs(WORKSPACE_LAYOUT.kit));
+    return out.sort();
+}
+/** Checks the shared kit's CSS and TSX against the contract. Issue files are workspace-relative. */
+export function validateKit(ws) {
+    const issues = [];
+    const view = readContract(ws);
+    const kitIds = [];
+    for (const file of kitFiles(ws)) {
+        const text = readFileSync(ws.abs(file), "utf8");
+        if (file.endsWith(".css")) {
+            issues.push(...checkCssFile(file, text, view));
+        }
+        else {
+            const r = checkTsxFile(parseSource(file, text), { contract: view, inKit: true });
+            kitIds.push(...r.kitIds);
+            issues.push(...r.issues);
+        }
+    }
+    issues.push(...duplicateKitIds(kitIds));
+    return issues;
+}
+/** Checks the shared contract and kit once, then every prototype. Issue files are workspace-relative. */
+export function validateWorkspace(ws, opts = {}) {
+    const issues = [];
+    const contract = validateProject(ws.abs(LAYOUT.design), ws.abs(WORKSPACE_LAYOUT.contract));
+    issues.push(...contract.issues
+        .filter((i) => i.file.startsWith("contract/"))
+        .map((i) => ({ ...i, file: `${WORKSPACE_LAYOUT.contract}/${i.file.slice("contract/".length)}` })));
+    if (opts.contractOnly)
+        return { ok: !issues.some((i) => i.severity === "error"), issues: sortIssues(issues) };
+    issues.push(...validateKit(ws));
+    for (const name of listPrototypes(ws)) {
+        const r = validate(projectIn(ws, name), { skipContract: true });
+        issues.push(...r.issues.map((i) => ({ ...i, file: `${WORKSPACE_LAYOUT.prototypes}/${name}/${i.file}` })));
+    }
+    return { ok: !issues.some((i) => i.severity === "error"), issues: sortIssues(issues) };
+}
+/** What to tell a designer when validateWorkspace found nothing, so an empty workspace doesn't read as checked prototypes. */
+export function workspaceSuccess(ws, opts = {}) {
+    if (opts.contractOnly)
+        return "All good: the design contract is fine.";
+    const count = listPrototypes(ws).length;
+    if (!count)
+        return "The design contract and kit are fine. There are no prototypes yet.";
+    return count === 1 ? "All good: the prototype follows the design contract." : "All good: the prototypes follow the design contract.";
+}
+// Files a new prototype copies from an existing one, so it gets the same pinned versions and setup.
+const SKELETON = ["package.json", "index.html", "vite.config.ts", "tsconfig.json", ".env.example", "src/main.tsx", "src/styles/global.css"];
+const EMPTY_FLOWS = `import { defineFlows } from "@cogitato/runtime";
+
+// How screens connect. Each step is "{screen id}.{state}". \`kit export-flows\` turns this into
+// design/flows.json for the canvas; steps appear in the order they're first mentioned.
+export default defineFlows([]);
+`;
+/** Starts prototypes/<name>/ from an existing prototype's setup, with one empty Home screen. */
+export function createPrototype(ws, name) {
+    if (!PROTOTYPE_NAME.test(name)) {
+        throw new KitError(`"${name}" can't be a prototype name. Use lowercase words with dashes, like "onboarding" or "account-settings".`);
+    }
+    const existing = listPrototypes(ws);
+    if (existing.includes(name) || existsSync(ws.abs(`${WORKSPACE_LAYOUT.prototypes}/${name}`)))
+        throw new KitError(`There's already a prototype called "${name}". Pick another name.`);
+    if (!existing.length)
+        throw new KitError("There's no prototype here to copy the setup from. Ask a developer to check the workspace.");
+    const from = ws.abs(`${WORKSPACE_LAYOUT.prototypes}/${existing[0]}`);
+    const to = ws.abs(`${WORKSPACE_LAYOUT.prototypes}/${name}`);
+    const files = [];
+    for (const rel of SKELETON) {
+        if (!existsSync(join(from, rel)))
+            continue;
+        mkdirSync(join(to, rel, ".."), { recursive: true });
+        copyFileSync(join(from, rel), join(to, rel));
+        files.push(`${WORKSPACE_LAYOUT.prototypes}/${name}/${rel}`);
+    }
+    const pkgPath = join(to, "package.json");
+    writeFileSync(pkgPath, JSON.stringify({ ...JSON.parse(readFileSync(pkgPath, "utf8")), name }, null, 2) + "\n");
+    const html = join(to, "index.html");
+    if (existsSync(html))
+        writeFileSync(html, readFileSync(html, "utf8").replace(/<title>[^<]*<\/title>/, `<title>${name} prototype</title>`));
+    mkdirSync(join(to, LAYOUT.design), { recursive: true });
+    mkdirSync(join(to, "src", "screens"), { recursive: true });
+    writeFileSync(join(to, "src", "flows.ts"), EMPTY_FLOWS);
+    files.push(`${WORKSPACE_LAYOUT.prototypes}/${name}/src/flows.ts`);
+    const project = projectIn(ws, name);
+    const screen = createScreen(project, { id: "home", title: "Home" });
+    files.push(...screen.files.map((f) => `${WORKSPACE_LAYOUT.prototypes}/${name}/${f}`));
+    exportFlows(project);
+    return { name, files };
+}
+//# sourceMappingURL=workspace.js.map

package/dist/workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../src/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAClH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,eAAe,EAAyB,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAc,MAAM,YAAY,CAAC;AACrD,OAAO,EACL,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,YAAY,GAEb,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAiB,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAErD,8CAA8C;AAE9C,8EAA8E;AAC9E,SAAS,QAAQ,CAAC,EAAa;IAC7B,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE;QAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO;QAC7B,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,IAAI,IAAI,KAAK,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBACxC,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACxF,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;IACnC,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,WAAW,CAAC,EAAa;IACvC,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACjF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,iBAAiB,CAAC,EAAa,EAAE,OAAmC,EAAE;IACpF,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3F,MAAM,CAAC,IAAI,CACT,GAAG,QAAQ,CAAC,MAAM;SACf,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;SAC7C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CACpG,CAAC;IACF,IAAI,IAAI,CAAC,YAAY;QAAE,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9G,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;IAEhC,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;AACzF,CAAC;AAED,8HAA8H;AAC9H,MAAM,UAAU,gBAAgB,CAAC,EAAa,EAAE,OAAmC,EAAE;IACnF,IAAI,IAAI,CAAC,YAAY;QAAE,OAAO,wCAAwC,CAAC;IACvE,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,CAAC,KAAK;QAAE,OAAO,oEAAoE,CAAC;IACxF,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,sDAAsD,CAAC,CAAC,CAAC,sDAAsD,CAAC;AACvI,CAAC;AAED,oGAAoG;AACpG,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,uBAAuB,CAAC,CAAC;AAE5I,MAAM,WAAW,GAAG;;;;;CAKnB,CAAC;AAEF,gGAAgG;AAChG,MAAM,UAAU,eAAe,CAAC,EAAa,EAAE,IAAY;IACzD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,QAAQ,CAAC,IAAI,IAAI,wGAAwG,CAAC,CAAC;IACvI,CAAC;IACD,MAAM,QAAQ,GAAG,cAAc,CAAC,EAAE,CAAC,CAAC;IACpC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,CAAC;QAAE,MAAM,IAAI,QAAQ,CAAC,uCAAuC,IAAI,uBAAuB,CAAC,CAAC;IACpL,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,MAAM,IAAI,QAAQ,CAAC,2FAA2F,CAAC,CAAC;IACtI,MAAM,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAAE,SAAS;QAC3C,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACzC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/G,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACpC,IAAI,UAAU,CAAC,IAAI,CAAC;QAAE,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,UAAU,IAAI,oBAAoB,CAAC,CAAC,CAAC;IAC3I,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;IACxD,KAAK,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,eAAe,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,UAAU,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACtF,WAAW,CAAC,OAAO,CAAC,CAAC;IACrB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACzB,CAAC"}

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@cogitato/kit-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "The `kit` command: validate prototypes against their design contract, export flows, preview the kit, check machine health",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cogitato/cogitato.git",
+    "directory": "packages/kit-cli"
+  },
+  "homepage": "https://github.com/cogitato/cogitato/tree/main/packages/kit-cli#readme",
+  "bugs": "https://github.com/cogitato/cogitato/issues",
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "kit": "./bin/kit.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./hosting": {
+      "types": "./dist/hosting.d.ts",
+      "default": "./dist/hosting.js"
+    }
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
+  "dependencies": {
+    "mri": "^1.2.0",
+    "postcss": "^8.4.49",
+    "typescript": "^5.7.2",
+    "@cogitato/contract": "0.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "vitest": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
 }