aiwf 0.3.18 → 0.3.19

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 (33) hide show
  1. package/README.ko.md +84 -0
  2. package/README.md +87 -0
  3. package/ai-tools/README.md +105 -0
  4. package/ai-tools/augment/README.md +371 -0
  5. package/ai-tools/augment/config.json +30 -0
  6. package/ai-tools/augment/template/.augment/aiwf-integration.md +387 -0
  7. package/ai-tools/augment/template/.augment/augment.yaml +347 -0
  8. package/ai-tools/augment/template/augment.config.json +64 -0
  9. package/ai-tools/claude-code/README.md +151 -0
  10. package/ai-tools/claude-code/config.json +28 -0
  11. package/ai-tools/claude-code/template/CLAUDE.md +91 -0
  12. package/ai-tools/cursor/README.md +314 -0
  13. package/ai-tools/cursor/config.json +29 -0
  14. package/ai-tools/cursor/template/.cursorrules +362 -0
  15. package/ai-tools/github-copilot/README.md +195 -0
  16. package/ai-tools/github-copilot/config.json +24 -0
  17. package/ai-tools/github-copilot/template/.github/copilot-instructions.md +202 -0
  18. package/ai-tools/windsurf/README.md +355 -0
  19. package/ai-tools/windsurf/config.json +29 -0
  20. package/ai-tools/windsurf/template/.windsurf/aiwf-rules.md +260 -0
  21. package/ai-tools/windsurf/template/.windsurf/windsurf.config.js +312 -0
  22. package/ai-tools/windsurf/template/windsurf.config.json +63 -0
  23. package/docs/CODE_CLEANUP_GUIDE.ko.md +415 -0
  24. package/docs/CODE_CLEANUP_GUIDE.md +415 -0
  25. package/docs/VALIDATOR_API.ko.md +324 -0
  26. package/docs/VALIDATOR_API.md +324 -0
  27. package/package.json +3 -2
  28. package/src/cli/index.js +338 -0
  29. package/src/lib/backup-manager.js +4 -3
  30. package/src/lib/installer.js +126 -3
  31. package/src/lib/validator.js +78 -313
  32. package/src/utils/messages.js +16 -2
  33. package/src/utils/paths.js +1 -20
