@getmonoceros/workbench 1.9.5 → 1.9.6

package/dist/bin.js

@@ -311,7 +311,7 @@ import { consola as consola2 } from "consola";
 import { promises as fs8 } from "fs";
 import { consola } from "consola";
 import { createPatch } from "diff";
-import path7 from "path";
+import path8 from "path";
 
 // src/config/io.ts
 import { promises as fs } from "fs";
@@ -2237,6 +2237,153 @@ import {
   YAMLMap as YAMLMap2,
   YAMLSeq
 } from "yaml";
+
+// src/init/manifest.ts
+import { existsSync as existsSync4, readFileSync as readFileSync2 } from "fs";
+import path7 from "path";
+function resolveManifestPath(name, checkoutRoot) {
+  if (checkoutRoot) {
+    const checkoutPath = path7.join(
+      checkoutRoot,
+      "images",
+      "features",
+      name,
+      "devcontainer-feature.json"
+    );
+    if (existsSync4(checkoutPath)) return checkoutPath;
+  }
+  const bundlePath = path7.join(
+    bundledFeaturesDir(),
+    name,
+    "devcontainer-feature.json"
+  );
+  if (existsSync4(bundlePath)) return bundlePath;
+  return null;
+}
+function loadFeatureManifestSummary(ref, checkoutRoot = workbenchCheckoutRoot()) {
+  const match = matchMonocerosFeature(ref);
+  if (!match) return void 0;
+  const manifestPath = resolveManifestPath(match.name, checkoutRoot);
+  if (!manifestPath) return void 0;
+  try {
+    const text = readFileSync2(manifestPath, "utf8");
+    const parsed = JSON.parse(text);
+    const rawHints = parsed["x-monoceros"]?.optionHints;
+    const optionHints = Array.isArray(rawHints) ? rawHints.filter(
+      (x) => typeof x === "string" && x.length > 0
+    ) : [];
+    const rawNotes = parsed["x-monoceros"]?.usageNotes;
+    const usageNotes = Array.isArray(rawNotes) ? rawNotes.filter(
+      (x) => typeof x === "string" && x.length > 0
+    ) : [];
+    const optionDescriptions = {};
+    const optionTypes = {};
+    const optionNames = [];
+    if (parsed.options) {
+      for (const [key, opt] of Object.entries(parsed.options)) {
+        if (!opt || typeof opt !== "object") continue;
+        optionNames.push(key);
+        if (typeof opt.description === "string" && opt.description.length > 0) {
+          optionDescriptions[key] = opt.description;
+        }
+        if (opt.type === "boolean") {
+          optionTypes[key] = "boolean";
+        } else if (opt.type === "string") {
+          optionTypes[key] = "string";
+        }
+      }
+    }
+    const name = typeof parsed.name === "string" ? parsed.name : "";
+    const description = typeof parsed.description === "string" ? parsed.description : "";
+    const rawUrl = typeof parsed.documentationURL === "string" ? parsed.documentationURL.trim() : "";
+    const documentationURL = rawUrl.length > 0 && rawUrl.toLowerCase() !== "tbd" ? rawUrl : void 0;
+    return {
+      name,
+      description,
+      documentationURL,
+      optionHints,
+      optionDescriptions,
+      optionNames,
+      optionTypes,
+      usageNotes
+    };
+  } catch {
+    return void 0;
+  }
+}
+
+// src/init/feature-doc.ts
+function buildFeatureHeaderLines(summary, width) {
+  const paragraphs = buildHeaderParagraphs(summary);
+  const wrapped = [];
+  for (const para of paragraphs) {
+    for (const line of wrapToComment(para, width)) {
+      wrapped.push(line);
+    }
+  }
+  return wrapped;
+}
+function buildFeatureHeaderCommentBefore(summary, width) {
+  const lines = buildFeatureHeaderLines(summary, width);
+  return lines.map((l) => ` ${l}`).join("\n");
+}
+function buildHeaderParagraphs(summary) {
+  if (!summary) return [];
+  const out = [];
+  const tagline = summary.name?.trim();
+  const description = summary.description?.trim();
+  if (tagline && description) {
+    out.push(`${tagline} \u2014 ${description}`);
+  } else if (tagline) {
+    out.push(tagline);
+  } else if (description) {
+    out.push(description);
+  }
+  for (const note of summary.usageNotes) {
+    const trimmed = note.trim();
+    if (trimmed.length > 0) out.push(trimmed);
+  }
+  if (summary.optionHints.length > 0) {
+    const parts = summary.optionHints.map((key) => {
+      const desc = summary.optionDescriptions[key];
+      const short = desc ? shortenOptionDescription(desc) : void 0;
+      return short ? `${key} (${short})` : key;
+    });
+    out.push(`Options: ${parts.join(", ")}.`);
+  }
+  if (summary.documentationURL) {
+    out.push(`See ${summary.documentationURL} for further information.`);
+  }
+  return out;
+}
+function shortenOptionDescription(desc) {
+  const firstSentence = desc.split(/(?<=[.!?])\s+/)[0]?.trim() ?? desc.trim();
+  return firstSentence.replace(/[.!?]+$/, "").trim();
+}
+function wrapToComment(text, width) {
+  const words = text.split(/\s+/).filter((w) => w.length > 0);
+  if (words.length === 0) return [""];
+  const usable = Math.max(width, 20);
+  const lines = [];
+  let current = "";
+  for (const w of words) {
+    if (current.length === 0) {
+      current = w;
+      continue;
+    }
+    if (current.length + 1 + w.length <= usable) {
+      current += " " + w;
+    } else {
+      lines.push(current);
+      current = w;
+    }
+  }
+  if (current.length > 0) lines.push(current);
+  return lines;
+}
+var FEATURE_HEADER_WIDTH = 76 - 2;
+
+// src/modify/yml.ts
 function ensureSeq(doc, key) {
   const existing = doc.get(key, true);
   if (existing && isSeq(existing)) return existing;
@@ -2474,6 +2621,15 @@ function addFeatureToDoc(doc, ref, options = {}, displayName) {
   if (Object.keys(options).length > 0) {
     entry2.set("options", options);
   }
+  const summary = loadFeatureManifestSummary(ref);
+  const headerBefore = buildFeatureHeaderCommentBefore(
+    summary,
+    FEATURE_HEADER_WIDTH
+  );
+  if (headerBefore.length > 0) {
+    entry2.commentBefore = headerBefore;
+    entry2.spaceBefore = true;
+  }
   seq.add(entry2);
   return true;
 }
@@ -2777,7 +2933,7 @@ async function tryCloneInRunningContainer(input, entry2) {
   logger.info(
     `Cloned ${entry2.url} into /workspaces/${containerName2}/${targetRel} inside the running container.`
   );
-  void path7;
+  void path8;
 }
 function shquote(value) {
   return `'${value.replace(/'/g, `'\\''`)}'`;
@@ -3456,12 +3612,12 @@ var addServiceCommand = defineCommand7({
 import { defineCommand as defineCommand8 } from "citty";
 
 // src/apply/index.ts
-import { existsSync as existsSync5, promises as fs11 } from "fs";
+import { existsSync as existsSync6, promises as fs11 } from "fs";
 import { consola as consola11 } from "consola";
 
 // src/config/state.ts
 import { promises as fs9 } from "fs";
-import path8 from "path";
+import path9 from "path";
 function buildStateFile(opts) {
   return {
     schemaVersion: CONFIG_SCHEMA_VERSION,
@@ -3471,7 +3627,7 @@ function buildStateFile(opts) {
   };
 }
 function stateFilePath(targetDir) {
-  return path8.join(targetDir, ".monoceros", "state.json");
+  return path9.join(targetDir, ".monoceros", "state.json");
 }
 async function readStateFile(targetDir) {
   try {
@@ -3482,7 +3638,7 @@ async function readStateFile(targetDir) {
   }
 }
 async function writeStateFile(targetDir, state) {
-  const monocerosDir = path8.join(targetDir, ".monoceros");
+  const monocerosDir = path9.join(targetDir, ".monoceros");
   await fs9.mkdir(monocerosDir, { recursive: true });
   await fs9.writeFile(
     stateFilePath(targetDir),
@@ -3554,8 +3710,8 @@ function solutionConfigToCreateOptions(config, featureDefaults = {}) {
 
 // src/devcontainer/compose.ts
 import { spawn as spawn5 } from "child_process";
-import { existsSync as existsSync4 } from "fs";
-import path10 from "path";
+import { existsSync as existsSync5 } from "fs";
+import path11 from "path";
 import { consola as consola9 } from "consola";
 
 // src/util/mask-secrets.ts
@@ -3616,20 +3772,20 @@ function createSecretMaskStream() {
 
 // src/devcontainer/cli.ts
 import { spawn as spawn4 } from "child_process";
-import { readFileSync as readFileSync2 } from "fs";
+import { readFileSync as readFileSync3 } from "fs";
 import { createRequire } from "module";
-import path9 from "path";
+import path10 from "path";
 var require_ = createRequire(import.meta.url);
 var cachedBinaryPath = null;
 function devcontainerCliPath() {
   if (cachedBinaryPath) return cachedBinaryPath;
   const pkgJsonPath = require_.resolve("@devcontainers/cli/package.json");
-  const pkg = JSON.parse(readFileSync2(pkgJsonPath, "utf8"));
+  const pkg = JSON.parse(readFileSync3(pkgJsonPath, "utf8"));
   const binEntry = typeof pkg.bin === "string" ? pkg.bin : pkg.bin?.devcontainer ?? "";
   if (!binEntry) {
     throw new Error("Could not resolve @devcontainers/cli bin entry.");
   }
-  cachedBinaryPath = path9.resolve(path9.dirname(pkgJsonPath), binEntry);
+  cachedBinaryPath = path10.resolve(path10.dirname(pkgJsonPath), binEntry);
   return cachedBinaryPath;
 }
 var spawnDevcontainer = (args, cwd, options = {}) => {
@@ -3701,16 +3857,16 @@ var spawnBash = (args, cwd) => {
   });
 };
 function composeProjectName(root) {
-  return `${path10.basename(root)}_devcontainer`;
+  return `${path11.basename(root)}_devcontainer`;
 }
 function resolveCompose(root) {
-  if (!existsSync4(path10.join(root, ".devcontainer"))) {
+  if (!existsSync5(path11.join(root, ".devcontainer"))) {
     throw new Error(
       `No .devcontainer/ at ${root}. Run \`monoceros apply <name>\` first.`
     );
   }
