forgehive 0.7.5 → 0.7.7

package/README.md

@@ -14,8 +14,8 @@
 <p align="center">
   <img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="Node.js ≥ 18">
   <img src="https://img.shields.io/badge/typescript-5.8-blue" alt="TypeScript">
-  <img src="https://img.shields.io/badge/tests-267%20passing-success" alt="267 tests">
-  <img src="https://img.shields.io/badge/bundle-247KB-lightgrey" alt="247KB bundle">
+  <img src="https://img.shields.io/badge/tests-273%20passing-success" alt="273 tests">
+  <img src="https://img.shields.io/badge/bundle-259KB-lightgrey" alt="259KB bundle">
   <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT">
 </p>
 
@@ -45,9 +45,9 @@ Claude loses all project knowledge between sessions. forgehive solves this by wr
 
 ---
 
-## Status: v0.7 — Stable
+## Status: v0.7.5 — Stable
 
-267 passing tests back the commands listed below. The v0.7 feature set has been validated end-to-end.
+273 passing tests back the commands listed below. The v0.7 feature set has been validated end-to-end.
 
 **Stable — use with confidence:**
 
@@ -93,6 +93,15 @@ If you run into issues, please open an issue on GitHub. The most valuable feedba
 
 ---
 
+## Documentation
+
+| Document | Description |
+|---|---|
+| [User Guide](docs/user-guide.md) | Installation, quick start, all commands with examples, troubleshooting |
+| [TUTORIAL.md](TUTORIAL.md) | Step-by-step walkthrough of a real session |
+
+---
+
 ## Installation
 
 ### From npm (recommended)
@@ -109,14 +118,14 @@ This makes both `fh` and `forgehive` available globally.
 git clone https://github.com/matharnica/forgehive
 cd forgehive
 npm install
-npm run build      # compiles to dist/cli.js (~247 KB)
+npm run build      # compiles to dist/cli.js (~259 KB)
 npm link           # makes 'fh' available globally
 ```
 
 Verify the installation:
 
 ```bash
-fh --version       # should print 0.7.2
+fh --version       # should print 0.7.5
 fh --help          # lists all available commands
 ```
 
@@ -332,6 +341,23 @@ Parses conventional commits (`feat:`, `fix:`, `chore:`, `docs:`, etc.) and group
 
 ---
 
+### Docs
+
+```bash
+fh docs                                        # list existing documentation
+fh docs user [--output path]                   # generate user guide → docs/user-guide.md
+fh docs api  [--output path]                   # generate API reference → docs/api.md
+fh docs onboard [--output path]                # generate onboarding doc → ONBOARDING.md
+fh docs changelog [--since tag] [--output path] # generate changelog → CHANGELOG.md
+fh docs adr "<title>"                          # create Architecture Decision Record
+```
+
+Generates documentation from your project's stack, memory, and git history. Each subcommand writes to a default path inside `docs/` (created if missing) or to the path given via `--output`. `fh docs user` and `fh docs api` write to `docs/user-guide.md` and `docs/api.md` respectively. `fh docs adr` creates a numbered ADR file in `.forgehive/memory/adrs/`.
+
+> `fh docs onboard` and `fh onboard` both generate onboarding documentation — they share the same generator. `fh docs onboard` allows specifying a custom `--output` path; `fh onboard` writes to stdout by default.
+
+---
+
 ### Developer Metrics
 
 ```bash
@@ -847,9 +873,9 @@ Global credential store (chmod 600). Managed exclusively via `fh mcp auth` comma
 |---|---|
 | Runtime | Node.js ≥ 18, ESM |
 | Language | TypeScript |
-| Build | esbuild -> `dist/cli.js` (~247 KB, single bundle) |
+| Build | esbuild -> `dist/cli.js` (~259 KB, single bundle) |
 | Type check | `tsc --noEmit` |
