@hivehub/rulebook 5.5.2 → 5.7.0

package/templates/frameworks/SPRING.md

@@ -1,39 +0,0 @@
-<!-- SPRING:START -->
-# Spring Boot Framework Rules
-
-**CRITICAL**: Every Spring service must satisfy these quality gates before merge.
-
-## Build & Quality Commands
-- Lint/format: `./gradlew checkstyleMain` or `mvn verify`
-- Unit tests: `./gradlew test` or `mvn test`
-- Integration tests: `./gradlew integrationTest` (if module exists)
-- Static analysis: `./gradlew jacocoTestReport` to ensure 80%+ coverage
-
-## Project Structure
-- Keep domain logic in `src/main/java/.../service`
-- Expose REST controllers in `controller` packages
-- Isolate configuration classes under `config`
-- Share DTOs via `dto` package and map with MapStruct where applicable
-
-## Implementation Guidelines
-- Manage configuration with `application.yml` profiles (dev/test/prod)
-- Prefer constructor injection, avoid `@Autowired` field injection
-- Wrap transactional operations with `@Transactional`
-- Use `ResponseEntity` for explicit HTTP semantics
-- Validate inputs using `javax.validation` annotations and `@Valid`
-
-## Build Matrix
-```bash
-# Gradle
-./gradlew clean check
-
-# Maven
-mvn -B clean verify
-```
-
-## Additional Checks
-- Ensure `application.yml` contains defaults for new properties
-- Update Flyway/Liquibase migrations when schema changes
-- Keep `README` and `/docs/architecture.md` synced with new services
-
-<!-- SPRING:END -->

package/templates/frameworks/SYMFONY.md

@@ -1,36 +0,0 @@
-<!-- SYMFONY:START -->
-# Symfony Framework Rules
-
-**Language**: PHP  
-**Version**: Symfony 6.0+ or 7.0+
-
-## Setup
-
-```yaml
-# config/packages/framework.yaml
-framework:
-    secret: '%env(APP_SECRET)%'
-    csrf_protection: true
-```
-
-## Quality Gates
-
-```bash
-php bin/console lint:twig templates/
-php bin/console lint:yaml config/
-vendor/bin/phpstan analyze src tests
-vendor/bin/phpunit
-```
-
-## Best Practices
-
-✅ Use dependency injection  
-✅ Follow PSR standards  
-✅ Use Doctrine ORM  
-✅ Implement security voters  
-
-❌ Don't bypass security  
-❌ Don't hardcode routes  
-
-<!-- SYMFONY:END -->
-

package/templates/frameworks/VUE.md

@@ -1,36 +0,0 @@
-<!-- VUE:START -->
-# Vue Framework Rules
-
-**CRITICAL**: Vue 3 projects should follow these guardrails.
-
-## Quality Commands
-- Lint: `npm run lint`
-- Unit tests: `npm run test:unit`
-- e2e tests (Cypress/Playwright): `npm run test:e2e`
-- Build: `npm run build`
-
-## Project Structure
-- Place feature modules in `src/modules/<feature>/`
-- Keep reusable components in `src/components`
-- Shared composables go in `src/composables`
-- Centralize Pinia/Vuex stores under `src/stores`
-
-## Implementation Guidelines
-- Adopt `<script setup>` with TypeScript and define props via `defineProps`
-- Leverage `defineEmits` for typed event emission
-- Lazy-load routes with dynamic imports in `router/index.ts`
-- Ensure global styles scoped via `:global` or dedicated CSS files
-
-## Pre-Commit Commands
-```bash
-npm run lint
-npm run test:unit
-npm run build
-```
-
-## Documentation
-- Update `/docs/vue-architecture.md` with module tree changes
-- Document composables in `/docs/composables.md`
-- Add component usage examples to `/docs/ui-components.md`
-
-<!-- VUE:END -->

package/templates/frameworks/ZEND.md

