@hivehub/rulebook 5.5.2 → 5.8.0

package/templates/hooks/update-check.sh

@@ -0,0 +1,103 @@
+#!/usr/bin/env bash
+# Claude Code SessionStart hook — rulebook update check.
+#
+# Compares the project's installed rulebook version (.rulebook/rulebook.json
+# → version) against the latest published @hivehub/rulebook on npm. When a
+# newer version exists, emits an additionalContext advisory so Claude can
+# offer to run `rulebook update`. The npm lookup is cached for 24h in
+# .rulebook/.update-check to keep session start fast and offline-friendly.
+#
+# Emits `{}` (no-op) on any of: no config, no network/npm, already current,
+# cache still fresh with no known update, or any error. Never blocks startup.
+
+set -euo pipefail
+
+# --- Resolve project root (from stdin JSON cwd, else env, else pwd) ----------
+input="$(cat || true)"
+PROJECT_ROOT=""
+if [[ -n "$input" ]] && command -v jq &>/dev/null; then
+  PROJECT_ROOT="$(printf '%s' "$input" | jq -r '.cwd // empty' 2>/dev/null || true)"
+fi
+[[ -z "$PROJECT_ROOT" ]] && PROJECT_ROOT="${CLAUDE_PROJECT_DIR:-$(pwd)}"
+
+CONFIG_FILE="${PROJECT_ROOT}/.rulebook/rulebook.json"
+CACHE_FILE="${PROJECT_ROOT}/.rulebook/.update-check"
+PKG="@hivehub/rulebook"
+CACHE_TTL=86400 # 24h in seconds
+
+emit_none() { printf '%s' '{}'; exit 0; }
+
+# Need jq + a config to do anything useful.
+command -v jq &>/dev/null || emit_none
+[[ -f "$CONFIG_FILE" ]] || emit_none
+
+installed="$(jq -r '.version // empty' "$CONFIG_FILE" 2>/dev/null || true)"
+[[ -z "$installed" ]] && emit_none
+
+# Allow opt-out via config: { "updateCheck": { "enabled": false } }.
+# Note: jq's `//` treats `false` as empty, so `.updateCheck.enabled // true`
+# would wrongly yield true when explicitly disabled — test the value directly.
+enabled="$(jq -r 'if .updateCheck.enabled == false then "false" else "true" end' "$CONFIG_FILE" 2>/dev/null || echo true)"
+[[ "$enabled" == "false" ]] && emit_none
+
+# --- Determine latest version (cache-first) ---------------------------------
+now="$(date -u +%s)"
+latest=""
+cache_ts=0
+if [[ -f "$CACHE_FILE" ]]; then
+  cache_ts="$(jq -r '.checkedAt // 0' "$CACHE_FILE" 2>/dev/null || echo 0)"
+  latest="$(jq -r '.latest // empty' "$CACHE_FILE" 2>/dev/null || true)"
+fi
+
+age=$(( now - cache_ts ))
+if [[ -z "$latest" || "$age" -ge "$CACHE_TTL" ]]; then
+  # Cache miss or stale — query npm with a hard timeout so startup never hangs.
+  fetched=""
+  if command -v npm &>/dev/null; then
+    if command -v timeout &>/dev/null; then
+      fetched="$(timeout 5 npm view "$PKG" version 2>/dev/null || true)"
+    else
+      fetched="$(npm view "$PKG" version 2>/dev/null || true)"
+    fi
+  fi
+  if [[ -n "$fetched" ]]; then
+    latest="$fetched"
+    # Refresh cache (best-effort; ignore write failures).
+    jq -nc --arg l "$latest" --argjson t "$now" \
+      '{latest: $l, checkedAt: $t}' > "$CACHE_FILE" 2>/dev/null || true
+  fi
+fi
+
+# No latest resolved (offline / first run with no network) — no-op.
+[[ -z "$latest" ]] && emit_none
+
+# --- Compare semver (numeric major.minor.patch, ignoring pre-release) -------
+ver_gt() {
+  # returns 0 (true) if $1 > $2
+  local a="${1%%-*}" b="${2%%-*}"
+  local IFS=.
+  # shellcheck disable=SC2206
+  local A=($a) B=($b)
+  for i in 0 1 2; do
+    local ai="${A[i]:-0}" bi="${B[i]:-0}"
+    # Strip non-numeric just in case.
+    ai="${ai//[!0-9]/}"; bi="${bi//[!0-9]/}"
+    ai="${ai:-0}"; bi="${bi:-0}"
+    if (( ai > bi )); then return 0; fi
+    if (( ai < bi )); then return 1; fi
+  done
+  return 1
+}
+
+if ver_gt "$latest" "$installed"; then
+  ctx="## Rulebook update available\n\nThis project is on rulebook **${installed}**, but **${latest}** is published on npm.\n\nAsk the user whether they want to update. If they agree, run \`rulebook update\` (or \`npx ${PKG}@latest update\`) to regenerate the rules to the latest version, then review the diff before committing. Do not update without the user's confirmation."
+  jq -nc --arg ctx "$ctx" '{
+    hookSpecificOutput: {
+      hookEventName: "SessionStart",
+      additionalContext: $ctx
+    }
+  }'
+  exit 0
+fi
+
+emit_none

