@mytechtoday/augment-extensions 0.1.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.
Files changed (50) hide show
  1. package/AGENTS.md +152 -0
  2. package/LICENSE +22 -0
  3. package/MODULES.md +124 -0
  4. package/README.md +195 -0
  5. package/cli/dist/cli.d.ts +3 -0
  6. package/cli/dist/cli.d.ts.map +1 -0
  7. package/cli/dist/cli.js +100 -0
  8. package/cli/dist/cli.js.map +1 -0
  9. package/cli/dist/commands/init.d.ts +6 -0
  10. package/cli/dist/commands/init.d.ts.map +1 -0
  11. package/cli/dist/commands/init.js +137 -0
  12. package/cli/dist/commands/init.js.map +1 -0
  13. package/cli/dist/commands/link.d.ts +6 -0
  14. package/cli/dist/commands/link.d.ts.map +1 -0
  15. package/cli/dist/commands/link.js +85 -0
  16. package/cli/dist/commands/link.js.map +1 -0
  17. package/cli/dist/commands/list.d.ts +7 -0
  18. package/cli/dist/commands/list.d.ts.map +1 -0
  19. package/cli/dist/commands/list.js +122 -0
  20. package/cli/dist/commands/list.js.map +1 -0
  21. package/cli/dist/commands/search.d.ts +6 -0
  22. package/cli/dist/commands/search.d.ts.map +1 -0
  23. package/cli/dist/commands/search.js +16 -0
  24. package/cli/dist/commands/search.js.map +1 -0
  25. package/cli/dist/commands/show.d.ts +6 -0
  26. package/cli/dist/commands/show.d.ts.map +1 -0
  27. package/cli/dist/commands/show.js +106 -0
  28. package/cli/dist/commands/show.js.map +1 -0
  29. package/cli/dist/commands/update.d.ts +6 -0
  30. package/cli/dist/commands/update.d.ts.map +1 -0
  31. package/cli/dist/commands/update.js +19 -0
  32. package/cli/dist/commands/update.js.map +1 -0
  33. package/modules/coding-standards/typescript/README.md +45 -0
  34. package/modules/coding-standards/typescript/module.json +27 -0
  35. package/modules/coding-standards/typescript/rules/naming-conventions.md +225 -0
  36. package/modules/workflows/beads/README.md +135 -0
  37. package/modules/workflows/beads/examples/complete-workflow-example.md +278 -0
  38. package/modules/workflows/beads/module.json +54 -0
  39. package/modules/workflows/beads/rules/best-practices.md +398 -0
  40. package/modules/workflows/beads/rules/file-format.md +283 -0
  41. package/modules/workflows/beads/rules/manual-setup.md +315 -0
  42. package/modules/workflows/beads/rules/workflow.md +285 -0
  43. package/modules/workflows/openspec/README.md +96 -0
  44. package/modules/workflows/openspec/examples/complete-change-example.md +230 -0
  45. package/modules/workflows/openspec/module.json +53 -0
  46. package/modules/workflows/openspec/rules/best-practices.md +272 -0
  47. package/modules/workflows/openspec/rules/manual-setup.md +231 -0
  48. package/modules/workflows/openspec/rules/spec-format.md +193 -0
  49. package/modules/workflows/openspec/rules/workflow.md +189 -0
  50. package/package.json +72 -0