@@ -1,35 +0,0 @@
-<!-- ZEND:START -->
-# Zend/Laminas Framework Rules
-
-**Language**: PHP  
-**Version**: Laminas MVC 3.x+
-
-## Setup
-
-```php
-// config/modules.config.php
-return [
-    'Laminas\Router',
-    'Application',
-];
-```
-
-## Quality Gates
-
-```bash
-vendor/bin/phpcs --standard=PSR12 src/
-vendor/bin/phpstan analyze
-vendor/bin/phpunit
-```
-
-## Best Practices
-
-✅ Use service manager  
-✅ Implement middleware  
-✅ Use form validation  
-
-❌ Don't skip CSRF tokens  
-❌ Don't expose errors in production  
-
-<!-- ZEND:END -->
-

package/templates/hooks/enforce-mcp-for-tasks.sh

@@ -1,31 +0,0 @@
-#!/usr/bin/env bash
-# PreToolUse hook: deny manual task file creation — must use MCP tools
-set -euo pipefail
-input="$(cat)"
-
-result="$(node -e "
-const input = JSON.parse(process.argv[1]);
-const tool = input.tool_name || '';
-if (tool === 'Write' || tool === 'Edit') {
-  const file = input.tool_input?.file_path || input.tool_input?.filePath || '';
-  // Block creating new proposal.md or .metadata.json in tasks/
-  if (/\.rulebook\/tasks\/[^/]+\/(proposal\.md|\.metadata\.json)$/.test(file.replace(/\\\\/g,'/'))) {
-    // Allow if editing existing file
-    try { require('fs').accessSync(file); console.log('ALLOW'); } catch { console.log('DENY'); }
-    process.exit(0);
-  }
-} else if (tool === 'Bash') {
-  const cmd = input.tool_input?.command || '';
-  if (/mkdir.*\.rulebook\/tasks\//.test(cmd) || /mkdir.*\.rulebook\\\\tasks\\\\/.test(cmd)) {
-    console.log('DENY');
-    process.exit(0);
-  }
-}
-console.log('ALLOW');
-" "$input" 2>/dev/null || echo "ALLOW")"
-
-if [[ "$result" == "DENY" ]]; then
-  echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"deny","permissionDecisionReason":"DENIED: task files must be created via rulebook_task_create MCP tool, not manually. Use: rulebook_task_create({ taskId: phase1_your-task-name })"}}'
-else
-  echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"allow"}}'
-fi

package/templates/hooks/enforce-no-deferred.sh

@@ -1,21 +0,0 @@
-#!/usr/bin/env bash
-# PreToolUse hook: deny deferred/TODO/skip items in tasks.md
-set -euo pipefail
-input="$(cat)"
-
-# Parse JSON with node (jq may not be available on Windows)
-result="$(node -e "
-const input = JSON.parse(process.argv[1]);
-const tool = input.tool_name || '';
-if (tool !== 'Edit' && tool !== 'Write') { console.log('ALLOW'); process.exit(0); }
-const file = input.tool_input?.file_path || input.tool_input?.filePath || '';
-if (!file.endsWith('tasks.md')) { console.log('ALLOW'); process.exit(0); }
-const content = input.tool_input?.new_string || input.tool_input?.content || '';
-if (/\b(deferred|skip(ped)?|later|todo)\b/i.test(content)) { console.log('DENY'); } else { console.log('ALLOW'); }
-" "$input" 2>/dev/null || echo "ALLOW")"
-
-if [[ "$result" == "DENY" ]]; then
-  echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"deny","permissionDecisionReason":"DENIED: tasks.md cannot contain deferred, skip, later, or TODO. Implement the item now or explain why impossible. See .claude/rules/no-deferred.md"}}'
-else
-  echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"allow"}}'
-fi

package/templates/hooks/enforce-no-shortcuts.sh

