@hivehub/rulebook 2.1.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +779 -661
- package/dist/cli/commands.d.ts +22 -0
- package/dist/cli/commands.d.ts.map +1 -1
- package/dist/cli/commands.js +291 -8
- package/dist/cli/commands.js.map +1 -1
- package/dist/core/claude-mcp.d.ts +32 -0
- package/dist/core/claude-mcp.d.ts.map +1 -0
- package/dist/core/claude-mcp.js +92 -0
- package/dist/core/claude-mcp.js.map +1 -0
- package/dist/core/config-manager.d.ts.map +1 -1
- package/dist/core/config-manager.js +27 -6
- package/dist/core/config-manager.js.map +1 -1
- package/dist/core/generator.d.ts.map +1 -1
- package/dist/core/generator.js +98 -49
- package/dist/core/generator.js.map +1 -1
- package/dist/core/migrator.d.ts +13 -0
- package/dist/core/migrator.d.ts.map +1 -1
- package/dist/core/migrator.js +76 -9
- package/dist/core/migrator.js.map +1 -1
- package/dist/core/openspec-migrator.d.ts +1 -1
- package/dist/core/openspec-migrator.d.ts.map +1 -1
- package/dist/core/openspec-migrator.js +14 -7
- package/dist/core/openspec-migrator.js.map +1 -1
- package/dist/core/workflow-generator.js +297 -261
- package/dist/core/workflow-generator.js.map +1 -1
- package/dist/index.js +40 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp/rulebook-server.d.ts.map +1 -1
- package/dist/mcp/rulebook-server.js +255 -74
- package/dist/mcp/rulebook-server.js.map +1 -1
- package/dist/memory/hnsw-index.d.ts +63 -0
- package/dist/memory/hnsw-index.d.ts.map +1 -0
- package/dist/memory/hnsw-index.js +421 -0
- package/dist/memory/hnsw-index.js.map +1 -0
- package/dist/memory/memory-cache.d.ts +33 -0
- package/dist/memory/memory-cache.d.ts.map +1 -0
- package/dist/memory/memory-cache.js +85 -0
- package/dist/memory/memory-cache.js.map +1 -0
- package/dist/memory/memory-hooks.d.ts +42 -0
- package/dist/memory/memory-hooks.d.ts.map +1 -0
- package/dist/memory/memory-hooks.js +193 -0
- package/dist/memory/memory-hooks.js.map +1 -0
- package/dist/memory/memory-manager.d.ts +55 -0
- package/dist/memory/memory-manager.d.ts.map +1 -0
- package/dist/memory/memory-manager.js +209 -0
- package/dist/memory/memory-manager.js.map +1 -0
- package/dist/memory/memory-search.d.ts +42 -0
- package/dist/memory/memory-search.d.ts.map +1 -0
- package/dist/memory/memory-search.js +166 -0
- package/dist/memory/memory-search.js.map +1 -0
- package/dist/memory/memory-store.d.ts +59 -0
- package/dist/memory/memory-store.d.ts.map +1 -0
- package/dist/memory/memory-store.js +394 -0
- package/dist/memory/memory-store.js.map +1 -0
- package/dist/memory/memory-types.d.ts +69 -0
- package/dist/memory/memory-types.d.ts.map +1 -0
- package/dist/memory/memory-types.js +7 -0
- package/dist/memory/memory-types.js.map +1 -0
- package/dist/memory/memory-vectorizer.d.ts +29 -0
- package/dist/memory/memory-vectorizer.d.ts.map +1 -0
- package/dist/memory/memory-vectorizer.js +104 -0
- package/dist/memory/memory-vectorizer.js.map +1 -0
- package/dist/types.d.ts +7 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +107 -106
- package/templates/commands/rulebook-memory-save.md +48 -0
- package/templates/commands/rulebook-memory-search.md +47 -0
- package/templates/commands/rulebook-task-apply.md +2 -2
- package/templates/commands/rulebook-task-archive.md +2 -2
- package/templates/commands/rulebook-task-create.md +2 -2
- package/templates/commands/rulebook-task-list.md +2 -2
- package/templates/commands/rulebook-task-show.md +2 -2
- package/templates/commands/rulebook-task-validate.md +2 -2
- package/templates/git/CI_CD_PATTERNS.md +4 -4
- package/templates/git/GITHUB_ACTIONS.md +3 -3
- package/templates/git/GITLAB_CI.md +4 -4
- package/templates/git/SECRETS_MANAGEMENT.md +4 -4
- package/templates/hooks/COMMIT_MSG.md +4 -4
- package/templates/hooks/POST_CHECKOUT.md +3 -3
- package/templates/hooks/PREPARE_COMMIT_MSG.md +3 -3
- package/templates/hooks/PRE_COMMIT.md +4 -4
- package/templates/hooks/PRE_PUSH.md +4 -4
- package/templates/modules/MEMORY.md +63 -0
- package/templates/skills/cli/aider/SKILL.md +59 -0
- package/templates/skills/cli/amazon-q/SKILL.md +35 -0
- package/templates/skills/cli/auggie/SKILL.md +42 -0
- package/templates/skills/cli/claude/SKILL.md +42 -0
- package/templates/skills/cli/claude-code/SKILL.md +146 -0
- package/templates/skills/cli/cline/SKILL.md +42 -0
- package/templates/skills/cli/codebuddy/SKILL.md +30 -0
- package/templates/skills/cli/codeium/SKILL.md +30 -0
- package/templates/skills/cli/codex/SKILL.md +31 -0
- package/templates/skills/cli/continue/SKILL.md +44 -0
- package/templates/skills/cli/cursor-cli/SKILL.md +38 -0
- package/templates/skills/cli/factory/SKILL.md +28 -0
- package/templates/skills/cli/gemini/SKILL.md +45 -0
- package/templates/skills/cli/kilocode/SKILL.md +28 -0
- package/templates/skills/cli/opencode/SKILL.md +28 -0
- package/templates/skills/core/agent-automation/SKILL.md +194 -0
- package/templates/skills/core/dag/SKILL.md +314 -0
- package/templates/skills/core/documentation-rules/SKILL.md +47 -0
- package/templates/skills/core/quality-enforcement/SKILL.md +78 -0
- package/templates/skills/frameworks/angular/SKILL.md +46 -0
- package/templates/skills/frameworks/django/SKILL.md +93 -0
- package/templates/skills/frameworks/electron/SKILL.md +157 -0
- package/templates/skills/frameworks/flask/SKILL.md +48 -0
- package/templates/skills/frameworks/flutter/SKILL.md +65 -0
- package/templates/skills/frameworks/jquery/SKILL.md +42 -0
- package/templates/skills/frameworks/laravel/SKILL.md +48 -0
- package/templates/skills/frameworks/nestjs/SKILL.md +53 -0
- package/templates/skills/frameworks/nextjs/SKILL.md +137 -0
- package/templates/skills/frameworks/nuxt/SKILL.md +50 -0
- package/templates/skills/frameworks/rails/SKILL.md +76 -0
- package/templates/skills/frameworks/react/SKILL.md +48 -0
- package/templates/skills/frameworks/react-native/SKILL.md +57 -0
- package/templates/skills/frameworks/spring/SKILL.md +49 -0
- package/templates/skills/frameworks/symfony/SKILL.md +46 -0
- package/templates/skills/frameworks/vue/SKILL.md +46 -0
- package/templates/skills/frameworks/zend/SKILL.md +45 -0
- package/templates/skills/ides/copilot/SKILL.md +47 -0
- package/templates/skills/ides/cursor/SKILL.md +53 -0
- package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -0
- package/templates/skills/ides/replit/SKILL.md +46 -0
- package/templates/skills/ides/tabnine/SKILL.md +39 -0
- package/templates/skills/ides/vscode/SKILL.md +50 -0
- package/templates/skills/ides/windsurf/SKILL.md +46 -0
- package/templates/skills/ides/zed/SKILL.md +42 -0
- package/templates/skills/languages/ada/SKILL.md +68 -0
- package/templates/skills/languages/c/SKILL.md +343 -0
- package/templates/skills/languages/cpp/SKILL.md +753 -0
- package/templates/skills/languages/csharp/SKILL.md +427 -0
- package/templates/skills/languages/dart/SKILL.md +342 -0
- package/templates/skills/languages/elixir/SKILL.md +464 -0
- package/templates/skills/languages/erlang/SKILL.md +371 -0
- package/templates/skills/languages/go/SKILL.md +655 -0
- package/templates/skills/languages/haskell/SKILL.md +187 -0
- package/templates/skills/languages/java/SKILL.md +617 -0
- package/templates/skills/languages/javascript/SKILL.md +641 -0
- package/templates/skills/languages/julia/SKILL.md +107 -0
- package/templates/skills/languages/kotlin/SKILL.md +521 -0
- package/templates/skills/languages/lisp/SKILL.md +110 -0
- package/templates/skills/languages/lua/SKILL.md +84 -0
- package/templates/skills/languages/objectivec/SKILL.md +100 -0
- package/templates/skills/languages/php/SKILL.md +426 -0
- package/templates/skills/languages/python/SKILL.md +692 -0
- package/templates/skills/languages/r/SKILL.md +360 -0
- package/templates/skills/languages/ruby/SKILL.md +431 -0
- package/templates/skills/languages/rust/SKILL.md +487 -0
- package/templates/skills/languages/sas/SKILL.md +83 -0
- package/templates/skills/languages/scala/SKILL.md +358 -0
- package/templates/skills/languages/solidity/SKILL.md +590 -0
- package/templates/skills/languages/sql/SKILL.md +147 -0
- package/templates/skills/languages/swift/SKILL.md +476 -0
- package/templates/skills/languages/zig/SKILL.md +275 -0
- package/templates/skills/modules/atlassian/SKILL.md +265 -0
- package/templates/skills/modules/context7/SKILL.md +64 -0
- package/templates/skills/modules/figma/SKILL.md +277 -0
- package/templates/skills/modules/github-mcp/SKILL.md +74 -0
- package/templates/skills/modules/grafana/SKILL.md +338 -0
- package/templates/skills/modules/memory/SKILL.md +73 -0
- package/templates/skills/modules/notion/SKILL.md +257 -0
- package/templates/skills/modules/playwright/SKILL.md +100 -0
- package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -0
- package/templates/skills/modules/serena/SKILL.md +347 -0
- package/templates/skills/modules/supabase/SKILL.md +233 -0
- package/templates/skills/modules/synap/SKILL.md +79 -0
- package/templates/skills/modules/vectorizer/SKILL.md +73 -0
- package/templates/skills/services/azure-blob/SKILL.md +194 -0
- package/templates/skills/services/cassandra/SKILL.md +249 -0
- package/templates/skills/services/dynamodb/SKILL.md +318 -0
- package/templates/skills/services/elasticsearch/SKILL.md +357 -0
- package/templates/skills/services/gcs/SKILL.md +188 -0
- package/templates/skills/services/influxdb/SKILL.md +275 -0
- package/templates/skills/services/kafka/SKILL.md +351 -0
- package/templates/skills/services/mariadb/SKILL.md +193 -0
- package/templates/skills/services/memcached/SKILL.md +252 -0
- package/templates/skills/services/minio/SKILL.md +211 -0
- package/templates/skills/services/mongodb/SKILL.md +278 -0
- package/templates/skills/services/mysql/SKILL.md +368 -0
- package/templates/skills/services/neo4j/SKILL.md +257 -0
- package/templates/skills/services/oracle/SKILL.md +300 -0
- package/templates/skills/services/postgresql/SKILL.md +336 -0
- package/templates/skills/services/rabbitmq/SKILL.md +296 -0
- package/templates/skills/services/redis/SKILL.md +302 -0
- package/templates/skills/services/s3/SKILL.md +308 -0
- package/templates/skills/services/sqlite/SKILL.md +304 -0
- package/templates/skills/services/sqlserver/SKILL.md +304 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "React"
|
|
3
|
+
description: "React applications must comply with these quality bars."
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- REACT:START -->
|
|
12
|
+
# React Framework Rules
|
|
13
|
+
|
|
14
|
+
**CRITICAL**: React applications must comply with these quality bars.
|
|
15
|
+
|
|
16
|
+
## Quality Commands
|
|
17
|
+
- Lint & type check: `npm run lint` + `npm run type-check`
|
|
18
|
+
- Unit/integration tests: `npm run test -- --watch=false`
|
|
19
|
+
- Build: `npm run build`
|
|
20
|
+
- Bundle analysis (optional): `npm run analyze`
|
|
21
|
+
|
|
22
|
+
## Project Structure
|
|
23
|
+
- Group features under `src/features/<name>/`
|
|
24
|
+
- Maintain shared UI primitives in `src/components`
|
|
25
|
+
- Keep hooks in `src/hooks`
|
|
26
|
+
- Centralize state management in `src/state` (Redux/Zustand/Recoil)
|
|
27
|
+
|
|
28
|
+
## Implementation Guidelines
|
|
29
|
+
- Use TypeScript everywhere (no implicit `any`)
|
|
30
|
+
- Prefer functional components with hooks
|
|
31
|
+
- Co-locate component tests as `<Component>.test.tsx`
|
|
32
|
+
- Use React Query/SWR for server state, keep caches invalidated on mutations
|
|
33
|
+
- Wrap new pages with error boundaries and suspense where needed
|
|
34
|
+
|
|
35
|
+
## Pre-Commit Checklist
|
|
36
|
+
```bash
|
|
37
|
+
npm run lint
|
|
38
|
+
npm run type-check
|
|
39
|
+
npm run test -- --watch=false
|
|
40
|
+
npm run build
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
- Update `/docs/react-architecture.md` when routes or global providers change
|
|
45
|
+
- Record reusable components in Storybook or `/docs/ui-components.md`
|
|
46
|
+
- Capture performance regressions in `/docs/performance.md`
|
|
47
|
+
|
|
48
|
+
<!-- REACT:END -->
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "React Native"
|
|
3
|
+
description: "Language: JavaScript, TypeScript"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- REACT_NATIVE:START -->
|
|
12
|
+
# React Native Framework Rules
|
|
13
|
+
|
|
14
|
+
**Language**: JavaScript, TypeScript
|
|
15
|
+
**Version**: React Native 0.72+
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx react-native init MyApp --template react-native-template-typescript
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Quality Gates
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm run lint
|
|
27
|
+
npm run type-check
|
|
28
|
+
npm test
|
|
29
|
+
npm run android # Test build
|
|
30
|
+
npm run ios # Test build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Best Practices
|
|
34
|
+
|
|
35
|
+
✅ Use TypeScript
|
|
36
|
+
✅ Implement proper navigation (React Navigation)
|
|
37
|
+
✅ Use platform-specific code when needed
|
|
38
|
+
✅ Optimize images and assets
|
|
39
|
+
✅ Test on both iOS and Android
|
|
40
|
+
|
|
41
|
+
❌ Don't hardcode dimensions
|
|
42
|
+
❌ Don't skip accessibility
|
|
43
|
+
❌ Don't ignore memory leaks
|
|
44
|
+
|
|
45
|
+
## Project Structure
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
src/
|
|
49
|
+
├── components/
|
|
50
|
+
├── screens/
|
|
51
|
+
├── navigation/
|
|
52
|
+
├── services/
|
|
53
|
+
└── utils/
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
<!-- REACT_NATIVE:END -->
|
|
57
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Spring"
|
|
3
|
+
description: "Every Spring service must satisfy these quality gates before merge."
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- SPRING:START -->
|
|
12
|
+
# Spring Boot Framework Rules
|
|
13
|
+
|
|
14
|
+
**CRITICAL**: Every Spring service must satisfy these quality gates before merge.
|
|
15
|
+
|
|
16
|
+
## Build & Quality Commands
|
|
17
|
+
- Lint/format: `./gradlew checkstyleMain` or `mvn verify`
|
|
18
|
+
- Unit tests: `./gradlew test` or `mvn test`
|
|
19
|
+
- Integration tests: `./gradlew integrationTest` (if module exists)
|
|
20
|
+
- Static analysis: `./gradlew jacocoTestReport` to ensure 80%+ coverage
|
|
21
|
+
|
|
22
|
+
## Project Structure
|
|
23
|
+
- Keep domain logic in `src/main/java/.../service`
|
|
24
|
+
- Expose REST controllers in `controller` packages
|
|
25
|
+
- Isolate configuration classes under `config`
|
|
26
|
+
- Share DTOs via `dto` package and map with MapStruct where applicable
|
|
27
|
+
|
|
28
|
+
## Implementation Guidelines
|
|
29
|
+
- Manage configuration with `application.yml` profiles (dev/test/prod)
|
|
30
|
+
- Prefer constructor injection, avoid `@Autowired` field injection
|
|
31
|
+
- Wrap transactional operations with `@Transactional`
|
|
32
|
+
- Use `ResponseEntity` for explicit HTTP semantics
|
|
33
|
+
- Validate inputs using `javax.validation` annotations and `@Valid`
|
|
34
|
+
|
|
35
|
+
## Build Matrix
|
|
36
|
+
```bash
|
|
37
|
+
# Gradle
|
|
38
|
+
./gradlew clean check
|
|
39
|
+
|
|
40
|
+
# Maven
|
|
41
|
+
mvn -B clean verify
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Additional Checks
|
|
45
|
+
- Ensure `application.yml` contains defaults for new properties
|
|
46
|
+
- Update Flyway/Liquibase migrations when schema changes
|
|
47
|
+
- Keep `README` and `/docs/architecture.md` synced with new services
|
|
48
|
+
|
|
49
|
+
<!-- SPRING:END -->
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Symfony"
|
|
3
|
+
description: "Language: PHP"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- SYMFONY:START -->
|
|
12
|
+
# Symfony Framework Rules
|
|
13
|
+
|
|
14
|
+
**Language**: PHP
|
|
15
|
+
**Version**: Symfony 6.0+ or 7.0+
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
```yaml
|
|
20
|
+
# config/packages/framework.yaml
|
|
21
|
+
framework:
|
|
22
|
+
secret: '%env(APP_SECRET)%'
|
|
23
|
+
csrf_protection: true
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Quality Gates
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
php bin/console lint:twig templates/
|
|
30
|
+
php bin/console lint:yaml config/
|
|
31
|
+
vendor/bin/phpstan analyze src tests
|
|
32
|
+
vendor/bin/phpunit
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Best Practices
|
|
36
|
+
|
|
37
|
+
✅ Use dependency injection
|
|
38
|
+
✅ Follow PSR standards
|
|
39
|
+
✅ Use Doctrine ORM
|
|
40
|
+
✅ Implement security voters
|
|
41
|
+
|
|
42
|
+
❌ Don't bypass security
|
|
43
|
+
❌ Don't hardcode routes
|
|
44
|
+
|
|
45
|
+
<!-- SYMFONY:END -->
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Vue"
|
|
3
|
+
description: "Vue 3 projects should follow these guardrails."
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- VUE:START -->
|
|
12
|
+
# Vue Framework Rules
|
|
13
|
+
|
|
14
|
+
**CRITICAL**: Vue 3 projects should follow these guardrails.
|
|
15
|
+
|
|
16
|
+
## Quality Commands
|
|
17
|
+
- Lint: `npm run lint`
|
|
18
|
+
- Unit tests: `npm run test:unit`
|
|
19
|
+
- e2e tests (Cypress/Playwright): `npm run test:e2e`
|
|
20
|
+
- Build: `npm run build`
|
|
21
|
+
|
|
22
|
+
## Project Structure
|
|
23
|
+
- Place feature modules in `src/modules/<feature>/`
|
|
24
|
+
- Keep reusable components in `src/components`
|
|
25
|
+
- Shared composables go in `src/composables`
|
|
26
|
+
- Centralize Pinia/Vuex stores under `src/stores`
|
|
27
|
+
|
|
28
|
+
## Implementation Guidelines
|
|
29
|
+
- Adopt `<script setup>` with TypeScript and define props via `defineProps`
|
|
30
|
+
- Leverage `defineEmits` for typed event emission
|
|
31
|
+
- Lazy-load routes with dynamic imports in `router/index.ts`
|
|
32
|
+
- Ensure global styles scoped via `:global` or dedicated CSS files
|
|
33
|
+
|
|
34
|
+
## Pre-Commit Commands
|
|
35
|
+
```bash
|
|
36
|
+
npm run lint
|
|
37
|
+
npm run test:unit
|
|
38
|
+
npm run build
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Documentation
|
|
42
|
+
- Update `/docs/vue-architecture.md` with module tree changes
|
|
43
|
+
- Document composables in `/docs/composables.md`
|
|
44
|
+
- Add component usage examples to `/docs/ui-components.md`
|
|
45
|
+
|
|
46
|
+
<!-- VUE:END -->
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Zend"
|
|
3
|
+
description: "Language: PHP"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "frameworks"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["frameworks", "framework"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- ZEND:START -->
|
|
12
|
+
# Zend/Laminas Framework Rules
|
|
13
|
+
|
|
14
|
+
**Language**: PHP
|
|
15
|
+
**Version**: Laminas MVC 3.x+
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
```php
|
|
20
|
+
// config/modules.config.php
|
|
21
|
+
return [
|
|
22
|
+
'Laminas\Router',
|
|
23
|
+
'Application',
|
|
24
|
+
];
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Quality Gates
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
vendor/bin/phpcs --standard=PSR12 src/
|
|
31
|
+
vendor/bin/phpstan analyze
|
|
32
|
+
vendor/bin/phpunit
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Best Practices
|
|
36
|
+
|
|
37
|
+
✅ Use service manager
|
|
38
|
+
✅ Implement middleware
|
|
39
|
+
✅ Use form validation
|
|
40
|
+
|
|
41
|
+
❌ Don't skip CSRF tokens
|
|
42
|
+
❌ Don't expose errors in production
|
|
43
|
+
|
|
44
|
+
<!-- ZEND:END -->
|
|
45
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Copilot"
|
|
3
|
+
description: "Tool: GitHub's AI pair programmer (inline + chat)"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- COPILOT:START -->
|
|
12
|
+
# GitHub Copilot Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: GitHub's AI pair programmer (inline + chat)
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Copilot reads:
|
|
19
|
+
- `.github/copilot-instructions.md` (generated by `rulebook init`)
|
|
20
|
+
- Workspace context (open files)
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# In Copilot Chat:
|
|
26
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
27
|
+
|
|
28
|
+
# Inline suggestions:
|
|
29
|
+
Accept/reject based on AGENTS.md standards
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Modes
|
|
33
|
+
|
|
34
|
+
**Inline Completions**: Context-aware suggestions while typing
|
|
35
|
+
**Copilot Chat**: Ask questions, request implementations
|
|
36
|
+
**Workspace Agent** (Labs): Multi-file autonomous mode
|
|
37
|
+
|
|
38
|
+
## Workflow
|
|
39
|
+
|
|
40
|
+
1. Rulebook generates `.github/copilot-instructions.md` → references AGENTS.md
|
|
41
|
+
2. Keep AGENTS.md open for context
|
|
42
|
+
3. Use `@workspace` to include project context
|
|
43
|
+
4. Reference `@AGENTS.md` explicitly in chat
|
|
44
|
+
|
|
45
|
+
**Critical**: Generated `copilot-instructions.md` points Copilot to AGENTS.md standards.
|
|
46
|
+
|
|
47
|
+
<!-- COPILOT:END -->
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Cursor"
|
|
3
|
+
description: "IDE: AI-first code editor with Agent mode and Composer"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- CURSOR:START -->
|
|
12
|
+
# Cursor IDE Rules
|
|
13
|
+
|
|
14
|
+
**IDE**: AI-first code editor with Agent mode and Composer
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Cursor automatically reads:
|
|
19
|
+
- `.cursorrules` (generated by `rulebook init`)
|
|
20
|
+
- `AGENTS.md` (via `@AGENTS.md` references)
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# In Cursor chat/composer:
|
|
26
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
27
|
+
|
|
28
|
+
# Agent mode (Ctrl+Shift+K):
|
|
29
|
+
Use for complex multi-file changes
|
|
30
|
+
Reference @AGENTS.md for standards
|
|
31
|
+
|
|
32
|
+
# Composer (Cmd+I):
|
|
33
|
+
Use for quick edits
|
|
34
|
+
Reference @AGENTS.md when needed
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Features
|
|
38
|
+
|
|
39
|
+
- **Auto-context**: Reads .cursorrules automatically
|
|
40
|
+
- **@ Mentions**: Use `@AGENTS.md` to include standards
|
|
41
|
+
- **Agent Mode**: Autonomous multi-step implementations
|
|
42
|
+
- **Composer**: Quick inline edits
|
|
43
|
+
|
|
44
|
+
## Workflow
|
|
45
|
+
|
|
46
|
+
1. Rulebook generates `.cursorrules` pointing to AGENTS.md
|
|
47
|
+
2. Use `@AGENTS.md` in prompts for explicit reference
|
|
48
|
+
3. Agent/Composer follows standards automatically
|
|
49
|
+
4. Review changes and run quality checks
|
|
50
|
+
|
|
51
|
+
**Critical**: `.cursorrules` ensures Cursor follows AGENTS.md by default.
|
|
52
|
+
|
|
53
|
+
<!-- CURSOR:END -->
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "JetBrains AI"
|
|
3
|
+
description: "IDEs: IntelliJ, PyCharm, WebStorm, GoLand, RustRover, Rider, CLion, PhpStorm"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- JETBRAINS_AI:START -->
|
|
12
|
+
# JetBrains AI Assistant Rules
|
|
13
|
+
|
|
14
|
+
**IDEs**: IntelliJ, PyCharm, WebStorm, GoLand, RustRover, Rider, CLion, PhpStorm
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
JetBrains AI reads workspace files automatically.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# In AI Assistant chat:
|
|
24
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
25
|
+
|
|
26
|
+
# Keep AGENTS.md open for AI to reference
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- **AI Chat**: Full conversation mode
|
|
32
|
+
- **Inline Suggestions**: Context-aware completions
|
|
33
|
+
- **Refactoring**: AI-powered code improvements
|
|
34
|
+
- **Test Generation**: Automated test creation
|
|
35
|
+
|
|
36
|
+
## Workflow
|
|
37
|
+
|
|
38
|
+
1. Keep AGENTS.md open in editor
|
|
39
|
+
2. Use AI Chat with "@AGENTS.md" references
|
|
40
|
+
3. Review suggested changes
|
|
41
|
+
4. Run IDE quality checks (built-in linters, tests)
|
|
42
|
+
|
|
43
|
+
**Critical**: Keep AGENTS.md open for AI Assistant to include standards in context.
|
|
44
|
+
|
|
45
|
+
<!-- JETBRAINS_AI:END -->
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Replit"
|
|
3
|
+
description: "Tool: Cloud IDE with Ghostwriter AI"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- REPLIT:START -->
|
|
12
|
+
# Replit IDE Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Cloud IDE with Ghostwriter AI
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Replit Ghostwriter reads workspace files automatically.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# In Ghostwriter chat:
|
|
24
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
25
|
+
|
|
26
|
+
# Inline completions:
|
|
27
|
+
Accept/reject based on AGENTS.md standards
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Features
|
|
31
|
+
|
|
32
|
+
- **Ghostwriter Chat**: AI assistant
|
|
33
|
+
- **Inline Completions**: Code suggestions
|
|
34
|
+
- **Explain Code**: AI explanations
|
|
35
|
+
- **Generate Code**: Full implementations
|
|
36
|
+
|
|
37
|
+
## Workflow
|
|
38
|
+
|
|
39
|
+
1. Keep AGENTS.md in workspace (Ghostwriter reads it)
|
|
40
|
+
2. Reference `@AGENTS.md` in chat
|
|
41
|
+
3. Review suggestions
|
|
42
|
+
4. Run tests in Replit console
|
|
43
|
+
|
|
44
|
+
**Critical**: Ghostwriter has workspace context - AGENTS.md is automatically available.
|
|
45
|
+
|
|
46
|
+
<!-- REPLIT:END -->
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Tabnine"
|
|
3
|
+
description: "Tool: Multi-IDE AI completion with team learning"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- TABNINE:START -->
|
|
12
|
+
# Tabnine AI Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Multi-IDE AI completion with team learning
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Works in: VS Code, JetBrains, Vim, Sublime, Atom, Emacs
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
Tabnine learns from your codebase automatically. Keep AGENTS.md in workspace for team learning.
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **Inline Completions**: AI-powered code suggestions
|
|
27
|
+
- **Team Learning**: Learns from team patterns
|
|
28
|
+
- **Multi-IDE**: Consistent across all editors
|
|
29
|
+
|
|
30
|
+
## Workflow
|
|
31
|
+
|
|
32
|
+
1. Keep AGENTS.md in project root
|
|
33
|
+
2. Tabnine learns standards from codebase
|
|
34
|
+
3. Accept/reject suggestions based on AGENTS.md patterns
|
|
35
|
+
4. Team model improves over time
|
|
36
|
+
|
|
37
|
+
**Critical**: Tabnine learns from existing code - maintain AGENTS.md standards in all files.
|
|
38
|
+
|
|
39
|
+
<!-- TABNINE:END -->
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "VS Code"
|
|
3
|
+
description: "IDE: VS Code with Copilot, Cody, Continue, or other AI extensions"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- VSCODE:START -->
|
|
12
|
+
# VS Code AI Extensions Rules
|
|
13
|
+
|
|
14
|
+
**IDE**: VS Code with Copilot, Cody, Continue, or other AI extensions
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
VS Code reads:
|
|
19
|
+
- `.vscode/settings.json` (generated by `rulebook init`)
|
|
20
|
+
- `.vscode/copilot-instructions.md` (if Copilot enabled)
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# In any AI chat/extension:
|
|
26
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
27
|
+
|
|
28
|
+
# Keep AGENTS.md open for context
|
|
29
|
+
# Extensions will reference it automatically
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Supported Extensions
|
|
33
|
+
|
|
34
|
+
- GitHub Copilot
|
|
35
|
+
- Cody
|
|
36
|
+
- Continue
|
|
37
|
+
- Codeium
|
|
38
|
+
- Tabnine
|
|
39
|
+
- Amazon Q
|
|
40
|
+
|
|
41
|
+
## Workflow
|
|
42
|
+
|
|
43
|
+
1. Rulebook generates `.vscode/settings.json` and `copilot-instructions.md`
|
|
44
|
+
2. Keep AGENTS.md open in workspace
|
|
45
|
+
3. Reference `@AGENTS.md` in extension prompts
|
|
46
|
+
4. Extensions read workspace context automatically
|
|
47
|
+
|
|
48
|
+
**Critical**: Generated settings point extensions to AGENTS.md standards.
|
|
49
|
+
|
|
50
|
+
<!-- VSCODE:END -->
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Windsurf"
|
|
3
|
+
description: "IDE: AI-powered editor with Cascade AI and Flow State"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- WINDSURF:START -->
|
|
12
|
+
# Windsurf IDE Rules
|
|
13
|
+
|
|
14
|
+
**IDE**: AI-powered editor with Cascade AI and Flow State
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Windsurf reads:
|
|
19
|
+
- `.windsurfrules` (generated by `rulebook init`)
|
|
20
|
+
- AGENTS.md (when open in workspace)
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# In Windsurf chat:
|
|
26
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
27
|
+
|
|
28
|
+
# Cascade AI:
|
|
29
|
+
Multi-file autonomous mode
|
|
30
|
+
Reference @AGENTS.md for standards
|
|
31
|
+
|
|
32
|
+
# Flow State:
|
|
33
|
+
Inline suggestions
|
|
34
|
+
Context-aware completions
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Workflow
|
|
38
|
+
|
|
39
|
+
1. Rulebook generates `.windsurfrules` → points to AGENTS.md
|
|
40
|
+
2. Keep AGENTS.md open in workspace
|
|
41
|
+
3. Use Cascade for complex tasks with `@AGENTS.md` references
|
|
42
|
+
4. Flow State provides inline suggestions
|
|
43
|
+
|
|
44
|
+
**Critical**: `.windsurfrules` ensures standards are followed automatically.
|
|
45
|
+
|
|
46
|
+
<!-- WINDSURF:END -->
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Zed"
|
|
3
|
+
description: "Tool: High-performance collaborative editor (Rust-powered)"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "ides"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["ides", "ide"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- ZED:START -->
|
|
12
|
+
# Zed Editor Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: High-performance collaborative editor (Rust-powered)
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
Zed reads workspace files for AI context.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# In Zed AI assistant:
|
|
24
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Features
|
|
28
|
+
|
|
29
|
+
- **AI Assistant**: Inline chat
|
|
30
|
+
- **Collaborative Editing**: Real-time collaboration
|
|
31
|
+
- **Fast Performance**: Rust-based, instant responsiveness
|
|
32
|
+
|
|
33
|
+
## Workflow
|
|
34
|
+
|
|
35
|
+
1. Keep AGENTS.md open in workspace
|
|
36
|
+
2. Use AI assistant with `@AGENTS.md` references
|
|
37
|
+
3. Review suggestions
|
|
38
|
+
4. Run quality checks in terminal
|
|
39
|
+
|
|
40
|
+
**Critical**: Zed's AI reads open files - keep AGENTS.md accessible.
|
|
41
|
+
|
|
42
|
+
<!-- ZED:END -->
|