@@ -0,0 +1,189 @@
1
+ # OpenSpec Workflow Guide
2
+
3
+ ## Overview
4
+
5
+ OpenSpec implements spec-driven development (SDD) where specifications are agreed upon before implementation. This workflow works with or without the OpenSpec CLI.
6
+
7
+ ## Core Workflow
8
+
9
+ ```
10
+ ┌────────────────────┐
11
+ │ Draft Change │
12
+ │ Proposal │
13
+ └────────┬───────────┘
14
+ │ share intent with your AI
15
+
16
+ ┌────────────────────┐
17
+ │ Review & Align │
18
+ │ (edit specs/tasks) │◀──── feedback loop ──────┐
19
+ └────────┬───────────┘ │
20
+ │ approved plan │
21
+ ▼ │
22
+ ┌────────────────────┐ │
23
+ │ Implement Tasks │──────────────────────────┘
24
+ │ (AI writes code) │
25
+ └────────┬───────────┘
26
+ │ ship the change
27
+
28
+ ┌────────────────────┐
29
+ │ Archive & Update │
30
+ │ Specs (source) │
31
+ └────────────────────┘
32
+ ```
33
+
34
+ ## Step 1: Draft Change Proposal
35
+
36
+ ### With CLI
37
+
38
+ Ask your AI agent:
39
+
40
+ ```
41
+ Create an OpenSpec change proposal for adding profile search filters by role and team
42
+ ```
43
+
44
+ Or use slash command (if supported):
45
+
46
+ ```
47
+ /openspec:proposal Add profile search filters
48
+ ```
49
+
50
+ ### Without CLI
51
+
52
+ Ask your AI agent:
53
+
54
+ ```
55
+ Create a new change folder in openspec/changes/add-profile-filters/ with:
56
+ 1. proposal.md - describing the change
57
+ 2. tasks.md - implementation checklist
58
+ 3. specs/ - folder with spec deltas for affected components
59
+ ```
60
+
61
+ ### What Gets Created
62
+
63
+ ```
64
+ openspec/changes/add-profile-filters/
65
+ ├── proposal.md # Why this change, what it does
66
+ ├── tasks.md # Checklist of implementation steps
67
+ └── specs/
68
+ └── profile/
69
+ └── spec.md # Delta showing additions/modifications
70
+ ```
71
+
72
+ ## Step 2: Review & Align
73
+
74
+ ### Validate (CLI only)
75
+
76
+ ```bash
77
+ openspec validate add-profile-filters
78
+ ```
79
+
80
+ ### Review
81
+
82
+ ```bash
83
+ # With CLI
84
+ openspec show add-profile-filters
85
+
86
+ # Without CLI - manually review files
87
+ cat openspec/changes/add-profile-filters/proposal.md
88
+ cat openspec/changes/add-profile-filters/tasks.md
89
+ cat openspec/changes/add-profile-filters/specs/profile/spec.md
90
+ ```
91
+
92
+ ### Iterate
93
+
94
+ Ask your AI to refine:
95
+
96
+ ```
97
+ Can you add acceptance criteria for the role and team filters?
98
+ ```
99
+
100
+ ```
101
+ The tasks look good, but can you break down task 2.1 into smaller steps?
102
+ ```
103
+
104
+ Continue until specs match your requirements.
105
+
106
+ ## Step 3: Implement Tasks
107
+
108
+ ### With CLI
109
+
110
+ ```
111
+ The specs look good. Let's implement this change.
112
+ ```
113
+
114
+ Or use slash command:
115
+
116
+ ```
117
+ /openspec:apply add-profile-filters
118
+ ```
119
+
120
+ ### Without CLI
121
+
122
+ ```
123
+ Please implement the tasks in openspec/changes/add-profile-filters/tasks.md
124
+ Mark each task complete as you finish it.
125
+ ```
126
+
127
+ ### AI Implementation Pattern
128
+
129
+ The AI agent will:
130
+
131
+ 1. Read the spec deltas to understand requirements
132
+ 2. Work through tasks.md sequentially
133
+ 3. Mark tasks complete: `- [x] 1.1 Add role filter component`
134
+ 4. Reference specs when making decisions
135
+ 5. Update tasks.md if scope changes
136
+
137
+ ## Step 4: Archive Completed Change
138
+
139
+ ### With CLI
140
+
141
+ ```bash
142
+ openspec archive add-profile-filters --yes
143
+ ```
144
+
145
+ Or ask AI:
146
+
147
+ ```
148
+ Please archive the add-profile-filters change
149
+ ```
150
+
151
+ ### Without CLI
152
+
153
+ Manually merge the changes:
154
+
155
+ 1. Copy spec deltas from `openspec/changes/add-profile-filters/specs/` to `openspec/specs/`
156
+ 2. Apply ADDED/MODIFIED/REMOVED sections to source specs
157
+ 3. Move change folder to archive: `openspec/archive/add-profile-filters/`
158
+
159
+ ## Commands Reference
160
+
161
+ ### With CLI
162
+
163
+ | Command | Action |
164
+ |---------|--------|
165
+ | `openspec init` | Initialize OpenSpec in project |
166
+ | `openspec list` | View active change folders |
167
+ | `openspec show <change>` | Display change details |
168
+ | `openspec validate <change>` | Check spec formatting |
169
+ | `openspec archive <change>` | Merge change into specs |
170
+ | `openspec update` | Refresh AI agent instructions |
171
+
172
+ ### Without CLI
173
+
174
+ All operations are manual file operations. AI agents can create/edit files directly.
175
+
176
+ ## Best Practices
177
+
178
+ 1. **One Change Per Folder**: Keep changes focused and atomic
179
+ 2. **Review Before Implementation**: Catch issues in specs, not code
180
+ 3. **Update Tasks During Implementation**: Reflect actual work done
181
+ 4. **Archive Promptly**: Keep changes/ folder clean
182
+ 5. **Use Descriptive Names**: `add-2fa` not `feature-123`
183
+
184
+ ## Next Steps
185
+
186
+ - See `spec-format.md` for specification syntax
187
+ - See `manual-setup.md` for CLI-free setup
188
+ - See `best-practices.md` for advanced patterns
189
+
package/package.json ADDED
@@ -0,0 +1,72 @@
1
+ {
2
+ "name": "@mytechtoday/augment-extensions",
3
+ "version": "0.1.0",
4
+ "description": "CLI tool for managing Augment Code AI extension modules",
5
+ "main": "cli/dist/index.js",
6
+ "bin": {
7
+ "augx": "cli/dist/cli.js"
8
+ },
9
+ "files": [
10
+ "cli/dist/",
11
+ "modules/",
12
+ "README.md",
13
+ "LICENSE",
14
+ "AGENTS.md",
15
+ "MODULES.md"
16
+ ],
17
+ "scripts": {
18
+ "build": "cd cli && tsc",
19
+ "dev": "cd cli && tsc --watch",
20
+ "test": "echo \"No tests yet\" && exit 0",
21
+ "lint": "cd cli && eslint src/**/*.ts",
22
+ "prepare": "npm run build",
23
+ "prepublishOnly": "npm run build"
24
+ },
25
+ "keywords": [
26
+ "augment",
27
+ "augment-code",
28
+ "ai",
29
+ "ai-assistant",
30
+ "coding-assistant",
31
+ "extensions",
32
+ "modules",
33
+ "coding-standards",
34
+ "typescript",
35
+ "openspec",
36
+ "beads"
37
+ ],
38
+ "author": "Augment Extensions",
39
+ "license": "MIT",
40
+ "repository": {
41
+ "type": "git",
42
+ "url": "https://github.com/mytech-today-now/augment.git"
43
+ },
44
+ "bugs": {
45
+ "url": "https://github.com/mytech-today-now/augment/issues"
46
+ },
47
+ "homepage": "https://github.com/mytech-today-now/augment#readme",
48
+ "engines": {
49
+ "node": ">=16.0.0"
50
+ },
51
+ "publishConfig": {
52
+ "access": "public"
53
+ },
54
+ "dependencies": {
55
+ "commander": "^11.0.0",
56
+ "chalk": "^5.3.0",
57
+ "inquirer": "^9.2.0",
58
+ "semver": "^7.5.0",
59
+ "yaml": "^2.3.0"
60
+ },
61
+ "devDependencies": {
62
+ "@types/node": "^20.0.0",
63
+ "@types/inquirer": "^9.0.0",
64
+ "@types/semver": "^7.5.0",
65
+ "@typescript-eslint/eslint-plugin": "^6.0.0",
66
+ "@typescript-eslint/parser": "^6.0.0",
67
+ "eslint": "^8.50.0",
68
+ "jest": "^29.7.0",
69
+ "typescript": "^5.2.0"
70
+ }
71
+ }
72
+