@hivehub/rulebook 5.4.1 → 5.5.0

package/templates/rules/rust.md

@@ -1,40 +1,40 @@
----
-paths:
-  - "**/*.rs"
-  - "Cargo.toml"
-  - "Cargo.lock"
-  - "rust-toolchain.toml"
----
-<!-- Generated by @hivehub/rulebook v5.3.0 — delete this comment to prevent regeneration on `rulebook update` -->
-
-# Rust rules
-
-Loaded by Claude Code when touching Rust sources or Cargo manifests.
-
-## Non-negotiables
-
-1. **`cargo check` before `cargo test`.** Check is 5–10x faster and surfaces type/borrow errors immediately. `cargo test` runs the checker anyway, but you lose the fast feedback loop.
-2. **`cargo clippy -- -D warnings`** must pass before committing. Warnings are errors in this project.
-3. **`cargo fmt`** before committing. Formatting is not a stylistic choice — `rustfmt` is the only authority.
-4. **No `unwrap()` / `expect()` in non-test code** unless the invariant is obvious from the surrounding 5 lines. Prefer `?` and proper error types.
-5. **No `unsafe` without a `// SAFETY:` comment** explaining why the invariants hold.
-
-## Conventions
-
-- Error types: use `thiserror` for libraries, `anyhow` for applications. Do not mix.
-- `Result<T, E>` returns on public APIs; never panic for recoverable errors.
-- `#[must_use]` on functions returning a value the caller must handle.
-- Lifetimes explicit only when the compiler asks for them. Do not add elided lifetimes "for clarity".
-- Trait bounds on the impl block, not on every method, unless they genuinely differ.
-
-## Testing
-
-- Unit tests in `#[cfg(test)] mod tests { ... }` at the bottom of the same file.
-- Integration tests in `tests/`, one file per public behavior.
-- `cargo test --all-features` is the baseline; default features may hide bugs.
-
-## Build & tooling
-
-- Never commit `target/` or `Cargo.lock` for libraries (commit for binaries).
-- Prefer `cargo add <crate>` over editing `Cargo.toml` by hand.
-- Use `cargo-watch` locally; never add watchers to CI.
+---
+paths:
+  - "**/*.rs"
+  - "Cargo.toml"
+  - "Cargo.lock"
+  - "rust-toolchain.toml"
+---
+<!-- Generated by @hivehub/rulebook v5.3.0 — delete this comment to prevent regeneration on `rulebook update` -->
+
+# Rust rules
+
+Loaded by Claude Code when touching Rust sources or Cargo manifests.
+
+## Non-negotiables
+
+1. **`cargo check` before `cargo test`.** Check is 5–10x faster and surfaces type/borrow errors immediately. `cargo test` runs the checker anyway, but you lose the fast feedback loop.
+2. **`cargo clippy -- -D warnings`** must pass before committing. Warnings are errors in this project.
+3. **`cargo fmt`** before committing. Formatting is not a stylistic choice — `rustfmt` is the only authority.
+4. **No `unwrap()` / `expect()` in non-test code** unless the invariant is obvious from the surrounding 5 lines. Prefer `?` and proper error types.
+5. **No `unsafe` without a `// SAFETY:` comment** explaining why the invariants hold.
+
+## Conventions
+
+- Error types: use `thiserror` for libraries, `anyhow` for applications. Do not mix.
+- `Result<T, E>` returns on public APIs; never panic for recoverable errors.
+- `#[must_use]` on functions returning a value the caller must handle.
+- Lifetimes explicit only when the compiler asks for them. Do not add elided lifetimes "for clarity".
+- Trait bounds on the impl block, not on every method, unless they genuinely differ.
+
+## Testing
+
+- Unit tests in `#[cfg(test)] mod tests { ... }` at the bottom of the same file.
+- Integration tests in `tests/`, one file per public behavior.
+- `cargo test --all-features` is the baseline; default features may hide bugs.
+
+## Build & tooling
+
+- Never commit `target/` or `Cargo.lock` for libraries (commit for binaries).
+- Prefer `cargo add <crate>` over editing `Cargo.toml` by hand.
+- Use `cargo-watch` locally; never add watchers to CI.

package/templates/rules/sequential-editing.md

