codingbuddy-rules 0.0.0-canary.20251222065027.7844cd5

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.
Files changed (32) hide show
  1. package/.ai-rules/CHANGELOG.md +117 -0
  2. package/.ai-rules/README.md +232 -0
  3. package/.ai-rules/adapters/antigravity.md +195 -0
  4. package/.ai-rules/adapters/claude-code.md +117 -0
  5. package/.ai-rules/adapters/codex.md +124 -0
  6. package/.ai-rules/adapters/cursor.md +128 -0
  7. package/.ai-rules/adapters/kiro.md +130 -0
  8. package/.ai-rules/adapters/q.md +126 -0
  9. package/.ai-rules/agents/README.md +681 -0
  10. package/.ai-rules/agents/accessibility-specialist.json +514 -0
  11. package/.ai-rules/agents/architecture-specialist.json +501 -0
  12. package/.ai-rules/agents/backend-developer.json +494 -0
  13. package/.ai-rules/agents/code-quality-specialist.json +565 -0
  14. package/.ai-rules/agents/code-reviewer.json +565 -0
  15. package/.ai-rules/agents/devops-engineer.json +277 -0
  16. package/.ai-rules/agents/documentation-specialist.json +543 -0
  17. package/.ai-rules/agents/frontend-developer.json +402 -0
  18. package/.ai-rules/agents/performance-specialist.json +528 -0
  19. package/.ai-rules/agents/security-specialist.json +464 -0
  20. package/.ai-rules/agents/seo-specialist.json +427 -0
  21. package/.ai-rules/agents/test-strategy-specialist.json +542 -0
  22. package/.ai-rules/agents/ui-ux-designer.json +513 -0
  23. package/.ai-rules/keyword-modes.json +20 -0
  24. package/.ai-rules/rules/augmented-coding.md +292 -0
  25. package/.ai-rules/rules/clarification-guide.md +138 -0
  26. package/.ai-rules/rules/core.md +1030 -0
  27. package/.ai-rules/rules/project.md +200 -0
  28. package/.ai-rules/schemas/README.md +66 -0
  29. package/.ai-rules/schemas/agent.schema.json +258 -0
  30. package/index.d.ts +4 -0
  31. package/index.js +8 -0
  32. package/package.json +32 -0