package/templates/ides/CONTINUE_RULES.md

@@ -1,16 +1,16 @@
-<!-- RULEBOOK:START -->
-# Continue.dev — Code Assistant Rules
-
-## Context Loading
-- Always read AGENTS.md before making changes
-- Check `.rulebook/specs/` for relevant spec files
-
-## Code Standards
-- Match existing code style and conventions
-- Prefer editing existing files over creating new ones
-- Add types for all new parameters and return values
-
-## Testing
-- Write tests for every new function
-- Run existing tests after changes to verify no regressions
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Continue.dev — Code Assistant Rules
+
+## Context Loading
+- Always read AGENTS.md before making changes
+- Check `.rulebook/specs/` for relevant spec files
+
+## Code Standards
+- Match existing code style and conventions
+- Prefer editing existing files over creating new ones
+- Add types for all new parameters and return values
+
+## Testing
+- Write tests for every new function
+- Run existing tests after changes to verify no regressions
+<!-- RULEBOOK:END -->

package/templates/ides/COPILOT_INSTRUCTIONS.md

@@ -1,23 +1,23 @@
-<!-- RULEBOOK:START -->
-# GitHub Copilot — Project Instructions
-
-## Code Style
-- Use TypeScript with strict mode
-- Follow existing naming conventions (camelCase functions, PascalCase classes)
-- Prefer `async/await` over callbacks or raw Promises
-
-## Architecture
-- Follow the module structure described in AGENTS.md
-- Keep functions small and focused (single responsibility)
-- Use dependency injection over direct imports where possible
-
-## Testing
-- Write Vitest tests for all new functions
-- Place tests in `tests/` directory, not alongside source files
-- Mock external dependencies in unit tests
-
-## Security
-- Never commit credentials or API keys
-- Validate all external input at system boundaries
-- Follow OWASP top 10 guidelines
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# GitHub Copilot — Project Instructions
+
+## Code Style
+- Use TypeScript with strict mode
+- Follow existing naming conventions (camelCase functions, PascalCase classes)
+- Prefer `async/await` over callbacks or raw Promises
+
+## Architecture
+- Follow the module structure described in AGENTS.md
+- Keep functions small and focused (single responsibility)
+- Use dependency injection over direct imports where possible
+
+## Testing
+- Write Vitest tests for all new functions
+- Place tests in `tests/` directory, not alongside source files
+- Mock external dependencies in unit tests
+
+## Security
+- Never commit credentials or API keys
+- Validate all external input at system boundaries
+- Follow OWASP top 10 guidelines
+<!-- RULEBOOK:END -->

package/templates/ides/GEMINI_RULES.md

@@ -1,17 +1,17 @@
-<!-- RULEBOOK:START -->
-# Gemini CLI — Project Directives
-
-## Code Generation Rules
-- Generate TypeScript with strict mode enabled
-- Follow existing file and function naming conventions
-- Always add error handling for async operations
-- Generate tests alongside implementation code
-
-## Quality Standards
-- All code must pass TypeScript type-check
-- All code must pass ESLint without warnings
-- Test coverage must meet project thresholds
-
-## Project Context
-See AGENTS.md for full project architecture and team conventions.
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Gemini CLI — Project Directives
+
+## Code Generation Rules
+- Generate TypeScript with strict mode enabled
+- Follow existing file and function naming conventions
+- Always add error handling for async operations
+- Generate tests alongside implementation code
+
+## Quality Standards
+- All code must pass TypeScript type-check
+- All code must pass ESLint without warnings
+- Test coverage must meet project thresholds
+
+## Project Context
+See AGENTS.md for full project architecture and team conventions.
+<!-- RULEBOOK:END -->