@@ -1,31 +0,0 @@
-#!/usr/bin/env bash
-# PreToolUse hook: deny stubs, TODOs, placeholders in source code
-set -euo pipefail
-input="$(cat)"
-
-result="$(node -e "
-const input = JSON.parse(process.argv[1]);
-const tool = input.tool_name || '';
-if (tool !== 'Edit' && tool !== 'Write') { console.log('ALLOW'); process.exit(0); }
-const file = input.tool_input?.file_path || input.tool_input?.filePath || '';
-// Only check source files
-if (!/\.(ts|tsx|js|jsx|py|rs|go|java|cs|cpp|c|hpp|h)$/.test(file)) { console.log('ALLOW'); process.exit(0); }
-// Skip test files
-if (/\.test\.|\.spec\.|__tests__|\/tests\//.test(file)) { console.log('ALLOW'); process.exit(0); }
-const content = input.tool_input?.new_string || input.tool_input?.content || '';
-if (/\/\/\s*(TODO|FIXME|HACK)\b|\/\*\s*(TODO|FIXME|HACK)\b|#\s*(TODO|FIXME|HACK)\b/.test(content)) { console.log('DENY_TODO'); process.exit(0); }
-if (/\bplaceholder\b|\bstub\b/i.test(content)) { console.log('DENY_STUB'); process.exit(0); }
-console.log('ALLOW');
-" "$input" 2>/dev/null || echo "ALLOW")"
-
-case "$result" in
-  DENY_TODO)
-    echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"deny","permissionDecisionReason":"DENIED: source code cannot contain // TODO, // FIXME, or // HACK. Implement the logic now. See .claude/rules/no-shortcuts.md"}}'
-    ;;
-  DENY_STUB)
-    echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"deny","permissionDecisionReason":"DENIED: source code cannot contain placeholders or stubs. Implement real logic. See .claude/rules/no-shortcuts.md"}}'
-    ;;
-  *)
-    echo '{"hookSpecificOutput":{"hookEventName":"PreToolUse","permissionDecision":"allow"}}'
-    ;;
-esac

package/templates/ides/COPILOT.md

@@ -1,37 +0,0 @@
-<!-- COPILOT:START -->
-# GitHub Copilot Rules
-
-**Tool**: GitHub's AI pair programmer (inline + chat)
-
-## Quick Start
-
-Copilot reads:
-- `.github/copilot-instructions.md` (generated by `rulebook init`)
-- Workspace context (open files)
-
-## Usage
-
-```bash
-# In Copilot Chat:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Inline suggestions:
-Accept/reject based on AGENTS.md standards
-```
-
-## Modes
-
-**Inline Completions**: Context-aware suggestions while typing
-**Copilot Chat**: Ask questions, request implementations
-**Workspace Agent** (Labs): Multi-file autonomous mode
-
-## Workflow
-
-1. Rulebook generates `.github/copilot-instructions.md` → references AGENTS.md
-2. Keep AGENTS.md open for context
-3. Use `@workspace` to include project context
-4. Reference `@AGENTS.md` explicitly in chat
-
-**Critical**: Generated `copilot-instructions.md` points Copilot to AGENTS.md standards.
-
-<!-- COPILOT:END -->

package/templates/ides/CURSOR.md

@@ -1,43 +0,0 @@
-<!-- CURSOR:START -->
-# Cursor IDE Rules
-
-**IDE**: AI-first code editor with Agent mode and Composer
-
-## Quick Start
-
-Cursor automatically reads:
-- `.cursorrules` (generated by `rulebook init`)
-- `AGENTS.md` (via `@AGENTS.md` references)
-
-## Usage
-
-```bash
-# In Cursor chat/composer:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Agent mode (Ctrl+Shift+K):
-Use for complex multi-file changes
-Reference @AGENTS.md for standards
-
-# Composer (Cmd+I):
-Use for quick edits
-Reference @AGENTS.md when needed
-```
-
-## Features
-
-- **Auto-context**: Reads .cursorrules automatically
-- **@ Mentions**: Use `@AGENTS.md` to include standards
-- **Agent Mode**: Autonomous multi-step implementations
-- **Composer**: Quick inline edits
-
-## Workflow
-
-1. Rulebook generates `.cursorrules` pointing to AGENTS.md
-2. Use `@AGENTS.md` in prompts for explicit reference
-3. Agent/Composer follows standards automatically
-4. Review changes and run quality checks
-
-**Critical**: `.cursorrules` ensures Cursor follows AGENTS.md by default.
-
-<!-- CURSOR:END -->

