@hivehub/rulebook 5.4.1 → 5.5.1

package/templates/frameworks/NESTJS.md

@@ -1,43 +1,43 @@
-<!-- NESTJS:START -->
-# NestJS Framework Rules
-
-**CRITICAL**: Align all NestJS services, modules, and controllers with these conventions.
-
-## Project Structure
-- Maintain feature-first modules under `src/<feature>/`
-- Keep global providers in `src/common/`
-- Register new modules in `AppModule` and ensure dependency injection consistency
-- Prefer `@nestjs/config` for environment configuration
-
-## Quality Gates
-- Lint: `npm run lint`
-- Unit tests: `npm run test`
-- e2e tests: `npm run test:e2e`
-- Build validation: `npm run build`
-- Coverage threshold: **80%+** for service and controller layers
-
-## Implementation Guidelines
-- Use DTOs with `class-validator` and `class-transformer`
-- Encapsulate database access in providers (avoid direct repository use in controllers)
-- Document routes with `@nestjs/swagger` when OpenAPI is enabled
-- Keep asynchronous logic wrapped with `try/catch` and map errors to HTTP exceptions
-
-## Scripts to Run Before Commit
-```bash
-npm run lint
-npm run test
-npm run test:e2e
-npm run build
-```
-
-## Additional Checks
-- Ensure Circular Dependency detection is clean (`npm run lint -- --max-warnings=0`)
-- Synchronize `.env.example` with actual required variables
-- Maintain aligned versions for Nest core packages (`@nestjs/*`)
-
-## Documentation
-- Update `/docs/architecture.md` with new modules and providers
-- Keep OpenAPI spec regenerated via `npm run swagger:generate`
-- Log breaking changes in `CHANGELOG.md`
-
-<!-- NESTJS:END -->
+<!-- NESTJS:START -->
+# NestJS Framework Rules
+
+**CRITICAL**: Align all NestJS services, modules, and controllers with these conventions.
+
+## Project Structure
+- Maintain feature-first modules under `src/<feature>/`
+- Keep global providers in `src/common/`
+- Register new modules in `AppModule` and ensure dependency injection consistency
+- Prefer `@nestjs/config` for environment configuration
+
+## Quality Gates
+- Lint: `npm run lint`
+- Unit tests: `npm run test`
+- e2e tests: `npm run test:e2e`
+- Build validation: `npm run build`
+- Coverage threshold: **80%+** for service and controller layers
+
+## Implementation Guidelines
+- Use DTOs with `class-validator` and `class-transformer`
+- Encapsulate database access in providers (avoid direct repository use in controllers)
+- Document routes with `@nestjs/swagger` when OpenAPI is enabled
+- Keep asynchronous logic wrapped with `try/catch` and map errors to HTTP exceptions
+
+## Scripts to Run Before Commit
+```bash
+npm run lint
+npm run test
+npm run test:e2e
+npm run build
+```
+
+## Additional Checks
+- Ensure Circular Dependency detection is clean (`npm run lint -- --max-warnings=0`)
+- Synchronize `.env.example` with actual required variables
+- Maintain aligned versions for Nest core packages (`@nestjs/*`)
+
+## Documentation
+- Update `/docs/architecture.md` with new modules and providers
+- Keep OpenAPI spec regenerated via `npm run swagger:generate`
+- Log breaking changes in `CHANGELOG.md`
+
+<!-- NESTJS:END -->

package/templates/frameworks/NEXTJS.md