package/templates/ides/OPENCODE.md

@@ -0,0 +1,63 @@
+<!-- OPENCODE:START -->
+# OpenCode Integration
+
+This project is managed by [@hivellm/rulebook](https://github.com/hivellm/rulebook).
+The OpenCode integration mirrors the Claude Code experience inside the
+[OpenCode](https://opencode.ai) terminal coding agent.
+
+## What Rulebook generates for OpenCode
+
+| File / Path | Purpose |
+|---|---|
+| `opencode.json` | Adds `$schema`, `mcp.rulebook`, and `instructions` (lazy-loads `AGENTS.md`, `AGENTS.override.md`, `.rulebook/specs/*.md`). Preserves all user-defined keys. |
+| `.opencode/commands/<name>.md` | One file per user-invocable Rulebook slash command. |
+| `.opencode/agents/<role>.md` | One file per Rulebook role agent, frontmatter translated. |
+| `.opencode/skills/<name>/SKILL.md` | One directory per Rulebook dev skill, name-normalized to OpenCode's regex. |
+| `.opencode/.rulebook-managed.json` | Sidecar so `rulebook update` knows which keys to refresh. |
+
+## Critical rules
+
+These mirror the rules every other Rulebook-supported tool follows:
+
+1. **Read `AGENTS.md` and `AGENTS.override.md`** before making changes.
+2. **Never revert or discard uncommitted work** — fix forward.
+3. **Edit files sequentially**, not in parallel. For 3+ files, decompose
+   into 1–2 file sub-tasks.
+4. **Run type-check / lint before tests** — diagnostic-first.
+5. **If a fix fails twice, escalate** — research, ask, or open a team.
+6. **Prefer MCP tools** (`mcp__rulebook__*`) over shell commands.
+7. **Capture learnings** at the end of significant work.
+8. **Never archive a task** without docs updated, tests written, and
+   tests passing.
+
+## Model tier mapping
+
+| Rulebook tier | OpenCode model |
+|---|---|
+| `haiku` | `anthropic/claude-haiku-4-5` |
+| `sonnet` | `anthropic/claude-sonnet-4-6` |
+| `opus` | `anthropic/claude-opus-4-7` |
+
+## Permission synthesis
+
+| Role type | `permission.edit` | `permission.bash` |
+|---|---|---|
+| Read-only (researcher, code-reviewer, security-reviewer, accessibility-reviewer, ux-reviewer, performance-engineer) | `deny` | `ask` |
+| All other roles | `allow` | `allow` |
+
+## Isolation
+
+Set `OPENCODE_DISABLE_CLAUDE_CODE=*` if you want OpenCode to ignore a
+`CLAUDE.md` shared with Claude Code, so only `AGENTS.md` is consulted.
+
+## Documentation
+
+- [opencode.ai/docs/rules](https://opencode.ai/docs/rules/)
+- [opencode.ai/docs/config](https://opencode.ai/docs/config/)
+- [opencode.ai/docs/mcp-servers](https://opencode.ai/docs/mcp-servers/)
+- [opencode.ai/docs/commands](https://opencode.ai/docs/commands/)
+- [opencode.ai/docs/agents](https://opencode.ai/docs/agents/)
+- [opencode.ai/docs/skills](https://opencode.ai/docs/skills/)
+- [opencode.ai/docs/permissions](https://opencode.ai/docs/permissions/)
+
+<!-- OPENCODE:END -->

package/templates/ides/WINDSURF_RULES.md

@@ -1,14 +1,14 @@
-<!-- RULEBOOK:START -->
-# Windsurf — Project Rules
-
-You are an AI assistant for this project. Follow these rules:
-
-1. Read AGENTS.md for full project context before starting any task
-2. Never create files in the root unless explicitly asked
-3. All TypeScript must be strict-mode compatible
-4. Write tests for new functionality
-5. Run quality checks before marking work complete
-
-## Project Structure
-Follow the existing directory structure. See AGENTS.md for details.
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Windsurf — Project Rules
+
+You are an AI assistant for this project. Follow these rules:
+
+1. Read AGENTS.md for full project context before starting any task
+2. Never create files in the root unless explicitly asked
+3. All TypeScript must be strict-mode compatible
+4. Write tests for new functionality
+5. Run quality checks before marking work complete
+
+## Project Structure
+Follow the existing directory structure. See AGENTS.md for details.
+<!-- RULEBOOK:END -->