forgedock 1.0.21 → 1.1.1

package/bin/init-detect.mjs

@@ -323,3 +323,98 @@ export async function detectConfig(cwd = process.cwd()) {
     meta: { remoteDetected },
   };
 }
+
+// ---------------------------------------------------------------------------
+// Minimal forge.yaml template builder
+// ---------------------------------------------------------------------------
+
+/**
+ * Escape a value for embedding inside a YAML double-quoted scalar.
+ *
+ * Backslash MUST be escaped first to avoid double-escaping an already-escaped
+ * quote. This mirrors the escaping applied by the full-config generator in
+ * forgedock.mjs and prevents Windows paths (which contain `\`) from corrupting
+ * the emitted YAML. (Ref: forge#810 — init() did not escape backslashes.)
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+function escapeYamlScalar(value) {
+  return String(value).replace(/\\/g, "\\\\").replace(/"/g, '\\"');
+}
+
+/**
+ * Build a minimal forge.yaml document containing ONLY the three required
+ * sections — project, paths, branches — with no commented optional blocks.
+ *
+ * This is the `npx forgedock init --minimal` output. It is intentionally
+ * complete enough to pass `npx forgedock doctor` (which requires project,
+ * paths, AND branches) and to drive `/work-on` (which needs
+ * paths.worktree_base for git worktrees) — while staying ~20 lines instead of
+ * the ~200-line full template. Optional sections (repos, project_board,
+ * review, verification, …) fall back to sensible defaults and can be added
+ * later from forge.yaml.example / docs/CONFIG.md.
+ *
+ * Pure: returns a string, performs no I/O.
+ *
+ * @param {object} opts
+ * @param {string} opts.projectName - Human-readable project name.
+ * @param {string} opts.owner - GitHub org/user that owns the repo.
+ * @param {string} opts.repo - Repository name (no owner prefix).
+ * @param {string} [opts.description] - One-line project description (omitted if empty).
+ * @param {string} opts.root - Absolute path to the project root.
+ * @param {string} opts.worktreeBase - Directory where git worktrees are created.
+ * @param {string} opts.defaultBranch - Default branch (e.g. main).
+ * @param {string} opts.stagingBranch - Staging branch for fast-lane PRs.
+ * @returns {string} The minimal forge.yaml content.
+ */
+export function buildMinimalForgeYaml({
+  projectName,
+  owner,
+  repo,
+  description = "",
+  root,
+  worktreeBase,
+  defaultBranch,
+  stagingBranch,
+}) {
+  const e = escapeYamlScalar;
+  const descLine = description
+    ? `\n  description: "${e(description)}"`
+    : "";
+
+  return `# forge.yaml — ForgeDock Configuration (minimal)
+#
+# Generated by: npx forgedock init --minimal
+#
+# Only project, paths, and branches are required — everything else is optional
+# and falls back to sensible defaults. Start here and add sections as you need
+# them. See forge.yaml.example and docs/CONFIG.md for the full reference.
+
+# =============================================================================
+# PROJECT (REQUIRED)
+# =============================================================================
+
+project:
+  name: "${e(projectName)}"
+  owner: "${e(owner)}"
+  repo: "${e(repo)}"${descLine}
+
+# =============================================================================
+# PATHS (REQUIRED)
+# =============================================================================
+
+paths:
+  root: "${e(root)}"
+  worktree_base: "${e(worktreeBase)}"
+
+# =============================================================================
+# BRANCHES (REQUIRED)
+# =============================================================================
+
+branches:
+  default: "${e(defaultBranch)}"
+  staging: "${e(stagingBranch)}"
+  feature_pattern: "milestone/{slug}"
+`;
+}