@hivehub/rulebook 4.0.0 → 4.2.0

package/templates/frameworks/RAILS.md

@@ -1,66 +1,66 @@
-<!-- RAILS:START -->
-# Ruby on Rails Framework Rules
-
-**Language**: Ruby  
-**Version**: Rails 7.0+
-
-## Setup & Configuration
-
-```ruby
-# config/database.yml
-production:
-  url: <%= ENV['DATABASE_URL'] %>
-
-# config/environments/production.rb
-config.force_ssl = true
-config.log_level = :info
-```
-
-## Quality Gates
-
-```bash
-# Code quality
-bundle exec rubocop             # Lint
-bundle exec brakeman           # Security scan
-
-# Tests
-bundle exec rspec              # Run tests
-bundle exec rspec --format documentation  # Verbose
-
-# Type check (optional)
-bundle exec steep check        # Static typing
-```
-
-## Best Practices
-
-✅ **DO:**
-- Use strong parameters
-- Implement authentication (Devise/custom)
-- Use ActiveRecord callbacks sparingly
-- Write RSpec/Minitest tests
-- Use database migrations
-- Enable CSRF protection
-
-❌ **DON'T:**
-- Skip validations in models
-- Use `params` without permit
-- Store secrets in code
-- Skip database indexes
-- Ignore N+1 queries
-
-## Project Structure
-
-```
-app/
-├── controllers/
-├── models/
-├── views/
-├── jobs/
-└── mailers/
-config/
-db/
-spec/
-```
-
-<!-- RAILS:END -->
-
+<!-- RAILS:START -->
+# Ruby on Rails Framework Rules
+
+**Language**: Ruby  
+**Version**: Rails 7.0+
+
+## Setup & Configuration
+
+```ruby
+# config/database.yml
+production:
+  url: <%= ENV['DATABASE_URL'] %>
+
+# config/environments/production.rb
+config.force_ssl = true
+config.log_level = :info
+```
+
+## Quality Gates
+
+```bash
+# Code quality
+bundle exec rubocop             # Lint
+bundle exec brakeman           # Security scan
+
+# Tests
+bundle exec rspec              # Run tests
+bundle exec rspec --format documentation  # Verbose
+
+# Type check (optional)
+bundle exec steep check        # Static typing
+```
+
+## Best Practices
+
+✅ **DO:**
+- Use strong parameters
+- Implement authentication (Devise/custom)
+- Use ActiveRecord callbacks sparingly
+- Write RSpec/Minitest tests
+- Use database migrations
+- Enable CSRF protection
+
+❌ **DON'T:**
+- Skip validations in models
+- Use `params` without permit
+- Store secrets in code
+- Skip database indexes
+- Ignore N+1 queries
+
+## Project Structure
+
+```
+app/
+├── controllers/
+├── models/
+├── views/
+├── jobs/
+└── mailers/
+config/
+db/
+spec/
+```
+
+<!-- RAILS:END -->
+

package/templates/frameworks/REACT.md