@@ -1,127 +1,127 @@
-<!-- NEXTJS:START -->
-# Next.js Framework Rules
-
-**Language**: TypeScript, JavaScript  
-**Version**: Next.js 14+ (App Router)
-
-## Setup & Configuration
-
-```typescript
-// next.config.ts
-import type { NextConfig } from 'next'
-
-const nextConfig: NextConfig = {
-  reactStrictMode: true,
-  images: {
-    domains: ['your-domain.com'],
-  },
-  env: {
-    CUSTOM_KEY: process.env.CUSTOM_KEY,
-  },
-}
-
-export default nextConfig
-```
-
-## Quality Gates
-
-```bash
-# Type check
-npm run type-check  # or: tsc --noEmit
-
-# Lint
-npm run lint        # Next.js ESLint
-
-# Format
-npx prettier --check "**/*.{ts,tsx}"
-
-# Tests
-npm test            # Vitest or Jest
-
-# Build
-npm run build       # Must succeed
-
-# Check bundle size
-npm run build && npx @next/bundle-analyzer
-```
-
-## Best Practices
-
-✅ **DO:**
-- Use App Router (app/) for new projects
-- Implement Server Components by default
-- Use Client Components ('use client') only when needed
-- Optimize images with next/image
-- Use dynamic imports for code splitting
-- Implement proper metadata/SEO
-- Use Server Actions for mutations
-- Enable React Strict Mode
-
-❌ **DON'T:**
-- Use getServerSideProps/getStaticProps in App Router
-- Fetch on client when server fetch is better
-- Skip image optimization
-- Ignore bundle size
-- Use 'use client' everywhere
-- Hardcode API URLs
-- Skip error boundaries
-
-## Project Structure (App Router)
-
-```
-app/
-├── layout.tsx         # Root layout
-├── page.tsx           # Home page
-├── (routes)/
-│   ├── dashboard/
-│   │   ├── layout.tsx
-│   │   └── page.tsx
-│   └── api/
-│       └── users/
-│           └── route.ts
-├── components/
-├── lib/
-└── types/
-```
-
-## Server vs Client Components
-
-```typescript
-// Server Component (default)
-async function ServerComponent() {
-  const data = await fetch('https://api.example.com/data')
-  return <div>{data}</div>
-}
-
-// Client Component
-'use client'
-import { useState } from 'react'
-
-function ClientComponent() {
-  const [count, setCount] = useState(0)
-  return <button onClick={() => setCount(count + 1)}>{count}</button>
-}
-```
-
-## Route Handlers (API Routes)
-
-```typescript
-// app/api/users/route.ts
-import { NextRequest, NextResponse } from 'next/server'
-
-export async function GET(request: NextRequest) {
-  const searchParams = request.nextUrl.searchParams
-  const id = searchParams.get('id')
-  
-  return NextResponse.json({ id })
-}
-
-export async function POST(request: NextRequest) {
-  const body = await request.json()
-  // Handle POST
-  return NextResponse.json({ success: true })
-}
-```
-
-<!-- NEXTJS:END -->
-
+<!-- NEXTJS:START -->
+# Next.js Framework Rules
+
+**Language**: TypeScript, JavaScript  
+**Version**: Next.js 14+ (App Router)
+
+## Setup & Configuration
+
+```typescript
+// next.config.ts
+import type { NextConfig } from 'next'
+
+const nextConfig: NextConfig = {
+  reactStrictMode: true,
+  images: {
+    domains: ['your-domain.com'],
+  },
+  env: {
+    CUSTOM_KEY: process.env.CUSTOM_KEY,
+  },
+}
+
+export default nextConfig
+```
+
+## Quality Gates
+
+```bash
+# Type check
+npm run type-check  # or: tsc --noEmit
+
+# Lint
+npm run lint        # Next.js ESLint
+
+# Format
+npx prettier --check "**/*.{ts,tsx}"
+
+# Tests
+npm test            # Vitest or Jest
+
+# Build
+npm run build       # Must succeed
+
+# Check bundle size
+npm run build && npx @next/bundle-analyzer
+```
+
+## Best Practices
+
+✅ **DO:**
+- Use App Router (app/) for new projects
+- Implement Server Components by default
+- Use Client Components ('use client') only when needed
+- Optimize images with next/image
+- Use dynamic imports for code splitting
+- Implement proper metadata/SEO
+- Use Server Actions for mutations
+- Enable React Strict Mode
+
+❌ **DON'T:**
+- Use getServerSideProps/getStaticProps in App Router
+- Fetch on client when server fetch is better
+- Skip image optimization
+- Ignore bundle size
+- Use 'use client' everywhere
+- Hardcode API URLs
+- Skip error boundaries
+
+## Project Structure (App Router)
+
+```
+app/
+├── layout.tsx         # Root layout
+├── page.tsx           # Home page
+├── (routes)/
+│   ├── dashboard/
+│   │   ├── layout.tsx
+│   │   └── page.tsx
+│   └── api/
+│       └── users/
+│           └── route.ts
+├── components/
+├── lib/
+└── types/
+```
+
+## Server vs Client Components
+
+```typescript
+// Server Component (default)
+async function ServerComponent() {
+  const data = await fetch('https://api.example.com/data')
+  return <div>{data}</div>
+}
+
+// Client Component
+'use client'
+import { useState } from 'react'
+
+function ClientComponent() {
+  const [count, setCount] = useState(0)
+  return <button onClick={() => setCount(count + 1)}>{count}</button>
+}
+```
+
+## Route Handlers (API Routes)
+
+```typescript
+// app/api/users/route.ts
+import { NextRequest, NextResponse } from 'next/server'
+
+export async function GET(request: NextRequest) {
+  const searchParams = request.nextUrl.searchParams
+  const id = searchParams.get('id')
+  
+  return NextResponse.json({ id })
+}
+
+export async function POST(request: NextRequest) {
+  const body = await request.json()
+  // Handle POST
+  return NextResponse.json({ success: true })
+}
+```
+
+<!-- NEXTJS:END -->
+

