agcel 1.0.1
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/.agent/workflows/api-gen.md +59 -0
- package/.agent/workflows/architect.md +44 -0
- package/.agent/workflows/brainstorm.md +223 -0
- package/.agent/workflows/build.md +38 -0
- package/.agent/workflows/changelog.md +51 -0
- package/.agent/workflows/checkpoint.md +138 -0
- package/.agent/workflows/commit.md +223 -0
- package/.agent/workflows/debug.md +57 -0
- package/.agent/workflows/deploy.md +76 -0
- package/.agent/workflows/doc.md +247 -0
- package/.agent/workflows/execute-plan.md +225 -0
- package/.agent/workflows/feature.md +255 -0
- package/.agent/workflows/fix.md +323 -0
- package/.agent/workflows/help.md +63 -0
- package/.agent/workflows/index.md +148 -0
- package/.agent/workflows/load.md +112 -0
- package/.agent/workflows/mode.md +170 -0
- package/.agent/workflows/optimize.md +53 -0
- package/.agent/workflows/plan.md +337 -0
- package/.agent/workflows/pr.md +74 -0
- package/.agent/workflows/product-plan.md +36 -0
- package/.agent/workflows/production-deploy.md +39 -0
- package/.agent/workflows/refactor.md +63 -0
- package/.agent/workflows/research.md +116 -0
- package/.agent/workflows/review.md +344 -0
- package/.agent/workflows/security-scan.md +56 -0
- package/.agent/workflows/ship.md +221 -0
- package/.agent/workflows/spawn.md +177 -0
- package/.agent/workflows/status.md +59 -0
- package/.agent/workflows/tdd.md +139 -0
- package/.agent/workflows/test.md +340 -0
- package/.agent/workflows/verify.md +35 -0
- package/LICENSE +21 -0
- package/README.md +67 -0
- package/dist/commands/init.js +142 -0
- package/dist/commands/install.js +98 -0
- package/dist/commands/list.js +49 -0
- package/dist/commands/restart.js +17 -0
- package/dist/commands/start.js +41 -0
- package/dist/commands/status.js +24 -0
- package/dist/commands/stop.js +29 -0
- package/dist/commands/uninstall.js +78 -0
- package/dist/index.js +58 -0
- package/dist/server/index.js +174 -0
- package/dist/utils/index.js +63 -0
- package/package.json +54 -0
- package/skills/api-security-best-practices/SKILL.md +291 -0
- package/skills/api-security-best-practices/references/examples.md +617 -0
- package/skills/architecture/SKILL.md +59 -0
- package/skills/architecture/context-discovery.md +43 -0
- package/skills/architecture/examples.md +94 -0
- package/skills/architecture/pattern-selection.md +68 -0
- package/skills/architecture/patterns-reference.md +50 -0
- package/skills/architecture/trade-off-analysis.md +77 -0
- package/skills/aws-serverless/SKILL.md +327 -0
- package/skills/brainstorming/SKILL.md +234 -0
- package/skills/c4-context/SKILL.md +154 -0
- package/skills/ci-cd-engineer/SKILL.md +50 -0
- package/skills/code-auditing/SKILL.md +55 -0
- package/skills/copywriting/SKILL.md +248 -0
- package/skills/database-engineer/SKILL.md +47 -0
- package/skills/doc-coauthoring/SKILL.md +379 -0
- package/skills/docker-expert/SKILL.md +412 -0
- package/skills/langgraph/SKILL.md +291 -0
- package/skills/postgresql/SKILL.md +73 -0
- package/skills/pricing-strategy/SKILL.md +360 -0
- package/skills/product-manager/SKILL.md +57 -0
- package/skills/prompt-engineer/README.md +659 -0
- package/skills/prompt-engineer/SKILL.md +256 -0
- package/skills/python-patterns/SKILL.md +445 -0
- package/skills/qa-engineer/SKILL.md +42 -0
- package/skills/rag-engineer/SKILL.md +94 -0
- package/skills/react-patterns/SKILL.md +202 -0
- package/skills/secure-refactoring/SKILL.md +54 -0
- package/skills/security-documentation/SKILL.md +53 -0
- package/skills/senior-architect/SKILL.md +213 -0
- package/skills/senior-architect/references/architecture_patterns.md +103 -0
- package/skills/senior-architect/references/system_design_workflows.md +103 -0
- package/skills/senior-architect/references/tech_decision_guide.md +103 -0
- package/skills/senior-architect/scripts/architecture_diagram_generator.py +114 -0
- package/skills/senior-architect/scripts/dependency_analyzer.py +114 -0
- package/skills/senior-architect/scripts/project_architect.py +114 -0
- package/skills/seo-audit/SKILL.md +491 -0
- package/skills/sql-injection-testing/SKILL.md +452 -0
- package/skills/test-driven-development/SKILL.md +375 -0
- package/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/skills/test-fixing/SKILL.md +123 -0
- package/skills/testing-patterns/SKILL.md +263 -0
- package/skills/typescript-expert/SKILL.md +202 -0
- package/skills/typescript-expert/references/advanced-topics.md +252 -0
- package/skills/typescript-expert/references/tsconfig-strict.json +92 -0
- package/skills/typescript-expert/references/typescript-cheatsheet.md +383 -0
- package/skills/typescript-expert/references/utility-types.ts +335 -0
- package/skills/typescript-expert/scripts/ts_diagnostic.py +203 -0
- package/skills/ui-ux-designer/SKILL.md +46 -0
- package/skills/vercel-deployment/SKILL.md +83 -0
- package/skills/vulnerability-scanner/SKILL.md +280 -0
- package/skills/vulnerability-scanner/checklists.md +121 -0
- package/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/skills/writing-plans/SKILL.md +120 -0
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# /commit - Smart Commit Command
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Create a well-formatted commit with auto-generated message based on staged changes.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/commit [optional message hint]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Arguments
|
|
14
|
+
|
|
15
|
+
- `$ARGUMENTS`: Optional hint for commit message focus (e.g., "auth", "bugfix", "refactor")
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
Create a commit for staged changes with hint: **$ARGUMENTS**
|
|
20
|
+
|
|
21
|
+
## Workflow
|
|
22
|
+
|
|
23
|
+
### Step 1: Analyze Changes
|
|
24
|
+
|
|
25
|
+
1. **Check Status**
|
|
26
|
+
```bash
|
|
27
|
+
git status
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
2. **View Staged Changes**
|
|
31
|
+
```bash
|
|
32
|
+
git diff --staged
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
3. **Review Recent Commits**
|
|
36
|
+
```bash
|
|
37
|
+
git log --oneline -5
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Step 2: Categorize Changes
|
|
41
|
+
|
|
42
|
+
Determine commit type:
|
|
43
|
+
- `feat`: New feature
|
|
44
|
+
- `fix`: Bug fix
|
|
45
|
+
- `docs`: Documentation
|
|
46
|
+
- `style`: Formatting
|
|
47
|
+
- `refactor`: Code restructuring
|
|
48
|
+
- `test`: Adding tests
|
|
49
|
+
- `chore`: Maintenance
|
|
50
|
+
|
|
51
|
+
### Step 3: Generate Message
|
|
52
|
+
|
|
53
|
+
Follow conventional commit format:
|
|
54
|
+
```
|
|
55
|
+
type(scope): subject
|
|
56
|
+
|
|
57
|
+
body (optional)
|
|
58
|
+
|
|
59
|
+
footer (optional)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Step 4: Create Commit
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
git commit -m "$(cat <<'EOF'
|
|
66
|
+
type(scope): subject
|
|
67
|
+
|
|
68
|
+
- Change 1
|
|
69
|
+
- Change 2
|
|
70
|
+
|
|
71
|
+
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
|
72
|
+
|
|
73
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
74
|
+
EOF
|
|
75
|
+
)"
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Commit Message Guidelines
|
|
79
|
+
|
|
80
|
+
### Subject Line
|
|
81
|
+
- Max 50 characters
|
|
82
|
+
- Imperative mood ("Add" not "Added")
|
|
83
|
+
- No period at end
|
|
84
|
+
- Capitalize first letter
|
|
85
|
+
|
|
86
|
+
### Body
|
|
87
|
+
- Wrap at 72 characters
|
|
88
|
+
- Explain what and why
|
|
89
|
+
- Use bullet points for multiple changes
|
|
90
|
+
|
|
91
|
+
### Examples
|
|
92
|
+
|
|
93
|
+
#### Feature
|
|
94
|
+
```
|
|
95
|
+
feat(auth): add password reset functionality
|
|
96
|
+
|
|
97
|
+
- Add reset token generation
|
|
98
|
+
- Implement email sending
|
|
99
|
+
- Add rate limiting for reset requests
|
|
100
|
+
|
|
101
|
+
Closes #123
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### Bug Fix
|
|
105
|
+
```
|
|
106
|
+
fix(api): handle null user in profile endpoint
|
|
107
|
+
|
|
108
|
+
The profile endpoint crashed when accessing deleted users.
|
|
109
|
+
Added null check and proper 404 response.
|
|
110
|
+
|
|
111
|
+
Fixes #456
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Refactor
|
|
115
|
+
```
|
|
116
|
+
refactor(database): extract query builders
|
|
117
|
+
|
|
118
|
+
Split large database service into focused modules
|
|
119
|
+
for better maintainability and testing.
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
#### Documentation
|
|
123
|
+
```
|
|
124
|
+
docs(readme): update installation instructions
|
|
125
|
+
|
|
126
|
+
- Add prerequisites section
|
|
127
|
+
- Update configuration examples
|
|
128
|
+
- Fix broken links
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### Test
|
|
132
|
+
```
|
|
133
|
+
test(auth): add missing login tests
|
|
134
|
+
|
|
135
|
+
- Add test for invalid credentials
|
|
136
|
+
- Add test for locked account
|
|
137
|
+
- Add test for expired session
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
#### Chore
|
|
141
|
+
```
|
|
142
|
+
chore(deps): update dependencies
|
|
143
|
+
|
|
144
|
+
- Update React to 18.2
|
|
145
|
+
- Update TypeScript to 5.3
|
|
146
|
+
- Remove unused packages
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Output
|
|
150
|
+
|
|
151
|
+
### Commit Created
|
|
152
|
+
|
|
153
|
+
```markdown
|
|
154
|
+
## Commit Created
|
|
155
|
+
|
|
156
|
+
**Hash**: `abc1234`
|
|
157
|
+
**Branch**: `feature/auth-improvements`
|
|
158
|
+
|
|
159
|
+
### Message
|
|
160
|
+
```
|
|
161
|
+
feat(auth): add OAuth2 login support
|
|
162
|
+
|
|
163
|
+
- Implement Google OAuth provider
|
|
164
|
+
- Implement GitHub OAuth provider
|
|
165
|
+
- Add session token generation
|
|
166
|
+
- Update user model for OAuth data
|
|
167
|
+
|
|
168
|
+
Closes #789
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Files Changed
|
|
172
|
+
| Status | File |
|
|
173
|
+
|--------|------|
|
|
174
|
+
| M | src/auth/providers.ts |
|
|
175
|
+
| A | src/auth/oauth/google.ts |
|
|
176
|
+
| A | src/auth/oauth/github.ts |
|
|
177
|
+
| M | src/models/user.ts |
|
|
178
|
+
| A | tests/auth/oauth.test.ts |
|
|
179
|
+
|
|
180
|
+
### Stats
|
|
181
|
+
- 5 files changed
|
|
182
|
+
- 234 insertions(+)
|
|
183
|
+
- 12 deletions(-)
|
|
184
|
+
|
|
185
|
+
### Next Steps
|
|
186
|
+
```bash
|
|
187
|
+
# Push to remote
|
|
188
|
+
git push -u origin feature/auth-improvements
|
|
189
|
+
|
|
190
|
+
# Create PR
|
|
191
|
+
gh pr create
|
|
192
|
+
```
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Pre-Commit Checks
|
|
196
|
+
|
|
197
|
+
Before committing:
|
|
198
|
+
- [ ] No secrets in staged files
|
|
199
|
+
- [ ] No debug statements
|
|
200
|
+
- [ ] No TODO comments (unless intentional)
|
|
201
|
+
- [ ] Code is formatted
|
|
202
|
+
|
|
203
|
+
## Amending Commits
|
|
204
|
+
|
|
205
|
+
If pre-commit hooks modify files:
|
|
206
|
+
```bash
|
|
207
|
+
# Stage modified files and amend
|
|
208
|
+
git add -A
|
|
209
|
+
git commit --amend --no-edit
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
<!-- CUSTOMIZATION POINT -->
|
|
213
|
+
## Variations
|
|
214
|
+
|
|
215
|
+
Modify behavior via CLAUDE.md:
|
|
216
|
+
- Commit message format
|
|
217
|
+
- Required sections
|
|
218
|
+
- Issue reference format
|
|
219
|
+
- Co-author settings
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
## Gap Analysis Rule
|
|
223
|
+
Always identify gaps and suggest next steps to users. In case there is no gaps anymore, then AI should clearly state that there is no gap left.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# /debug - Debug Command
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Analyze and debug an error, exception, or unexpected behavior.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/debug [error message or description]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
Debug issue: **$ARGUMENTS**
|
|
16
|
+
|
|
17
|
+
## Workflow
|
|
18
|
+
|
|
19
|
+
### Step 1: Analyze Error
|
|
20
|
+
|
|
21
|
+
1. Parse error message and stack trace
|
|
22
|
+
2. Identify error location
|
|
23
|
+
3. Understand error type
|
|
24
|
+
|
|
25
|
+
### Step 2: Investigate
|
|
26
|
+
|
|
27
|
+
1. Trace execution path
|
|
28
|
+
2. Check related code
|
|
29
|
+
3. Form hypotheses
|
|
30
|
+
|
|
31
|
+
### Step 3: Fix
|
|
32
|
+
|
|
33
|
+
1. Implement minimal fix
|
|
34
|
+
2. Verify fix works
|
|
35
|
+
3. Add regression test
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Debug Report
|
|
41
|
+
|
|
42
|
+
### Error
|
|
43
|
+
[Error message]
|
|
44
|
+
|
|
45
|
+
### Root Cause
|
|
46
|
+
[Explanation]
|
|
47
|
+
|
|
48
|
+
### Fix
|
|
49
|
+
[Code changes]
|
|
50
|
+
|
|
51
|
+
### Prevention
|
|
52
|
+
[Test added]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## Gap Analysis Rule
|
|
57
|
+
Always identify gaps and suggest next steps to users. In case there is no gaps anymore, then AI should clearly state that there is no gap left.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# /deploy - Deployment Command
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Deploy the application to a specified environment with proper checks.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/deploy [environment: staging | production]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
Deploy to: **$ARGUMENTS**
|
|
16
|
+
|
|
17
|
+
## Workflow
|
|
18
|
+
|
|
19
|
+
### Pre-Deploy Checks
|
|
20
|
+
|
|
21
|
+
1. **Verify Build**
|
|
22
|
+
```bash
|
|
23
|
+
pnpm build
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
2. **Run Tests**
|
|
27
|
+
```bash
|
|
28
|
+
pnpm test
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
3. **Security Scan**
|
|
32
|
+
```bash
|
|
33
|
+
npm audit --audit-level=high
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Deploy
|
|
37
|
+
|
|
38
|
+
1. **Staging**
|
|
39
|
+
```bash
|
|
40
|
+
# Deploy to staging environment
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
2. **Production** (requires confirmation)
|
|
44
|
+
```bash
|
|
45
|
+
# Deploy to production environment
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Post-Deploy
|
|
49
|
+
|
|
50
|
+
1. **Verify Deployment**
|
|
51
|
+
- Health checks
|
|
52
|
+
- Smoke tests
|
|
53
|
+
|
|
54
|
+
2. **Monitor**
|
|
55
|
+
- Check logs
|
|
56
|
+
- Watch metrics
|
|
57
|
+
|
|
58
|
+
## Output
|
|
59
|
+
|
|
60
|
+
```markdown
|
|
61
|
+
## Deployment Complete
|
|
62
|
+
|
|
63
|
+
**Environment**: staging
|
|
64
|
+
**Version**: v1.2.3
|
|
65
|
+
**URL**: https://staging.example.com
|
|
66
|
+
|
|
67
|
+
### Checks
|
|
68
|
+
- [x] Build successful
|
|
69
|
+
- [x] Tests passing
|
|
70
|
+
- [x] Security scan clean
|
|
71
|
+
- [x] Health check passed
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## Gap Analysis Rule
|
|
76
|
+
Always identify gaps and suggest next steps to users. In case there is no gaps anymore, then AI should clearly state that there is no gap left.
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
# /doc - Documentation Command
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Generate or update documentation including API docs, README files, code comments, and technical specifications.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/doc [target | 'api' | 'readme' | 'changelog']
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Arguments
|
|
14
|
+
|
|
15
|
+
- `$ARGUMENTS`:
|
|
16
|
+
- File/function path: Document specific code
|
|
17
|
+
- `api`: Generate API documentation
|
|
18
|
+
- `readme`: Update README file
|
|
19
|
+
- `changelog`: Generate changelog from commits
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
Generate documentation for: **$ARGUMENTS**
|
|
24
|
+
|
|
25
|
+
## Workflow
|
|
26
|
+
|
|
27
|
+
### For Code Documentation
|
|
28
|
+
|
|
29
|
+
1. **Analyze Code**
|
|
30
|
+
- Read the code thoroughly
|
|
31
|
+
- Understand purpose and behavior
|
|
32
|
+
- Identify inputs and outputs
|
|
33
|
+
- Note side effects
|
|
34
|
+
|
|
35
|
+
2. **Generate Documentation**
|
|
36
|
+
- Add docstrings/JSDoc
|
|
37
|
+
- Include examples
|
|
38
|
+
- Document edge cases
|
|
39
|
+
- Add type annotations
|
|
40
|
+
|
|
41
|
+
### For API Documentation
|
|
42
|
+
|
|
43
|
+
1. **Find All Endpoints**
|
|
44
|
+
- Scan route definitions
|
|
45
|
+
- Identify HTTP methods
|
|
46
|
+
- Note authentication requirements
|
|
47
|
+
|
|
48
|
+
2. **Document Each Endpoint**
|
|
49
|
+
- Request format
|
|
50
|
+
- Response format
|
|
51
|
+
- Error responses
|
|
52
|
+
- Examples
|
|
53
|
+
|
|
54
|
+
### For README
|
|
55
|
+
|
|
56
|
+
1. **Analyze Project**
|
|
57
|
+
- Purpose and features
|
|
58
|
+
- Installation steps
|
|
59
|
+
- Usage examples
|
|
60
|
+
- Configuration
|
|
61
|
+
|
|
62
|
+
2. **Generate/Update**
|
|
63
|
+
- Clear structure
|
|
64
|
+
- Working examples
|
|
65
|
+
- Up-to-date info
|
|
66
|
+
|
|
67
|
+
### For Changelog
|
|
68
|
+
|
|
69
|
+
1. **Analyze Commits**
|
|
70
|
+
```bash
|
|
71
|
+
git log --oneline --since="last release"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
2. **Categorize Changes**
|
|
75
|
+
- Added
|
|
76
|
+
- Changed
|
|
77
|
+
- Fixed
|
|
78
|
+
- Removed
|
|
79
|
+
|
|
80
|
+
## Templates
|
|
81
|
+
|
|
82
|
+
### Python Docstring
|
|
83
|
+
```python
|
|
84
|
+
def calculate_discount(price: float, percentage: float) -> float:
|
|
85
|
+
"""
|
|
86
|
+
Calculate discounted price.
|
|
87
|
+
|
|
88
|
+
Args:
|
|
89
|
+
price: Original price in dollars.
|
|
90
|
+
percentage: Discount percentage (0-100).
|
|
91
|
+
|
|
92
|
+
Returns:
|
|
93
|
+
The discounted price.
|
|
94
|
+
|
|
95
|
+
Raises:
|
|
96
|
+
ValueError: If percentage is not between 0 and 100.
|
|
97
|
+
|
|
98
|
+
Example:
|
|
99
|
+
>>> calculate_discount(100.0, 20)
|
|
100
|
+
80.0
|
|
101
|
+
"""
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### TypeScript JSDoc
|
|
105
|
+
```typescript
|
|
106
|
+
/**
|
|
107
|
+
* Calculate discounted price.
|
|
108
|
+
*
|
|
109
|
+
* @param price - Original price in dollars
|
|
110
|
+
* @param percentage - Discount percentage (0-100)
|
|
111
|
+
* @returns The discounted price
|
|
112
|
+
* @throws {RangeError} If percentage is not between 0 and 100
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* calculateDiscount(100, 20); // returns 80
|
|
116
|
+
*/
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### API Endpoint
|
|
120
|
+
```markdown
|
|
121
|
+
## POST /api/orders
|
|
122
|
+
|
|
123
|
+
Create a new order.
|
|
124
|
+
|
|
125
|
+
### Authentication
|
|
126
|
+
Requires Bearer token.
|
|
127
|
+
|
|
128
|
+
### Request Body
|
|
129
|
+
```json
|
|
130
|
+
{
|
|
131
|
+
"items": [
|
|
132
|
+
{ "productId": "123", "quantity": 2 }
|
|
133
|
+
],
|
|
134
|
+
"shippingAddress": {
|
|
135
|
+
"street": "123 Main St",
|
|
136
|
+
"city": "New York",
|
|
137
|
+
"zip": "10001"
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Response (201 Created)
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"id": "order_456",
|
|
146
|
+
"status": "pending",
|
|
147
|
+
"total": 99.99,
|
|
148
|
+
"createdAt": "2024-01-15T10:00:00Z"
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Errors
|
|
153
|
+
| Status | Code | Description |
|
|
154
|
+
|--------|------|-------------|
|
|
155
|
+
| 400 | INVALID_ITEMS | Items array is empty |
|
|
156
|
+
| 401 | UNAUTHORIZED | Invalid or missing token |
|
|
157
|
+
| 422 | OUT_OF_STOCK | Item not available |
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### README Section
|
|
161
|
+
```markdown
|
|
162
|
+
## Installation
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
npm install my-package
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Quick Start
|
|
169
|
+
|
|
170
|
+
```typescript
|
|
171
|
+
import { Client } from 'my-package';
|
|
172
|
+
|
|
173
|
+
const client = new Client({ apiKey: 'your-key' });
|
|
174
|
+
const result = await client.fetch();
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Configuration
|
|
178
|
+
|
|
179
|
+
| Option | Type | Default | Description |
|
|
180
|
+
|--------|------|---------|-------------|
|
|
181
|
+
| `apiKey` | string | required | Your API key |
|
|
182
|
+
| `timeout` | number | 5000 | Request timeout in ms |
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Changelog Entry
|
|
186
|
+
```markdown
|
|
187
|
+
## [1.2.0] - 2024-01-15
|
|
188
|
+
|
|
189
|
+
### Added
|
|
190
|
+
- Password reset functionality (#123)
|
|
191
|
+
- Email verification for new accounts
|
|
192
|
+
|
|
193
|
+
### Changed
|
|
194
|
+
- Improved error messages for validation failures
|
|
195
|
+
- Updated dependencies to latest versions
|
|
196
|
+
|
|
197
|
+
### Fixed
|
|
198
|
+
- Race condition in session handling (#456)
|
|
199
|
+
- Incorrect timezone in date displays
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
## Output
|
|
203
|
+
|
|
204
|
+
### Documentation Report
|
|
205
|
+
|
|
206
|
+
```markdown
|
|
207
|
+
## Documentation Updated
|
|
208
|
+
|
|
209
|
+
### Files Modified
|
|
210
|
+
- `src/services/auth.ts` - Added JSDoc comments
|
|
211
|
+
- `docs/api/auth.md` - New API documentation
|
|
212
|
+
- `README.md` - Updated configuration section
|
|
213
|
+
|
|
214
|
+
### Documentation Added
|
|
215
|
+
|
|
216
|
+
#### Code Comments
|
|
217
|
+
- `AuthService.login()` - Full JSDoc with examples
|
|
218
|
+
- `AuthService.logout()` - Parameter documentation
|
|
219
|
+
- `validateToken()` - Return type and exceptions
|
|
220
|
+
|
|
221
|
+
#### API Documentation
|
|
222
|
+
- POST /api/auth/login
|
|
223
|
+
- POST /api/auth/logout
|
|
224
|
+
- POST /api/auth/refresh
|
|
225
|
+
|
|
226
|
+
### Coverage
|
|
227
|
+
- Functions documented: 15/18 (83%)
|
|
228
|
+
- Endpoints documented: 12/12 (100%)
|
|
229
|
+
|
|
230
|
+
### Next Steps
|
|
231
|
+
1. Add examples to remaining functions
|
|
232
|
+
2. Create getting started guide
|
|
233
|
+
3. Add architecture diagram
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
<!-- CUSTOMIZATION POINT -->
|
|
237
|
+
## Variations
|
|
238
|
+
|
|
239
|
+
Modify behavior via CLAUDE.md:
|
|
240
|
+
- Documentation format
|
|
241
|
+
- Required sections
|
|
242
|
+
- Example requirements
|
|
243
|
+
- API documentation tool
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
## Gap Analysis Rule
|
|
247
|
+
Always identify gaps and suggest next steps to users. In case there is no gaps anymore, then AI should clearly state that there is no gap left.
|