cp-toolkit 2.0.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 (196) hide show
  1. package/README.md +130 -0
  2. package/bin/cp-kit.js +72 -0
  3. package/package.json +46 -0
  4. package/src/commands/add.js +212 -0
  5. package/src/commands/doctor.js +149 -0
  6. package/src/commands/init.js +662 -0
  7. package/src/commands/list.js +128 -0
  8. package/src/index.js +13 -0
  9. package/templates/agents/backend-specialist.md +263 -0
  10. package/templates/agents/code-archaeologist.md +106 -0
  11. package/templates/agents/database-architect.md +226 -0
  12. package/templates/agents/debugger.md +225 -0
  13. package/templates/agents/devops-engineer.md +242 -0
  14. package/templates/agents/documentation-writer.md +104 -0
  15. package/templates/agents/explorer-agent.md +73 -0
  16. package/templates/agents/frontend-specialist.md +556 -0
  17. package/templates/agents/game-developer.md +162 -0
  18. package/templates/agents/mobile-developer.md +377 -0
  19. package/templates/agents/orchestrator.md +416 -0
  20. package/templates/agents/penetration-tester.md +188 -0
  21. package/templates/agents/performance-optimizer.md +187 -0
  22. package/templates/agents/product-manager.md +112 -0
  23. package/templates/agents/product-owner.md +95 -0
  24. package/templates/agents/project-planner.md +406 -0
  25. package/templates/agents/qa-automation-engineer.md +103 -0
  26. package/templates/agents/security-auditor.md +170 -0
  27. package/templates/agents/seo-specialist.md +111 -0
  28. package/templates/agents/test-engineer.md +158 -0
  29. package/templates/github/agents/backend-specialist.md +67 -0
  30. package/templates/github/agents/code-archaeologist.md +61 -0
  31. package/templates/github/agents/database-architect.md +73 -0
  32. package/templates/github/agents/debugger.md +71 -0
  33. package/templates/github/agents/devops-engineer.md +85 -0
  34. package/templates/github/agents/documentation-writer.md +107 -0
  35. package/templates/github/agents/explorer-agent.md +87 -0
  36. package/templates/github/agents/frontend-specialist.md +54 -0
  37. package/templates/github/agents/game-developer.md +94 -0
  38. package/templates/github/agents/mobile-developer.md +75 -0
  39. package/templates/github/agents/orchestrator.md +48 -0
  40. package/templates/github/agents/penetration-tester.md +87 -0
  41. package/templates/github/agents/performance-optimizer.md +70 -0
  42. package/templates/github/agents/product-manager.md +85 -0
  43. package/templates/github/agents/product-owner.md +77 -0
  44. package/templates/github/agents/project-planner.md +83 -0
  45. package/templates/github/agents/qa-automation-engineer.md +95 -0
  46. package/templates/github/agents/security-auditor.md +72 -0
  47. package/templates/github/agents/seo-specialist.md +78 -0
  48. package/templates/github/agents/test-engineer.md +79 -0
  49. package/templates/github/instructions/database.instructions.md +74 -0
  50. package/templates/github/instructions/python.instructions.md +76 -0
  51. package/templates/github/instructions/security.instructions.md +73 -0
  52. package/templates/github/instructions/typescript.instructions.md +50 -0
  53. package/templates/rules/GEMINI.md +273 -0
  54. package/templates/scripts/mcp-server.js +704 -0
  55. package/templates/skills/core/behavioral-modes/SKILL.md +242 -0
  56. package/templates/skills/core/brainstorming/SKILL.md +163 -0
  57. package/templates/skills/core/brainstorming/dynamic-questioning.md +350 -0
  58. package/templates/skills/core/clean-code/SKILL.md +201 -0
  59. package/templates/skills/core/intelligent-routing/SKILL.md +335 -0
  60. package/templates/skills/core/mcp-builder/SKILL.md +176 -0
  61. package/templates/skills/core/parallel-agents/SKILL.md +175 -0
  62. package/templates/skills/core/plan-writing/SKILL.md +152 -0
  63. package/templates/skills/optional/api-patterns/SKILL.md +81 -0
  64. package/templates/skills/optional/api-patterns/api-style.md +42 -0
  65. package/templates/skills/optional/api-patterns/auth.md +24 -0
  66. package/templates/skills/optional/api-patterns/documentation.md +26 -0
  67. package/templates/skills/optional/api-patterns/graphql.md +41 -0
  68. package/templates/skills/optional/api-patterns/rate-limiting.md +31 -0
  69. package/templates/skills/optional/api-patterns/response.md +37 -0
  70. package/templates/skills/optional/api-patterns/rest.md +40 -0
  71. package/templates/skills/optional/api-patterns/scripts/api_validator.py +211 -0
  72. package/templates/skills/optional/api-patterns/security-testing.md +122 -0
  73. package/templates/skills/optional/api-patterns/trpc.md +41 -0
  74. package/templates/skills/optional/api-patterns/versioning.md +22 -0
  75. package/templates/skills/optional/app-builder/SKILL.md +75 -0
  76. package/templates/skills/optional/app-builder/agent-coordination.md +71 -0
  77. package/templates/skills/optional/app-builder/feature-building.md +53 -0
  78. package/templates/skills/optional/app-builder/project-detection.md +34 -0
  79. package/templates/skills/optional/app-builder/scaffolding.md +118 -0
  80. package/templates/skills/optional/app-builder/tech-stack.md +40 -0
  81. package/templates/skills/optional/app-builder/templates/SKILL.md +39 -0
  82. package/templates/skills/optional/app-builder/templates/astro-static/TEMPLATE.md +76 -0
  83. package/templates/skills/optional/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
  84. package/templates/skills/optional/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
  85. package/templates/skills/optional/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
  86. package/templates/skills/optional/app-builder/templates/express-api/TEMPLATE.md +83 -0
  87. package/templates/skills/optional/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
  88. package/templates/skills/optional/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
  89. package/templates/skills/optional/app-builder/templates/nextjs-fullstack/TEMPLATE.md +82 -0
  90. package/templates/skills/optional/app-builder/templates/nextjs-saas/TEMPLATE.md +100 -0
  91. package/templates/skills/optional/app-builder/templates/nextjs-static/TEMPLATE.md +106 -0
  92. package/templates/skills/optional/app-builder/templates/nuxt-app/TEMPLATE.md +101 -0
  93. package/templates/skills/optional/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
  94. package/templates/skills/optional/app-builder/templates/react-native-app/TEMPLATE.md +93 -0
  95. package/templates/skills/optional/architecture/SKILL.md +55 -0
  96. package/templates/skills/optional/architecture/context-discovery.md +43 -0
  97. package/templates/skills/optional/architecture/examples.md +94 -0
  98. package/templates/skills/optional/architecture/pattern-selection.md +68 -0
  99. package/templates/skills/optional/architecture/patterns-reference.md +50 -0
  100. package/templates/skills/optional/architecture/trade-off-analysis.md +77 -0
  101. package/templates/skills/optional/bash-linux/SKILL.md +199 -0
  102. package/templates/skills/optional/code-review-checklist/SKILL.md +109 -0
  103. package/templates/skills/optional/database-design/SKILL.md +52 -0
  104. package/templates/skills/optional/database-design/database-selection.md +43 -0
  105. package/templates/skills/optional/database-design/indexing.md +39 -0
  106. package/templates/skills/optional/database-design/migrations.md +48 -0
  107. package/templates/skills/optional/database-design/optimization.md +36 -0
  108. package/templates/skills/optional/database-design/orm-selection.md +30 -0
  109. package/templates/skills/optional/database-design/schema-design.md +56 -0
  110. package/templates/skills/optional/database-design/scripts/schema_validator.py +172 -0
  111. package/templates/skills/optional/deployment-procedures/SKILL.md +241 -0
  112. package/templates/skills/optional/documentation-templates/SKILL.md +194 -0
  113. package/templates/skills/optional/frontend-design/SKILL.md +418 -0
  114. package/templates/skills/optional/frontend-design/animation-guide.md +331 -0
  115. package/templates/skills/optional/frontend-design/color-system.md +311 -0
  116. package/templates/skills/optional/frontend-design/decision-trees.md +418 -0
  117. package/templates/skills/optional/frontend-design/motion-graphics.md +306 -0
  118. package/templates/skills/optional/frontend-design/scripts/accessibility_checker.py +183 -0
  119. package/templates/skills/optional/frontend-design/scripts/ux_audit.py +722 -0
  120. package/templates/skills/optional/frontend-design/typography-system.md +345 -0
  121. package/templates/skills/optional/frontend-design/ux-psychology.md +541 -0
  122. package/templates/skills/optional/frontend-design/visual-effects.md +383 -0
  123. package/templates/skills/optional/game-development/2d-games/SKILL.md +119 -0
  124. package/templates/skills/optional/game-development/3d-games/SKILL.md +135 -0
  125. package/templates/skills/optional/game-development/SKILL.md +167 -0
  126. package/templates/skills/optional/game-development/game-art/SKILL.md +185 -0
  127. package/templates/skills/optional/game-development/game-audio/SKILL.md +190 -0
  128. package/templates/skills/optional/game-development/game-design/SKILL.md +129 -0
  129. package/templates/skills/optional/game-development/mobile-games/SKILL.md +108 -0
  130. package/templates/skills/optional/game-development/multiplayer/SKILL.md +132 -0
  131. package/templates/skills/optional/game-development/pc-games/SKILL.md +144 -0
  132. package/templates/skills/optional/game-development/vr-ar/SKILL.md +123 -0
  133. package/templates/skills/optional/game-development/web-games/SKILL.md +150 -0
  134. package/templates/skills/optional/geo-fundamentals/SKILL.md +156 -0
  135. package/templates/skills/optional/geo-fundamentals/scripts/geo_checker.py +289 -0
  136. package/templates/skills/optional/i18n-localization/SKILL.md +154 -0
  137. package/templates/skills/optional/i18n-localization/scripts/i18n_checker.py +241 -0
  138. package/templates/skills/optional/lint-and-validate/SKILL.md +45 -0
  139. package/templates/skills/optional/lint-and-validate/scripts/lint_runner.py +172 -0
  140. package/templates/skills/optional/lint-and-validate/scripts/type_coverage.py +173 -0
  141. package/templates/skills/optional/mobile-design/SKILL.md +394 -0
  142. package/templates/skills/optional/mobile-design/decision-trees.md +516 -0
  143. package/templates/skills/optional/mobile-design/mobile-backend.md +491 -0
  144. package/templates/skills/optional/mobile-design/mobile-color-system.md +420 -0
  145. package/templates/skills/optional/mobile-design/mobile-debugging.md +122 -0
  146. package/templates/skills/optional/mobile-design/mobile-design-thinking.md +357 -0
  147. package/templates/skills/optional/mobile-design/mobile-navigation.md +458 -0
  148. package/templates/skills/optional/mobile-design/mobile-performance.md +767 -0
  149. package/templates/skills/optional/mobile-design/mobile-testing.md +356 -0
  150. package/templates/skills/optional/mobile-design/mobile-typography.md +433 -0
  151. package/templates/skills/optional/mobile-design/platform-android.md +666 -0
  152. package/templates/skills/optional/mobile-design/platform-ios.md +561 -0
  153. package/templates/skills/optional/mobile-design/scripts/mobile_audit.py +670 -0
  154. package/templates/skills/optional/mobile-design/touch-psychology.md +537 -0
  155. package/templates/skills/optional/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -0
  156. package/templates/skills/optional/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
  157. package/templates/skills/optional/nextjs-react-expert/3-server-server-side-performance.md +490 -0
  158. package/templates/skills/optional/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
  159. package/templates/skills/optional/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
  160. package/templates/skills/optional/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
  161. package/templates/skills/optional/nextjs-react-expert/7-js-javascript-performance.md +684 -0
  162. package/templates/skills/optional/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
  163. package/templates/skills/optional/nextjs-react-expert/SKILL.md +267 -0
  164. package/templates/skills/optional/nextjs-react-expert/scripts/convert_rules.py +222 -0
  165. package/templates/skills/optional/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
  166. package/templates/skills/optional/nodejs-best-practices/SKILL.md +333 -0
  167. package/templates/skills/optional/performance-profiling/SKILL.md +143 -0
  168. package/templates/skills/optional/performance-profiling/scripts/lighthouse_audit.py +76 -0
  169. package/templates/skills/optional/powershell-windows/SKILL.md +167 -0
  170. package/templates/skills/optional/python-patterns/SKILL.md +441 -0
  171. package/templates/skills/optional/red-team-tactics/SKILL.md +199 -0
  172. package/templates/skills/optional/seo-fundamentals/SKILL.md +129 -0
  173. package/templates/skills/optional/seo-fundamentals/scripts/seo_checker.py +219 -0
  174. package/templates/skills/optional/server-management/SKILL.md +161 -0
  175. package/templates/skills/optional/systematic-debugging/SKILL.md +109 -0
  176. package/templates/skills/optional/tailwind-patterns/SKILL.md +269 -0
  177. package/templates/skills/optional/tdd-workflow/SKILL.md +149 -0
  178. package/templates/skills/optional/testing-patterns/SKILL.md +178 -0
  179. package/templates/skills/optional/testing-patterns/scripts/test_runner.py +219 -0
  180. package/templates/skills/optional/vulnerability-scanner/SKILL.md +276 -0
  181. package/templates/skills/optional/vulnerability-scanner/checklists.md +121 -0
  182. package/templates/skills/optional/vulnerability-scanner/scripts/security_scan.py +458 -0
  183. package/templates/skills/optional/web-design-guidelines/SKILL.md +57 -0
  184. package/templates/skills/optional/webapp-testing/SKILL.md +187 -0
  185. package/templates/skills/optional/webapp-testing/scripts/playwright_runner.py +173 -0
  186. package/templates/workflows/brainstorm.md +113 -0
  187. package/templates/workflows/create.md +59 -0
  188. package/templates/workflows/debug.md +103 -0
  189. package/templates/workflows/deploy.md +176 -0
  190. package/templates/workflows/enhance.md +63 -0
  191. package/templates/workflows/orchestrate.md +237 -0
  192. package/templates/workflows/plan.md +89 -0
  193. package/templates/workflows/preview.md +81 -0
  194. package/templates/workflows/status.md +86 -0
  195. package/templates/workflows/test.md +144 -0
  196. package/templates/workflows/ui-ux-pro-max.md +296 -0