@@ -0,0 +1,124 @@
1
+ # GitHub Copilot / Codex Integration Guide
2
+
3
+ This guide explains how to use the common AI rules (`.ai-rules/`) with GitHub Copilot and Codex.
4
+
5
+ ## Overview
6
+
7
+ GitHub Copilot can use custom instructions from `.github/` or `.codex/` directory.
8
+
9
+ ## Integration Method
10
+
11
+ ### Option 1: Using .github/copilot-instructions.md
12
+
13
+ Create `.github/copilot-instructions.md`:
14
+
15
+ ```markdown
16
+ # GitHub Copilot Custom Instructions
17
+
18
+ ## Common AI Rules
19
+
20
+ This project uses shared rules from `.ai-rules/` directory.
21
+
22
+ ### Workflow (PLAN/ACT/EVAL)
23
+ Refer to `.ai-rules/rules/core.md` for detailed workflow guidance.
24
+
25
+ ### Tech Stack & Project Structure
26
+ - See `.ai-rules/rules/project.md` for complete project setup
27
+ - Refer to project's package.json
28
+ - Layered architecture: app → widgets → features → entities → shared
29
+
30
+ ### Coding Standards
31
+ - See `.ai-rules/rules/augmented-coding.md`
32
+ - TDD for core logic, test-after for UI
33
+ - SOLID principles, 90%+ test coverage
34
+ - No mocking, test real behavior
35
+
36
+ ### Specialist Knowledge
37
+ - Refer to `.ai-rules/agents/*.json` for domain-specific guidance
38
+ ```
39
+
40
+ ### Option 2: Using .codex/ directory (Recommended)
41
+
42
+ This project includes a pre-configured `.codex/rules/system-prompt.md` file.
43
+
44
+ **Included features:**
45
+ - Common AI rules reference from `.ai-rules/`
46
+ - PLAN/ACT/EVAL workflow modes
47
+ - Keyword Invocation support
48
+ - TDD and code quality guidelines
49
+ - Specialist agents reference
50
+
51
+ **File location**: `.codex/rules/system-prompt.md`
52
+
53
+ See [docs/codex-adapter-configuration.md](../../docs/codex-adapter-configuration.md) for detailed configuration guide.
54
+
55
+ ## Directory Structure
56
+
57
+ ```
58
+ .codex/
59
+ └── rules/
60
+ └── system-prompt.md # Codex system prompt (pre-configured)
61
+
62
+ .github/
63
+ └── copilot-instructions.md # GitHub Copilot instructions (optional)
64
+
65
+ .ai-rules/ # Common rules for all AI tools
66
+ ├── rules/
67
+ │ ├── core.md
68
+ │ ├── project.md
69
+ │ └── augmented-coding.md
70
+ ├── agents/
71
+ │ └── *.json
72
+ └── adapters/
73
+ └── codex.md # This guide
74
+ ```
75
+
76
+ ## Configuration Guide
77
+
78
+ For detailed setup instructions, see:
79
+ - **Quick Start**: [docs/codex-adapter-configuration.md](../../docs/codex-adapter-configuration.md)
80
+ - **Keyword Invocation**: [docs/keyword-invocation.md](../../docs/keyword-invocation.md)
81
+
82
+ ## Usage
83
+
84
+ ### In GitHub Copilot Chat
85
+
86
+ ```
87
+ You: Implement new feature following our TDD workflow
88
+
89
+ Copilot: [References .ai-rules/rules/augmented-coding.md]
90
+ [Follows project structure from .ai-rules/rules/project.md]
91
+ ```
92
+
93
+ ### In Code Completions
94
+
95
+ Copilot will use context from:
96
+ - `.ai-rules/rules/project.md` for naming conventions
97
+ - `.ai-rules/rules/augmented-coding.md` for code quality patterns
98
+ - Existing codebase structure
99
+
100
+ ## GitHub Copilot Workspace Integration
101
+
102
+ When using Copilot Workspace:
103
+ 1. It automatically reads `.github/copilot-instructions.md`
104
+ 2. Can reference `.ai-rules/` files for detailed context
105
+ 3. Applies rules across all generated code
106
+
107
+ ## Benefits
108
+
109
+ - ✅ Better code suggestions aligned with project standards
110
+ - ✅ Consistent with other AI tools (Cursor, Claude, etc.)
111
+ - ✅ Leverages GitHub's integration
112
+ - ✅ Easy to maintain
113
+
114
+ ## Limitations
115
+
116
+ - GitHub Copilot has shorter context compared to chat-based tools
117
+ - Instructions must be concise
118
+ - Best used as reference + code completion, not full workflow execution
119
+
120
+ ## Maintenance
121
+
122
+ 1. Update `.ai-rules/rules/*.md` for universal rule changes
123
+ 2. Keep `.github/copilot-instructions.md` concise (Copilot's context limit)
124
+ 3. Link to detailed rules in `.ai-rules/` rather than duplicating
@@ -0,0 +1,128 @@
1
+ # Cursor Integration Guide
2
+
3
+ This guide explains how to use the common AI rules (`.ai-rules/`) in Cursor.
4
+
5
+ ## Overview
6
+
7
+ Cursor continues to use its native `.cursor/` directory structure while referencing the common rules from `.ai-rules/`.
8
+
9
+ ## Integration Method
10
+
11
+ ### 1. Reference Common Rules
12
+
13
+ Create `.cursor/rules/imports.mdc` to reference common rules:
14
+
15
+ ```markdown
16
+ ---
17
+ description: Common AI Rules Import
18
+ globs:
19
+ alwaysApply: true
20
+ ---
21
+
22
+ # Common Rules
23
+
24
+ This project uses shared rules from `.ai-rules/` directory for all AI assistants.
25
+
26
+ ## 📚 Core Rules
27
+ See [../../.ai-rules/rules/core.md](../../.ai-rules/rules/core.md) for:
28
+ - PLAN/ACT/EVAL workflow modes
29
+ - Agent activation rules
30
+ - Communication guidelines
31
+
32
+ ## 🏗️ Project Setup
33
+ See [../../.ai-rules/rules/project.md](../../.ai-rules/rules/project.md) for:
34
+ - Tech stack and dependencies
35
+ - Project structure and architecture
36
+ - Development rules and conventions
37
+ - Domain knowledge and business context
38
+
39
+ ## 🎯 Augmented Coding Principles
40
+ See [../../.ai-rules/rules/augmented-coding.md](../../.ai-rules/rules/augmented-coding.md) for:
41
+ - TDD cycle (Red → Green → Refactor)
42
+ - Code quality standards (SOLID, DRY)
43
+ - Testing best practices
44
+ - Commit discipline
45
+
46
+ ## 🤖 Specialist Agents
47
+ See [../../.ai-rules/agents/README.md](../../.ai-rules/agents/README.md) for available specialist agents:
48
+ - Frontend Developer, Code Reviewer
49
+ - Architecture, Test Strategy, Performance, Security
50
+ - Accessibility, SEO, Design System, Documentation
51
+ - Code Quality, DevOps Engineer
52
+ ```
53
+
54
+ ### 2. Keep Cursor-Specific Features
55
+
56
+ Maintain `.cursor/rules/cursor-specific.mdc` for Cursor-only features:
57
+
58
+ ```markdown
59
+ ---
60
+ description: Cursor-specific configurations
61
+ globs:
62
+ alwaysApply: true
63
+ ---
64
+
65
+ # Cursor-Specific Features
66
+
67
+ ## File Globbing
68
+
69
+ [Add Cursor-specific glob patterns here]
70
+
71
+ ## Agent Tool Integration
72
+
73
+ [Add Cursor-specific todo_write tool usage]
74
+ ```
75
+
76
+ ## Current Structure
77
+
78
+ ```
79
+ .cursor/
80
+ ├── agents/ # Keep for Cursor compatibility
81
+ ├── rules/
82
+ │ ├── core.mdc # Keep existing (can add reference to .ai-rules)
83
+ │ ├── project.mdc # Keep existing (can add reference to .ai-rules)
84
+ │ ├── augmented-coding.mdc # Keep existing
85
+ │ ├── imports.mdc # NEW: References to .ai-rules
86
+ │ └── cursor-specific.mdc # NEW: Cursor-only features
87
+ └── config.json # Cursor configuration
88
+
89
+ .ai-rules/ # Common rules for all AI tools
90
+ ├── rules/
91
+ │ ├── core.md
92
+ │ ├── project.md
93
+ │ └── augmented-coding.md
94
+ ├── agents/
95
+ │ └── *.json
96
+ └── adapters/
97
+ └── cursor.md (this file)
98
+ ```
99
+
100
+ ## Usage
101
+
102
+ ### In Cursor Chat
103
+
104
+ Reference rules directly:
105
+ ```
106
+ @.ai-rules/rules/core.md
107
+ @.ai-rules/agents/frontend-developer.json
108
+
109
+ Create a new feature following our common workflow
110
+ ```
111
+
112
+ ### In Cursor Composer
113
+
114
+ The `.cursor/rules/imports.mdc` with `alwaysApply: true` will automatically apply common rules to all Composer sessions.
115
+
116
+ ## Benefits
117
+
118
+ - ✅ Seamless integration with existing Cursor setup
119
+ - ✅ Access to common rules shared across all AI tools
120
+ - ✅ Cursor-specific features (globs, alwaysApply) still work
121
+ - ✅ Easy to update: change `.ai-rules/` once, all tools benefit
122
+
123
+ ## Maintenance
124
+
125
+ When updating rules:
126
+ 1. Update `.ai-rules/rules/*.md` for changes affecting all AI tools
127
+ 2. Update `.cursor/rules/*.mdc` only for Cursor-specific changes
128
+ 3. Keep both in sync for best experience
@@ -0,0 +1,130 @@
1
+ # Kiro Integration Guide
2
+
3
+ This guide explains how to use the common AI rules (`.ai-rules/`) with Kiro.
4
+
5
+ ## Overview
6
+
7
+ Kiro uses the `.kiro/` directory for custom guidelines and configuration.
8
+
9
+ ## Integration Method
10
+
11
+ ### Create Kiro Configuration
12
+
13
+ Create `.kiro/rules/guidelines.md`:
14
+
15
+ ```markdown
16
+ # Kiro Guidelines
17
+
18
+ ## Common AI Rules
19
+
20
+ This project uses shared coding rules from `.ai-rules/` for consistency across all AI coding assistants.
21
+
22
+ ### Workflow Reference
23
+
24
+ See `.ai-rules/rules/core.md` for:
25
+ - **PLAN mode**: Create implementation plans with TDD approach
26
+ - **ACT mode**: Execute changes following quality standards
27
+ - **EVAL mode**: Evaluate code quality and suggest improvements
28
+
29
+ ### Project Context
30
+
31
+ See `.ai-rules/rules/project.md` for:
32
+ - **Tech Stack**: 프로젝트의 package.json 참조
33
+ - **Architecture**: Layered structure (app → widgets → features → entities → shared)
34
+ - **Conventions**: File naming, import/export rules, pure/impure function separation
35
+
36
+ ### Coding Principles
37
+
38
+ See `.ai-rules/rules/augmented-coding.md` for:
39
+ - **TDD Cycle**: Red (failing test) → Green (minimal code) → Refactor
40
+ - **Quality Standards**: SOLID principles, DRY, code complexity management
41
+ - **Testing**: 90%+ coverage goal, no mocking, real behavior testing
42
+ - **Commit Discipline**: Separate structural and behavioral changes
43
+
44
+ ### Specialist Knowledge
45
+
46
+ See `.ai-rules/agents/` for domain expertise:
47
+ - Frontend Development (React/Next.js, TDD, design system)
48
+ - Code Review (quality evaluation, architecture analysis)
49
+ - Security (OAuth 2.0, JWT, XSS/CSRF protection)
50
+ - Performance (bundle optimization, rendering)
51
+ - Accessibility (WCAG 2.1 AA compliance)
52
+ - And more...
53
+
54
+ ## Kiro-Specific Features
55
+
56
+ [Add Kiro-specific customizations here]
57
+
58
+ ### Communication
59
+ - Always respond in Korean (한국어)
60
+ - Use clear, structured markdown formatting
61
+ - Provide actionable, specific feedback
62
+ ```
63
+
64
+ ## Directory Structure
65
+
66
+ ```
67
+ .kiro/
68
+ ├── rules/
69
+ │ └── guidelines.md # References .ai-rules
70
+ └── config.json # Kiro configuration (optional)
71
+
72
+ .ai-rules/
73
+ ├── rules/
74
+ │ ├── core.md
75
+ │ ├── project.md
76
+ │ └── augmented-coding.md
77
+ ├── agents/
78
+ │ └── *.json
79
+ └── adapters/
80
+ └── kiro.md # This guide
81
+ ```
82
+
83
+ ## Usage
84
+
85
+ ### In Kiro Session
86
+
87
+ ```
88
+ User: 새로운 컴포넌트 구현해줘
89
+
90
+ Kiro: # Mode: PLAN
91
+ [Follows .ai-rules/rules/core.md workflow]
92
+ [References .ai-rules/rules/project.md for structure]
93
+ [Applies .ai-rules/rules/augmented-coding.md TDD]
94
+
95
+ User: ACT
96
+
97
+ Kiro: # Mode: ACT
98
+ [Executes with quality standards from .ai-rules]
99
+ ```
100
+
101
+ ### Code Generation
102
+
103
+ Kiro will generate code following:
104
+ - Project structure from `.ai-rules/rules/project.md`
105
+ - Code quality patterns from `.ai-rules/rules/augmented-coding.md`
106
+ - Specialist knowledge from `.ai-rules/agents/*.json`
107
+
108
+ ## Benefits
109
+
110
+ - ✅ Consistent standards across all AI tools (Cursor, Claude, Antigravity, Q, etc.)
111
+ - ✅ Well-defined workflow and quality expectations
112
+ - ✅ Access to specialist domain knowledge
113
+ - ✅ Easy maintenance: update `.ai-rules/` once, all tools benefit
114
+
115
+ ## Kiro-Specific Advantages
116
+
117
+ [Document Kiro's unique capabilities here and how they complement common rules]
118
+
119
+ ## Maintenance
120
+
121
+ 1. Update `.ai-rules/rules/*.md` for changes affecting all AI tools
122
+ 2. Update `.kiro/rules/guidelines.md` only for Kiro-specific features
123
+ 3. Common rules propagate automatically to all Kiro sessions
124
+
125
+ ## Getting Started
126
+
127
+ 1. Ensure `.ai-rules/` directory exists with all common rules
128
+ 2. Create `.kiro/rules/guidelines.md` with content above
129
+ 3. Start a Kiro session - it will automatically reference common rules
130
+ 4. Use PLAN/ACT/EVAL workflow as defined in `.ai-rules/rules/core.md`
@@ -0,0 +1,126 @@
1
+ # Amazon Q Integration Guide
2
+
3
+ This guide explains how to use the common AI rules (`.ai-rules/`) with Amazon Q Developer.
4
+
5
+ ## Overview
6
+
7
+ Amazon Q uses the `.q/` directory or AWS-specific configuration for custom instructions.
8
+
9
+ ## Integration Method
10
+
11
+ ### Create Amazon Q Configuration
12
+
13
+ Create `.q/rules/customizations.md`:
14
+
15
+ ```markdown
16
+ # Amazon Q Customizations
17
+
18
+ ## Common AI Rules
19
+
20
+ This project follows shared coding rules from `.ai-rules/` for consistency across all AI assistants.
21
+
22
+ ### Workflow Modes (PLAN/ACT/EVAL)
23
+
24
+ Refer to `.ai-rules/rules/core.md` for:
25
+ - PLAN: Create implementation plans
26
+ - ACT: Execute code changes
27
+ - EVAL: Quality assessment and improvements
28
+
29
+ ### Project Setup
30
+
31
+ Refer to `.ai-rules/rules/project.md` for:
32
+ - **Tech Stack**: 프로젝트의 package.json 참조
33
+ - **Architecture**: Layered structure (app → widgets → features → entities → shared)
34
+ - **Development Rules**: File naming, import/export conventions
35
+
36
+ ### Coding Standards
37
+
38
+ Refer to `.ai-rules/rules/augmented-coding.md` for:
39
+ - **TDD Workflow**: Red → Green → Refactor
40
+ - **Code Quality**: SOLID principles, DRY, 90%+ coverage
41
+ - **Testing**: No mocking, test real behavior
42
+
43
+ ### Specialist Expertise
44
+
45
+ Refer to `.ai-rules/agents/*.json` for domain-specific knowledge:
46
+ - Frontend development patterns
47
+ - Security best practices
48
+ - Performance optimization
49
+ - Accessibility guidelines
50
+
51
+ ## Amazon Q Specific Features
52
+
53
+ ### AWS Integration
54
+ - Leverage Q's AWS knowledge for deployment
55
+ - Use Q's security scanning with our security rules
56
+ - Apply Q's cost optimization suggestions
57
+
58
+ ### Language Support
59
+ - Respond in Korean (한국어) as per project standard
60
+ - Use technical Korean terminology
61
+ ```
62
+
63
+ ## Directory Structure
64
+
65
+ ```
66
+ .q/
67
+ ├── rules/
68
+ │ └── customizations.md # References .ai-rules
69
+ └── config.json # Q configuration (optional)
70
+
71
+ .ai-rules/
72
+ ├── rules/
73
+ │ ├── core.md
74
+ │ ├── project.md
75
+ │ └── augmented-coding.md
76
+ ├── agents/
77
+ │ └── *.json
78
+ └── adapters/
79
+ └── q.md # This guide
80
+ ```
81
+
82
+ ## Usage
83
+
84
+ ### In Amazon Q Chat
85
+
86
+ ```
87
+ You: 새로운 API 엔드포인트 만들어줘
88
+
89
+ Q: [Follows .ai-rules/rules/core.md workflow]
90
+ [Applies .ai-rules/rules/augmented-coding.md TDD]
91
+ [Uses .ai-rules/rules/project.md structure]
92
+ ```
93
+
94
+ ### Code Suggestions
95
+
96
+ Amazon Q will provide suggestions based on:
97
+ - Your project structure from `.ai-rules/rules/project.md`
98
+ - Code quality patterns from `.ai-rules/rules/augmented-coding.md`
99
+ - Language/framework idioms from specialist agents
100
+
101
+ ## Benefits
102
+
103
+ - ✅ Consistent rules across all AI tools
104
+ - ✅ AWS-specific guidance when needed
105
+ - ✅ Security and cost optimization aligned with project standards
106
+ - ✅ Easy updates via `.ai-rules/`
107
+
108
+ ## AWS-Specific Considerations
109
+
110
+ ### When Using Q for AWS Services
111
+
112
+ Amazon Q excels at:
113
+ - AWS service integration (S3, Lambda, DynamoDB, etc.)
114
+ - Infrastructure as Code (CDK, CloudFormation)
115
+ - Security best practices for AWS
116
+
117
+ Combine Q's AWS expertise with project rules:
118
+ - Use `.ai-rules/agents/security-specialist.json` for general security
119
+ - Let Q provide AWS-specific security guidance
120
+ - Apply `.ai-rules/agents/devops-engineer.json` for deployment patterns
121
+
122
+ ## Maintenance
123
+
124
+ 1. Update `.ai-rules/rules/*.md` for universal changes
125
+ 2. Update `.q/rules/customizations.md` for Q-specific enhancements
126
+ 3. Leverage Q's AWS knowledge alongside project standards