@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,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Codeium"
|
|
3
|
+
description: "Tool: Free AI coding assistant"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- CODEIUM:START -->
|
|
12
|
+
# Codeium CLI/Extension Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Free AI coding assistant
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Reference AGENTS.md in prompts:
|
|
19
|
+
```
|
|
20
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Workflow
|
|
24
|
+
|
|
25
|
+
1. Keep AGENTS.md open for context
|
|
26
|
+
2. Use inline suggestions or chat
|
|
27
|
+
3. Review generated code
|
|
28
|
+
4. Run quality checks
|
|
29
|
+
|
|
30
|
+
<!-- CODEIUM:END -->
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Codex"
|
|
3
|
+
description: "Tool: OpenAI code generation API"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- CODEX:START -->
|
|
12
|
+
# Codex (OpenAI) Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: OpenAI code generation API
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Include AGENTS.md content in API system prompt:
|
|
19
|
+
```
|
|
20
|
+
System: "Follow these standards: [AGENTS.md content]"
|
|
21
|
+
User: "Implement [feature] with tests (95%+ coverage)."
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Workflow
|
|
25
|
+
|
|
26
|
+
1. Paste AGENTS.md into system prompt
|
|
27
|
+
2. Request features
|
|
28
|
+
3. Review code
|
|
29
|
+
4. Run quality checks
|
|
30
|
+
|
|
31
|
+
<!-- CODEX:END -->
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Continue"
|
|
3
|
+
description: "Tool: Open-source Copilot alternative (VS Code extension + CLI)"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- CONTINUE:START -->
|
|
12
|
+
# Continue CLI/Extension Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Open-source Copilot alternative (VS Code extension + CLI)
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# In VS Code: Install Continue extension
|
|
20
|
+
# Or CLI: npm install -g continue-cli
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Always reference AGENTS.md in prompts:
|
|
27
|
+
"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
|
|
28
|
+
|
|
29
|
+
# Slash commands:
|
|
30
|
+
/edit # Edit files
|
|
31
|
+
/chat # Ask questions
|
|
32
|
+
/cmd # Run terminal commands
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Workflow
|
|
36
|
+
|
|
37
|
+
1. Open AGENTS.md in editor for Continue to read
|
|
38
|
+
2. Use `/edit` to modify code following standards
|
|
39
|
+
3. Reference AGENTS.md in every request
|
|
40
|
+
4. Run quality checks after changes
|
|
41
|
+
|
|
42
|
+
**Critical**: Keep AGENTS.md open or reference it explicitly in prompts.
|
|
43
|
+
|
|
44
|
+
<!-- CONTINUE:END -->
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Cursor CLI"
|
|
3
|
+
description: "Tool: Cursor IDE automation and scripting"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- CURSOR_CLI:START -->
|
|
12
|
+
# Cursor CLI Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Cursor IDE automation and scripting
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Cursor reads .cursorrules automatically
|
|
20
|
+
# This file is generated by rulebook init
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
Cursor automatically references:
|
|
26
|
+
- `.cursorrules` (generated by rulebook)
|
|
27
|
+
- `AGENTS.md` (via @AGENTS.md references)
|
|
28
|
+
|
|
29
|
+
## Workflow
|
|
30
|
+
|
|
31
|
+
1. Use `@AGENTS.md` in chat to reference standards
|
|
32
|
+
2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
33
|
+
3. Cursor respects .cursorrules and AGENTS.md automatically
|
|
34
|
+
4. Review and accept changes
|
|
35
|
+
|
|
36
|
+
**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
|
|
37
|
+
|
|
38
|
+
<!-- CURSOR_CLI:END -->
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Factory"
|
|
3
|
+
description: "Tool: Code generation and automation"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- FACTORY:START -->
|
|
12
|
+
# Factory Droid Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Code generation and automation
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
"Follow @AGENTS.md standards. Generate [code] with tests."
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
1. Reference AGENTS.md in prompts
|
|
25
|
+
2. Review generated code
|
|
26
|
+
3. Run quality checks
|
|
27
|
+
|
|
28
|
+
<!-- FACTORY:END -->
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Gemini CLI"
|
|
3
|
+
description: "Tool: Google Gemini API with 2M token context"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- GEMINI:START -->
|
|
12
|
+
# Gemini CLI Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Google Gemini API with 2M token context
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Install gemini CLI
|
|
20
|
+
npm install -g @google/generative-ai-cli
|
|
21
|
+
|
|
22
|
+
# Set API key
|
|
23
|
+
export GEMINI_API_KEY=your_key
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# Always reference AGENTS.md:
|
|
30
|
+
gemini --prompt "Read @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
31
|
+
|
|
32
|
+
# Include files:
|
|
33
|
+
gemini --files AGENTS.md,src/feature.ts
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Workflow
|
|
37
|
+
|
|
38
|
+
1. Include AGENTS.md in context with `--files AGENTS.md`
|
|
39
|
+
2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
40
|
+
3. Review output
|
|
41
|
+
4. Run quality checks: `npm run lint && npm test`
|
|
42
|
+
|
|
43
|
+
**Critical**: Reference @AGENTS.md for consistent code generation.
|
|
44
|
+
|
|
45
|
+
<!-- GEMINI:END -->
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Kilocode"
|
|
3
|
+
description: "Tool: Lightweight coding companion"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- KILOCODE:START -->
|
|
12
|
+
# Kilo Code Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Lightweight coding companion
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
1. Reference AGENTS.md
|
|
25
|
+
2. Review code
|
|
26
|
+
3. Run quality checks
|
|
27
|
+
|
|
28
|
+
<!-- KILOCODE:END -->
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Opencode"
|
|
3
|
+
description: "Tool: Open-source AI assistant"
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "cli"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["cli", "cli-tool"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- OPENCODE:START -->
|
|
12
|
+
# OpenCode Rules
|
|
13
|
+
|
|
14
|
+
**Tool**: Open-source AI assistant
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
1. Reference AGENTS.md
|
|
25
|
+
2. Review code
|
|
26
|
+
3. Run quality checks
|
|
27
|
+
|
|
28
|
+
<!-- OPENCODE:END -->
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Agent Automation"
|
|
3
|
+
description: "Mandatory workflow that AI agents MUST execute after EVERY implementation."
|
|
4
|
+
version: "1.0.0"
|
|
5
|
+
category: "core"
|
|
6
|
+
author: "Rulebook"
|
|
7
|
+
tags: ["core"]
|
|
8
|
+
dependencies: []
|
|
9
|
+
conflicts: []
|
|
10
|
+
---
|
|
11
|
+
<!-- AGENT_AUTOMATION:START -->
|
|
12
|
+
# Agent Automation Rules
|
|
13
|
+
|
|
14
|
+
**CRITICAL**: Mandatory workflow that AI agents MUST execute after EVERY implementation.
|
|
15
|
+
|
|
16
|
+
## Workflow Overview
|
|
17
|
+
|
|
18
|
+
After completing ANY feature, bug fix, or code change, execute this workflow in order:
|
|
19
|
+
|
|
20
|
+
### Step 1: Quality Checks (MANDATORY)
|
|
21
|
+
|
|
22
|
+
Run these checks in order - ALL must pass:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
1. Type check (if applicable)
|
|
26
|
+
2. Lint (MUST pass with ZERO warnings)
|
|
27
|
+
3. Format code
|
|
28
|
+
4. Run ALL tests (MUST pass 100%)
|
|
29
|
+
5. Verify coverage meets threshold (default 95%)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Language-specific commands**: See your language template (TYPESCRIPT, RUST, PYTHON, etc.) for exact commands.
|
|
33
|
+
|
|
34
|
+
**IF ANY CHECK FAILS:**
|
|
35
|
+
- ❌ STOP immediately
|
|
36
|
+
- ❌ DO NOT proceed
|
|
37
|
+
- ❌ DO NOT commit
|
|
38
|
+
- ✅ Fix the issue first
|
|
39
|
+
- ✅ Re-run ALL checks
|
|
40
|
+
|
|
41
|
+
### Step 2: Security & Dependency Audits
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Check for vulnerabilities (language-specific)
|
|
45
|
+
# Check for outdated dependencies (informational)
|
|
46
|
+
# Find unused dependencies (optional)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
**Language-specific commands**: See your language template for audit commands.
|
|
50
|
+
|
|
51
|
+
**IF VULNERABILITIES FOUND:**
|
|
52
|
+
- ✅ Attempt automatic fix
|
|
53
|
+
- ✅ Document if auto-fix fails
|
|
54
|
+
- ✅ Include in Step 5 report
|
|
55
|
+
- ❌ Never ignore critical/high vulnerabilities without user approval
|
|
56
|
+
|
|
57
|
+
### Step 3: Update OpenSpec Tasks
|
|
58
|
+
|
|
59
|
+
If `openspec/` directory exists:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Mark completed tasks as [DONE]
|
|
63
|
+
# Update in-progress tasks
|
|
64
|
+
# Add new tasks if discovered
|
|
65
|
+
# Update progress percentages
|
|
66
|
+
# Document deviations or blockers
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Step 4: Update Documentation
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Update ROADMAP.md (if feature is milestone)
|
|
73
|
+
# Update CHANGELOG.md (conventional commits format)
|
|
74
|
+
# Update feature specs (if implementation differs)
|
|
75
|
+
# Update README.md (if public API changed)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Step 5: Git Commit
|
|
79
|
+
|
|
80
|
+
**ONLY after ALL above steps pass:**
|
|
81
|
+
|
|
82
|
+
**⚠️ CRITICAL: All commit messages MUST be in English**
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
git add .
|
|
86
|
+
git commit -m "<type>(<scope>): <description>
|
|
87
|
+
|
|
88
|
+
- Detailed change 1
|
|
89
|
+
- Detailed change 2
|
|
90
|
+
- Tests: [describe coverage]
|
|
91
|
+
- Coverage: X% (threshold: 95%)
|
|
92
|
+
|
|
93
|
+
Closes #<issue> (if applicable)"
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**Commit Types**: `feat`, `fix`, `docs`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`
|
|
97
|
+
|
|
98
|
+
**Language Requirement**: Commit messages must be written in English. Never use Portuguese, Spanish, or any other language.
|
|
99
|
+
|
|
100
|
+
### Step 6: Report to User
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
✅ Implementation Complete
|
|
104
|
+
|
|
105
|
+
📝 Changes:
|
|
106
|
+
- [List main changes]
|
|
107
|
+
|
|
108
|
+
🧪 Quality Checks:
|
|
109
|
+
- ✅ Type check: Passed
|
|
110
|
+
- ✅ Linting: Passed (0 warnings)
|
|
111
|
+
- ✅ Formatting: Applied
|
|
112
|
+
- ✅ Tests: X/X passed (100%)
|
|
113
|
+
- ✅ Coverage: X% (threshold: 95%)
|
|
114
|
+
|
|
115
|
+
🔒 Security:
|
|
116
|
+
- ✅ No vulnerabilities
|
|
117
|
+
|
|
118
|
+
📊 OpenSpec:
|
|
119
|
+
- ✅ Tasks updated
|
|
120
|
+
- ✅ Progress: X% → Y%
|
|
121
|
+
|
|
122
|
+
📚 Documentation:
|
|
123
|
+
- ✅ CHANGELOG.md updated
|
|
124
|
+
- ✅ [other docs updated]
|
|
125
|
+
|
|
126
|
+
💾 Git:
|
|
127
|
+
- ✅ Committed: <commit message>
|
|
128
|
+
- ✅ Hash: <commit hash>
|
|
129
|
+
|
|
130
|
+
📋 Next Steps:
|
|
131
|
+
- [ ] Review changes
|
|
132
|
+
- [ ] Push to remote (if ready)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Automation Exceptions
|
|
136
|
+
|
|
137
|
+
Skip steps ONLY when:
|
|
138
|
+
|
|
139
|
+
1. **Exploratory Code**: User says "experimental", "draft", "try"
|
|
140
|
+
- Still run quality checks
|
|
141
|
+
- Don't commit
|
|
142
|
+
|
|
143
|
+
2. **User Explicitly Requests**: User says "skip tests", "no commit"
|
|
144
|
+
- Only skip requested step
|
|
145
|
+
- Warn about skipped steps
|
|
146
|
+
|
|
147
|
+
3. **Emergency Hotfix**: Critical production bug
|
|
148
|
+
- Run minimal checks
|
|
149
|
+
- Document technical debt
|
|
150
|
+
|
|
151
|
+
**In ALL other cases: Execute complete workflow**
|
|
152
|
+
|
|
153
|
+
## Error Recovery
|
|
154
|
+
|
|
155
|
+
If workflow fails 3+ times:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
1. Create backup branch
|
|
159
|
+
2. Reset to last stable commit
|
|
160
|
+
3. Report to user with error details
|
|
161
|
+
4. Request guidance or try alternative approach
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## Best Practices
|
|
165
|
+
|
|
166
|
+
### DO's ✅
|
|
167
|
+
- ALWAYS run complete workflow
|
|
168
|
+
- ALWAYS update OpenSpec and documentation
|
|
169
|
+
- ALWAYS use conventional commits
|
|
170
|
+
- ALWAYS report summary to user
|
|
171
|
+
- ASK before skipping steps
|
|
172
|
+
|
|
173
|
+
### DON'Ts ❌
|
|
174
|
+
- NEVER skip quality checks without permission
|
|
175
|
+
- NEVER commit failing tests
|
|
176
|
+
- NEVER commit linting errors
|
|
177
|
+
- NEVER skip documentation updates
|
|
178
|
+
- NEVER assume user wants to skip automation
|
|
179
|
+
- NEVER commit debug code or secrets
|
|
180
|
+
|
|
181
|
+
## Summary
|
|
182
|
+
|
|
183
|
+
**Complete workflow after EVERY implementation:**
|
|
184
|
+
|
|
185
|
+
1. ✅ Quality checks (type, lint, format, test, coverage)
|
|
186
|
+
2. ✅ Security audit
|
|
187
|
+
3. ✅ Update OpenSpec tasks
|
|
188
|
+
4. ✅ Update documentation
|
|
189
|
+
5. ✅ Git commit (conventional format)
|
|
190
|
+
6. ✅ Report summary to user
|
|
191
|
+
|
|
192
|
+
**Only skip with explicit user permission and document why.**
|
|
193
|
+
|
|
194
|
+
<!-- AGENT_AUTOMATION:END -->
|