@hivehub/rulebook 4.2.2 → 4.3.0

package/templates/frameworks/FLUTTER.md

@@ -1,55 +1,55 @@
-<!-- FLUTTER:START -->
-# Flutter Framework Rules
-
-**Language**: Dart  
-**Version**: Flutter 3.10+
-
-## Setup
-
-```yaml
-# pubspec.yaml
-dependencies:
-  flutter:
-    sdk: flutter
-  cupertino_icons: ^1.0.2
-
-dev_dependencies:
-  flutter_test:
-    sdk: flutter
-  flutter_lints: ^2.0.0
-```
-
-## Quality Gates
-
-```bash
-dart format --set-exit-if-changed .
-dart analyze --fatal-infos
-flutter test
-flutter build apk --release  # Test build
-```
-
-## Best Practices
-
-✅ Use StatelessWidget when possible  
-✅ Implement proper state management (Provider, Riverpod, Bloc)  
-✅ Use const constructors  
-✅ Optimize widget rebuilds  
-✅ Test on multiple devices  
-
-❌ Don't use `print()` in production  
-❌ Don't skip null safety  
-❌ Don't ignore platform differences  
-
-## Project Structure
-
-```
-lib/
-├── main.dart
-├── models/
-├── screens/
-├── widgets/
-└── services/
-```
-
-<!-- FLUTTER:END -->
-
+<!-- FLUTTER:START -->
+# Flutter Framework Rules
+
+**Language**: Dart  
+**Version**: Flutter 3.10+
+
+## Setup
+
+```yaml
+# pubspec.yaml
+dependencies:
+  flutter:
+    sdk: flutter
+  cupertino_icons: ^1.0.2
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  flutter_lints: ^2.0.0
+```
+
+## Quality Gates
+
+```bash
+dart format --set-exit-if-changed .
+dart analyze --fatal-infos
+flutter test
+flutter build apk --release  # Test build
+```
+
+## Best Practices
+
+✅ Use StatelessWidget when possible  
+✅ Implement proper state management (Provider, Riverpod, Bloc)  
+✅ Use const constructors  
+✅ Optimize widget rebuilds  
+✅ Test on multiple devices  
+
+❌ Don't use `print()` in production  
+❌ Don't skip null safety  
+❌ Don't ignore platform differences  
+
+## Project Structure
+
+```
+lib/
+├── main.dart
+├── models/
+├── screens/
+├── widgets/
+└── services/
+```
+
+<!-- FLUTTER:END -->
+

package/templates/frameworks/JQUERY.md

@@ -1,32 +1,32 @@
-<!-- JQUERY:START -->
-# jQuery Framework Rules
-
-**Language**: JavaScript  
-**Version**: jQuery 3.x+
-
-## Setup
-
-```html
-<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
-```
-
-## Best Practices
-
-✅ Use modern JS alongside jQuery  
-✅ Minimize DOM manipulation  
-✅ Cache jQuery selectors  
-✅ Use event delegation  
-
-❌ Don't use jQuery for everything  
-❌ Don't pollute global scope  
-❌ Don't skip CSP headers  
-
-## Quality Gates
-
-```bash
-eslint src/**/*.js
-jest
-```
-
-<!-- JQUERY:END -->
-
+<!-- JQUERY:START -->
+# jQuery Framework Rules
+
+**Language**: JavaScript  
+**Version**: jQuery 3.x+
+
+## Setup
+
+```html
+<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
+```
+
+## Best Practices
+
+✅ Use modern JS alongside jQuery  
+✅ Minimize DOM manipulation  
+✅ Cache jQuery selectors  
+✅ Use event delegation  
+
+❌ Don't use jQuery for everything  
+❌ Don't pollute global scope  
+❌ Don't skip CSP headers  
+
+## Quality Gates
+
+```bash
+eslint src/**/*.js
+jest
+```
+
+<!-- JQUERY:END -->
+

package/templates/frameworks/LARAVEL.md

@@ -1,38 +1,38 @@
-<!-- LARAVEL:START -->
-# Laravel Framework Rules
-
-**CRITICAL**: Laravel services must respect these conventions and quality checks.
-
-## Quality Commands
-- Static analysis: `./vendor/bin/pint --test`
-- Lint style: `./vendor/bin/phpcs --standard=PSR12 app/`
-- Unit tests: `php artisan test`
-- Feature tests: `php artisan test --testsuite=Feature`
-- Coverage: ensure `php artisan test --coverage` ≥ 80%
-
-## Project Structure
-- Keep HTTP controllers in `app/Http/Controllers`
-- Use form requests for validation in `app/Http/Requests`
-- Organize business logic in `app/Services`
-- Leverage repositories for data persistence where appropriate
-- Store queued jobs in `app/Jobs`
-
-## Implementation Guidelines
-- Use migrations for every schema change (`php artisan make:migration`)
-- Keep Eloquent models lean; move heavy logic into services
-- Cache configuration after deployment (`php artisan config:cache`)
-- Register scheduled tasks in `app/Console/Kernel.php`
-- Ensure `app/Providers` registers new bindings/events
-
-## Composer Hygiene
-```bash
-composer install --no-dev --prefer-dist
-composer dump-autoload
-```
-
-## Additional Checks
-- Sync `.env.example` whenever new variables are introduced
-- Document API changes in `/docs/laravel-api.md`
-- Generate API resources via `php artisan make:resource`
-
-<!-- LARAVEL:END -->
+<!-- LARAVEL:START -->
+# Laravel Framework Rules
+
+**CRITICAL**: Laravel services must respect these conventions and quality checks.
+
+## Quality Commands
+- Static analysis: `./vendor/bin/pint --test`
+- Lint style: `./vendor/bin/phpcs --standard=PSR12 app/`
+- Unit tests: `php artisan test`
+- Feature tests: `php artisan test --testsuite=Feature`
+- Coverage: ensure `php artisan test --coverage` ≥ 80%
+
+## Project Structure
+- Keep HTTP controllers in `app/Http/Controllers`
+- Use form requests for validation in `app/Http/Requests`
+- Organize business logic in `app/Services`
+- Leverage repositories for data persistence where appropriate
+- Store queued jobs in `app/Jobs`
+
+## Implementation Guidelines
+- Use migrations for every schema change (`php artisan make:migration`)
+- Keep Eloquent models lean; move heavy logic into services
+- Cache configuration after deployment (`php artisan config:cache`)
+- Register scheduled tasks in `app/Console/Kernel.php`
+- Ensure `app/Providers` registers new bindings/events
+
+## Composer Hygiene
+```bash
+composer install --no-dev --prefer-dist
+composer dump-autoload
+```
+
+## Additional Checks
+- Sync `.env.example` whenever new variables are introduced
+- Document API changes in `/docs/laravel-api.md`
+- Generate API resources via `php artisan make:resource`
+
+<!-- LARAVEL:END -->

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