@codewizard-dt/bootstrap 6.1.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/scripts/README.md
CHANGED
|
@@ -21,7 +21,7 @@ All scripts use `set -euo pipefail`. Every script that touches a target project
|
|
|
21
21
|
|--------|---------|---------|
|
|
22
22
|
| `lib.sh` | Every script above | Shared bash library: `resolve_project_dir` (path resolution + validation), `mcp_installed`/`serena_installed`/`detect_installed_mcps` (MCP state checks), `run_project_sync` (the common setup/update sequence: `install-global.sh --skip-mcps` first — hooks/skills/deny-list/hooks-wiring/fileSuggestion, offline-safe — then the guarded interactive MCP install, wiki scaffold, gitignore, the wiki-alias backfill, Obsidian, MCP-tools guide, Serena bootstrap), and `prompt_yn`/`prompt_scope` (interactive prompt helpers). |
|
|
23
23
|
| `install-mcps.sh` | `install-global.sh`, `setup-project.sh`, `update-project.sh` | Installs Brave Search, Context7, Playwright, and (when a project dir is given) Serena. Two modes: non-interactive (`install-global.sh`'s default — installs everything missing at user scope) and `--interactive --project-dir <dir>` (prompts per-MCP and asks for scope, used by `setup`/`update`). Playwright has a dedicated conflict flow: registered as `playwright` (user scope) by default; when a project ships its own `playwright`, a git-tracked `.mcp.json` is never modified (interactive options: register ours as `playwright-shared` + disable the project entry machine-locally via `disabledMcpjsonServers` in `.claude/settings.local.json` / register alongside / skip), while a machine-local registration can be replaced or kept (ours then uses the alternate name). Non-interactive conflicts are left untouched with a hint. |
|
|
24
|
-
| `sync-wiki-scaffold.sh` | `setup-project.sh`, `update-project.sh`, `migrate-project.sh` | Scaffolds an **empty** wiki into the target project from `templates/wiki/`: creates `raw/` + all `wiki/` family directories, lifecycle docs, per-family `index.md`, and stub `index.md`/`log.md`. Copy-once for project-owned files; always-refreshes `conventions.md` and `lifecycle.md`. Delivers guides from `raw/guides/` tier-wise into `wiki/guides/`: `command-anti-patterns.md` required (always refreshed); `evals-framework.md` + `type-checking-templates/` optional (`--interactive` prompts on first delivery, sticky refresh once present — legacy `.docs/guides/` presence counts, opt out by deleting); migrates legacy `.docs/guides/` (template-owned files removed or relocated, deprecated `task-spec.md` deleted, empty dirs pruned). Also delivers the `## LLM Wiki` section and `.env` safety policy (copy-once, sentinel-guarded, from `templates/CLAUDE-wiki.md` / `templates/CLAUDE-env-safety.md`) into the target's **`CLAUDE.local.md` by default** (machine-local; a missing `CLAUDE.md` is no longer created for it, and `merge-gitignore.sh` adds `CLAUDE.local.md` to `.git/info/exclude`) — when a `CLAUDE.md` already exists without the schema, interactive runs may opt into appending to it instead (default answer: no → `CLAUDE.local.md`). |
|
|
24
|
+
| `sync-wiki-scaffold.sh` | `setup-project.sh`, `update-project.sh`, `migrate-project.sh` | Scaffolds an **empty** wiki into the target project from `templates/wiki/`: creates `raw/` + all `wiki/` family directories, lifecycle docs, per-family `index.md`, and stub `index.md`/`log.md`. Copy-once for project-owned files; always-refreshes `conventions.md` and `lifecycle.md`. Delivers guides from `raw/guides/` tier-wise into `wiki/guides/`: `command-anti-patterns.md` required (always refreshed); `evals-framework.md` + `type-checking-templates/` optional (`--interactive` prompts on first delivery, sticky refresh once present — legacy `.docs/guides/` presence counts, opt out by deleting); migrates legacy `.docs/guides/` (template-owned files removed or relocated, deprecated `task-spec.md` deleted, empty dirs pruned). Also delivers the `## LLM Wiki` section and `.env` safety policy (copy-once, sentinel-guarded, from `templates/CLAUDE-wiki.md` / `templates/CLAUDE-env-safety.md`) into the target's **`CLAUDE.local.md` by default** (machine-local; a missing `CLAUDE.md` is no longer created for it, and `merge-gitignore.sh` adds `CLAUDE.local.md` to `.git/info/exclude`) — when a `CLAUDE.md` already exists without the schema, interactive runs may opt into appending to it instead (default answer: no → `CLAUDE.local.md`). Step 8 then appends the `## Prose Output Style` section (copy-once, sentinel-guarded, from `templates/CLAUDE-prose-style.md`) to the same file. |
|
|
25
25
|
| `build-mcp-guide.sh` | `setup-project.sh`, `update-project.sh`, `migrate-project.sh` | Assembles `wiki/guides/mcp-tools.md` in the target project from the per-server stub files in `templates/guides/stubs/`, including only the sections for MCPs actually installed. |
|
|
26
26
|
| `bootstrap-serena.sh` | `setup-project.sh`, `update-project.sh` | Headlessly triggers `.serena/project.yml` creation via `claude --print` and enables the optional Serena tools needed by this template's workflow. Preflights `claude` and `python3`. |
|
|
27
27
|
| `rename-wiki-ids.js` | `migrate-project.sh` (invoked via `node`; `--count` and `--dry-run` for the preflight/preview) | Zero-dependency Node script that renames `DEC-NNNN` → `ADR-NNNN` (`wiki/work/decisions/`) and `REQ-NNNN` → `PRD-NNNN` (`wiki/work/requirements/`) in an existing wiki: renames the files (active + `archive/`; `git mv` when tracked, plain rename otherwise), rewrites every reference to a renamed ID in `wiki/**/*.md` (`id:`, `[[…]]` links with `#DM` anchors, typed links, link text and relative link targets), keeps the old ID as an alias on each renamed file, and appends one entry to `wiki/log.md`. Only IDs that belong to a renamed file are rewritten, so look-alike text (e.g. a PRD's own "REQ-1 … REQ-2" list) is left alone; existing log entries and `raw/` are never edited. Idempotent; exits 1 without changing anything if a target name already exists. Unlike `backfill-wiki-aliases.js`, failures are not swallowed — it is an explicit command. Renamed skill names mentioned in prose are not rewritten. |
|
|
@@ -240,4 +240,23 @@ if [ -f "$ENV_TEMPLATE" ] && [ -f "$SCHEMA_FILE" ]; then
|
|
|
240
240
|
fi
|
|
241
241
|
fi
|
|
242
242
|
|
|
243
|
+
# 8. Append the prose-style guidelines to the same file that holds the wiki
|
|
244
|
+
# schema (copy-once). Sentinel: a line starting with "## Prose Output Style",
|
|
245
|
+
# checked in BOTH files so the section is never duplicated across them.
|
|
246
|
+
PROSE_TEMPLATE="$SCRIPT_DIR/templates/CLAUDE-prose-style.md"
|
|
247
|
+
if [ -f "$PROSE_TEMPLATE" ] && [ -f "$SCHEMA_FILE" ]; then
|
|
248
|
+
if { [ -f "$TARGET_CLAUDE" ] && grep -q '^## Prose Output Style' "$TARGET_CLAUDE"; } \
|
|
249
|
+
|| { [ -f "$TARGET_LOCAL" ] && grep -q '^## Prose Output Style' "$TARGET_LOCAL"; }; then
|
|
250
|
+
echo "$(basename "$SCHEMA_FILE") already has the Prose Output Style section, skipping."
|
|
251
|
+
else
|
|
252
|
+
{
|
|
253
|
+
echo ""
|
|
254
|
+
echo "---"
|
|
255
|
+
echo ""
|
|
256
|
+
cat "$PROSE_TEMPLATE"
|
|
257
|
+
} >> "$SCHEMA_FILE"
|
|
258
|
+
echo "Prose Output Style section appended to $(basename "$SCHEMA_FILE")."
|
|
259
|
+
fi
|
|
260
|
+
fi
|
|
261
|
+
|
|
243
262
|
echo "Wiki scaffold synced."
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## Prose Output Style
|
|
2
|
+
|
|
3
|
+
Write for a technically proficient software engineer. Priorities, in order: clarity, completeness, brevity. Minimize cognitive load, not word count.
|
|
4
|
+
|
|
5
|
+
**Substance**
|
|
6
|
+
- Lead with the answer. Add context, constraints, tradeoffs, risks and caveats only where they change what the reader does.
|
|
7
|
+
- Separate facts from assumptions, and flag meaningful uncertainty.
|
|
8
|
+
- Assume competence: use standard terminology without explaining familiar concepts.
|
|
9
|
+
- Favor actionable guidance and concrete detail (numbers, named tools, file paths, measurable outcomes) over abstract claims.
|
|
10
|
+
- Explain a decision only when the choice is non-obvious or alternatives matter.
|
|
11
|
+
- Match depth to complexity: short answers for simple questions, full explanation for complex ones.
|
|
12
|
+
|
|
13
|
+
**Form**
|
|
14
|
+
- Short paragraphs. Use lists, tables or code blocks only when they aid comprehension.
|
|
15
|
+
- Headings and titles are direct one-liners under 10 words that state the actual point. No colon-split titles ("Topic: Why X Wins").
|
|
16
|
+
- No emojis. No em dashes; use commas or periods.
|
|
17
|
+
- Vary sentence openings; do not start consecutive sentences with the same word or phrase.
|
|
18
|
+
- State ideas directly. Avoid "X, not Y" and other contrastive or antithetical framing.
|
|
19
|
+
- Avoid rhetorical rhythm (stacked clauses, speech-like cadence, motivational tone).
|
|
20
|
+
- Cut hype and filler: unlock, leverage, harness, democratize, elevate, revolutionize, transform, embrace, unleash, delve, cutting-edge, game changer, powerful, and similar words that vanish without changing the meaning.
|
|
21
|
+
|
|
22
|
+
**Final check:** the answer is immediately understandable, has all necessary information, and cannot be shortened without losing clarity or completeness.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codewizard-dt/bootstrap",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.2.0",
|
|
4
4
|
"description": "Bootstrap Claude Code projects with an LLM Wiki, reusable skills, hooks, and MCP setup",
|
|
5
5
|
"homepage": "https://github.com/codewizard-dt/bootstrap-wiki#readme",
|
|
6
6
|
"bugs": {
|