package/templates/frameworks/NUXT.md

@@ -1,40 +1,40 @@
-<!-- NUXT:START -->
-# Nuxt Framework Rules
-
-**CRITICAL**: Nuxt 3 applications must keep these standards to ensure SSR quality.
-
-## Quality Commands
-- Lint: `npm run lint`
-- Type check: `npm run type-check`
-- Unit tests: `npm run test`
-- Build for production: `npm run build`
-- Generate static output (if applicable): `npm run generate`
-
-## Project Structure
-- Define routes with file-based routing under `pages/`
-- Keep server API handlers within `server/api/`
-- Organize composables in `composables/`
-- Place reusable UI components in `components/`
-- Store state via Pinia modules in `stores/`
-
-## Implementation Guidelines
-- Use runtime config via `useRuntimeConfig()` for secrets
-- SSR-safe operations only inside `onServerPrefetch`/server routes
-- Prefer `definePageMeta` to control page-level features
-- Maintain i18n messages in `/locales`
-- Cache heavy computations with Nitro storage if needed
-
-## Pre-Commit Commands
-```bash
-npm run lint
-npm run type-check
-npm run test
-npm run build
-```
-
-## Documentation
-- Keep `/docs/nuxt-architecture.md` current with route layout and middleware
-- Document server API contracts in `/docs/api.md`
-- Capture deployment steps (SSR vs static) in `/docs/deployment.md`
-
-<!-- NUXT:END -->
+<!-- NUXT:START -->
+# Nuxt Framework Rules
+
+**CRITICAL**: Nuxt 3 applications must keep these standards to ensure SSR quality.
+
+## Quality Commands
+- Lint: `npm run lint`
+- Type check: `npm run type-check`
+- Unit tests: `npm run test`
+- Build for production: `npm run build`
+- Generate static output (if applicable): `npm run generate`
+
+## Project Structure
+- Define routes with file-based routing under `pages/`
+- Keep server API handlers within `server/api/`
+- Organize composables in `composables/`
+- Place reusable UI components in `components/`
+- Store state via Pinia modules in `stores/`
+
+## Implementation Guidelines
+- Use runtime config via `useRuntimeConfig()` for secrets
+- SSR-safe operations only inside `onServerPrefetch`/server routes
+- Prefer `definePageMeta` to control page-level features
+- Maintain i18n messages in `/locales`
+- Cache heavy computations with Nitro storage if needed
+
+## Pre-Commit Commands
+```bash
+npm run lint
+npm run type-check
+npm run test
+npm run build
+```
+
+## Documentation
+- Keep `/docs/nuxt-architecture.md` current with route layout and middleware
+- Document server API contracts in `/docs/api.md`
+- Capture deployment steps (SSR vs static) in `/docs/deployment.md`
+
+<!-- NUXT:END -->

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 -->