agent-docs-bootstrap 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -4,6 +4,20 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), versions follo
 
 ## [Unreleased]
 
+## [0.4.2] - 2026-10-27
+
+### Fixed
+- Content hashes left out every dot file, so a user's own hidden file in a kit folder, such as `.claude/skills/docs-check/.notes.md`, did not count as a change and was deleted by an update or `--uninstall`. Only files the OS adds are left out now: `.DS_Store`, `._*`, `Thumbs.db`, `desktop.ini`. A folder without them hashes as in 0.4.0.
+- `LEGACY` lacked what 0.4.0 and 0.4.1 installed for `docs-check`, so installs stuck on 0.4.0 would stop recovering once `docs-check` changed. The hash is added, and `scripts/check.mjs` now installs every release tag and fails when `LEGACY` misses anything one of them installed; CI fetches the tags for it.
+
+## [0.4.1] - 2026-10-27
+
+### Fixed
+- A `.DS_Store` or other OS file inside an installed folder counted as a change: the first run skipped the path and dropped its marker line, and later runs called it "not installed by this kit", so updates stopped for the whole team once the marker was committed. Dot files, `Thumbs.db` and `desktop.ini` are now left out of content hashes; a folder without them hashes exactly as in 0.4.0.
+- A path that exists without a marker line but holds content a kit version wrote, byte for byte, is recognised, updated and listed again, so installs stuck on 0.4.0 recover with a normal run.
+- A shipped path the user changed keeps its marker line and old hash, so every run reports the same thing about it instead of "changed" first and "not installed by this kit" afterwards.
+- The installer exits non-zero and lists the paths it could not install when a shipped path is skipped, so an agent or CI notices an incomplete install. A changed path the kit no longer ships is only a warning.
+
 ## [0.4.0] - 2026-10-27
 
 ### Changed

package/README.md

@@ -17,7 +17,7 @@ You need Node.js 18+ and a git repository.
 1. From your project root, install the skills and subagents:
 
    ```bash
-   npx agent-docs-bootstrap@0.4.0 --target claude
+   npx agent-docs-bootstrap@0.4.2 --target claude
    ```
 
    Replace `claude` with `codex`, `opencode`, a list such as `claude,codex`, or `all`.
@@ -103,19 +103,19 @@ All options run the same installer from your project root. Pin the version: the
 **From npm** (recommended):
 
 ```bash
-npx agent-docs-bootstrap@0.4.0 --target claude
+npx agent-docs-bootstrap@0.4.2 --target claude
 ```
 
 **From a GitHub release tag**, when the npm registry is blocked or unavailable:
 
 ```bash
-npx github:TraneDev/agent-docs-bootstrap#v0.4.0 --target claude
+npx github:TraneDev/agent-docs-bootstrap#v0.4.2 --target claude
 ```
 
 **From a clone**, to read or change the kit first:
 
 ```bash
-git clone --branch v0.4.0 https://github.com/TraneDev/agent-docs-bootstrap.git ~/agent-docs-bootstrap
+git clone --branch v0.4.2 https://github.com/TraneDev/agent-docs-bootstrap.git ~/agent-docs-bootstrap
 node ~/agent-docs-bootstrap/install.mjs --target claude
 ```
 
@@ -134,7 +134,8 @@ Two skills are installed, `docs-bootstrap` and `docs-check`. The guides by other
 `.agent-docs-bootstrap` lists every installed path with a hash of what was written. The installer replaces or removes a path only if it is listed there and its content still matches, so it never touches files it did not create or that you changed:
 
 - a path that exists but is not listed is skipped with a warning;
-- a listed path whose content you changed, for example a skill you replaced with your own version, is left in place as yours, with a warning, and drops out of the marker;
+- a listed path whose content you changed is left in place, with a warning, and the installer exits non-zero; a changed path the kit no longer ships, for example a skill you replaced with your own version, becomes yours and drops out of the marker;
+- files the OS adds to the kit's folders (`.DS_Store`, `._*`, `Thumbs.db`, `desktop.ini`) do not count as a change; a file of your own there, hidden or not, does, so it is never deleted;
 - a marker line not shaped like a path the kit installs (for example `src` or `../x`, added by a bad merge) is ignored with a warning.
 
 ### Other agents