@@ -1,38 +1,38 @@
-<!-- REACT:START -->
-# React Framework Rules
-
-**CRITICAL**: React applications must comply with these quality bars.
-
-## Quality Commands
-- Lint & type check: `npm run lint` + `npm run type-check`
-- Unit/integration tests: `npm run test -- --watch=false`
-- Build: `npm run build`
-- Bundle analysis (optional): `npm run analyze`
-
-## Project Structure
-- Group features under `src/features/<name>/`
-- Maintain shared UI primitives in `src/components`
-- Keep hooks in `src/hooks`
-- Centralize state management in `src/state` (Redux/Zustand/Recoil)
-
-## Implementation Guidelines
-- Use TypeScript everywhere (no implicit `any`)
-- Prefer functional components with hooks
-- Co-locate component tests as `<Component>.test.tsx`
-- Use React Query/SWR for server state, keep caches invalidated on mutations
-- Wrap new pages with error boundaries and suspense where needed
-
-## Pre-Commit Checklist
-```bash
-npm run lint
-npm run type-check
-npm run test -- --watch=false
-npm run build
-```
-
-## Documentation
-- Update `/docs/react-architecture.md` when routes or global providers change
-- Record reusable components in Storybook or `/docs/ui-components.md`
-- Capture performance regressions in `/docs/performance.md`
-
-<!-- REACT:END -->
+<!-- REACT:START -->
+# React Framework Rules
+
+**CRITICAL**: React applications must comply with these quality bars.
+
+## Quality Commands
+- Lint & type check: `npm run lint` + `npm run type-check`
+- Unit/integration tests: `npm run test -- --watch=false`
+- Build: `npm run build`
+- Bundle analysis (optional): `npm run analyze`
+
+## Project Structure
+- Group features under `src/features/<name>/`
+- Maintain shared UI primitives in `src/components`
+- Keep hooks in `src/hooks`
+- Centralize state management in `src/state` (Redux/Zustand/Recoil)
+
+## Implementation Guidelines
+- Use TypeScript everywhere (no implicit `any`)
+- Prefer functional components with hooks
+- Co-locate component tests as `<Component>.test.tsx`
+- Use React Query/SWR for server state, keep caches invalidated on mutations
+- Wrap new pages with error boundaries and suspense where needed
+
+## Pre-Commit Checklist
+```bash
+npm run lint
+npm run type-check
+npm run test -- --watch=false
+npm run build
+```
+
+## Documentation
+- Update `/docs/react-architecture.md` when routes or global providers change
+- Record reusable components in Storybook or `/docs/ui-components.md`
+- Capture performance regressions in `/docs/performance.md`
+
+<!-- REACT:END -->

package/templates/frameworks/REACT_NATIVE.md

@@ -1,47 +1,47 @@
-<!-- REACT_NATIVE:START -->
-# React Native Framework Rules
-
-**Language**: JavaScript, TypeScript  
-**Version**: React Native 0.72+
-
-## Setup
-
-```bash
-npx react-native init MyApp --template react-native-template-typescript
-```
-
-## Quality Gates
-
-```bash
-npm run lint
-npm run type-check
-npm test
-npm run android  # Test build
-npm run ios      # Test build
-```
-
-## Best Practices
-
-✅ Use TypeScript  
-✅ Implement proper navigation (React Navigation)  
-✅ Use platform-specific code when needed  
-✅ Optimize images and assets  
-✅ Test on both iOS and Android  
-
-❌ Don't hardcode dimensions  
-❌ Don't skip accessibility  
-❌ Don't ignore memory leaks  
-
-## Project Structure
-
-```
-src/
-├── components/
-├── screens/
-├── navigation/
-├── services/
-└── utils/
-```
-
-<!-- REACT_NATIVE:END -->
-
+<!-- REACT_NATIVE:START -->
+# React Native Framework Rules
+
+**Language**: JavaScript, TypeScript  
+**Version**: React Native 0.72+
+
+## Setup
+
+```bash
+npx react-native init MyApp --template react-native-template-typescript
+```
+
+## Quality Gates
+
+```bash
+npm run lint
+npm run type-check
+npm test
+npm run android  # Test build
+npm run ios      # Test build
+```
+
+## Best Practices
+
+✅ Use TypeScript  
+✅ Implement proper navigation (React Navigation)  
+✅ Use platform-specific code when needed  
+✅ Optimize images and assets  
+✅ Test on both iOS and Android  
+
+❌ Don't hardcode dimensions  
+❌ Don't skip accessibility  
+❌ Don't ignore memory leaks  
+
+## Project Structure
+
+```
+src/
+├── components/
+├── screens/
+├── navigation/
+├── services/
+└── utils/
+```
+
+<!-- REACT_NATIVE:END -->
+

package/templates/frameworks/SPRING.md

@@ -1,39 +1,39 @@
-<!-- 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 -->
+<!-- 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 +1,36 @@
-<!-- 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 -->
-
+<!-- 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 +1,36 @@
-<!-- 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 -->
+<!-- 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 +1,35 @@
-<!-- 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 -->
-
+<!-- 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 -->
+