package/templates/ides/JETBRAINS_AI.md

@@ -1,35 +0,0 @@
-<!-- JETBRAINS_AI:START -->
-# JetBrains AI Assistant Rules
-
-**IDEs**: IntelliJ, PyCharm, WebStorm, GoLand, RustRover, Rider, CLion, PhpStorm
-
-## Quick Start
-
-JetBrains AI reads workspace files automatically.
-
-## Usage
-
-```bash
-# In AI Assistant chat:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Keep AGENTS.md open for AI to reference
-```
-
-## Features
-
-- **AI Chat**: Full conversation mode
-- **Inline Suggestions**: Context-aware completions
-- **Refactoring**: AI-powered code improvements
-- **Test Generation**: Automated test creation
-
-## Workflow
-
-1. Keep AGENTS.md open in editor
-2. Use AI Chat with "@AGENTS.md" references
-3. Review suggested changes
-4. Run IDE quality checks (built-in linters, tests)
-
-**Critical**: Keep AGENTS.md open for AI Assistant to include standards in context.
-
-<!-- JETBRAINS_AI:END -->

package/templates/ides/REPLIT.md

@@ -1,36 +0,0 @@
-<!-- REPLIT:START -->
-# Replit IDE Rules
-
-**Tool**: Cloud IDE with Ghostwriter AI
-
-## Quick Start
-
-Replit Ghostwriter reads workspace files automatically.
-
-## Usage
-
-```bash
-# In Ghostwriter chat:
-"Follow @AGENTS.md. Implement [feature] with tests."
-
-# Inline completions:
-Accept/reject based on AGENTS.md standards
-```
-
-## Features
-
-- **Ghostwriter Chat**: AI assistant
-- **Inline Completions**: Code suggestions
-- **Explain Code**: AI explanations
-- **Generate Code**: Full implementations
-
-## Workflow
-
-1. Keep AGENTS.md in workspace (Ghostwriter reads it)
-2. Reference `@AGENTS.md` in chat
-3. Review suggestions
-4. Run tests in Replit console
-
-**Critical**: Ghostwriter has workspace context - AGENTS.md is automatically available.
-
-<!-- REPLIT:END -->

package/templates/ides/TABNINE.md

@@ -1,29 +0,0 @@
-<!-- TABNINE:START -->
-# Tabnine AI Rules
-
-**Tool**: Multi-IDE AI completion with team learning
-
-## Quick Start
-
-Works in: VS Code, JetBrains, Vim, Sublime, Atom, Emacs
-
-## Usage
-
-Tabnine learns from your codebase automatically. Keep AGENTS.md in workspace for team learning.
-
-## Features
-
-- **Inline Completions**: AI-powered code suggestions
-- **Team Learning**: Learns from team patterns
-- **Multi-IDE**: Consistent across all editors
-
-## Workflow
-
-1. Keep AGENTS.md in project root
-2. Tabnine learns standards from codebase
-3. Accept/reject suggestions based on AGENTS.md patterns
-4. Team model improves over time
-
-**Critical**: Tabnine learns from existing code - maintain AGENTS.md standards in all files.
-
-<!-- TABNINE:END -->

package/templates/ides/VSCODE.md