@@ -1,21 +1,21 @@
----
-name: sequential-editing
-tier: 1
-description: "Edit files one at a time, never batch-edit"
-alwaysApply: true
-filePatterns: ["*"]
-tools: ["all"]
----
-
-# Sequential File Editing
-
-ALWAYS edit files one at a time: Read file1 → Edit file1 → Read file2 → Edit file2.
-
-NEVER batch-read multiple files then batch-edit them. By the time you edit file 3, context from file 1 may be stale.
-
-When a task touches 3+ files across subsystems:
-1. **STOP** — do not start implementing
-2. **Plan** the changes (list files, dependency order)
-3. **Decompose** into sub-tasks of 1-2 files each
-4. **Execute** sub-tasks in dependency order (upstream first)
-5. **Build/test** after each sub-task
+---
+name: sequential-editing
+tier: 1
+description: "Edit files one at a time, never batch-edit"
+alwaysApply: true
+filePatterns: ["*"]
+tools: ["all"]
+---
+
+# Sequential File Editing
+
+ALWAYS edit files one at a time: Read file1 → Edit file1 → Read file2 → Edit file2.
+
+NEVER batch-read multiple files then batch-edit them. By the time you edit file 3, context from file 1 may be stale.
+
+When a task touches 3+ files across subsystems:
+1. **STOP** — do not start implementing
+2. **Plan** the changes (list files, dependency order)
+3. **Decompose** into sub-tasks of 1-2 files each
+4. **Execute** sub-tasks in dependency order (upstream first)
+5. **Build/test** after each sub-task

package/templates/rules/session-workflow.md

@@ -1,24 +1,24 @@
----
-name: session-workflow
-tier: 2
-description: "Read PLANS.md at session start, save summary at session end"
-alwaysApply: true
-filePatterns: ["*"]
-tools: ["all"]
----
-
-# Session Workflow — Preserve Context Across Sessions
-
-## At Session Start
-1. Read `.rulebook/PLANS.md` for current context and active task
-2. Search memory for relevant past work: `rulebook_memory_search` or `rulebook_session_start`
-3. Check `.rulebook/tasks/` for pending work
-
-## During Session
-- Update PLANS.md when making key decisions or discoveries
-- Save important context to memory as you go
-
-## At Session End
-1. Save session summary to PLANS.md: `rulebook_session_end`
-2. Summary should include: what was accomplished, key decisions, next steps
-3. Update tasks.md with completed items
+---
+name: session-workflow
+tier: 2
+description: "Read PLANS.md at session start, save summary at session end"
+alwaysApply: true
+filePatterns: ["*"]
+tools: ["all"]
+---
+
+# Session Workflow — Preserve Context Across Sessions
+
+## At Session Start
+1. Read `.rulebook/PLANS.md` for current context and active task
+2. Search memory for relevant past work: `rulebook_memory_search` or `rulebook_session_start`
+3. Check `.rulebook/tasks/` for pending work
+
+## During Session
+- Update PLANS.md when making key decisions or discoveries
+- Save important context to memory as you go
+
+## At Session End
+1. Save session summary to PLANS.md: `rulebook_session_end`
+2. Summary should include: what was accomplished, key decisions, next steps
+3. Update tasks.md with completed items

package/templates/rules/task-decomposition.md

@@ -1,32 +1,32 @@
----
-name: task-decomposition
-tier: 2
-description: "Decompose multi-file tasks into 1-2 file sub-tasks"
-alwaysApply: true
-filePatterns: ["*"]
-tools: ["all"]
----
-
-# Task Decomposition
-
-When a task touches multiple subsystems, decompose into sub-tasks where each modifies **at most 1-2 files**.
-
-## Why
-
-AI agents lose accuracy when editing 3+ files in one pass. Context from earlier files gets compressed away.
-
-## Rules
-
-1. **Each sub-task modifies 1-2 files** — never more
-2. **Each sub-task is independently verifiable** — it compiles, it doesn't break existing behavior
-3. **Sub-tasks follow data flow order** — upstream first (component → buffer → renderer → shader)
-4. **Each sub-task has a clear "done when"** — not "implement X", but "field Y exists with default Z"
-5. **Build after each sub-task** — verify compilation before proceeding
-
-## When an Agent Receives a Multi-File Task
-
-1. **STOP** — do not start implementing
-2. **Create a change plan** listing all files and dependency order
-3. **Decompose** into sub-tasks following this rule
-4. **Report back** with the decomposition
-5. **Implement** one sub-task at a time
+---
+name: task-decomposition
+tier: 2
+description: "Decompose multi-file tasks into 1-2 file sub-tasks"
+alwaysApply: true
+filePatterns: ["*"]
+tools: ["all"]
+---
+
+# Task Decomposition
+
+When a task touches multiple subsystems, decompose into sub-tasks where each modifies **at most 1-2 files**.
+
+## Why
+
+AI agents lose accuracy when editing 3+ files in one pass. Context from earlier files gets compressed away.
+
+## Rules
+
+1. **Each sub-task modifies 1-2 files** — never more
+2. **Each sub-task is independently verifiable** — it compiles, it doesn't break existing behavior
+3. **Sub-tasks follow data flow order** — upstream first (component → buffer → renderer → shader)
+4. **Each sub-task has a clear "done when"** — not "implement X", but "field Y exists with default Z"
+5. **Build after each sub-task** — verify compilation before proceeding
+
+## When an Agent Receives a Multi-File Task
+
+1. **STOP** — do not start implementing
+2. **Create a change plan** listing all files and dependency order
+3. **Decompose** into sub-tasks following this rule
+4. **Report back** with the decomposition
+5. **Implement** one sub-task at a time

