nxds-cli 0.5.0 → 0.6.1

package/dist/index.js

@@ -4543,7 +4543,7 @@ async function fetchRelease(registry, version) {
   if (isNewerSchema(value)) {
     const release = version === "latest" ? "The latest nxds release" : `nxds ${version}`;
     throw new CliError(
-      `${release} needs a newer nxds-cli than ${"0.5.0"}. Run \`${CLI_COMMAND}\` to get the newest one.`
+      `${release} needs a newer nxds-cli than ${"0.6.1"}. Run \`${CLI_COMMAND}\` to get the newest one.`
     );
   }
   const invalid2 = (problems) => new CliError(
@@ -6295,7 +6295,7 @@ function localPackage(source) {
 function assertWritable(out, overwrite) {
   if (!existsSync9(out) || readdirSync(out).length === 0 || overwrite) return;
   throw new UsageError(
-    `${out} already has files. Pass --overwrite to replace its project/ folder, or choose another --out.`
+    `${out} already has files. Pass --overwrite to replace the export in it, or choose another --out.`
   );
 }
 function readPaths(file) {
@@ -6310,6 +6310,12 @@ function readPaths(file) {
 function stalePaths(existing, exported) {
   return existing.filter((file) => file.startsWith("project/")).filter((file) => !isPageGenerated(file.slice("project/".length))).filter((file) => !exported.has(file)).sort();
 }
+var EXPORT_NAMES = /* @__PURE__ */ new Set(["project", "files.json", "removed.json"]);
+var isRootName = (name) => name !== "" && name !== "." && name !== ".." && path10.basename(name) === name && !EXPORT_NAMES.has(name);
+var sha256 = (bytes) => createHash("sha256").update(bytes).digest("hex");
+var isEntryList = (value) => Array.isArray(value) && value.every(
+  (entry) => typeof entry?.path === "string" && typeof entry.sha256 === "string"
+);
 function readManifest(root) {
   const file = path10.join(root, "files.json");
   if (!existsSync9(file)) {
@@ -6318,39 +6324,99 @@ function readManifest(root) {
     );
   }
   const value = readJson(file);
-  if (!Array.isArray(value) || !value.every(
-    (entry) => typeof entry?.path === "string" && typeof entry.sha256 === "string"
-  )) {
+  if (!isEntryList(value?.project) || !isEntryList(value.root)) {
     throw new CliError(
-      `${file} must be a JSON array of { path, sha256 } entries.`
+      `${file} must hold project and root, each a JSON array of { path, sha256 } entries.`
     );
   }
-  return value;
+  return { project: value.project, root: value.root };
 }
-function readProject2(root) {
-  const projectDir = path10.join(root, "project");
+function readEntries(dir, entries, prefix) {
   const files = /* @__PURE__ */ new Map();
-  for (const entry of readManifest(root)) {
-    const file = path10.join(projectDir, entry.path);
-    const relative = path10.relative(projectDir, file);
-    if (relative.split(path10.sep)[0] === ".." || path10.isAbsolute(relative)) {
-      throw new CliError(`files.json lists ${entry.path}, outside project/.`);
-    }
+  for (const entry of entries) {
+    const file = path10.join(dir, entry.path);
     if (!existsSync9(file) || !lstatSync(file).isFile()) {
       throw new CliError(
-        `project/${entry.path} is missing from the release, or isn't a regular file.`
+        `${prefix}${entry.path} is missing from the release, or isn't a regular file.`
       );
     }
     const bytes = readFileSync5(file);
-    if (createHash("sha256").update(bytes).digest("hex") !== entry.sha256) {
+    if (sha256(bytes) !== entry.sha256) {
       throw new CliError(
-        `project/${entry.path} doesn't match the release's files.json, so nothing was written.`
+        `${prefix}${entry.path} doesn't match the release's files.json, so nothing was written.`
       );
     }
     files.set(entry.path, bytes);
   }
   return files;
 }
+function readRelease(root) {
+  const manifest = readManifest(root);
+  const projectDir = path10.join(root, "project");
+  for (const { path: file } of manifest.project) {
+    const relative = path10.relative(projectDir, path10.join(projectDir, file));
+    if (relative.split(path10.sep)[0] === ".." || path10.isAbsolute(relative)) {
+      throw new CliError(`files.json lists ${file}, outside project/.`);
+    }
+  }
+  for (const { path: file } of manifest.root) {
+    if (!isRootName(file)) {
+      throw new CliError(
+        `files.json lists ${file || "an empty path"} as a root file. A root file is one name beside project/, other than project, files.json and removed.json.`
+      );
+    }
+  }
+  if (!manifest.root.some((entry) => entry.path === "SETUP.md")) {
+    throw new CliError(
+      "The release's files.json lists no SETUP.md, so there's no guide to follow."
+    );
+  }
+  return {
+    files: readEntries(projectDir, manifest.project, "project/"),
+    rootFiles: readEntries(root, manifest.root, "")
+  };
+}
+function droppedRootFiles(out, rootFiles) {
+  const file = path10.join(out, "files.json");
+  if (!existsSync9(file)) return [];
+  const value = readJson(file);
+  if (!isEntryList(value?.root)) {
+    throw new UsageError(
+      `${file} must hold root, a JSON array of { path, sha256 } entries. Delete it, then run the command again.`
+    );
+  }
+  return value.root.filter(
+    (entry) => isRootName(entry.path) && !rootFiles.has(entry.path)
+  );
+}
+function removeDroppedRootFiles(out, dropped) {
+  const edited = [];
+  for (const entry of dropped) {
+    const file = path10.join(out, entry.path);
+    if (!existsSync9(file)) continue;
+    const unchanged = lstatSync(file).isFile() && sha256(readFileSync5(file)) === entry.sha256;
+    if (unchanged) rmSync(file);
+    else edited.push(entry.path);
+  }
+  return edited;
+}
+function writeRootFiles(out, rootFiles) {
+  for (const [name, bytes] of rootFiles) {
+    writeFileSync3(path10.join(out, name), bytes);
+  }
+}
+var entriesOf = (files) => [...files].map(([file, bytes]) => ({ path: file, sha256: sha256(bytes) }));
+function writeManifest(out, files, rootFiles) {
+  const manifest = {
+    project: entriesOf(files),
+    root: entriesOf(rootFiles)
+  };
+  writeFileSync3(
+    path10.join(out, "files.json"),
+    `${JSON.stringify(manifest, null, 2)}
+`
+  );
+}
 function mergeIndex(files, currentFile) {
   const exported = files.get("design-system.json");
   if (!exported) throw new CliError("The release has no design-system.json.");
@@ -6426,42 +6492,57 @@ async function exportClaudeDesign(cwd, options) {
     options.release ?? "latest"
   );
   try {
-    const files = readProject2(pkg.root);
+    const { files, rootFiles } = readRelease(pkg.root);
     if (options.index) mergeIndex(files, path10.resolve(cwd, options.index));
     const exported = new Set(
       [...files.keys()].map((file) => `project/${file}`)
     );
     const removed = options.existing ? stalePaths(readPaths(path10.resolve(cwd, options.existing)), exported) : [];
-    const coverageFile = path10.join(pkg.root, "coverage.md");
-    const coverage = existsSync9(coverageFile) ? readFileSync5(coverageFile) : void 0;
+    const dropped = droppedRootFiles(out, rootFiles);
     writeProject(out, files);
-    if (coverage) writeFileSync3(path10.join(out, "coverage.md"), coverage);
+    const kept = removeDroppedRootFiles(out, dropped);
+    writeRootFiles(out, rootFiles);
+    writeManifest(out, files, rootFiles);
+    const removedFile = path10.join(out, "removed.json");
     if (options.existing) {
-      writeFileSync3(
-        path10.join(out, "removed.json"),
-        `${JSON.stringify(removed, null, 2)}
-`
-      );
+      writeFileSync3(removedFile, `${JSON.stringify(removed, null, 2)}
+`);
+    } else {
+      rmSync(removedFile, { force: true });
     }
     const relative = path10.relative(cwd, out) || ".";
     const lines2 = [
-      `Exported nxds ${pkg.version} as a Claude Design System: ${files.size} files in ${path10.join(relative, "project")}.`,
-      `Publish ${relative} as a Design System artifact in Claude, with ${relative} as the root.`
+      `Exported nxds ${pkg.version} as a Claude Design System: ${files.size} files in ${path10.join(relative, "project")}.`
     ];
-    if (removed.length > 0) {
+    if (rootFiles.has("coverage.md")) {
       lines2.push(
-        `Remove the ${removed.length} files the system has and this release doesn't: they're listed in ${path10.join(relative, "removed.json")}.`
+        `The props the canvas can't set are in ${path10.join(relative, "coverage.md")}.`
       );
     }
-    if (coverage) {
+    for (const name of kept) {
       lines2.push(
-        `The props the canvas can't set are in ${path10.join(relative, "coverage.md")}.`
+        `Kept ${path10.join(relative, name)}: this release doesn't ship it, and you edited it.`
+      );
+    }
+    if (removed.length > 0) {
+      lines2.push(
+        `Remove the ${removed.length} files the system has and this release doesn't: they're listed in ${path10.join(relative, "removed.json")}.`
       );
     }
+    lines2.push(
+      `Read ${path10.join(relative, "SETUP.md")} and follow it. It publishes the system, installs it on a canvas and checks it.`
+    );
     return {
-      ok: true,
+      ok: kept.length === 0,
       lines: lines2,
-      data: { version: pkg.version, out, files: files.size, removed }
+      data: {
+        version: pkg.version,
+        out,
+        files: files.size,
+        removed,
+        kept: kept.map((name) => path10.join(out, name)),
+        root: [...rootFiles.keys()].map((name) => path10.join(out, name))
+      }
     };
   } finally {
     pkg.cleanup();
@@ -6895,7 +6976,7 @@ function program(done, write) {
     // Errors are printed once, by `main`, as text or JSON.
     outputError: () => {
     }
-  }).exitOverride().name(CLI_COMMAND).description("Add nxds to your app.").version("0.5.0", "-v, --version", "print the version").helpOption("-h, --help", "show help").helpCommand("help [command]", "show help for a command").option("--json", "print machine-readable JSON").option("--cwd <path>", "run in another folder").addOption(
+  }).exitOverride().name(CLI_COMMAND).description("Add nxds to your app.").version("0.6.1", "-v, --version", "print the version").helpOption("-h, --help", "show help").helpCommand("help [command]", "show help for a command").option("--json", "print machine-readable JSON").option("--cwd <path>", "run in another folder").addOption(
     new Option(
       "--registry <url|path>",
       "where to get nxds releases (default: https://nxds.dev/r)"
@@ -6987,7 +7068,7 @@ Docs: https://nxds.dev/getting-started/install`
   ).option(
     "--existing <path>",
     "a JSON list of the system's current file paths, to list the ones this release removes"
-  ).option("--overwrite", "replace the project/ folder in --out", false).option(
+  ).option("--overwrite", "replace the export in --out", false).option(
     "--source <path>",
     "a built @nxds/claude-design dist folder, instead of the npm release"
   ).addOption(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nxds-cli",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "type": "module",
   "description": "Install nxds components, blocks and setup into your app.",
   "keywords": [
@@ -45,9 +45,9 @@
     "@types/semver": "^7.8.0",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "@nxds/claude-design": "0.12.0",
-    "@nxds/core": "0.12.0",
-    "@nxds/catalog": "0.0.1"
+    "@nxds/catalog": "0.0.1",
+    "@nxds/claude-design": "0.13.2",
+    "@nxds/core": "0.12.0"
   },
   "scripts": {
     "build": "tsup",