package/install.mjs

@@ -11,9 +11,10 @@
 //   codex     skills → .agents/skills/   agents → .codex/agents/*.toml
 //   opencode  skills → .agents/skills/   agents → .opencode/agents/*.md   commands → .opencode/commands/*.md
 // Installed paths are listed in .agent-docs-bootstrap with a hash of what was written. A path is replaced or removed
-// only if it is listed, has the shape of a path the kit writes (<layout folder>/<kit name>), and its content still
-// matches that hash; a changed path is left in place as the user's. On an update, listed paths this version no
-// longer ships are removed under the same rule.
+// only if its line has the shape of a path the kit writes (<layout folder>/<kit name>) and its content still matches
+// that hash or something a version of the kit wrote. OS files such as .DS_Store do not count; a user's own file,
+// hidden or not, does. A changed path is left in place and the run exits non-zero. On an update, listed paths this
+// version no longer ships are removed under the same rule, or left to the user if changed.
 // No network access, no changes to harness settings, no admin rights.
 
 import fs from 'node:fs';
@@ -64,7 +65,9 @@ for (const l of read(MARKER).split('\n').map(l => l.trim()).filter(l => l && !l.
   if (isOwnedPath(r)) old.set(r, h);
   else warn(`ignored '${r}' in .agent-docs-bootstrap: not a path this kit installs`);
 }
-// Hashes of every path versions 0.1.0–0.3.0 installed (all targets, no model flags). Fixed: never edit.
+// Hashes of every path each released version installed (all targets, no model flags), so an install whose marker
+// lost its lines is still recognised after the kit changes. Every release adds the outgoing version's hashes;
+// nothing is ever removed. check.mjs installs each release tag and fails, listing the missing ones.
 const LEGACY = new Set([
   '00ca80d7077c0e4b', '122ae594f7eb38bd', '185ec7d02d9cf70b', '1f5a0fe496f38dd6', '3798ad63dd954bac',
   '4c36074d70c5a88c', '562d1e8f3a090ffd', '698cadefe39cb46f', '6acf8481d4dd6a1a', '72bcff6d0e5476ba',
@@ -72,9 +75,22 @@ const LEGACY = new Set([
   '900cf27ab683e5d1', '96288a3e60126264', '9e0e5c30da22c059', 'b45162299d9aa78b', 'c5d47d8811aa61ee',
   'c87450584ed42c8b', 'cf2f8a40c91f3c45', 'dac09810ceb351f7', 'dc418221c7363caa', 'f741ba5711364c55',
   'fceff4c3b3159c80', 'fd975138dcda6b38', 'fe412d3c3c312f7a',
+  // 0.4.0, 0.4.1
+  '7f6ef4c3f161abfa',
 ]);
+
+const skills = skillDirs();
+const agents = AGENTS.map(n => parseAgent(path.join(KIT, 'agents', `${n}.md`)));
+const models = { 'docs-scout': a['scout-model'], 'docs-reader': a['reader-model'] };
+const COMMANDS = [['docs-bootstrap', "Build the project's reference documentation"], ['docs-check', "Optional: test the project's documentation with a fresh reader"]];
+const commandBody = (name, what) => `---\ndescription: ${JSON.stringify(`${what} (${name})`)}\n---\nLoad the \`${name}\` skill and follow it. Arguments from the developer, if any: $ARGUMENTS\n`;
+// What this version writes when no model is pinned. Content that matches it or LEGACY byte for byte is the kit's,
+// even where the marker lost its line (0.4.0 counted a .DS_Store as a change and dropped the line).
+const CURRENT = new Set([...skills.map(d => contentHash(d)),
+  ...TARGETS.flatMap(t => agents.map(ag => textHash(render(t, ag)))), ...COMMANDS.map(([n, w]) => textHash(commandBody(n, w)))]);
+const isKitContent = (h) => LEGACY.has(h) || CURRENT.has(h);
 // The path is the kit's and nobody changed it since it was installed.
-const isUnchanged = (r) => { const h = contentHash(abs(r)); return old.get(r) ? h === old.get(r) : LEGACY.has(h); };
+const isUnchanged = (r) => { const h = contentHash(abs(r)); return h === old.get(r) || isKitContent(h); };
 const changedNote = (r) => `${r} changed since it was installed, so it is left in place as yours`;
 if (a.uninstall) { uninstall(); process.exit(0); }
 
@@ -90,11 +106,18 @@ if (!GLOBAL) {
 
 const installed = new Map();
 const released = new Set();
+const shipped = new Set();
+const skipped = [];
+// A shipped path the user changed keeps its marker line and old hash, so every run says the same thing about it.
 function writeOwned(r, fn) {
-  if (installed.has(r) || released.has(r)) return false;
+  if (shipped.has(r)) return false;
+  shipped.add(r);
   const dst = abs(r);
-  if (exists(dst) && !old.has(r)) { warn(`skipped ${r}: exists and was not installed by this kit`); return false; }
-  if (exists(dst) && !isUnchanged(r)) { warn(`skipped ${changedNote(r)}; delete it and run again to get this version`); released.add(r); return false; }
+  if (exists(dst)) {
+    const why = !old.has(r) && !isKitContent(contentHash(dst)) ? 'exists and was not installed by this kit'
+      : old.has(r) && !isUnchanged(r) ? 'changed since it was installed' : '';
+    if (why) { warn(`skipped ${r}: ${why}`); skipped.push(r); return false; }
+  }
   fs.rmSync(dst, { recursive: true, force: true });
   fs.mkdirSync(path.dirname(dst), { recursive: true });
   fn(dst);
@@ -102,10 +125,6 @@ function writeOwned(r, fn) {
   return true;
 }
 
-const skills = skillDirs();
-const agents = AGENTS.map(n => parseAgent(path.join(KIT, 'agents', `${n}.md`)));
-const models = { 'docs-scout': a['scout-model'], 'docs-reader': a['reader-model'] };
-
 for (const t of targets) {
   const L = LAYOUT[t];
   console.log(`\n${t}`);
@@ -118,29 +137,36 @@ for (const t of targets) {
     const r = `${L.agents}/${ag.name}.${ext}`;
     if (writeOwned(r, dst => fs.writeFileSync(dst, render(t, ag, models[ag.name])))) log(`agent  ${r}`);
   }
-  if (L.commands) for (const [name, what] of [['docs-bootstrap', "Build the project's reference documentation"], ['docs-check', "Optional: test the project's documentation with a fresh reader"]]) {
+  if (L.commands) for (const [name, what] of COMMANDS) {
     const r = `${L.commands}/${name}.md`;
-    const body = `---\ndescription: ${JSON.stringify(`${what} (${name})`)}\n---\nLoad the \`${name}\` skill and follow it. Arguments from the developer, if any: $ARGUMENTS\n`;
-    if (writeOwned(r, dst => fs.writeFileSync(dst, body))) log(`command /${name}`);
+    if (writeOwned(r, dst => fs.writeFileSync(dst, commandBody(name, what)))) log(`command /${name}`);
   }
 }
 
 // Paths an earlier version installed into these targets' folders and this version no longer ships.
 const ownDirs = new Set(targets.flatMap(t => Object.values(LAYOUT[t])));
 for (const r of old.keys()) {
-  if (installed.has(r) || released.has(r) || !ownDirs.has(path.dirname(r)) || !exists(abs(r))) continue;
+  if (shipped.has(r) || !ownDirs.has(path.dirname(r)) || !exists(abs(r))) continue;
   if (isUnchanged(r)) { fs.rmSync(abs(r), { recursive: true, force: true }); log(`removed  ${r} (no longer shipped)`); }
   else { warn(`not removed: ${changedNote(r)}`); released.add(r); }
 }
 
-// Keep entries of earlier installs (e.g. another target) that are still on disk; a changed path is no longer listed.
+// Keep entries of earlier installs (e.g. another target) and skipped shipped paths that are still on disk; a changed
+// path this version no longer ships is the user's and is no longer listed.
 const keep = [...old].filter(([r]) => !installed.has(r) && !released.has(r) && exists(abs(r)));
 fs.writeFileSync(MARKER, [`version=${VERSION}`, ...[...keep, ...installed].map(([r, h]) => h ? `${r} ${h}` : r)].join('\n') + '\n');
 
-console.log(`\nDone: agent-docs-bootstrap ${VERSION}, ${targets.join(', ')}${GLOBAL ? ' (global)' : ''}.`);
-if (!GLOBAL) log(`commit the installed folders and .agent-docs-bootstrap so the whole team gets the same version`);
-log('restart the agent session so it picks up the new skills and subagents');
-log('start with the docs-bootstrap skill (Claude Code /docs-bootstrap, Codex $docs-bootstrap, OpenCode /docs-bootstrap)');
+if (skipped.length) {
+  console.error(`\nIncomplete: agent-docs-bootstrap ${VERSION} could not install ${skipped.length} path(s):`);
+  for (const r of skipped) console.error(`  ${r}`);
+  console.error('They hold content this kit did not write. To get this version, move or delete them, then run the installer again.');
+  process.exitCode = 1;
+} else {
+  console.log(`\nDone: agent-docs-bootstrap ${VERSION}, ${targets.join(', ')}${GLOBAL ? ' (global)' : ''}.`);
+  if (!GLOBAL) log(`commit the installed folders and .agent-docs-bootstrap so the whole team gets the same version`);
+  log('restart the agent session so it picks up the new skills and subagents');
+  log('start with the docs-bootstrap skill (Claude Code /docs-bootstrap, Codex $docs-bootstrap, OpenCode /docs-bootstrap)');
+}
 
 // ---------- rendering
 function render(target, ag, model) {
@@ -220,15 +246,22 @@ function usage(code, msg) {
   process.exit(code);
 }
 // Content hash of an installed file or folder: relative names and text with line endings normalised, so a
-// checkout with CRLF line endings still matches.
+// checkout with CRLF line endings still matches. Files the OS adds (.DS_Store, ._*, Thumbs.db, desktop.ini) are
+// left out; the kit ships none (check.mjs makes sure). The format must not change: markers and LEGACY depend on it.
 function contentHash(p) {
   const h = createHash('sha256');
   const files = fs.lstatSync(p).isDirectory() ? listFiles(p).sort() : [''];
   for (const f of files) h.update(`${f}\0${read(path.join(p, f)).replace(/\r\n/g, '\n')}\0`);
   return h.digest('hex').slice(0, 16);
 }
+// Only files the OS adds on its own. A user's own hidden file, such as .notes.md, is content and counts as a change.
+function isOsFile(name) { return /^(\.DS_Store|Thumbs\.db|desktop\.ini)$/i.test(name) || name.startsWith('._'); }
+// The same hash for text about to be written as a file.
+function textHash(text) {
+  return createHash('sha256').update(`\0${text.replace(/\r\n/g, '\n')}\0`).digest('hex').slice(0, 16);
+}
 function listFiles(dir, base = dir) {
-  return fs.readdirSync(dir, { withFileTypes: true }).flatMap(e => {
+  return fs.readdirSync(dir, { withFileTypes: true }).filter(e => !isOsFile(e.name)).flatMap(e => {
     const p = path.join(dir, e.name);
     return e.isDirectory() ? listFiles(p, base) : [path.relative(base, p).split(path.sep).join('/')];
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-docs-bootstrap",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Agent skills that build reference documentation for a codebase (glossary, ADRs, architecture, how-tos, AGENTS.md) through interviews with the team, with an optional check by a fresh agent. Works with any agent that runs skills; the installer sets up Claude Code, Codex and OpenCode.",
   "license": "MIT",
   "repository": { "type": "git", "url": "git+https://github.com/TraneDev/agent-docs-bootstrap.git" },