@@ -1,40 +0,0 @@
-<!-- VSCODE:START -->
-# VS Code AI Extensions Rules
-
-**IDE**: VS Code with Copilot, Cody, Continue, or other AI extensions
-
-## Quick Start
-
-VS Code reads:
-- `.vscode/settings.json` (generated by `rulebook init`)
-- `.vscode/copilot-instructions.md` (if Copilot enabled)
-
-## Usage
-
-```bash
-# In any AI chat/extension:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Keep AGENTS.md open for context
-# Extensions will reference it automatically
-```
-
-## Supported Extensions
-
-- GitHub Copilot
-- Cody
-- Continue
-- Codeium
-- Tabnine
-- Amazon Q
-
-## Workflow
-
-1. Rulebook generates `.vscode/settings.json` and `copilot-instructions.md`
-2. Keep AGENTS.md open in workspace
-3. Reference `@AGENTS.md` in extension prompts
-4. Extensions read workspace context automatically
-
-**Critical**: Generated settings point extensions to AGENTS.md standards.
-
-<!-- VSCODE:END -->

package/templates/ides/WINDSURF.md

@@ -1,36 +0,0 @@
-<!-- WINDSURF:START -->
-# Windsurf IDE Rules
-
-**IDE**: AI-powered editor with Cascade AI and Flow State
-
-## Quick Start
-
-Windsurf reads:
-- `.windsurfrules` (generated by `rulebook init`)
-- AGENTS.md (when open in workspace)
-
-## Usage
-
-```bash
-# In Windsurf chat:
-"Follow @AGENTS.md. Implement [feature] with tests."
-
-# Cascade AI:
-Multi-file autonomous mode
-Reference @AGENTS.md for standards
-
-# Flow State:
-Inline suggestions
-Context-aware completions
-```
-
-## Workflow
-
-1. Rulebook generates `.windsurfrules` → points to AGENTS.md
-2. Keep AGENTS.md open in workspace
-3. Use Cascade for complex tasks with `@AGENTS.md` references
-4. Flow State provides inline suggestions
-
-**Critical**: `.windsurfrules` ensures standards are followed automatically.
-
-<!-- WINDSURF:END -->

package/templates/ides/ZED.md

@@ -1,32 +0,0 @@
-<!-- ZED:START -->
-# Zed Editor Rules
-
-**Tool**: High-performance collaborative editor (Rust-powered)
-
-## Quick Start
-
-Zed reads workspace files for AI context.
-
-## Usage
-
-```bash
-# In Zed AI assistant:
-"Follow @AGENTS.md. Implement [feature] with tests."
-```
-
-## Features
-
-- **AI Assistant**: Inline chat
-- **Collaborative Editing**: Real-time collaboration
-- **Fast Performance**: Rust-based, instant responsiveness
-
-## Workflow
-
-1. Keep AGENTS.md open in workspace
-2. Use AI assistant with `@AGENTS.md` references
-3. Review suggestions
-4. Run quality checks in terminal
-
-**Critical**: Zed's AI reads open files - keep AGENTS.md accessible.
-
-<!-- ZED:END -->

package/templates/ides/cursor-mdc/go.mdc

@@ -1,24 +0,0 @@
----
-description: Go coding standards and best practices
-globs: ["**/*.go"]
-alwaysApply: false
----
-
-# Go Rules
-
-See `/.rulebook/specs/GO.md` for full requirements.
-
-## Key Rules
-
-- Always check and handle errors (never `_` for error returns)
-- Use `errors.Is()` / `errors.As()` for error comparison
-- Prefer `context.Context` for cancellation and deadlines
-- Use `fmt.Errorf("...: %w", err)` for error wrapping
-- Follow standard Go project layout (`cmd/`, `internal/`, `pkg/`)
-- Run `gofmt` and `golangci-lint` before committing
-
-## Error Handling
-
-- Return errors as last return value
-- Wrap errors with context using `%w`
-- Use sentinel errors for well-known conditions

package/templates/ides/cursor-mdc/python.mdc

