aiwf 0.3.19 → 0.3.21

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.
@@ -1,387 +0,0 @@
1
- # Augment AIWF Integration Guide
2
-
3
- ## Overview
4
-
5
- This guide configures Augment Code to deeply understand and work with AIWF projects. Augment's codebase comprehension and team collaboration features are enhanced with AIWF's structured approach.
6
-
7
- ## Core Integration Concepts
8
-
9
- ### 1. Deep Codebase Understanding
10
-
11
- Augment learns your AIWF structure:
12
- - **Feature Ledger**: Understands all features and their relationships
13
- - **Sprint Tasks**: Knows current work and priorities
14
- - **AI Personas**: Applies appropriate context based on personas
15
- - **Architecture**: Comprehends system design through ADRs
16
-
17
- ### 2. Team Collaboration
18
-
19
- AIWF + Augment enables:
20
- - Shared understanding of features across team
21
- - Task assignment based on expertise
22
- - Consistent code patterns
23
- - Automated knowledge sharing
24
-
25
- ### 3. Intelligent Assistance
26
-
27
- Augment provides AIWF-aware help:
28
- - Suggests relevant features for new code
29
- - Warns about feature conflicts
30
- - Recommends appropriate personas
31
- - Tracks sprint progress
32
-
33
- ## Configuration
34
-
35
- ### Feature Ledger Integration
36
-
37
- Augment automatically indexes:
38
- ```
39
- .aiwf/feature-ledger/
40
- ├── FL-001-authentication.json
41
- ├── FL-002-user-profiles.json
42
- └── feature-map.json
43
- ```
44
-
45
- Understanding includes:
46
- - Feature specifications
47
- - Dependencies
48
- - Implementation status
49
- - Related code locations
50
-
51
- ### Sprint Awareness
52
-
53
- Current sprint context:
54
- ```
55
- .aiwf/03_SPRINTS/S03_M02_ecosystem_integration/
56
- ├── sprint_metadata.json
57
- ├── T13_S03_AI_도구_통합.md
58
- └── sprint_goals.md
59
- ```
60
-
61
- Augment knows:
62
- - Active tasks
63
- - Task assignments
64
- - Progress status
65
- - Acceptance criteria
66
-
67
- ### AI Persona Application
68
-
69
- Available personas:
70
- ```
71
- .aiwf/personas/
72
- ├── analyst.json
73
- ├── architect.json
74
- ├── developer.json
75
- ├── reviewer.json
76
- └── tester.json
77
- ```
78
-
79
- Augment applies persona-specific:
80
- - Code suggestions
81
- - Review criteria
82
- - Documentation style
83
- - Testing approaches
84
-
85
- ## Usage Patterns
86
-
87
- ### 1. Feature-Aware Coding
88
-
89
- When writing code, Augment:
90
- - Suggests feature references
91
- - Validates against ledger
92
- - Maintains consistency
93
- - Updates documentation
94
-
95
- Example:
96
- ```javascript
97
- // Start typing a function
98
- function processPayment() {
99
- // Augment suggests:
100
- // Feature: FL-003 - Payment Processing
101
- // Dependencies: FL-001 (Auth), FL-002 (User)
102
- // Sprint Task: T14_S03
103
- }
104
- ```
105
-
106
- ### 2. Smart Code Completion
107
-
108
- Context-aware suggestions:
109
-
110
- ```javascript
111
- // When implementing authentication
112
- user.authenticate() // Augment knows this relates to FL-001
113
-
114
- // Suggests methods from feature spec:
115
- user.validateCredentials()
116
- user.generateToken()
117
- user.setupTwoFactor()
118
- ```
119
-
120
- ### 3. Team Collaboration
121
-
122
- Shared understanding:
123
-
124
- ```javascript
125
- // Team member A implements feature
126
- // @augment FL-001 implementation by @alice
127
-
128
- // Team member B sees context
129
- // Augment shows: "Alice implemented FL-001, see patterns in auth.js"
130
- ```
131
-
132
- ### 4. Automated Documentation
133
-
134
- Augment generates:
135
-
136
- ```javascript
137
- /**
138
- * Processes user payment
139
- *
140
- * @feature FL-003 - Payment Processing
141
- * @sprint S03
142
- * @task T14_S03
143
- * @dependencies FL-001, FL-002
144
- * @augment-generated
145
- */
146
- function processPayment(userId, amount) {
147
- // Implementation
148
- }
149
- ```
150
-
151
- ### 5. Code Review Integration
152
-
153
- During reviews, Augment:
154
- - Checks feature compliance
155
- - Validates sprint alignment
156
- - Ensures persona guidelines
157
- - Suggests improvements
158
-
159
- ## Best Practices
160
-
161
- ### 1. Feature First
162
-
163
- Always start with feature context:
164
- ```
165
- @augment explain FL-001
166
- @augment show dependencies for current file
167
- @augment validate against feature spec
168
- ```
169
-
170
- ### 2. Team Sync
171
-
172
- Keep team aligned:
173
- ```
174
- @augment share feature understanding
175
- @augment show team progress on S03
176
- @augment who worked on FL-001?
177
- ```
178
-
179
- ### 3. Sprint Focus
180
-
181
- Stay on track:
182
- ```
183
- @augment current sprint tasks
184
- @augment my assigned tasks
185
- @augment task progress T13_S03
186
- ```
187
-
188
- ### 4. Documentation
189
-
190
- Let Augment help:
191
- ```
192
- @augment document this function
193
- @augment update feature docs
194
- @augment generate API docs
195
- ```
196
-
197
- ## Advanced Features
198
-
199
- ### 1. Codebase Analysis
200
-
201
- Deep understanding commands:
202
-
203
- ```
204
- @augment analyze feature coverage
205
- @augment find feature gaps
206
- @augment suggest refactoring for FL-001
207
- @augment architecture review
208
- ```
209
-
210
- ### 2. Test Generation
211
-
212
- AIWF-aware testing:
213
-
214
- ```javascript
215
- // @augment generate tests for FL-001
216
- // Generates:
217
- describe('Authentication Feature (FL-001)', () => {
218
- it('should validate credentials', () => {
219
- // Test based on feature spec
220
- });
221
-
222
- it('should handle 2FA', () => {
223
- // Test for feature requirement
224
- });
225
- });
226
- ```
227
-
228
- ### 3. Refactoring Suggestions
229
-
230
- Intelligent improvements:
231
-
232
- ```
233
- @augment refactor for feature FL-001
234
- // Suggests:
235
- // - Extract authentication logic to service
236
- // - Implement strategy pattern for auth methods
237
- // - Add feature flag for gradual rollout
238
- ```
239
-
240
- ### 4. Knowledge Queries
241
-
242
- Ask about your codebase:
243
-
244
- ```
245
- @augment how does authentication work?
246
- @augment what features depend on user service?
247
- @augment show architecture for payment system
248
- @augment who has expertise in FL-003?
249
- ```
250
-
251
- ## Team Features
252
-
253
- ### 1. Expertise Mapping
254
-
255
- Augment tracks:
256
- - Who implemented which features
257
- - Domain expertise by team member
258
- - Code ownership patterns
259
- - Review participation
260
-
261
- ### 2. Task Assignment
262
-
263
- Smart suggestions:
264
- ```
265
- @augment who should implement T14_S03?
266
- // Based on:
267
- // - Feature expertise
268
- // - Current workload
269
- // - Past performance
270
- ```
271
-
272
- ### 3. Knowledge Transfer
273
-
274
- Automated documentation:
275
- ```
276
- @augment create onboarding guide for FL-001
277
- @augment explain payment flow to new developer
278
- @augment document team decisions on auth
279
- ```
280
-
281
- ### 4. Code Consistency
282
-
283
- Team-wide patterns:
284
- ```
285
- @augment show team coding patterns
286
- @augment enforce style for FL-001
287
- @augment suggest consistent naming
288
- ```
289
-
290
- ## Performance Optimization
291
-
292
- ### 1. Context Management
293
-
294
- - Augment automatically compresses large contexts
295
- - Prioritizes relevant features
296
- - Caches frequently accessed data
297
- - Optimizes for quick responses
298
-
299
- ### 2. Indexing Strategy
300
-
301
- - Incremental indexing on file changes
302
- - Priority indexing for active features
303
- - Background indexing for full codebase
304
- - Smart cache invalidation
305
-
306
- ### 3. Team Sync
307
-
308
- - Efficient delta syncing
309
- - Compressed knowledge transfer
310
- - Lazy loading of team data
311
- - Local caching of common queries
312
-
313
- ## Integration Commands
314
-
315
- Quick reference:
316
-
317
- ```bash
318
- # Feature commands
319
- @augment feature list
320
- @augment feature show FL-001
321
- @augment feature validate
322
-
323
- # Sprint commands
324
- @augment sprint current
325
- @augment sprint tasks
326
- @augment sprint progress
327
-
328
- # Team commands
329
- @augment team status
330
- @augment team expertise
331
- @augment team assign T14_S03
332
-
333
- # Analysis commands
334
- @augment analyze codebase
335
- @augment analyze dependencies
336
- @augment analyze architecture
337
- ```
338
-
339
- ## Troubleshooting
340
-
341
- ### Common Issues
342
-
343
- 1. **Augment not recognizing features**
344
- - Run `@augment reindex features`
345
- - Check .augment/config.json
346
- - Verify feature ledger structure
347
-
348
- 2. **Team sync issues**
349
- - Check network connectivity
350
- - Verify team permissions
351
- - Run `@augment team sync --force`
352
-
353
- 3. **Slow performance**
354
- - Enable compression: `@augment config set compression true`
355
- - Clear cache: `@augment cache clear`
356
- - Reduce context size
357
-
358
- ### Debug Mode
359
-
360
- Enable detailed logging:
361
-
362
- ```json
363
- {
364
- "augment": {
365
- "debug": {
366
- "enabled": true,
367
- "verbose": true,
368
- "log_file": ".augment/debug.log"
369
- }
370
- }
371
- }
372
- ```
373
-
374
- ## Best Practices Summary
375
-
376
- 1. **Always reference features** in code and commits
377
- 2. **Keep sprint tasks updated** as you work
378
- 3. **Use appropriate personas** for different tasks
379
- 4. **Leverage team features** for collaboration
380
- 5. **Let Augment generate** documentation
381
- 6. **Trust codebase analysis** for decisions
382
- 7. **Share knowledge** through Augment
383
- 8. **Maintain feature specs** for accuracy
384
-
385
- ---
386
-
387
- *Augment AIWF Integration v1.0.0*
@@ -1,347 +0,0 @@
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