@@ -0,0 +1,347 @@
1
+ # Augment AI Configuration for AIWF Projects
2
+ # Version: 1.0.0
3
+
4
+ # Project identification
5
+ project:
6
+ type: aiwf
7
+ framework_version: 1.0.0
8
+ name: "${PROJECT_NAME}"
9
+ description: "AI Workflow Framework project with Augment integration"
10
+
11
+ # AIWF structure mapping
12
+ structure:
13
+ root: .aiwf
14
+ directories:
15
+ features: 06_FEATURE_LEDGERS
16
+ sprints: 03_SPRINTS
17
+ tasks: 04_GENERAL_TASKS
18
+ personas: personas
19
+ templates: 99_TEMPLATES
20
+ architecture: 05_ARCHITECTURAL_DECISIONS
21
+ state: 10_STATE_OF_PROJECT
22
+
23
+ # Context providers
24
+ context:
25
+ providers:
26
+ - name: feature_ledger
27
+ type: markdown
28
+ path: .aiwf/06_FEATURE_LEDGERS/**/*.md
29
+ parser: aiwf_feature
30
+ cache: true
31
+ refresh: on_save
32
+
33
+ - name: current_sprint
34
+ type: directory
35
+ path: .aiwf/03_SPRINTS
36
+ parser: aiwf_sprint
37
+ watch: true
38
+
39
+ - name: active_persona
40
+ type: json
41
+ path: .aiwf/current_persona.json
42
+ watch: true
43
+
44
+ - name: project_manifest
45
+ type: markdown
46
+ path: .aiwf/00_PROJECT_MANIFEST.md
47
+ parser: aiwf_manifest
48
+ cache: true
49
+
50
+ # Code generation patterns
51
+ patterns:
52
+ # File naming
53
+ naming:
54
+ services: "{feature_id}_{name}.service.{ext}"
55
+ controllers: "{feature_id}_{name}.controller.{ext}"
56
+ tests: "{name}.spec.{ext}"
57
+ components: "{name}.component.{ext}"
58
+
59
+ # Import organization
60
+ imports:
61
+ order:
62
+ - external
63
+ - "@aiwf/core"
64
+ - "@aiwf/*"
65
+ - internal
66
+ - feature
67
+ - relative
68
+ grouping: true
69
+ sorting: alphabetical
70
+
71
+ # Documentation
72
+ documentation:
73
+ style: jsdoc
74
+ required_tags:
75
+ - "@feature"
76
+ - "@task"
77
+ - "@persona"
78
+ auto_generate:
79
+ feature_id: true
80
+ task_id: true
81
+ sprint_id: true
82
+ timestamp: false
83
+
84
+ # Persona configurations
85
+ personas:
86
+ architect:
87
+ focus:
88
+ - system_design
89
+ - architectural_patterns
90
+ - scalability
91
+ - abstractions
92
+ patterns:
93
+ - interfaces
94
+ - abstract_classes
95
+ - design_patterns
96
+ - dependency_injection
97
+ suggestions:
98
+ priority: architecture_first
99
+ examples: true
100
+ alternatives: multiple
101
+
102
+ security:
103
+ focus:
104
+ - input_validation
105
+ - authentication
106
+ - authorization
107
+ - encryption
108
+ patterns:
109
+ - sanitization
110
+ - rate_limiting
111
+ - audit_logging
112
+ - security_headers
113
+ warnings:
114
+ level: high
115
+ types:
116
+ - sql_injection
117
+ - xss
118
+ - csrf
119
+ - exposed_secrets
120
+
121
+ frontend:
122
+ focus:
123
+ - user_experience
124
+ - component_design
125
+ - performance
126
+ - accessibility
127
+ patterns:
128
+ - react_hooks
129
+ - state_management
130
+ - responsive_design
131
+ - lazy_loading
132
+ frameworks:
133
+ react: true
134
+ vue: true
135
+ angular: true
136
+
137
+ backend:
138
+ focus:
139
+ - api_design
140
+ - data_models
141
+ - business_logic
142
+ - integrations
143
+ patterns:
144
+ - rest_api
145
+ - graphql
146
+ - microservices
147
+ - event_driven
148
+ databases:
149
+ sql: true
150
+ nosql: true
151
+ cache: true
152
+
153
+ data_analyst:
154
+ focus:
155
+ - data_processing
156
+ - visualization
157
+ - statistics
158
+ - reporting
159
+ patterns:
160
+ - pandas_operations
161
+ - numpy_calculations
162
+ - chart_generation
163
+ - data_pipelines
164
+ libraries:
165
+ pandas: true
166
+ numpy: true
167
+ matplotlib: true
168
+ seaborn: true
169
+
170
+ # Code suggestions behavior
171
+ suggestions:
172
+ # Context awareness
173
+ context_depth: 3
174
+ include_related_features: true
175
+ check_dependencies: true
176
+
177
+ # Validation
178
+ validation:
179
+ feature_status: always
180
+ task_alignment: always
181
+ sprint_scope: warning
182
+ persona_match: info
183
+
184
+ # Auto-completion
185
+ autocomplete:
186
+ trigger_chars: 3
187
+ show_metadata: true
188
+ include_examples: true
189
+ max_suggestions: 10
190
+
191
+ # Intelligence features
192
+ intelligence:
193
+ learn_from_codebase: true
194
+ adapt_to_style: true
195
+ suggest_refactoring: true
196
+ detect_patterns: true
197
+
198
+ # Integration rules
199
+ rules:
200
+ # Feature validation
201
+ - id: feature_validation
202
+ name: "Require feature validation"
203
+ severity: error
204
+ applies_to: ["services", "controllers"]
205
+ pattern: "class.*"
206
+ requires: "validateFeature|checkFeature"
207
+ message: "All services must validate their feature status"
208
+
209
+ # Task references
210
+ - id: task_reference
211
+ name: "Task reference required"
212
+ severity: warning
213
+ applies_to: ["all"]
214
+ pattern: "export (class|function|const)"
215
+ requires: "@task"
216
+ message: "Exported items should reference their task ID"
217
+
218
+ # Security checks
219
+ - id: input_sanitization
220
+ name: "Input sanitization"
221
+ severity: error
222
+ applies_to: ["controllers", "api"]
223
+ pattern: "req\\.(body|params|query)"
224
+ requires: "sanitize|validate"
225
+ message: "User input must be sanitized"
226
+
227
+ # Test coverage
228
+ - id: test_required
229
+ name: "Test file required"
230
+ severity: warning
231
+ applies_to: ["services", "controllers", "utils"]
232
+ requires_file: "{name}.spec.{ext}"
233
+ message: "Test file is missing"
234
+
235
+ # Error handling
236
+ error_handling:
237
+ style: contextual
238
+ include_metadata: true
239
+ patterns:
240
+ feature_error: |
241
+ class {Name}Error extends Error {
242
+ constructor(message, context) {
243
+ super(`[{feature_id}/{task_id}] ${message}`);
244
+ this.feature = '{feature_id}';
245
+ this.task = '{task_id}';
246
+ this.timestamp = new Date().toISOString();
247
+ }
248
+ }
249
+
250
+ # Git integration
251
+ git:
252
+ hooks:
253
+ pre_commit:
254
+ - validate_features
255
+ - check_task_references
256
+ - run_linter
257
+ post_commit:
258
+ - update_feature_progress
259
+ - log_to_sprint
260
+
261
+ commit_format: "{type}({feature_id}): {message}"
262
+ branch_format: "feature/{feature_id}-{name}"
263
+
264
+ # Performance optimization
265
+ performance:
266
+ analyze: true
267
+ suggest_optimizations: true
268
+ track_metrics: true
269
+ thresholds:
270
+ response_time: 100ms
271
+ bundle_size: 500kb
272
+ memory_usage: 100mb
273
+
274
+ # Testing integration
275
+ testing:
276
+ framework: jest
277
+ coverage:
278
+ threshold: 80
279
+ include_feature_tests: true
280
+ require_acceptance_tests: true
281
+ patterns:
282
+ unit: "*.spec.{js,ts}"
283
+ integration: "*.integration.{js,ts}"
284
+ e2e: "*.e2e.{js,ts}"
285
+
286
+ # Documentation generation
287
+ documentation:
288
+ auto_generate: true
289
+ update_on_save: true
290
+ targets:
291
+ - feature_ledger
292
+ - api_docs
293
+ - readme
294
+ - changelog
295
+ format:
296
+ style: markdown
297
+ include_examples: true
298
+ include_diagrams: true
299
+
300
+ # Custom commands
301
+ commands:
302
+ - name: "Create Feature"
303
+ command: "aiwf:create-feature"
304
+ shortcut: "cmd+shift+f"
305
+ description: "Create a new feature in Feature Ledger"
306
+
307
+ - name: "Update Task"
308
+ command: "aiwf:update-task"
309
+ shortcut: "cmd+shift+t"
310
+ description: "Update current task status"
311
+
312
+ - name: "Switch Persona"
313
+ command: "aiwf:switch-persona"
314
+ shortcut: "cmd+shift+p"
315
+ description: "Switch active AI persona"
316
+
317
+ - name: "Sprint Status"
318
+ command: "aiwf:sprint-status"
319
+ shortcut: "cmd+shift+s"
320
+ description: "Show current sprint status"
321
+
322
+ # Cache configuration
323
+ cache:
324
+ enabled: true
325
+ location: .augment/cache
326
+ max_size: 100mb
327
+ ttl: 24h
328
+ clear_on:
329
+ - major_version_change
330
+ - structure_change
331
+ - manual_clear
332
+
333
+ # Telemetry
334
+ telemetry:
335
+ enabled: false
336
+ anonymous: true
337
+ track:
338
+ - feature_usage
339
+ - persona_switches
340
+ - performance_metrics
341
+
342
+ # Experimental features
343
+ experimental:
344
+ ai_refactoring: false
345
+ auto_test_generation: false
346
+ smart_documentation: false
347
+ predictive_coding: false
@@ -0,0 +1,64 @@
1
+ {
2
+ "augment": {
3
+ "version": "1.0.0",
4
+ "aiwf_integration": {
5
+ "enabled": true,
6
+ "sync_mode": "realtime",
7
+ "features": {
8
+ "feature_ledger": {
9
+ "path": ".aiwf/feature-ledger/",
10
+ "auto_index": true,
11
+ "deep_understanding": true
12
+ },
13
+ "personas": {
14
+ "path": ".aiwf/personas/",
15
+ "team_shared": true,
16
+ "context_switching": true
17
+ },
18
+ "sprints": {
19
+ "path": ".aiwf/03_SPRINTS/",
20
+ "team_visibility": true,
21
+ "progress_tracking": true
22
+ }
23
+ }
24
+ },
25
+ "codebase_understanding": {
26
+ "aiwf_aware": true,
27
+ "feature_mapping": true,
28
+ "dependency_tracking": true,
29
+ "architecture_comprehension": true
30
+ },
31
+ "team_features": {
32
+ "shared_context": true,
33
+ "feature_ownership": true,
34
+ "task_assignment": true,
35
+ "code_review_integration": true
36
+ },
37
+ "ai_configuration": {
38
+ "models": {
39
+ "code_completion": "augment-fast",
40
+ "code_understanding": "augment-deep",
41
+ "documentation": "augment-doc",
42
+ "review": "augment-review"
43
+ },
44
+ "context_window": {
45
+ "size": 150000,
46
+ "compression": true,
47
+ "feature_prioritization": true
48
+ }
49
+ },
50
+ "automation": {
51
+ "feature_discovery": true,
52
+ "task_suggestions": true,
53
+ "documentation_generation": true,
54
+ "test_generation": true,
55
+ "refactoring_suggestions": true
56
+ },
57
+ "integrations": {
58
+ "ide": ["vscode", "intellij", "vim"],
59
+ "vcs": ["git", "github", "gitlab"],
60
+ "ci_cd": ["github-actions", "jenkins", "circleci"],
61
+ "communication": ["slack", "teams", "discord"]
62
+ }
63
+ }
64
+ }
@@ -0,0 +1,151 @@
1
+ # Claude Code AIWF Integration Template
2
+
3
+ ## Overview
4
+
5
+ This template provides seamless integration between Claude Code and the AI Workflow Framework (AIWF). It enhances Claude Code's capabilities with AIWF's structured development features.
6
+
7
+ ## Features
8
+
9
+ - **Feature Ledger Integration**: Automatic synchronization with AIWF's feature tracking system
10
+ - **AI Persona Support**: Access to specialized AI personas for different development contexts
11
+ - **Sprint Management**: Integration with AIWF's sprint and task management
12
+ - **Context Compression**: Efficient handling of large codebases
13
+ - **Offline Cache**: Local caching for improved performance
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ # Install Claude Code template
19
+ aiwf ai-tool install claude-code
20
+
21
+ # Or manually copy template files
22
+ cp -r .aiwf/ai-tools/claude-code/template/* .
23
+ ```
24
+
25
+ ## Configuration
26
+
27
+ The template includes:
28
+
29
+ 1. **CLAUDE.md**: Main configuration file for Claude Code
30
+ - AIWF feature documentation
31
+ - Command quick reference
32
+ - Best practices guide
33
+
34
+ 2. **.claude/**: Directory for Claude-specific settings
35
+ - Context rules
36
+ - Custom instructions
37
+ - Project metadata
38
+
39
+ ## Usage
40
+
41
+ ### 1. Feature Ledger Integration
42
+
43
+ Claude Code automatically recognizes Feature Ledger entries:
44
+
45
+ ```bash
46
+ # View features directly in Claude Code
47
+ @features list
48
+ @features show <feature-id>
49
+ ```
50
+
51
+ ### 2. AI Personas
52
+
53
+ Activate specialized personas within Claude Code:
54
+
55
+ ```
56
+ @persona architect
57
+ Design a microservices architecture for the payment system.
58
+
59
+ @persona reviewer
60
+ Review the authentication module for security issues.
61
+ ```
62
+
63
+ ### 3. Sprint Tasks
64
+
65
+ Work with sprint tasks seamlessly:
66
+
67
+ ```
68
+ @task start T13_S03
69
+ @task status
70
+ @task complete T13_S03
71
+ ```
72
+
73
+ ### 4. Context Management
74
+
75
+ Handle large files efficiently:
76
+
77
+ ```
78
+ @compress src/large-module.js
79
+ @expand compressed/large-module.js
80
+ ```
81
+
82
+ ## Best Practices
83
+
84
+ 1. **Start with Feature Ledger**: Always check existing features before implementing new ones
85
+ 2. **Use Appropriate Personas**: Select the right AI persona for each task type
86
+ 3. **Follow Sprint Structure**: Update task status as you progress
87
+ 4. **Manage Context Wisely**: Use compression for large files to stay within limits
88
+ 5. **Document Decisions**: Reference ADRs in your implementation
89
+
90
+ ## Customization
91
+
92
+ ### Adding Project-Specific Rules
93
+
94
+ Edit `CLAUDE.md` to add your project-specific guidelines:
95
+
96
+ ```markdown
97
+ ### Project-Specific Guidelines
98
+
99
+ - Use TypeScript for all new modules
100
+ - Follow Clean Architecture principles
101
+ - Implement comprehensive error handling
102
+ ```
103
+
104
+ ### Configuring AI Personas
105
+
106
+ Customize persona behavior in `.claude/personas.json`:
107
+
108
+ ```json
109
+ {
110
+ "custom_personas": {
111
+ "backend_specialist": {
112
+ "focus": "Node.js, API design, database optimization",
113
+ "style": "pragmatic, performance-focused"
114
+ }
115
+ }
116
+ }
117
+ ```
118
+
119
+ ## Troubleshooting
120
+
121
+ ### Common Issues
122
+
123
+ 1. **Feature Ledger not syncing**
124
+ - Run `aiwf ledger sync`
125
+ - Check `.aiwf/feature-ledger/` permissions
126
+
127
+ 2. **Personas not responding**
128
+ - Verify persona files in `.aiwf/personas/`
129
+ - Run `aiwf persona validate`
130
+
131
+ 3. **Context overflow**
132
+ - Use `aiwf context stats` to check usage
133
+ - Compress large files with `aiwf context compress`
134
+
135
+ ## Updates
136
+
137
+ Keep your template updated:
138
+
139
+ ```bash
140
+ aiwf ai-tool update claude-code
141
+ ```
142
+
143
+ ## Support
144
+
145
+ - Documentation: [AIWF Docs](https://aiwf.dev/docs)
146
+ - Issues: [GitHub Issues](https://github.com/moonklabs/aiwf/issues)
147
+ - Community: [Discord Server](https://discord.gg/aiwf)
148
+
149
+ ---
150
+
151
+ *Claude Code Integration Template v1.0.0*
@@ -0,0 +1,28 @@
1
+ {
2
+ "name": "claude-code",
3
+ "version": "1.0.0",
4
+ "description": "Claude Code integration template for AIWF",
5
+ "compatible_aiwf_version": ">=0.1.0",
6
+ "features": {
7
+ "feature_ledger": true,
8
+ "ai_persona": true,
9
+ "context_compression": true,
10
+ "offline_cache": true
11
+ },
12
+ "setup_commands": [],
13
+ "files_to_copy": [
14
+ {
15
+ "source": "template/.claude",
16
+ "destination": ".claude"
17
+ },
18
+ {
19
+ "source": "template/CLAUDE.md",
20
+ "destination": "CLAUDE.md"
21
+ }
22
+ ],
23
+ "settings": {
24
+ "auto_context_update": true,
25
+ "feature_ledger_integration": "automatic",
26
+ "persona_activation": "on_demand"
27
+ }
28
+ }
@@ -0,0 +1,91 @@
1
+ # CLAUDE.md
2
+
3
+ This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
+
5
+ ## AIWF Integration
6
+
7
+ This project uses the AI Workflow Framework (AIWF) for AI-assisted development. Claude Code is configured to work seamlessly with AIWF features.
8
+
9
+ ### Available AIWF Features
10
+
11
+ 1. **Feature Ledger**: Track and reference all features through `.aiwf/feature-ledger/`
12
+ 2. **AI Personas**: Access specialized AI personas for different contexts in `.aiwf/personas/`
13
+ 3. **Sprint Management**: Follow structured sprints in `.aiwf/03_SPRINTS/`
14
+ 4. **Templates**: Use standardized templates from `.aiwf/99_TEMPLATES/`
15
+
16
+ ### Working with Feature Ledger
17
+
18
+ When implementing new features:
19
+ 1. Check existing features in the ledger first
20
+ 2. Reference feature IDs in commit messages
21
+ 3. Update feature status as you work
22
+ 4. Use `aiwf ledger show <feature-id>` to view details
23
+
24
+ ### AI Persona Usage
25
+
26
+ Available personas can be activated with:
27
+ - `@persona analyst` - For system analysis tasks
28
+ - `@persona architect` - For architecture decisions
29
+ - `@persona developer` - For implementation tasks
30
+ - `@persona reviewer` - For code reviews
31
+ - `@persona tester` - For testing scenarios
32
+
33
+ ### Context Compression
34
+
35
+ To manage context limits effectively:
36
+ - Use `aiwf context compress` to optimize large files
37
+ - Reference compressed files with `@compressed/<filename>`
38
+ - Claude Code will automatically expand when needed
39
+
40
+ ### Sprint Task Workflow
41
+
42
+ 1. View current sprint: `aiwf sprint current`
43
+ 2. List tasks: `aiwf sprint tasks`
44
+ 3. Start a task: `aiwf task start <task-id>`
45
+ 4. Complete a task: `aiwf task complete <task-id>`
46
+
47
+ ### Best Practices
48
+
49
+ 1. **Always check Feature Ledger before implementing new features**
50
+ 2. **Use appropriate AI personas for specialized tasks**
51
+ 3. **Keep context focused using compression when needed**
52
+ 4. **Follow sprint structure and update task status**
53
+ 5. **Reference ADRs for architectural decisions**
54
+
55
+ ### AIWF Commands Quick Reference
56
+
57
+ ```bash
58
+ # Feature Ledger
59
+ aiwf ledger list # List all features
60
+ aiwf ledger show <id> # Show feature details
61
+ aiwf ledger add # Add new feature
62
+
63
+ # Sprint Management
64
+ aiwf sprint current # Show current sprint
65
+ aiwf sprint tasks # List sprint tasks
66
+ aiwf task start <id> # Start a task
67
+ aiwf task complete <id> # Complete a task
68
+
69
+ # AI Personas
70
+ aiwf persona list # List available personas
71
+ aiwf persona use <name> # Activate a persona
72
+
73
+ # Context Management
74
+ aiwf context compress <file> # Compress large file
75
+ aiwf context stats # Show context usage
76
+ ```
77
+
78
+ ### Project-Specific Guidelines
79
+
80
+ <!-- Project-specific guidelines will be added here by the development team -->
81
+
82
+ ### Integration Notes
83
+
84
+ - Feature Ledger is automatically synchronized
85
+ - AI Personas enhance Claude Code's contextual understanding
86
+ - Sprint tasks provide structured development workflow
87
+ - Context compression helps manage large codebases efficiently
88
+
89
+ ---
90
+
91
+ *This template is part of AIWF's Claude Code integration. Version: 1.0.0*