-  const composeFile = path10.join(root, ".devcontainer", "compose.yaml");
-  if (!existsSync4(composeFile)) {
+  const composeFile = path11.join(root, ".devcontainer", "compose.yaml");
+  if (!existsSync5(composeFile)) {
     throw new Error(
       `No compose.yaml at ${composeFile}. \`start\` / \`stop\` / \`status\` / \`logs\` require services configured via \`monoceros add-service <name> <svc>\`. Use \`monoceros shell <name>\` to enter the container directly.`
     );
@@ -4005,7 +4161,7 @@ function formatRootlessNotSupportedError() {
 // src/devcontainer/identity.ts
 import { spawn as spawn8 } from "child_process";
 import { promises as fs10 } from "fs";
-import path11 from "path";
+import path12 from "path";
 import { consola as consola10 } from "consola";
 var realGitConfigGet = (key) => {
   return new Promise((resolve, reject) => {
@@ -4119,8 +4275,8 @@ async function resolveIdentityWithPrompt(options = {}) {
   };
 }
 async function collectGitIdentity(devContainerRoot, options = {}) {
-  const gitconfigDir = path11.join(devContainerRoot, ".monoceros");
-  const gitconfigPath = path11.join(gitconfigDir, "gitconfig");
+  const gitconfigDir = path12.join(devContainerRoot, ".monoceros");
+  const gitconfigPath = path12.join(gitconfigDir, "gitconfig");
   const logger = options.logger ?? { info: () => {
   }, warn: () => {
   } };
@@ -4210,7 +4366,7 @@ ${sectionLine(label)}
     );
   }
   const ymlPath = containerConfigPath(opts.name, home);
-  if (!existsSync5(ymlPath)) {
+  if (!existsSync6(ymlPath)) {
     throw new Error(
       `No such config: ${ymlPath}. Run \`monoceros init <template> ${opts.name}\` first.`
     );
@@ -4339,7 +4495,7 @@ ${sectionLine(label)}
   return { targetDir, configPath: ymlPath, containerExitCode: exitCode };
 }
 async function assertSafeTargetDir(targetDir, expectedOrigin) {
-  if (!existsSync5(targetDir)) return;
+  if (!existsSync6(targetDir)) return;
   const entries = await fs11.readdir(targetDir);
   if (entries.length === 0) return;
   const state = await readStateFile(targetDir);
@@ -4432,7 +4588,7 @@ async function persistPromptedIdentity(prompted, ymlPath, home, logger) {
 }
 
 // src/version.ts
-var CLI_VERSION = true ? "1.9.5" : "dev";
+var CLI_VERSION = true ? "1.9.6" : "dev";
 
 // src/commands/_dispatch.ts
 import { consola as consola12 } from "consola";
@@ -4594,82 +4750,6 @@ import { defineCommand as defineCommand10 } from "citty";
 // src/completion/resolve.ts
 import { existsSync as existsSync7, promises as fs12 } from "fs";
 import path13 from "path";
-
-// src/init/manifest.ts
-import { existsSync as existsSync6, readFileSync as readFileSync3 } from "fs";
-import path12 from "path";
-function resolveManifestPath(name, checkoutRoot) {
-  if (checkoutRoot) {
-    const checkoutPath = path12.join(
-      checkoutRoot,
-      "images",
-      "features",
-      name,
-      "devcontainer-feature.json"
-    );
-    if (existsSync6(checkoutPath)) return checkoutPath;
-  }
-  const bundlePath = path12.join(
-    bundledFeaturesDir(),
-    name,
-    "devcontainer-feature.json"
-  );
-  if (existsSync6(bundlePath)) return bundlePath;
-  return null;
-}
-function loadFeatureManifestSummary(ref, checkoutRoot = workbenchCheckoutRoot()) {
-  const match = matchMonocerosFeature(ref);
-  if (!match) return void 0;
-  const manifestPath = resolveManifestPath(match.name, checkoutRoot);
-  if (!manifestPath) return void 0;
-  try {
-    const text = readFileSync3(manifestPath, "utf8");
-    const parsed = JSON.parse(text);
-    const rawHints = parsed["x-monoceros"]?.optionHints;
-    const optionHints = Array.isArray(rawHints) ? rawHints.filter(
-      (x) => typeof x === "string" && x.length > 0
-    ) : [];
-    const rawNotes = parsed["x-monoceros"]?.usageNotes;
-    const usageNotes = Array.isArray(rawNotes) ? rawNotes.filter(
-      (x) => typeof x === "string" && x.length > 0
-    ) : [];
-    const optionDescriptions = {};
-    const optionTypes = {};
-    const optionNames = [];
-    if (parsed.options) {
-      for (const [key, opt] of Object.entries(parsed.options)) {
-        if (!opt || typeof opt !== "object") continue;
-        optionNames.push(key);
-        if (typeof opt.description === "string" && opt.description.length > 0) {
-          optionDescriptions[key] = opt.description;
-        }
-        if (opt.type === "boolean") {
-          optionTypes[key] = "boolean";
-        } else if (opt.type === "string") {
-          optionTypes[key] = "string";
-        }
-      }
-    }
-    const name = typeof parsed.name === "string" ? parsed.name : "";
-    const description = typeof parsed.description === "string" ? parsed.description : "";
-    const rawUrl = typeof parsed.documentationURL === "string" ? parsed.documentationURL.trim() : "";
-    const documentationURL = rawUrl.length > 0 && rawUrl.toLowerCase() !== "tbd" ? rawUrl : void 0;
-    return {
-      name,
-      description,
-      documentationURL,
-      optionHints,
-      optionDescriptions,
-      optionNames,
-      optionTypes,
-      usageNotes
-    };
-  } catch {
-    return void 0;
-  }
-}
-
-// src/completion/resolve.ts
 async function resolveCompletions(line, point, opts = {}) {
   const { prev, current } = parseCompletionLine(line, point);
   const ctx = { prev, current, opts };
@@ -5305,12 +5385,8 @@ function routingHeader(name) {
 }
 function renderFeatureBlock(out, feature, summary, commented) {
   const yamlPrefix = commented ? "# " : "";
-  const headerLines = buildHeaderLines(summary);
-  for (const line of headerLines) {
-    const wrapped = wrapToComment(line, COMMENT_WIDTH - 2);
-    for (const wl of wrapped) {
-      out.push(`# ${wl}`.trimEnd());
-    }
+  for (const wl of buildFeatureHeaderLines(summary, COMMENT_WIDTH - 2)) {
+    out.push(`# ${wl}`.trimEnd());
   }
   out.push(`${yamlPrefix}  - ref: ${feature.ref}`);
   const options = feature.options ?? {};
@@ -5340,41 +5416,6 @@ function renderFeatureBlock(out, feature, summary, commented) {
     }
   }
 }
-function buildHeaderLines(summary) {
-  const out = [];
-  if (!summary) {
-    return out;
-  }
-  const tagline = summary.name?.trim();
-  const description = summary.description?.trim();
-  if (tagline && description) {
-    out.push(`${tagline} \u2014 ${description}`);
-  } else if (tagline) {
-    out.push(tagline);
-  } else if (description) {
-    out.push(description);
-  }
-  for (const note of summary.usageNotes) {
-    const trimmed = note.trim();
-    if (trimmed.length > 0) out.push(trimmed);
-  }
-  if (summary.optionHints.length > 0) {
-    const parts = summary.optionHints.map((key) => {
-      const desc = summary.optionDescriptions[key];
-      const short = desc ? shortenOptionDescription(desc) : void 0;
-      return short ? `${key} (${short})` : key;
-    });
-    out.push(`Options: ${parts.join(", ")}.`);
-  }
-  if (summary.documentationURL) {
-    out.push(`See ${summary.documentationURL} for further information.`);
-  }
-  return out;
-}
-function shortenOptionDescription(desc) {
-  const firstSentence = desc.split(/(?<=[.!?])\s+/)[0]?.trim() ?? desc.trim();
-  return firstSentence.replace(/[.!?]+$/, "").trim();
-}
 function pushHeader(out, header, name) {
   for (const line of header.replace(/<name>/g, name).split("\n")) {
     out.push(line);
@@ -5387,27 +5428,6 @@ function pushSectionHeader(out, text, _commented) {
     out.push(`# ${wl}`.trimEnd());
   }
 }
-function wrapToComment(text, width) {
-  const words = text.split(/\s+/).filter((w) => w.length > 0);
-  if (words.length === 0) return [""];
-  const usable = Math.max(width, 20);
-  const lines = [];
-  let current = "";
-  for (const w of words) {
-    if (current.length === 0) {
-      current = w;
-      continue;
-    }
-    if (current.length + 1 + w.length <= usable) {
-      current += " " + w;
-    } else {
-      lines.push(current);
-      current = w;
-    }
-  }
-  if (current.length > 0) lines.push(current);
-  return lines;
-}
 function renderScalarValue(value) {
   if (typeof value === "string") {
     return /^[A-Za-z_][A-Za-z0-9._-]*$/.test(value) ? value : JSON.stringify(value);