package/templates/rules/typescript.md

@@ -1,40 +1,40 @@
----
-paths:
-  - "**/*.ts"
-  - "**/*.tsx"
-  - "tsconfig.json"
-  - "tsconfig.*.json"
----
-<!-- Generated by @hivehub/rulebook v5.3.0 — delete this comment to prevent regeneration on `rulebook update` -->
-
-# TypeScript rules
-
-Loaded by Claude Code when touching TypeScript files. Keeps guidance focused so the main `CLAUDE.md` stays small.
-
-## Non-negotiables
-
-1. **Type-check before test.** Run the project's `type-check` (usually `tsc --noEmit` or `npm run type-check`) before running the test suite. A type error is a faster, cheaper signal than a test failure.
-2. **No `any`** unless the value is genuinely untyped (e.g. `JSON.parse` output before validation). Prefer `unknown` with a narrowing step.
-3. **No `// @ts-ignore` / `// @ts-expect-error`** without a one-line comment explaining why. If you can fix the type, fix it.
-4. **Strict null checks.** Treat `undefined` and `null` as distinct. Use optional chaining (`?.`) and nullish coalescing (`??`), not `||`, for "value might be absent" logic.
-5. **ESM everywhere.** Use `import`/`export`, not `require`. Relative imports include the `.js` extension (Node ESM rule) even when the source file is `.ts`.
-
-## Conventions
-
-- Public API types live next to their implementation. Large shared types go in `src/types.ts` or `src/types/`.
-- Interfaces for object shapes, `type` aliases for unions and mapped types.
-- `readonly` wherever mutation is not required.
-- Exhaustive `switch` on union types uses a `const _exhaustive: never = x;` tail.
-- Async functions return `Promise<T>` explicitly on public APIs.
-
-## Testing
-
-- Use the project's configured test runner (Vitest, Jest, Node test) — do not add a new one.
-- Mock at the module boundary, not inside the unit under test.
-- Every `describe` has at least one `it`; no empty test blocks.
-
-## Build & tooling
-
-- Never commit `dist/`, `build/`, `.tsbuildinfo`, or `node_modules/`.
-- `tsconfig.json` is the source of truth for compiler options. Do not override via inline comments unless explicitly required.
-- Prefer `tsx` / `ts-node` for scripts; never shell-execute a raw `.ts` file in production.
+---
+paths:
+  - "**/*.ts"
+  - "**/*.tsx"
+  - "tsconfig.json"
+  - "tsconfig.*.json"
+---
+<!-- Generated by @hivehub/rulebook v5.3.0 — delete this comment to prevent regeneration on `rulebook update` -->
+
+# TypeScript rules
+
+Loaded by Claude Code when touching TypeScript files. Keeps guidance focused so the main `CLAUDE.md` stays small.
+
+## Non-negotiables
+
+1. **Type-check before test.** Run the project's `type-check` (usually `tsc --noEmit` or `npm run type-check`) before running the test suite. A type error is a faster, cheaper signal than a test failure.
+2. **No `any`** unless the value is genuinely untyped (e.g. `JSON.parse` output before validation). Prefer `unknown` with a narrowing step.
+3. **No `// @ts-ignore` / `// @ts-expect-error`** without a one-line comment explaining why. If you can fix the type, fix it.
+4. **Strict null checks.** Treat `undefined` and `null` as distinct. Use optional chaining (`?.`) and nullish coalescing (`??`), not `||`, for "value might be absent" logic.
+5. **ESM everywhere.** Use `import`/`export`, not `require`. Relative imports include the `.js` extension (Node ESM rule) even when the source file is `.ts`.
+
+## Conventions
+
+- Public API types live next to their implementation. Large shared types go in `src/types.ts` or `src/types/`.
+- Interfaces for object shapes, `type` aliases for unions and mapped types.
+- `readonly` wherever mutation is not required.
+- Exhaustive `switch` on union types uses a `const _exhaustive: never = x;` tail.
+- Async functions return `Promise<T>` explicitly on public APIs.
+
+## Testing
+
+- Use the project's configured test runner (Vitest, Jest, Node test) — do not add a new one.
+- Mock at the module boundary, not inside the unit under test.
+- Every `describe` has at least one `it`; no empty test blocks.
+
+## Build & tooling
+
+- Never commit `dist/`, `build/`, `.tsbuildinfo`, or `node_modules/`.
+- `tsconfig.json` is the source of truth for compiler options. Do not override via inline comments unless explicitly required.
+- Prefer `tsx` / `ts-node` for scripts; never shell-execute a raw `.ts` file in production.