@@ -0,0 +1,152 @@
1
+ ---
2
+ name: plan-writing
3
+ description: Structured task planning with clear breakdowns, dependencies, and verification criteria. Use when implementing features, refactoring, or any multi-step work.
4
+ allowed-tools: Read, Glob, Grep
5
+ ---
6
+
7
+ # Plan Writing
8
+
9
+ > Source: obra/superpowers
10
+
11
+ ## Overview
12
+ This skill provides a framework for breaking down work into clear, actionable tasks with verification criteria.
13
+
14
+ ## Task Breakdown Principles
15
+
16
+ ### 1. Small, Focused Tasks
17
+ - Each task should take 2-5 minutes
18
+ - One clear outcome per task
19
+ - Independently verifiable
20
+
21
+ ### 2. Clear Verification
22
+ - How do you know it's done?
23
+ - What can you check/test?
24
+ - What's the expected output?
25
+
26
+ ### 3. Logical Ordering
27
+ - Dependencies identified
28
+ - Parallel work where possible
29
+ - Critical path highlighted
30
+ - **Phase X: Verification is always LAST**
31
+
32
+ ### 4. Dynamic Naming in Project Root
33
+ - Plan files are saved as `{task-slug}.md` in the PROJECT ROOT
34
+ - Name derived from task (e.g., "add auth" → `auth-feature.md`)
35
+ - **NEVER** inside `.claude/`, `docs/`, or temp folders
36
+
37
+ ## Planning Principles (NOT Templates!)
38
+
39
+ > 🔴 **NO fixed templates. Each plan is UNIQUE to the task.**
40
+
41
+ ### Principle 1: Keep It SHORT
42
+
43
+ | ❌ Wrong | ✅ Right |
44
+ |----------|----------|
45
+ | 50 tasks with sub-sub-tasks | 5-10 clear tasks max |
46
+ | Every micro-step listed | Only actionable items |
47
+ | Verbose descriptions | One-line per task |
48
+
49
+ > **Rule:** If plan is longer than 1 page, it's too long. Simplify.
50
+
51
+ ---
52
+
53
+ ### Principle 2: Be SPECIFIC, Not Generic
54
+
55
+ | ❌ Wrong | ✅ Right |
56
+ |----------|----------|
57
+ | "Set up project" | "Run `npx create-next-app`" |
58
+ | "Add authentication" | "Install next-auth, create `/api/auth/[...nextauth].ts`" |
59
+ | "Style the UI" | "Add Tailwind classes to `Header.tsx`" |
60
+
61
+ > **Rule:** Each task should have a clear, verifiable outcome.
62
+
63
+ ---
64
+
65
+ ### Principle 3: Dynamic Content Based on Project Type
66
+
67
+ **For NEW PROJECT:**
68
+ - What tech stack? (decide first)
69
+ - What's the MVP? (minimal features)
70
+ - What's the file structure?
71
+
72
+ **For FEATURE ADDITION:**
73
+ - Which files are affected?
74
+ - What dependencies needed?
75
+ - How to verify it works?
76
+
77
+ **For BUG FIX:**
78
+ - What's the root cause?
79
+ - What file/line to change?
80
+ - How to test the fix?
81
+
82
+ ---
83
+
84
+ ### Principle 4: Scripts Are Project-Specific
85
+
86
+ > 🔴 **DO NOT copy-paste script commands. Choose based on project type.**
87
+
88
+ | Project Type | Relevant Scripts |
89
+ |--------------|------------------|
90
+ | Frontend/React | `ux_audit.py`, `accessibility_checker.py` |
91
+ | Backend/API | `api_validator.py`, `security_scan.py` |
92
+ | Mobile | `mobile_audit.py` |
93
+ | Database | `schema_validator.py` |
94
+ | Full-stack | Mix of above based on what you touched |
95
+
96
+ **Wrong:** Adding all scripts to every plan
97
+ **Right:** Only scripts relevant to THIS task
98
+
99
+ ---
100
+
101
+ ### Principle 5: Verification is Simple
102
+
103
+ | ❌ Wrong | ✅ Right |
104
+ |----------|----------|
105
+ | "Verify the component works correctly" | "Run `npm run dev`, click button, see toast" |
106
+ | "Test the API" | "curl localhost:3000/api/users returns 200" |
107
+ | "Check styles" | "Open browser, verify dark mode toggle works" |
108
+
109
+ ---
110
+
111
+ ## Plan Structure (Flexible, Not Fixed!)
112
+
113
+ ```
114
+ # [Task Name]
115
+
116
+ ## Goal
117
+ One sentence: What are we building/fixing?
118
+
119
+ ## Tasks
120
+ - [ ] Task 1: [Specific action] → Verify: [How to check]
121
+ - [ ] Task 2: [Specific action] → Verify: [How to check]
122
+ - [ ] Task 3: [Specific action] → Verify: [How to check]
123
+
124
+ ## Done When
125
+ - [ ] [Main success criteria]
126
+ ```
127
+
128
+ > **That's it.** No phases, no sub-sections unless truly needed.
129
+ > Keep it minimal. Add complexity only when required.
130
+
131
+ ## Notes
132
+ [Any important considerations]
133
+ ```
134
+
135
+ ---
136
+
137
+ ## Best Practices (Quick Reference)
138
+
139
+ 1. **Start with goal** - What are we building/fixing?
140
+ 2. **Max 10 tasks** - If more, break into multiple plans
141
+ 3. **Each task verifiable** - Clear "done" criteria
142
+ 4. **Project-specific** - No copy-paste templates
143
+ 5. **Update as you go** - Mark `[x]` when complete
144
+
145
+ ---
146
+
147
+ ## When to Use
148
+
149
+ - New project from scratch
150
+ - Adding a feature
151
+ - Fixing a bug (if complex)
152
+ - Refactoring multiple files
@@ -0,0 +1,81 @@
1
+ ---
2
+ name: api-patterns
3
+ description: API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.
4
+ allowed-tools: Read, Write, Edit, Glob, Grep
5
+ ---
6
+
7
+ # API Patterns
8
+
9
+ > API design principles and decision-making for 2025.
10
+ > **Learn to THINK, not copy fixed patterns.**
11
+
12
+ ## 🎯 Selective Reading Rule
13
+
14
+ **Read ONLY files relevant to the request!** Check the content map, find what you need.
15
+
16
+ ---
17
+
18
+ ## 📑 Content Map
19
+
20
+ | File | Description | When to Read |
21
+ |------|-------------|--------------|
22
+ | `api-style.md` | REST vs GraphQL vs tRPC decision tree | Choosing API type |
23
+ | `rest.md` | Resource naming, HTTP methods, status codes | Designing REST API |
24
+ | `response.md` | Envelope pattern, error format, pagination | Response structure |
25
+ | `graphql.md` | Schema design, when to use, security | Considering GraphQL |
26
+ | `trpc.md` | TypeScript monorepo, type safety | TS fullstack projects |
27
+ | `versioning.md` | URI/Header/Query versioning | API evolution planning |
28
+ | `auth.md` | JWT, OAuth, Passkey, API Keys | Auth pattern selection |
29
+ | `rate-limiting.md` | Token bucket, sliding window | API protection |
30
+ | `documentation.md` | OpenAPI/Swagger best practices | Documentation |
31
+ | `security-testing.md` | OWASP API Top 10, auth/authz testing | Security audits |
32
+
33
+ ---
34
+
35
+ ## 🔗 Related Skills
36
+
37
+ | Need | Skill |
38
+ |------|-------|
39
+ | API implementation | `@[skills/backend-development]` |
40
+ | Data structure | `@[skills/database-design]` |
41
+ | Security details | `@[skills/security-hardening]` |
42
+
43
+ ---
44
+
45
+ ## ✅ Decision Checklist
46
+
47
+ Before designing an API:
48
+
49
+ - [ ] **Asked user about API consumers?**
50
+ - [ ] **Chosen API style for THIS context?** (REST/GraphQL/tRPC)
51
+ - [ ] **Defined consistent response format?**
52
+ - [ ] **Planned versioning strategy?**
53
+ - [ ] **Considered authentication needs?**
54
+ - [ ] **Planned rate limiting?**
55
+ - [ ] **Documentation approach defined?**
56
+
57
+ ---
58
+
59
+ ## ❌ Anti-Patterns
60
+
61
+ **DON'T:**
62
+ - Default to REST for everything
63
+ - Use verbs in REST endpoints (/getUsers)
64
+ - Return inconsistent response formats
65
+ - Expose internal errors to clients
66
+ - Skip rate limiting
67
+
68
+ **DO:**
69
+ - Choose API style based on context
70
+ - Ask about client requirements
71
+ - Document thoroughly
72
+ - Use appropriate status codes
73
+
74
+ ---
75
+
76
+ ## Script
77
+
78
+ | Script | Purpose | Command |
79
+ |--------|---------|---------|
80
+ | `scripts/api_validator.py` | API endpoint validation | `python scripts/api_validator.py <project_path>` |
81
+
@@ -0,0 +1,42 @@
1
+ # API Style Selection (2025)
2
+
3
+ > REST vs GraphQL vs tRPC - Hangi durumda hangisi?
4
+
5
+ ## Decision Tree
6
+
7
+ ```
8
+ Who are the API consumers?
9
+
10
+ ├── Public API / Multiple platforms
11
+ │ └── REST + OpenAPI (widest compatibility)
12
+
13
+ ├── Complex data needs / Multiple frontends
14
+ │ └── GraphQL (flexible queries)
15
+
16
+ ├── TypeScript frontend + backend (monorepo)
17
+ │ └── tRPC (end-to-end type safety)
18
+
19
+ ├── Real-time / Event-driven
20
+ │ └── WebSocket + AsyncAPI
21
+
22
+ └── Internal microservices
23
+ └── gRPC (performance) or REST (simplicity)
24
+ ```
25
+
26
+ ## Comparison
27
+
28
+ | Factor | REST | GraphQL | tRPC |
29
+ |--------|------|---------|------|
30
+ | **Best for** | Public APIs | Complex apps | TS monorepos |
31
+ | **Learning curve** | Low | Medium | Low (if TS) |
32
+ | **Over/under fetching** | Common | Solved | Solved |
33
+ | **Type safety** | Manual (OpenAPI) | Schema-based | Automatic |
34
+ | **Caching** | HTTP native | Complex | Client-based |
35
+
36
+ ## Selection Questions
37
+
38
+ 1. Who are the API consumers?
39
+ 2. Is the frontend TypeScript?
40
+ 3. How complex are the data relationships?
41
+ 4. Is caching critical?
42
+ 5. Public or internal API?
@@ -0,0 +1,24 @@
1
+ # Authentication Patterns
2
+
3
+ > Choose auth pattern based on use case.
4
+
5
+ ## Selection Guide
6
+
7
+ | Pattern | Best For |
8
+ |---------|----------|
9
+ | **JWT** | Stateless, microservices |
10
+ | **Session** | Traditional web, simple |
11
+ | **OAuth 2.0** | Third-party integration |
12
+ | **API Keys** | Server-to-server, public APIs |
13
+ | **Passkey** | Modern passwordless (2025+) |
14
+
15
+ ## JWT Principles
16
+
17
+ ```
18
+ Important:
19
+ ├── Always verify signature
20
+ ├── Check expiration
21
+ ├── Include minimal claims
22
+ ├── Use short expiry + refresh tokens
23
+ └── Never store sensitive data in JWT
24
+ ```
@@ -0,0 +1,26 @@
1
+ # API Documentation Principles
2
+
3
+ > Good docs = happy developers = API adoption.
4
+
5
+ ## OpenAPI/Swagger Essentials
6
+
7
+ ```
8
+ Include:
9
+ ├── All endpoints with examples
10
+ ├── Request/response schemas
11
+ ├── Authentication requirements
12
+ ├── Error response formats
13
+ └── Rate limiting info
14
+ ```
15
+
16
+ ## Good Documentation Has
17
+
18
+ ```
19
+ Essentials:
20
+ ├── Quick start / Getting started
21
+ ├── Authentication guide
22
+ ├── Complete API reference
23
+ ├── Error handling guide
24
+ ├── Code examples (multiple languages)
25
+ └── Changelog
26
+ ```
@@ -0,0 +1,41 @@
1
+ # GraphQL Principles
2
+
3
+ > Flexible queries for complex, interconnected data.
4
+
5
+ ## When to Use
6
+
7
+ ```
8
+ ✅ Good fit:
9
+ ├── Complex, interconnected data
10
+ ├── Multiple frontend platforms
11
+ ├── Clients need flexible queries
12
+ ├── Evolving data requirements
13
+ └── Reducing over-fetching matters
14
+
15
+ ❌ Poor fit:
16
+ ├── Simple CRUD operations
17
+ ├── File upload heavy
18
+ ├── HTTP caching important
19
+ └── Team unfamiliar with GraphQL
20
+ ```
21
+
22
+ ## Schema Design Principles
23
+
24
+ ```
25
+ Principles:
26
+ ├── Think in graphs, not endpoints
27
+ ├── Design for evolvability (no versions)
28
+ ├── Use connections for pagination
29
+ ├── Be specific with types (not generic "data")
30
+ └── Handle nullability thoughtfully
31
+ ```
32
+
33
+ ## Security Considerations
34
+
35
+ ```
36
+ Protect against:
37
+ ├── Query depth attacks → Set max depth
38
+ ├── Query complexity → Calculate cost
39
+ ├── Batching abuse → Limit batch size
40
+ ├── Introspection → Disable in production
41
+ ```
@@ -0,0 +1,31 @@
1
+ # Rate Limiting Principles
2
+
3
+ > Protect your API from abuse and overload.
4
+
5
+ ## Why Rate Limit
6
+
7
+ ```
8
+ Protect against:
9
+ ├── Brute force attacks
10
+ ├── Resource exhaustion
11
+ ├── Cost overruns (if pay-per-use)
12
+ └── Unfair usage
13
+ ```
14
+
15
+ ## Strategy Selection
16
+
17
+ | Type | How | When |
18
+ |------|-----|------|
19
+ | **Token bucket** | Burst allowed, refills over time | Most APIs |
20
+ | **Sliding window** | Smooth distribution | Strict limits |
21
+ | **Fixed window** | Simple counters per window | Basic needs |
22
+
23
+ ## Response Headers
24
+
25
+ ```
26
+ Include in headers:
27
+ ├── X-RateLimit-Limit (max requests)
28
+ ├── X-RateLimit-Remaining (requests left)
29
+ ├── X-RateLimit-Reset (when limit resets)
30
+ └── Return 429 when exceeded
31
+ ```
@@ -0,0 +1,37 @@
1
+ # Response Format Principles
2
+
3
+ > Consistency is key - choose a format and stick to it.
4
+
5
+ ## Common Patterns
6
+
7
+ ```
8
+ Choose one:
9
+ ├── Envelope pattern ({ success, data, error })
10
+ ├── Direct data (just return the resource)
11
+ └── HAL/JSON:API (hypermedia)
12
+ ```
13
+
14
+ ## Error Response
15
+
16
+ ```
17
+ Include:
18
+ ├── Error code (for programmatic handling)
19
+ ├── User message (for display)
20
+ ├── Details (for debugging, field-level errors)
21
+ ├── Request ID (for support)
22
+ └── NOT internal details (security!)
23
+ ```
24
+
25
+ ## Pagination Types
26
+
27
+ | Type | Best For | Trade-offs |
28
+ |------|----------|------------|
29
+ | **Offset** | Simple, jumpable | Performance on large datasets |
30
+ | **Cursor** | Large datasets | Can't jump to page |
31
+ | **Keyset** | Performance critical | Requires sortable key |
32
+
33
+ ### Selection Questions
34
+
35
+ 1. How large is the dataset?
36
+ 2. Do users need to jump to specific pages?
37
+ 3. Is data frequently changing?
@@ -0,0 +1,40 @@
1
+ # REST Principles
2
+
3
+ > Resource-based API design - nouns not verbs.
4
+
5
+ ## Resource Naming Rules
6
+
7
+ ```
8
+ Principles:
9
+ ├── Use NOUNS, not verbs (resources, not actions)
10
+ ├── Use PLURAL forms (/users not /user)
11
+ ├── Use lowercase with hyphens (/user-profiles)
12
+ ├── Nest for relationships (/users/123/posts)
13
+ └── Keep shallow (max 3 levels deep)
14
+ ```
15
+
16
+ ## HTTP Method Selection
17
+
18
+ | Method | Purpose | Idempotent? | Body? |
19
+ |--------|---------|-------------|-------|
20
+ | **GET** | Read resource(s) | Yes | No |
21
+ | **POST** | Create new resource | No | Yes |
22
+ | **PUT** | Replace entire resource | Yes | Yes |
23
+ | **PATCH** | Partial update | No | Yes |
24
+ | **DELETE** | Remove resource | Yes | No |
25
+
26
+ ## Status Code Selection
27
+
28
+ | Situation | Code | Why |
29
+ |-----------|------|-----|
30
+ | Success (read) | 200 | Standard success |
31
+ | Created | 201 | New resource created |
32
+ | No content | 204 | Success, nothing to return |
33
+ | Bad request | 400 | Malformed request |
34
+ | Unauthorized | 401 | Missing/invalid auth |
35
+ | Forbidden | 403 | Valid auth, no permission |
36
+ | Not found | 404 | Resource doesn't exist |
37
+ | Conflict | 409 | State conflict (duplicate) |
38
+ | Validation error | 422 | Valid syntax, invalid data |
39
+ | Rate limited | 429 | Too many requests |
40
+ | Server error | 500 | Our fault |
@@ -0,0 +1,211 @@
1
+ #!/usr/bin/env python3
2
+ """
3
+ API Validator - Checks API endpoints for best practices.
4
+ Validates OpenAPI specs, response formats, and common issues.
5
+ """
6
+ import sys
7
+ import json
8
+ import re
9
+ from pathlib import Path
10
+
11
+ # Fix Windows console encoding for Unicode output
12
+ try:
13
+ sys.stdout.reconfigure(encoding='utf-8', errors='replace')
14
+ sys.stderr.reconfigure(encoding='utf-8', errors='replace')
15
+ except AttributeError:
16
+ pass # Python < 3.7
17
+
18
+ def find_api_files(project_path: Path) -> list:
19
+ """Find API-related files."""
20
+ patterns = [
21
+ "**/*api*.ts", "**/*api*.js", "**/*api*.py",
22
+ "**/routes/*.ts", "**/routes/*.js", "**/routes/*.py",
23
+ "**/controllers/*.ts", "**/controllers/*.js",
24
+ "**/endpoints/*.ts", "**/endpoints/*.py",
25
+ "**/*.openapi.json", "**/*.openapi.yaml",
26
+ "**/swagger.json", "**/swagger.yaml",
27
+ "**/openapi.json", "**/openapi.yaml"
28
+ ]
29
+
30
+ files = []
31
+ for pattern in patterns:
32
+ files.extend(project_path.glob(pattern))
33
+
34
+ # Exclude node_modules, etc.
35
+ return [f for f in files if not any(x in str(f) for x in ['node_modules', '.git', 'dist', 'build', '__pycache__'])]
36
+
37
+ def check_openapi_spec(file_path: Path) -> dict:
38
+ """Check OpenAPI/Swagger specification."""
39
+ issues = []
40
+ passed = []
41
+
42
+ try:
43
+ content = file_path.read_text(encoding='utf-8')
44
+
45
+ if file_path.suffix == '.json':
46
+ spec = json.loads(content)
47
+ else:
48
+ # Basic YAML check
49
+ if 'openapi:' in content or 'swagger:' in content:
50
+ passed.append("[OK] OpenAPI/Swagger version defined")
51
+ else:
52
+ issues.append("[X] No OpenAPI version found")
53
+
54
+ if 'paths:' in content:
55
+ passed.append("[OK] Paths section exists")
56
+ else:
57
+ issues.append("[X] No paths defined")
58
+
59
+ if 'components:' in content or 'definitions:' in content:
60
+ passed.append("[OK] Schema components defined")
61
+
62
+ return {'file': str(file_path), 'passed': passed, 'issues': issues, 'type': 'openapi'}
63
+
64
+ # JSON OpenAPI checks
65
+ if 'openapi' in spec or 'swagger' in spec:
66
+ passed.append("[OK] OpenAPI version defined")
67
+
68
+ if 'info' in spec:
69
+ if 'title' in spec['info']:
70
+ passed.append("[OK] API title defined")
71
+ if 'version' in spec['info']:
72
+ passed.append("[OK] API version defined")
73
+ if 'description' not in spec['info']:
74
+ issues.append("[!] API description missing")
75
+
76
+ if 'paths' in spec:
77
+ path_count = len(spec['paths'])
78
+ passed.append(f"[OK] {path_count} endpoints defined")
79
+
80
+ # Check each path
81
+ for path, methods in spec['paths'].items():
82
+ for method, details in methods.items():
83
+ if method in ['get', 'post', 'put', 'patch', 'delete']:
84
+ if 'responses' not in details:
85
+ issues.append(f"[X] {method.upper()} {path}: No responses defined")
86
+ if 'summary' not in details and 'description' not in details:
87
+ issues.append(f"[!] {method.upper()} {path}: No description")
88
+
89
+ except Exception as e:
90
+ issues.append(f"[X] Parse error: {e}")
91
+
92
+ return {'file': str(file_path), 'passed': passed, 'issues': issues, 'type': 'openapi'}
93
+
94
+ def check_api_code(file_path: Path) -> dict:
95
+ """Check API code for common issues."""
96
+ issues = []
97
+ passed = []
98
+
99
+ try:
100
+ content = file_path.read_text(encoding='utf-8')
101
+
102
+ # Check for error handling
103
+ error_patterns = [
104
+ r'try\s*{', r'try:', r'\.catch\(',
105
+ r'except\s+', r'catch\s*\('
106
+ ]
107
+ has_error_handling = any(re.search(p, content) for p in error_patterns)
108
+ if has_error_handling:
109
+ passed.append("[OK] Error handling present")
110
+ else:
111
+ issues.append("[X] No error handling found")
112
+
113
+ # Check for status codes
114
+ status_patterns = [
115
+ r'status\s*\(\s*\d{3}\s*\)', r'statusCode\s*[=:]\s*\d{3}',
116
+ r'HttpStatus\.', r'status_code\s*=\s*\d{3}',
117
+ r'\.status\(\d{3}\)', r'res\.status\('
118
+ ]
119
+ has_status = any(re.search(p, content) for p in status_patterns)
120
+ if has_status:
121
+ passed.append("[OK] HTTP status codes used")
122
+ else:
123
+ issues.append("[!] No explicit HTTP status codes")
124
+
125
+ # Check for validation
126
+ validation_patterns = [
127
+ r'validate', r'schema', r'zod', r'joi', r'yup',
128
+ r'pydantic', r'@Body\(', r'@Query\('
129
+ ]
130
+ has_validation = any(re.search(p, content, re.I) for p in validation_patterns)
131
+ if has_validation:
132
+ passed.append("[OK] Input validation present")
133
+ else:
134
+ issues.append("[!] No input validation detected")
135
+
136
+ # Check for auth middleware
137
+ auth_patterns = [
138
+ r'auth', r'jwt', r'bearer', r'token',
139
+ r'middleware', r'guard', r'@Authenticated'
140
+ ]
141
+ has_auth = any(re.search(p, content, re.I) for p in auth_patterns)
142
+ if has_auth:
143
+ passed.append("[OK] Authentication/authorization detected")
144
+
145
+ # Check for rate limiting
146
+ rate_patterns = [r'rateLimit', r'throttle', r'rate.?limit']
147
+ has_rate = any(re.search(p, content, re.I) for p in rate_patterns)
148
+ if has_rate:
149
+ passed.append("[OK] Rate limiting present")
150
+
151
+ # Check for logging
152
+ log_patterns = [r'console\.log', r'logger\.', r'logging\.', r'log\.']
153
+ has_logging = any(re.search(p, content) for p in log_patterns)
154
+ if has_logging:
155
+ passed.append("[OK] Logging present")
156
+
157
+ except Exception as e:
158
+ issues.append(f"[X] Read error: {e}")
159
+
160
+ return {'file': str(file_path), 'passed': passed, 'issues': issues, 'type': 'code'}
161
+
162
+ def main():
163
+ target = sys.argv[1] if len(sys.argv) > 1 else "."
164
+ project_path = Path(target)
165
+
166
+ print("\n" + "=" * 60)
167
+ print(" API VALIDATOR - Endpoint Best Practices Check")
168
+ print("=" * 60 + "\n")
169
+
170
+ api_files = find_api_files(project_path)
171
+
172
+ if not api_files:
173
+ print("[!] No API files found.")
174
+ print(" Looking for: routes/, controllers/, api/, openapi.json/yaml")
175
+ sys.exit(0)
176
+
177
+ results = []
178
+ for file_path in api_files[:15]: # Limit
179
+ if 'openapi' in file_path.name.lower() or 'swagger' in file_path.name.lower():
180
+ result = check_openapi_spec(file_path)
181
+ else:
182
+ result = check_api_code(file_path)
183
+ results.append(result)
184
+
185
+ # Print results
186
+ total_issues = 0
187
+ total_passed = 0
188
+
189
+ for result in results:
190
+ print(f"\n[FILE] {result['file']} [{result['type']}]")
191
+ for item in result['passed']:
192
+ print(f" {item}")
193
+ total_passed += 1
194
+ for item in result['issues']:
195
+ print(f" {item}")
196
+ if item.startswith("[X]"):
197
+ total_issues += 1
198
+
199
+ print("\n" + "=" * 60)
200
+ print(f"[RESULTS] {total_passed} passed, {total_issues} critical issues")
201
+ print("=" * 60)
202
+
203
+ if total_issues == 0:
204
+ print("[OK] API validation passed")
205
+ sys.exit(0)
206
+ else:
207
+ print("[X] Fix critical issues before deployment")
208
+ sys.exit(1)
209
+
210
+ if __name__ == "__main__":
211
+ main()