@@ -1,24 +0,0 @@
----
-description: Python coding standards and best practices
-globs: ["**/*.py"]
-alwaysApply: false
----
-
-# Python Rules
-
-See `/.rulebook/specs/PYTHON.md` for full requirements.
-
-## Key Rules
-
-- Type hints required for all function signatures
-- Use `dataclasses` or `pydantic` for structured data
-- Prefer `pathlib.Path` over `os.path`
-- Use `async/await` for I/O-bound operations
-- Black formatting, ruff linting
-- `__all__` in modules to control public API
-
-## Error Handling
-
-- Use specific exception types (not bare `except`)
-- Validate inputs at module boundaries
-- Log errors with context before re-raising

package/templates/ides/cursor-mdc/quality.mdc

@@ -1,25 +0,0 @@
----
-description: Quality enforcement rules — type safety, linting, testing, coverage
-alwaysApply: true
----
-
-# Quality Enforcement
-
-See `/.rulebook/specs/QUALITY_ENFORCEMENT.md` for full requirements.
-
-## Mandatory Quality Gates
-
-Every change MUST pass all quality gates before merge:
-
-1. **Type Check** — `npm run type-check` (zero TypeScript errors)
-2. **Lint** — `npm run lint` (zero ESLint errors)
-3. **Tests** — `npm test` (all tests pass)
-4. **Coverage** — Meet configured threshold (default 75%)
-
-## Code Standards
-
-- No `any` types without explicit justification
-- No unused variables or imports
-- Error handling at system boundaries only
-- No over-engineering: minimum complexity for the task
-- No backwards-compatibility hacks for unused code

package/templates/ides/cursor-mdc/ralph.mdc

@@ -1,39 +0,0 @@
----
-description: Ralph autonomous loop directives for AI-driven task completion
-alwaysApply: false
----
-
-# Ralph Autonomous Loop
-
-See `/.rulebook/specs/AGENT_AUTOMATION.md` for full directives.
-
-## Ralph Commands
-
-```bash
-rulebook ralph init     # Initialize autonomous loop
-rulebook ralph run      # Start iterating on tasks
-rulebook ralph status   # Check progress
-rulebook ralph pause    # Pause for manual intervention
-rulebook ralph history  # View past iterations
-```
-
-## PRD Format
-
-Ralph uses `.rulebook/ralph/prd.json` with `userStories[]`:
-
-```json
-{
-  "id": "US-001",
-  "title": "Story Title",
-  "description": "What needs to be done",
-  "acceptanceCriteria": ["Must compile", "Tests pass"],
-  "passes": false
-}
-```
-
-## Quality Gates
-
-All 4 gates MUST pass per iteration:
-- type-check ✓, lint ✓, tests ✓, coverage ✓
-
-Failed gates mark the story `passes: false` for retry.

package/templates/ides/cursor-mdc/rulebook.mdc

@@ -1,38 +0,0 @@
----
-description: Core Rulebook project directives and task management rules
-alwaysApply: true
----
-
-# Project Agent Directives
-
-Generated by @hivehub/rulebook. See `.rulebook/specs/` for detailed specifications.
-
-## Task Management
-
-All tasks MUST follow the Rulebook task structure:
-
-```
-.rulebook/tasks/<task-id>/
-├── proposal.md         # Why and what changes
-├── tasks.md            # Simple checklist only
-└── specs/<module>/spec.md  # Technical specs
-```
-
-- Use `rulebook task create` to create tasks
-- `tasks.md` contains ONLY simple checklist items
-- Technical details go in `specs/<module>/spec.md`
-- NEVER create README.md or PROCESS.md in task directories
-
-## Quality Gates
-
-Before every commit:
-- `npm run type-check` — TypeScript must compile
-- `npm run lint` — Zero lint errors
-- `npm test` — All tests must pass
-- Coverage threshold must be met
-
-## Spec References
-
-- Core rules: `/.rulebook/specs/RULEBOOK.md`
-- Quality enforcement: `/.rulebook/specs/QUALITY_ENFORCEMENT.md`
-- Git workflow: `/.rulebook/specs/GIT.md`