-| Tests | `node:test` (native) + tsx ESM loader, 267 tests |
+| Tests | `node:test` (native) + tsx ESM loader, 273 tests |
 | Dependencies | `js-yaml` (sole runtime dependency) |
 
 ```bash
@@ -860,6 +886,19 @@ npm test            # node --import tsx/esm --test test/*.test.ts
 
 ---
 
+## Changelog
+
+| Version | What's new |
+|---|---|
+| **0.7.5** | `fh --version` reads from `package.json` (no longer hardcoded) |
+| **0.7.4** | Party slash commands installed by `fh init` (`/party`, `/review-party`, `/design-party`, `/full-party`, `/security-party`) |
+| **0.7.3** | User Docs generation (`fh docs user`, `fh docs api`, `fh docs list`) |
+| **0.7.2** | `fh --help`, `fh init --force`, `fh story sprint`, `fh velocity show` fixes |
+| **0.7.1** | Story Cards, Epics, Velocity tracking |
+| **0.7.0** | CI, Map, Onboard, Changelog, Metrics, Sync, Background agents |
+
+---
+
 ## License
 
 MIT

package/dist/cli.js

@@ -6460,7 +6460,7 @@ import fs30 from "node:fs";
 import path31 from "node:path";
 import { spawnSync as spawnSync11 } from "node:child_process";
 var SOURCE_EXTS = [".ts", ".tsx", ".js", ".jsx", ".py", ".go"];
-var IGNORE_DIRS3 = ["node_modules", ".git", "dist", ".forgehive", "coverage", ".next", "build", "test"];
+var IGNORE_DIRS3 = ["node_modules", ".git", "dist", ".forgehive", "coverage", ".next", "build", "test", "__tests__", "spec"];
 var EXPORT_PATTERNS = [
   /^export\s+(?:async\s+)?function\s+(\w+)/gm,
   /^export\s+(?:const|let|var)\s+(\w+)/gm,
@@ -6476,6 +6476,27 @@ function readCapabilities2(forgehiveDir2) {
     return {};
   }
 }
+function extractCapabilityInfo(caps) {
+  if (typeof caps.language === "string") {
+    return {
+      language: caps.language,
+      packageManager: typeof caps.packageManager === "string" ? caps.packageManager : void 0,
+      entryPoints: Array.isArray(caps.entryPoints) ? caps.entryPoints : void 0
+    };
+  }
+  const confirmed = caps.capabilities?.confirmed ?? [];
+  const ids = confirmed.map((c) => c.id ?? "").filter(Boolean);
+  let language;
+  if (ids.includes("typescript")) language = "typescript";
+  else if (ids.includes("javascript")) language = "javascript";
+  else if (ids.includes("python")) language = "python";
+  else if (ids.includes("go")) language = "go";
+  let packageManager;
+  if (ids.includes("pnpm")) packageManager = "pnpm";
+  else if (ids.includes("yarn")) packageManager = "yarn";
+  else if (ids.includes("npm")) packageManager = "npm";
+  return { language, packageManager };
+}
 function readMemoryFiles2(forgehiveDir2) {
   const memDir = path31.join(forgehiveDir2, "memory");
   if (!fs30.existsSync(memDir)) return {};
@@ -6518,6 +6539,7 @@ function walkSourceFiles(dir) {
 function generateUserGuide(projectRoot2, forgehiveDir2) {
   const projectName = path31.basename(projectRoot2);
   const caps = readCapabilities2(forgehiveDir2);
+  const { language: lang, packageManager, entryPoints } = extractCapabilityInfo(caps);
   const memFiles = readMemoryFiles2(forgehiveDir2);
   const commits = getRecentCommits2(projectRoot2);
   const lines = [];
@@ -6528,16 +6550,15 @@ function generateUserGuide(projectRoot2, forgehiveDir2) {
   lines.push("## Overview");
   lines.push("");
   if (memFiles["project.md"]) {
-    const content = memFiles["project.md"].replace(/^---[\s\S]*?---\n/m, "").trim();
+    const content = memFiles["project.md"].replace(/^---[\s\S]*?---\n/, "").trim();
     lines.push(content);
   } else {
-    lines.push(`${projectName} is a ${caps.language ?? "software"} application.`);
+    lines.push(`${projectName} is a ${lang ?? "software"} application.`);
   }
   lines.push("");
   lines.push("## Requirements");
   lines.push("");
-  const pm = caps.packageManager ?? "npm";
-  const lang = caps.language;
+  const pm = packageManager ?? "npm";
   if (lang === "typescript" || lang === "javascript") {
     lines.push("- **Node.js** \u2265 18");
     lines.push(`- **${pm}** (package manager)`);
@@ -6564,7 +6585,6 @@ function generateUserGuide(projectRoot2, forgehiveDir2) {
   }
   lines.push("```");
   lines.push("");
-  const entryPoints = caps.entryPoints;
   if (Array.isArray(entryPoints) && entryPoints.length > 0) {
     lines.push("## Getting Started");
     lines.push("");
@@ -6576,7 +6596,7 @@ function generateUserGuide(projectRoot2, forgehiveDir2) {
   if (memFiles["stack.md"]) {
     lines.push("## Configuration");
     lines.push("");
-    const content = memFiles["stack.md"].replace(/^---[\s\S]*?---\n/m, "").trim();
+    const content = memFiles["stack.md"].replace(/^---[\s\S]*?---\n/, "").trim();
     lines.push(content);
     lines.push("");
   }
@@ -7665,8 +7685,8 @@ Setze diese Umgebungsvariablen:`);
       pkg = JSON.parse(fs31.readFileSync(path32.join(projectRoot, "package.json"), "utf8"));
     } catch {
     }
-    const version2 = pkg.version ?? "unreleased";
-    const md = formatChangelog(commits, version2);
+    const pkgVersion = pkg.version ?? "unreleased";
+    const md = formatChangelog(commits, pkgVersion);
     const outputPath = outputArg ?? path32.join(projectRoot, "CHANGELOG.md");
     let existing = "";
     if (fs31.existsSync(outputPath)) existing = fs31.readFileSync(outputPath, "utf8");
@@ -7680,7 +7700,7 @@ Setze diese Umgebungsvariablen:`);
     }
     const adrsDir = path32.join(forgehiveDir, "memory", "adrs");
     fs31.mkdirSync(adrsDir, { recursive: true });
-    const existing = fs31.existsSync(adrsDir) ? fs31.readdirSync(adrsDir).filter((f) => f.endsWith(".md")).length : 0;
+    const existing = fs31.readdirSync(adrsDir).filter((f) => f.endsWith(".md")).length;
     const adrId = String(existing + 1).padStart(4, "0");
     const slug = title.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
     const filename = `${adrId}-${slug}.md`;