nxds-cli 0.5.0 → 0.6.0

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.0"}. 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) {
@@ -6351,6 +6351,26 @@ function readProject2(root) {
   }
   return files;
 }
+var ROOT_FILES = ["coverage.md", "SETUP.md"];
+function readRootFiles(root) {
+  const files = /* @__PURE__ */ new Map();
+  for (const name of ROOT_FILES) {
+    const file = path10.join(root, name);
+    if (!existsSync9(file)) continue;
+    if (!lstatSync(file).isFile()) {
+      throw new CliError(`The release's ${name} isn't a regular file.`);
+    }
+    files.set(name, readFileSync5(file));
+  }
+  return files;
+}
+function writeRootFiles(out, files) {
+  for (const name of ROOT_FILES) {
+    const bytes = files.get(name);
+    if (bytes) writeFileSync3(path10.join(out, name), bytes);
+    else rmSync(path10.join(out, name), { force: true });
+  }
+}
 function mergeIndex(files, currentFile) {
   const exported = files.get("design-system.json");
   if (!exported) throw new CliError("The release has no design-system.json.");
@@ -6427,41 +6447,48 @@ async function exportClaudeDesign(cwd, options) {
   );
   try {
     const files = readProject2(pkg.root);
+    const rootFiles = readRootFiles(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;
     writeProject(out, files);
-    if (coverage) writeFileSync3(path10.join(out, "coverage.md"), coverage);
+    writeRootFiles(out, 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) {
+    if (removed.length > 0) {
       lines2.push(
-        `The props the canvas can't set are in ${path10.join(relative, "coverage.md")}.`
+        `Remove the ${removed.length} files the system has and this release doesn't: they're listed in ${path10.join(relative, "removed.json")}.`
       );
     }
+    lines2.push(
+      rootFiles.has("SETUP.md") ? `Read ${path10.join(relative, "SETUP.md")} and follow it. It publishes the system, installs it on a canvas and checks it.` : `Publish ${relative} as a Design System artifact in Claude, with ${relative} as the root.`
+    );
     return {
       ok: true,
       lines: lines2,
-      data: { version: pkg.version, out, files: files.size, removed }
+      data: {
+        version: pkg.version,
+        out,
+        files: files.size,
+        removed,
+        root: [...rootFiles.keys()].map((name) => path10.join(out, name))
+      }
     };
   } finally {
     pkg.cleanup();
@@ -6895,7 +6922,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.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(
     new Option(
       "--registry <url|path>",
       "where to get nxds releases (default: https://nxds.dev/r)"
@@ -6987,7 +7014,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.0",
   "type": "module",
   "description": "Install nxds components, blocks and setup into your app.",
   "keywords": [
@@ -45,7 +45,7 @@
     "@types/semver": "^7.8.0",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "@nxds/claude-design": "0.12.0",
+    "@nxds/claude-design": "0.13.0",
     "@nxds/core": "0.12.0",
     "@nxds/catalog": "0.0.1"
   },