codeply-cli 0.5.0 → 0.5.2

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 (387) hide show
  1. package/LICENSE +21 -0
  2. package/THIRD_PARTY_NOTICES.md +65 -63
  3. package/bin/codeply.js +1 -1
  4. package/lib/agent.mjs +133 -24
  5. package/lib/ai.js +268 -9
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/bots.js +493 -16
  12. package/lib/chatgpt.js +282 -0
  13. package/lib/cloud-browser.mjs +143 -143
  14. package/lib/cloud.mjs +1186 -1105
  15. package/lib/commands.js +103 -103
  16. package/lib/config.js +83 -3
  17. package/lib/design-library/assemble-artifact.mjs +21 -21
  18. package/lib/design-library/cleanup.mjs +45 -45
  19. package/lib/design-library/index.json +22379 -22379
  20. package/lib/design-library/make-table-data.mjs +39 -39
  21. package/lib/diagnostics.js +192 -192
  22. package/lib/edit-engine.js +364 -364
  23. package/lib/github-agent.mjs +311 -311
  24. package/lib/history.js +75 -75
  25. package/lib/mail-watch.js +504 -0
  26. package/lib/mcp.js +258 -258
  27. package/lib/model-sync.js +114 -0
  28. package/lib/native-tools.mjs +16 -1
  29. package/lib/oauth-connectors.js +146 -24
  30. package/lib/permissions.js +109 -109
  31. package/lib/plugins.js +353 -353
  32. package/lib/publish.js +916 -0
  33. package/lib/reach.js +67 -0
  34. package/lib/server.mjs +457 -457
  35. package/lib/session-db.js +220 -220
  36. package/lib/share.js +168 -168
  37. package/lib/skills.js +2 -0
  38. package/lib/snapshot.js +146 -146
  39. package/lib/telemetry.js +102 -0
  40. package/lib/terminal-hints.js +154 -154
  41. package/lib/tools.mjs +316 -14
  42. package/lib/typecheck-worker.js +147 -147
  43. package/lib/web-tools.js +209 -158
  44. package/package.json +49 -49
  45. package/skills/SOURCE.md +58 -58
  46. package/skills/accessibility/SKILL.md +147 -147
  47. package/skills/agent-architecture-audit/SKILL.md +257 -257
  48. package/skills/agent-eval/SKILL.md +147 -147
  49. package/skills/agent-harness-construction/SKILL.md +74 -74
  50. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  51. package/skills/agent-payment-x402/SKILL.md +225 -225
  52. package/skills/agent-self-evaluation/SKILL.md +182 -182
  53. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  54. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  55. package/skills/agent-sort/SKILL.md +216 -216
  56. package/skills/agentic-engineering/SKILL.md +64 -64
  57. package/skills/agentic-os/SKILL.md +388 -388
  58. package/skills/ai-first-engineering/SKILL.md +52 -52
  59. package/skills/ai-regression-testing/SKILL.md +386 -386
  60. package/skills/android-clean-architecture/SKILL.md +340 -340
  61. package/skills/angular-developer/SKILL.md +155 -155
  62. package/skills/angular-developer/references/angular-animations.md +160 -160
  63. package/skills/angular-developer/references/angular-aria.md +410 -410
  64. package/skills/angular-developer/references/cli.md +86 -86
  65. package/skills/angular-developer/references/component-harnesses.md +59 -59
  66. package/skills/angular-developer/references/component-styling.md +91 -91
  67. package/skills/angular-developer/references/components.md +117 -117
  68. package/skills/angular-developer/references/creating-services.md +97 -97
  69. package/skills/angular-developer/references/data-resolvers.md +69 -69
  70. package/skills/angular-developer/references/define-routes.md +67 -67
  71. package/skills/angular-developer/references/defining-providers.md +72 -72
  72. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  73. package/skills/angular-developer/references/e2e-testing.md +56 -56
  74. package/skills/angular-developer/references/effects.md +83 -83
  75. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  76. package/skills/angular-developer/references/host-elements.md +80 -80
  77. package/skills/angular-developer/references/injection-context.md +63 -63
  78. package/skills/angular-developer/references/inputs.md +101 -101
  79. package/skills/angular-developer/references/linked-signal.md +59 -59
  80. package/skills/angular-developer/references/loading-strategies.md +61 -61
  81. package/skills/angular-developer/references/mcp.md +108 -108
  82. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  83. package/skills/angular-developer/references/outputs.md +86 -86
  84. package/skills/angular-developer/references/reactive-forms.md +122 -122
  85. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  86. package/skills/angular-developer/references/resource.md +77 -77
  87. package/skills/angular-developer/references/route-animations.md +56 -56
  88. package/skills/angular-developer/references/route-guards.md +52 -52
  89. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  90. package/skills/angular-developer/references/router-testing.md +87 -87
  91. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  92. package/skills/angular-developer/references/signal-forms.md +795 -795
  93. package/skills/angular-developer/references/signals-overview.md +94 -94
  94. package/skills/angular-developer/references/tailwind-css.md +69 -69
  95. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  96. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  97. package/skills/api-connector-builder/SKILL.md +121 -121
  98. package/skills/api-design/SKILL.md +524 -524
  99. package/skills/architecture-decision-records/SKILL.md +180 -180
  100. package/skills/article-writing/SKILL.md +80 -80
  101. package/skills/automation-audit-ops/SKILL.md +143 -143
  102. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  103. package/skills/autonomous-loops/SKILL.md +611 -611
  104. package/skills/backend-patterns/SKILL.md +562 -562
  105. package/skills/benchmark/SKILL.md +95 -95
  106. package/skills/benchmark-methodology/SKILL.md +191 -191
  107. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  108. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  109. package/skills/blueprint/SKILL.md +106 -106
  110. package/skills/brand-discovery/SKILL.md +145 -145
  111. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  112. package/skills/brand-discovery/references/20_positioning.md +44 -44
  113. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  114. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  115. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  116. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  117. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  118. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  119. package/skills/brand-voice/SKILL.md +98 -98
  120. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  121. package/skills/browser-qa/SKILL.md +105 -105
  122. package/skills/bun-runtime/SKILL.md +85 -85
  123. package/skills/canary-watch/SKILL.md +108 -108
  124. package/skills/carrier-relationship-management/SKILL.md +212 -212
  125. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  126. package/skills/ck/SKILL.md +148 -148
  127. package/skills/claude-devfleet/SKILL.md +112 -112
  128. package/skills/click-path-audit/SKILL.md +245 -245
  129. package/skills/clickhouse-io/SKILL.md +445 -445
  130. package/skills/code-tour/SKILL.md +254 -254
  131. package/skills/codebase-onboarding/SKILL.md +234 -234
  132. package/skills/codehealth-mcp/SKILL.md +167 -167
  133. package/skills/coding-standards/SKILL.md +551 -551
  134. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  135. package/skills/competitive-report-structure/SKILL.md +162 -162
  136. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  137. package/skills/config-gc/SKILL.md +120 -120
  138. package/skills/configure-ecc/SKILL.md +385 -385
  139. package/skills/connections-optimizer/SKILL.md +190 -190
  140. package/skills/content-engine/SKILL.md +132 -132
  141. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  142. package/skills/context-budget/SKILL.md +136 -136
  143. package/skills/continuous-agent-loop/SKILL.md +46 -46
  144. package/skills/continuous-learning/SKILL.md +132 -132
  145. package/skills/continuous-learning-v2/SKILL.md +361 -361
  146. package/skills/contract-first/SKILL.md +287 -287
  147. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  148. package/skills/cost-tracking/SKILL.md +97 -97
  149. package/skills/council/SKILL.md +204 -204
  150. package/skills/cpp-coding-standards/SKILL.md +724 -724
  151. package/skills/cpp-testing/SKILL.md +325 -325
  152. package/skills/crosspost/SKILL.md +112 -112
  153. package/skills/csharp-testing/SKILL.md +322 -322
  154. package/skills/customer-billing-ops/SKILL.md +141 -141
  155. package/skills/customs-trade-compliance/SKILL.md +263 -263
  156. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  157. package/skills/dashboard-builder/SKILL.md +109 -109
  158. package/skills/data-scraper-agent/SKILL.md +765 -765
  159. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  160. package/skills/database-migrations/SKILL.md +430 -430
  161. package/skills/deep-research/SKILL.md +160 -160
  162. package/skills/defi-amm-security/SKILL.md +167 -167
  163. package/skills/delivery-gate/SKILL.md +126 -126
  164. package/skills/deployment-patterns/SKILL.md +428 -428
  165. package/skills/design-system/SKILL.md +83 -83
  166. package/skills/django-celery/SKILL.md +458 -458
  167. package/skills/django-patterns/SKILL.md +735 -735
  168. package/skills/django-security/SKILL.md +644 -644
  169. package/skills/django-tdd/SKILL.md +730 -730
  170. package/skills/django-verification/SKILL.md +470 -470
  171. package/skills/dmux-workflows/SKILL.md +192 -192
  172. package/skills/docker-patterns/SKILL.md +365 -365
  173. package/skills/documentation-lookup/SKILL.md +91 -91
  174. package/skills/dotnet-patterns/SKILL.md +322 -322
  175. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  176. package/skills/e2e-testing/SKILL.md +327 -327
  177. package/skills/ecc-guide/SKILL.md +190 -190
  178. package/skills/ecc-recipes/SKILL.md +149 -149
  179. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  180. package/skills/email-ops/SKILL.md +122 -122
  181. package/skills/energy-procurement/SKILL.md +228 -228
  182. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  183. package/skills/error-handling/SKILL.md +377 -377
  184. package/skills/eval-harness/SKILL.md +271 -271
  185. package/skills/evm-token-decimals/SKILL.md +131 -131
  186. package/skills/exa-search/SKILL.md +108 -108
  187. package/skills/fal-ai-media/SKILL.md +289 -289
  188. package/skills/fastapi-patterns/SKILL.md +514 -514
  189. package/skills/finance-billing-ops/SKILL.md +128 -128
  190. package/skills/flox-environments/SKILL.md +497 -497
  191. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  192. package/skills/foundation-models-on-device/SKILL.md +243 -243
  193. package/skills/frontend-a11y/SKILL.md +446 -446
  194. package/skills/frontend-design-direction/SKILL.md +93 -93
  195. package/skills/frontend-patterns/SKILL.md +657 -657
  196. package/skills/frontend-slides/SKILL.md +185 -185
  197. package/skills/fsharp-testing/SKILL.md +281 -281
  198. package/skills/gan-style-harness/SKILL.md +279 -279
  199. package/skills/gateguard/SKILL.md +133 -133
  200. package/skills/generating-python-installer/SKILL.md +820 -820
  201. package/skills/git-workflow/SKILL.md +716 -716
  202. package/skills/github-ops/SKILL.md +145 -145
  203. package/skills/golang-patterns/SKILL.md +676 -676
  204. package/skills/golang-testing/SKILL.md +721 -721
  205. package/skills/google-workspace-ops/SKILL.md +96 -96
  206. package/skills/growth-log/SKILL.md +128 -128
  207. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  208. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  209. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  210. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  211. package/skills/hermes-imports/SKILL.md +89 -89
  212. package/skills/hexagonal-architecture/SKILL.md +277 -277
  213. package/skills/hipaa-compliance/SKILL.md +79 -79
  214. package/skills/homelab-network-readiness/SKILL.md +170 -170
  215. package/skills/homelab-network-setup/SKILL.md +130 -130
  216. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  217. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  218. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  219. package/skills/hookify-rules/SKILL.md +128 -128
  220. package/skills/inherit-legacy-style/SKILL.md +157 -157
  221. package/skills/intent-driven-development/SKILL.md +360 -360
  222. package/skills/inventory-demand-planning/SKILL.md +247 -247
  223. package/skills/investor-materials/SKILL.md +97 -97
  224. package/skills/investor-outreach/SKILL.md +92 -92
  225. package/skills/ios-icon-gen/SKILL.md +158 -158
  226. package/skills/iterative-retrieval/SKILL.md +212 -212
  227. package/skills/ito-basket-compare/SKILL.md +64 -64
  228. package/skills/ito-compute/SKILL.md +129 -129
  229. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  230. package/skills/ito-market-intelligence/SKILL.md +61 -61
  231. package/skills/ito-trade-planner/SKILL.md +68 -68
  232. package/skills/java-coding-standards/SKILL.md +384 -384
  233. package/skills/jira-integration/SKILL.md +303 -303
  234. package/skills/jpa-patterns/SKILL.md +152 -152
  235. package/skills/knowledge-ops/SKILL.md +155 -155
  236. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  237. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  238. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  239. package/skills/kotlin-patterns/SKILL.md +712 -712
  240. package/skills/kotlin-testing/SKILL.md +825 -825
  241. package/skills/kubernetes-patterns/SKILL.md +756 -756
  242. package/skills/laravel-patterns/SKILL.md +416 -416
  243. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  244. package/skills/laravel-security/SKILL.md +948 -948
  245. package/skills/laravel-tdd/SKILL.md +675 -675
  246. package/skills/laravel-verification/SKILL.md +180 -180
  247. package/skills/latency-critical-systems/SKILL.md +75 -75
  248. package/skills/lead-intelligence/SKILL.md +322 -322
  249. package/skills/liquid-glass-design/SKILL.md +279 -279
  250. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  251. package/skills/logistics-exception-management/SKILL.md +222 -222
  252. package/skills/loop-design-check/SKILL.md +143 -143
  253. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  254. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  255. package/skills/manim-video/SKILL.md +90 -90
  256. package/skills/market-research/SKILL.md +76 -76
  257. package/skills/marketing-campaign/SKILL.md +114 -114
  258. package/skills/mcp-server-patterns/SKILL.md +70 -70
  259. package/skills/messages-ops/SKILL.md +105 -105
  260. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  261. package/skills/mle-workflow/SKILL.md +348 -348
  262. package/skills/motion-advanced/SKILL.md +596 -596
  263. package/skills/motion-foundations/SKILL.md +299 -299
  264. package/skills/motion-patterns/SKILL.md +434 -434
  265. package/skills/motion-ui/SKILL.md +576 -576
  266. package/skills/mysql-patterns/SKILL.md +413 -413
  267. package/skills/nanoclaw-repl/SKILL.md +34 -34
  268. package/skills/nestjs-patterns/SKILL.md +231 -231
  269. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  270. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  271. package/skills/network-config-validation/SKILL.md +211 -211
  272. package/skills/network-interface-health/SKILL.md +153 -153
  273. package/skills/nextjs-turbopack/SKILL.md +58 -58
  274. package/skills/nodejs-keccak256/SKILL.md +103 -103
  275. package/skills/nutrient-document-processing/SKILL.md +168 -168
  276. package/skills/nuxt4-patterns/SKILL.md +101 -101
  277. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  278. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  279. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  280. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  281. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  282. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  283. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  284. package/skills/opensource-pipeline/SKILL.md +256 -256
  285. package/skills/orch-add-feature/SKILL.md +45 -45
  286. package/skills/orch-build-mvp/SKILL.md +49 -49
  287. package/skills/orch-change-feature/SKILL.md +43 -43
  288. package/skills/orch-fix-defect/SKILL.md +43 -43
  289. package/skills/orch-pipeline/SKILL.md +121 -121
  290. package/skills/orch-refine-code/SKILL.md +44 -44
  291. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  292. package/skills/perl-patterns/SKILL.md +505 -505
  293. package/skills/perl-security/SKILL.md +504 -504
  294. package/skills/perl-testing/SKILL.md +476 -476
  295. package/skills/plan-canvas/SKILL.md +153 -153
  296. package/skills/plan-orchestrate/SKILL.md +263 -263
  297. package/skills/plankton-code-quality/SKILL.md +237 -237
  298. package/skills/postgres-patterns/SKILL.md +148 -148
  299. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  300. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  301. package/skills/premium-web-design/SKILL.md +154 -154
  302. package/skills/prisma-patterns/SKILL.md +401 -401
  303. package/skills/product-capability/SKILL.md +142 -142
  304. package/skills/product-lens/SKILL.md +93 -93
  305. package/skills/production-audit/SKILL.md +207 -207
  306. package/skills/production-scheduling/SKILL.md +238 -238
  307. package/skills/project-flow-ops/SKILL.md +112 -112
  308. package/skills/prompt-optimizer/SKILL.md +398 -398
  309. package/skills/publish-website/SKILL.md +76 -0
  310. package/skills/python-patterns/SKILL.md +751 -751
  311. package/skills/python-testing/SKILL.md +817 -817
  312. package/skills/pytorch-patterns/SKILL.md +397 -397
  313. package/skills/quality-nonconformance/SKILL.md +260 -260
  314. package/skills/quarkus-patterns/SKILL.md +723 -723
  315. package/skills/quarkus-security/SKILL.md +468 -468
  316. package/skills/quarkus-tdd/SKILL.md +812 -812
  317. package/skills/quarkus-verification/SKILL.md +480 -480
  318. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  319. package/skills/react-native-patterns/SKILL.md +326 -326
  320. package/skills/react-patterns/SKILL.md +342 -342
  321. package/skills/react-performance/SKILL.md +575 -575
  322. package/skills/react-testing/SKILL.md +424 -424
  323. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  324. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  325. package/skills/redis-patterns/SKILL.md +404 -404
  326. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  327. package/skills/remotion-video-creation/SKILL.md +43 -43
  328. package/skills/repo-scan/SKILL.md +79 -79
  329. package/skills/research-ops/SKILL.md +113 -113
  330. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  331. package/skills/rules-distill/SKILL.md +265 -265
  332. package/skills/rust-patterns/SKILL.md +500 -500
  333. package/skills/rust-testing/SKILL.md +501 -501
  334. package/skills/safety-guard/SKILL.md +76 -76
  335. package/skills/santa-method/SKILL.md +307 -307
  336. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  337. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  338. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  339. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  340. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  341. package/skills/search-first/SKILL.md +183 -183
  342. package/skills/security-bounty-hunter/SKILL.md +100 -100
  343. package/skills/security-review/SKILL.md +504 -504
  344. package/skills/security-scan/SKILL.md +166 -166
  345. package/skills/seo/SKILL.md +155 -155
  346. package/skills/skill-comply/SKILL.md +59 -59
  347. package/skills/skill-scout/SKILL.md +141 -141
  348. package/skills/skill-stocktake/SKILL.md +195 -195
  349. package/skills/social-graph-ranker/SKILL.md +155 -155
  350. package/skills/social-publisher/SKILL.md +130 -130
  351. package/skills/springboot-patterns/SKILL.md +315 -315
  352. package/skills/springboot-security/SKILL.md +273 -273
  353. package/skills/springboot-tdd/SKILL.md +159 -159
  354. package/skills/springboot-verification/SKILL.md +232 -232
  355. package/skills/strategic-compact/SKILL.md +142 -142
  356. package/skills/swift-actor-persistence/SKILL.md +144 -144
  357. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  358. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  359. package/skills/swiftui-patterns/SKILL.md +259 -259
  360. package/skills/taste/SKILL.md +264 -264
  361. package/skills/taste/references/genre-taxonomy.md +87 -87
  362. package/skills/tdd-workflow/SKILL.md +583 -583
  363. package/skills/team-agent-orchestration/SKILL.md +111 -111
  364. package/skills/team-builder/SKILL.md +169 -169
  365. package/skills/terminal-ops/SKILL.md +110 -110
  366. package/skills/tinystruct-patterns/SKILL.md +279 -279
  367. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  368. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  369. package/skills/tinystruct-patterns/references/database.md +99 -99
  370. package/skills/tinystruct-patterns/references/routing.md +64 -64
  371. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  372. package/skills/tinystruct-patterns/references/testing.md +72 -72
  373. package/skills/token-budget-advisor/SKILL.md +134 -134
  374. package/skills/ui-demo/SKILL.md +466 -466
  375. package/skills/ui-to-vue/SKILL.md +135 -135
  376. package/skills/uncloud/SKILL.md +344 -344
  377. package/skills/unified-memory/SKILL.md +170 -170
  378. package/skills/unified-notifications-ops/SKILL.md +188 -188
  379. package/skills/verification-loop/SKILL.md +129 -129
  380. package/skills/video-editing/SKILL.md +311 -311
  381. package/skills/videodb/SKILL.md +375 -375
  382. package/skills/visa-doc-translate/SKILL.md +117 -117
  383. package/skills/vite-patterns/SKILL.md +450 -450
  384. package/skills/vue-patterns/SKILL.md +471 -471
  385. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  386. package/skills/workspace-surface-audit/SKILL.md +126 -126
  387. package/skills/x-api/SKILL.md +235 -235
@@ -1,551 +1,551 @@
1
- ---
2
- name: coding-standards
3
- description: Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed frontend or backend skills for framework-specific patterns.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Coding Standards & Best Practices
9
-
10
- Baseline coding conventions applicable across projects.
11
-
12
- This skill is the shared floor, not the detailed framework playbook.
13
-
14
- - Use `frontend-patterns` for React, state, forms, rendering, and UI architecture.
15
- - Use `backend-patterns` or `api-design` for repository/service layers, endpoint design, validation, and server-specific concerns.
16
- - Use `rules/common/coding-style.md` when you need the shortest reusable rule layer instead of a full skill walkthrough.
17
-
18
- ## When to Activate
19
-
20
- - Starting a new project or module
21
- - Reviewing code for quality and maintainability
22
- - Refactoring existing code to follow conventions
23
- - Enforcing naming, formatting, or structural consistency
24
- - Setting up linting, formatting, or type-checking rules
25
- - Onboarding new contributors to coding conventions
26
-
27
- ## Scope Boundaries
28
-
29
- Activate this skill for:
30
- - descriptive naming
31
- - immutability defaults
32
- - readability, KISS, DRY, and YAGNI enforcement
33
- - error-handling expectations and code-smell review
34
-
35
- Do not use this skill as the primary source for:
36
- - React composition, hooks, or rendering patterns
37
- - backend architecture, API design, or database layering
38
- - domain-specific framework guidance when a narrower ECC skill already exists
39
-
40
- ## Code Quality Principles
41
-
42
- ### 1. Readability First
43
- - Code is read more than written
44
- - Clear variable and function names
45
- - Self-documenting code preferred over comments
46
- - Consistent formatting
47
-
48
- ### 2. KISS (Keep It Simple, Stupid)
49
- - Simplest solution that works
50
- - Avoid over-engineering
51
- - No premature optimization
52
- - Easy to understand > clever code
53
-
54
- ### 3. DRY (Don't Repeat Yourself)
55
- - Extract common logic into functions
56
- - Create reusable components
57
- - Share utilities across modules
58
- - Avoid copy-paste programming
59
-
60
- ### 4. YAGNI (You Aren't Gonna Need It)
61
- - Don't build features before they're needed
62
- - Avoid speculative generality
63
- - Add complexity only when required
64
- - Start simple, refactor when needed
65
-
66
- ## TypeScript/JavaScript Standards
67
-
68
- ### Variable Naming
69
-
70
- ```typescript
71
- // PASS: GOOD: Descriptive names
72
- const marketSearchQuery = 'election'
73
- const isUserAuthenticated = true
74
- const totalRevenue = 1000
75
-
76
- // FAIL: BAD: Unclear names
77
- const q = 'election'
78
- const flag = true
79
- const x = 1000
80
- ```
81
-
82
- ### Function Naming
83
-
84
- ```typescript
85
- // PASS: GOOD: Verb-noun pattern
86
- async function fetchMarketData(marketId: string) { }
87
- function calculateSimilarity(a: number[], b: number[]) { }
88
- function isValidEmail(email: string): boolean { }
89
-
90
- // FAIL: BAD: Unclear or noun-only
91
- async function market(id: string) { }
92
- function similarity(a, b) { }
93
- function email(e) { }
94
- ```
95
-
96
- ### Immutability Pattern (CRITICAL)
97
-
98
- ```typescript
99
- // PASS: ALWAYS use spread operator
100
- const updatedUser = {
101
- ...user,
102
- name: 'New Name'
103
- }
104
-
105
- const updatedArray = [...items, newItem]
106
-
107
- // FAIL: NEVER mutate directly
108
- user.name = 'New Name' // BAD
109
- items.push(newItem) // BAD
110
- ```
111
-
112
- ### Error Handling
113
-
114
- ```typescript
115
- // PASS: GOOD: Comprehensive error handling
116
- async function fetchData(url: string) {
117
- try {
118
- const response = await fetch(url)
119
-
120
- if (!response.ok) {
121
- throw new Error(`HTTP ${response.status}: ${response.statusText}`)
122
- }
123
-
124
- return await response.json()
125
- } catch (error) {
126
- console.error('Fetch failed:', error)
127
- throw new Error('Failed to fetch data')
128
- }
129
- }
130
-
131
- // FAIL: BAD: No error handling
132
- async function fetchData(url) {
133
- const response = await fetch(url)
134
- return response.json()
135
- }
136
- ```
137
-
138
- ### Async/Await Best Practices
139
-
140
- ```typescript
141
- // PASS: GOOD: Parallel execution when possible
142
- const [users, markets, stats] = await Promise.all([
143
- fetchUsers(),
144
- fetchMarkets(),
145
- fetchStats()
146
- ])
147
-
148
- // FAIL: BAD: Sequential when unnecessary
149
- const users = await fetchUsers()
150
- const markets = await fetchMarkets()
151
- const stats = await fetchStats()
152
- ```
153
-
154
- ### Type Safety
155
-
156
- ```typescript
157
- // PASS: GOOD: Proper types
158
- interface Market {
159
- id: string
160
- name: string
161
- status: 'active' | 'resolved' | 'closed'
162
- created_at: Date
163
- }
164
-
165
- function getMarket(id: string): Promise<Market> {
166
- // Implementation
167
- }
168
-
169
- // FAIL: BAD: Using 'any'
170
- function getMarket(id: any): Promise<any> {
171
- // Implementation
172
- }
173
- ```
174
-
175
- ## React Best Practices
176
-
177
- ### Component Structure
178
-
179
- ```typescript
180
- // PASS: GOOD: Functional component with types
181
- interface ButtonProps {
182
- children: React.ReactNode
183
- onClick: () => void
184
- disabled?: boolean
185
- variant?: 'primary' | 'secondary'
186
- }
187
-
188
- export function Button({
189
- children,
190
- onClick,
191
- disabled = false,
192
- variant = 'primary'
193
- }: ButtonProps) {
194
- return (
195
- <button
196
- onClick={onClick}
197
- disabled={disabled}
198
- className={`btn btn-${variant}`}
199
- >
200
- {children}
201
- </button>
202
- )
203
- }
204
-
205
- // FAIL: BAD: No types, unclear structure
206
- export function Button(props) {
207
- return <button onClick={props.onClick}>{props.children}</button>
208
- }
209
- ```
210
-
211
- ### Custom Hooks
212
-
213
- ```typescript
214
- // PASS: GOOD: Reusable custom hook
215
- export function useDebounce<T>(value: T, delay: number): T {
216
- const [debouncedValue, setDebouncedValue] = useState<T>(value)
217
-
218
- useEffect(() => {
219
- const handler = setTimeout(() => {
220
- setDebouncedValue(value)
221
- }, delay)
222
-
223
- return () => clearTimeout(handler)
224
- }, [value, delay])
225
-
226
- return debouncedValue
227
- }
228
-
229
- // Usage
230
- const debouncedQuery = useDebounce(searchQuery, 500)
231
- ```
232
-
233
- ### State Management
234
-
235
- ```typescript
236
- // PASS: GOOD: Proper state updates
237
- const [count, setCount] = useState(0)
238
-
239
- // Functional update for state based on previous state
240
- setCount(prev => prev + 1)
241
-
242
- // FAIL: BAD: Direct state reference
243
- setCount(count + 1) // Can be stale in async scenarios
244
- ```
245
-
246
- ### Conditional Rendering
247
-
248
- ```typescript
249
- // PASS: GOOD: Clear conditional rendering
250
- {isLoading && <Spinner />}
251
- {error && <ErrorMessage error={error} />}
252
- {data && <DataDisplay data={data} />}
253
-
254
- // FAIL: BAD: Ternary hell
255
- {isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}
256
- ```
257
-
258
- ## API Design Standards
259
-
260
- ### REST API Conventions
261
-
262
- ```
263
- GET /api/markets # List all markets
264
- GET /api/markets/:id # Get specific market
265
- POST /api/markets # Create new market
266
- PUT /api/markets/:id # Update market (full)
267
- PATCH /api/markets/:id # Update market (partial)
268
- DELETE /api/markets/:id # Delete market
269
-
270
- # Query parameters for filtering
271
- GET /api/markets?status=active&limit=10&offset=0
272
- ```
273
-
274
- ### Response Format
275
-
276
- ```typescript
277
- // PASS: GOOD: Consistent response structure
278
- interface ApiResponse<T> {
279
- success: boolean
280
- data?: T
281
- error?: string
282
- meta?: {
283
- total: number
284
- page: number
285
- limit: number
286
- }
287
- }
288
-
289
- // Success response
290
- return NextResponse.json({
291
- success: true,
292
- data: markets,
293
- meta: { total: 100, page: 1, limit: 10 }
294
- })
295
-
296
- // Error response
297
- return NextResponse.json({
298
- success: false,
299
- error: 'Invalid request'
300
- }, { status: 400 })
301
- ```
302
-
303
- ### Input Validation
304
-
305
- ```typescript
306
- import { z } from 'zod'
307
-
308
- // PASS: GOOD: Schema validation
309
- const CreateMarketSchema = z.object({
310
- name: z.string().min(1).max(200),
311
- description: z.string().min(1).max(2000),
312
- endDate: z.string().datetime(),
313
- categories: z.array(z.string()).min(1)
314
- })
315
-
316
- export async function POST(request: Request) {
317
- const body = await request.json()
318
-
319
- try {
320
- const validated = CreateMarketSchema.parse(body)
321
- // Proceed with validated data
322
- } catch (error) {
323
- if (error instanceof z.ZodError) {
324
- return NextResponse.json({
325
- success: false,
326
- error: 'Validation failed',
327
- details: error.issues
328
- }, { status: 400 })
329
- }
330
- }
331
- }
332
- ```
333
-
334
- ## File Organization
335
-
336
- ### Project Structure
337
-
338
- ```
339
- src/
340
- ├── app/ # Next.js App Router
341
- │ ├── api/ # API routes
342
- │ ├── markets/ # Market pages
343
- │ └── (auth)/ # Auth pages (route groups)
344
- ├── components/ # React components
345
- │ ├── ui/ # Generic UI components
346
- │ ├── forms/ # Form components
347
- │ └── layouts/ # Layout components
348
- ├── hooks/ # Custom React hooks
349
- ├── lib/ # Utilities and configs
350
- │ ├── api/ # API clients
351
- │ ├── utils/ # Helper functions
352
- │ └── constants/ # Constants
353
- ├── types/ # TypeScript types
354
- └── styles/ # Global styles
355
- ```
356
-
357
- ### File Naming
358
-
359
- ```
360
- components/Button.tsx # PascalCase for components
361
- hooks/useAuth.ts # camelCase with 'use' prefix
362
- lib/formatDate.ts # camelCase for utilities
363
- types/market.types.ts # camelCase with .types suffix
364
- ```
365
-
366
- ## Comments & Documentation
367
-
368
- ### When to Comment
369
-
370
- ```typescript
371
- // PASS: GOOD: Explain WHY, not WHAT
372
- // Use exponential backoff to avoid overwhelming the API during outages
373
- const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
374
-
375
- // Deliberately using mutation here for performance with large arrays
376
- items.push(newItem)
377
-
378
- // FAIL: BAD: Stating the obvious
379
- // Increment counter by 1
380
- count++
381
-
382
- // Set name to user's name
383
- name = user.name
384
- ```
385
-
386
- ### JSDoc for Public APIs
387
-
388
- ```typescript
389
- /**
390
- * Searches markets using semantic similarity.
391
- *
392
- * @param query - Natural language search query
393
- * @param limit - Maximum number of results (default: 10)
394
- * @returns Array of markets sorted by similarity score
395
- * @throws {Error} If OpenAI API fails or Redis unavailable
396
- *
397
- * @example
398
- * ```typescript
399
- * const results = await searchMarkets('election', 5)
400
- * console.log(results[0].name) // "Trump vs Biden"
401
- * ```
402
- */
403
- export async function searchMarkets(
404
- query: string,
405
- limit: number = 10
406
- ): Promise<Market[]> {
407
- // Implementation
408
- }
409
- ```
410
-
411
- ## Performance Best Practices
412
-
413
- ### Memoization
414
-
415
- ```typescript
416
- import { useMemo, useCallback } from 'react'
417
-
418
- // PASS: GOOD: Memoize expensive computations
419
- // Copy before sorting - Array.prototype.sort mutates in place
420
- const sortedMarkets = useMemo(() => {
421
- return [...markets].sort((a, b) => b.volume - a.volume)
422
- }, [markets])
423
-
424
- // PASS: GOOD: Memoize callbacks
425
- const handleSearch = useCallback((query: string) => {
426
- setSearchQuery(query)
427
- }, [])
428
- ```
429
-
430
- ### Lazy Loading
431
-
432
- ```typescript
433
- import { lazy, Suspense } from 'react'
434
-
435
- // PASS: GOOD: Lazy load heavy components
436
- const HeavyChart = lazy(() => import('./HeavyChart'))
437
-
438
- export function Dashboard() {
439
- return (
440
- <Suspense fallback={<Spinner />}>
441
- <HeavyChart />
442
- </Suspense>
443
- )
444
- }
445
- ```
446
-
447
- ### Database Queries
448
-
449
- ```typescript
450
- // PASS: GOOD: Select only needed columns
451
- const { data } = await supabase
452
- .from('markets')
453
- .select('id, name, status')
454
- .limit(10)
455
-
456
- // FAIL: BAD: Select everything
457
- const { data } = await supabase
458
- .from('markets')
459
- .select('*')
460
- ```
461
-
462
- ## Testing Standards
463
-
464
- ### Test Structure (AAA Pattern)
465
-
466
- ```typescript
467
- test('calculates similarity correctly', () => {
468
- // Arrange
469
- const vector1 = [1, 0, 0]
470
- const vector2 = [0, 1, 0]
471
-
472
- // Act
473
- const similarity = calculateCosineSimilarity(vector1, vector2)
474
-
475
- // Assert
476
- expect(similarity).toBe(0)
477
- })
478
- ```
479
-
480
- ### Test Naming
481
-
482
- ```typescript
483
- // PASS: GOOD: Descriptive test names
484
- test('returns empty array when no markets match query', () => { })
485
- test('throws error when OpenAI API key is missing', () => { })
486
- test('falls back to substring search when Redis unavailable', () => { })
487
-
488
- // FAIL: BAD: Vague test names
489
- test('works', () => { })
490
- test('test search', () => { })
491
- ```
492
-
493
- ## Code Smell Detection
494
-
495
- Watch for these anti-patterns:
496
-
497
- ### 1. Long Functions
498
- ```typescript
499
- // FAIL: BAD: Function > 50 lines
500
- function processMarketData() {
501
- // 100 lines of code
502
- }
503
-
504
- // PASS: GOOD: Split into smaller functions
505
- function processMarketData() {
506
- const validated = validateData()
507
- const transformed = transformData(validated)
508
- return saveData(transformed)
509
- }
510
- ```
511
-
512
- ### 2. Deep Nesting
513
- ```typescript
514
- // FAIL: BAD: 5+ levels of nesting
515
- if (user) {
516
- if (user.isAdmin) {
517
- if (market) {
518
- if (market.isActive) {
519
- if (hasPermission) {
520
- // Do something
521
- }
522
- }
523
- }
524
- }
525
- }
526
-
527
- // PASS: GOOD: Early returns
528
- if (!user) return
529
- if (!user.isAdmin) return
530
- if (!market) return
531
- if (!market.isActive) return
532
- if (!hasPermission) return
533
-
534
- // Do something
535
- ```
536
-
537
- ### 3. Magic Numbers
538
- ```typescript
539
- // FAIL: BAD: Unexplained numbers
540
- if (retryCount > 3) { }
541
- setTimeout(callback, 500)
542
-
543
- // PASS: GOOD: Named constants
544
- const MAX_RETRIES = 3
545
- const DEBOUNCE_DELAY_MS = 500
546
-
547
- if (retryCount > MAX_RETRIES) { }
548
- setTimeout(callback, DEBOUNCE_DELAY_MS)
549
- ```
550
-
551
- **Remember**: Code quality is not negotiable. Clear, maintainable code enables rapid development and confident refactoring.
1
+ ---
2
+ name: coding-standards
3
+ description: Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed frontend or backend skills for framework-specific patterns.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Coding Standards & Best Practices
9
+
10
+ Baseline coding conventions applicable across projects.
11
+
12
+ This skill is the shared floor, not the detailed framework playbook.
13
+
14
+ - Use `frontend-patterns` for React, state, forms, rendering, and UI architecture.
15
+ - Use `backend-patterns` or `api-design` for repository/service layers, endpoint design, validation, and server-specific concerns.
16
+ - Use `rules/common/coding-style.md` when you need the shortest reusable rule layer instead of a full skill walkthrough.
17
+
18
+ ## When to Activate
19
+
20
+ - Starting a new project or module
21
+ - Reviewing code for quality and maintainability
22
+ - Refactoring existing code to follow conventions
23
+ - Enforcing naming, formatting, or structural consistency
24
+ - Setting up linting, formatting, or type-checking rules
25
+ - Onboarding new contributors to coding conventions
26
+
27
+ ## Scope Boundaries
28
+
29
+ Activate this skill for:
30
+ - descriptive naming
31
+ - immutability defaults
32
+ - readability, KISS, DRY, and YAGNI enforcement
33
+ - error-handling expectations and code-smell review
34
+
35
+ Do not use this skill as the primary source for:
36
+ - React composition, hooks, or rendering patterns
37
+ - backend architecture, API design, or database layering
38
+ - domain-specific framework guidance when a narrower ECC skill already exists
39
+
40
+ ## Code Quality Principles
41
+
42
+ ### 1. Readability First
43
+ - Code is read more than written
44
+ - Clear variable and function names
45
+ - Self-documenting code preferred over comments
46
+ - Consistent formatting
47
+
48
+ ### 2. KISS (Keep It Simple, Stupid)
49
+ - Simplest solution that works
50
+ - Avoid over-engineering
51
+ - No premature optimization
52
+ - Easy to understand > clever code
53
+
54
+ ### 3. DRY (Don't Repeat Yourself)
55
+ - Extract common logic into functions
56
+ - Create reusable components
57
+ - Share utilities across modules
58
+ - Avoid copy-paste programming
59
+
60
+ ### 4. YAGNI (You Aren't Gonna Need It)
61
+ - Don't build features before they're needed
62
+ - Avoid speculative generality
63
+ - Add complexity only when required
64
+ - Start simple, refactor when needed
65
+
66
+ ## TypeScript/JavaScript Standards
67
+
68
+ ### Variable Naming
69
+
70
+ ```typescript
71
+ // PASS: GOOD: Descriptive names
72
+ const marketSearchQuery = 'election'
73
+ const isUserAuthenticated = true
74
+ const totalRevenue = 1000
75
+
76
+ // FAIL: BAD: Unclear names
77
+ const q = 'election'
78
+ const flag = true
79
+ const x = 1000
80
+ ```
81
+
82
+ ### Function Naming
83
+
84
+ ```typescript
85
+ // PASS: GOOD: Verb-noun pattern
86
+ async function fetchMarketData(marketId: string) { }
87
+ function calculateSimilarity(a: number[], b: number[]) { }
88
+ function isValidEmail(email: string): boolean { }
89
+
90
+ // FAIL: BAD: Unclear or noun-only
91
+ async function market(id: string) { }
92
+ function similarity(a, b) { }
93
+ function email(e) { }
94
+ ```
95
+
96
+ ### Immutability Pattern (CRITICAL)
97
+
98
+ ```typescript
99
+ // PASS: ALWAYS use spread operator
100
+ const updatedUser = {
101
+ ...user,
102
+ name: 'New Name'
103
+ }
104
+
105
+ const updatedArray = [...items, newItem]
106
+
107
+ // FAIL: NEVER mutate directly
108
+ user.name = 'New Name' // BAD
109
+ items.push(newItem) // BAD
110
+ ```
111
+
112
+ ### Error Handling
113
+
114
+ ```typescript
115
+ // PASS: GOOD: Comprehensive error handling
116
+ async function fetchData(url: string) {
117
+ try {
118
+ const response = await fetch(url)
119
+
120
+ if (!response.ok) {
121
+ throw new Error(`HTTP ${response.status}: ${response.statusText}`)
122
+ }
123
+
124
+ return await response.json()
125
+ } catch (error) {
126
+ console.error('Fetch failed:', error)
127
+ throw new Error('Failed to fetch data')
128
+ }
129
+ }
130
+
131
+ // FAIL: BAD: No error handling
132
+ async function fetchData(url) {
133
+ const response = await fetch(url)
134
+ return response.json()
135
+ }
136
+ ```
137
+
138
+ ### Async/Await Best Practices
139
+
140
+ ```typescript
141
+ // PASS: GOOD: Parallel execution when possible
142
+ const [users, markets, stats] = await Promise.all([
143
+ fetchUsers(),
144
+ fetchMarkets(),
145
+ fetchStats()
146
+ ])
147
+
148
+ // FAIL: BAD: Sequential when unnecessary
149
+ const users = await fetchUsers()
150
+ const markets = await fetchMarkets()
151
+ const stats = await fetchStats()
152
+ ```
153
+
154
+ ### Type Safety
155
+
156
+ ```typescript
157
+ // PASS: GOOD: Proper types
158
+ interface Market {
159
+ id: string
160
+ name: string
161
+ status: 'active' | 'resolved' | 'closed'
162
+ created_at: Date
163
+ }
164
+
165
+ function getMarket(id: string): Promise<Market> {
166
+ // Implementation
167
+ }
168
+
169
+ // FAIL: BAD: Using 'any'
170
+ function getMarket(id: any): Promise<any> {
171
+ // Implementation
172
+ }
173
+ ```
174
+
175
+ ## React Best Practices
176
+
177
+ ### Component Structure
178
+
179
+ ```typescript
180
+ // PASS: GOOD: Functional component with types
181
+ interface ButtonProps {
182
+ children: React.ReactNode
183
+ onClick: () => void
184
+ disabled?: boolean
185
+ variant?: 'primary' | 'secondary'
186
+ }
187
+
188
+ export function Button({
189
+ children,
190
+ onClick,
191
+ disabled = false,
192
+ variant = 'primary'
193
+ }: ButtonProps) {
194
+ return (
195
+ <button
196
+ onClick={onClick}
197
+ disabled={disabled}
198
+ className={`btn btn-${variant}`}
199
+ >
200
+ {children}
201
+ </button>
202
+ )
203
+ }
204
+
205
+ // FAIL: BAD: No types, unclear structure
206
+ export function Button(props) {
207
+ return <button onClick={props.onClick}>{props.children}</button>
208
+ }
209
+ ```
210
+
211
+ ### Custom Hooks
212
+
213
+ ```typescript
214
+ // PASS: GOOD: Reusable custom hook
215
+ export function useDebounce<T>(value: T, delay: number): T {
216
+ const [debouncedValue, setDebouncedValue] = useState<T>(value)
217
+
218
+ useEffect(() => {
219
+ const handler = setTimeout(() => {
220
+ setDebouncedValue(value)
221
+ }, delay)
222
+
223
+ return () => clearTimeout(handler)
224
+ }, [value, delay])
225
+
226
+ return debouncedValue
227
+ }
228
+
229
+ // Usage
230
+ const debouncedQuery = useDebounce(searchQuery, 500)
231
+ ```
232
+
233
+ ### State Management
234
+
235
+ ```typescript
236
+ // PASS: GOOD: Proper state updates
237
+ const [count, setCount] = useState(0)
238
+
239
+ // Functional update for state based on previous state
240
+ setCount(prev => prev + 1)
241
+
242
+ // FAIL: BAD: Direct state reference
243
+ setCount(count + 1) // Can be stale in async scenarios
244
+ ```
245
+
246
+ ### Conditional Rendering
247
+
248
+ ```typescript
249
+ // PASS: GOOD: Clear conditional rendering
250
+ {isLoading && <Spinner />}
251
+ {error && <ErrorMessage error={error} />}
252
+ {data && <DataDisplay data={data} />}
253
+
254
+ // FAIL: BAD: Ternary hell
255
+ {isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}
256
+ ```
257
+
258
+ ## API Design Standards
259
+
260
+ ### REST API Conventions
261
+
262
+ ```
263
+ GET /api/markets # List all markets
264
+ GET /api/markets/:id # Get specific market
265
+ POST /api/markets # Create new market
266
+ PUT /api/markets/:id # Update market (full)
267
+ PATCH /api/markets/:id # Update market (partial)
268
+ DELETE /api/markets/:id # Delete market
269
+
270
+ # Query parameters for filtering
271
+ GET /api/markets?status=active&limit=10&offset=0
272
+ ```
273
+
274
+ ### Response Format
275
+
276
+ ```typescript
277
+ // PASS: GOOD: Consistent response structure
278
+ interface ApiResponse<T> {
279
+ success: boolean
280
+ data?: T
281
+ error?: string
282
+ meta?: {
283
+ total: number
284
+ page: number
285
+ limit: number
286
+ }
287
+ }
288
+
289
+ // Success response
290
+ return NextResponse.json({
291
+ success: true,
292
+ data: markets,
293
+ meta: { total: 100, page: 1, limit: 10 }
294
+ })
295
+
296
+ // Error response
297
+ return NextResponse.json({
298
+ success: false,
299
+ error: 'Invalid request'
300
+ }, { status: 400 })
301
+ ```
302
+
303
+ ### Input Validation
304
+
305
+ ```typescript
306
+ import { z } from 'zod'
307
+
308
+ // PASS: GOOD: Schema validation
309
+ const CreateMarketSchema = z.object({
310
+ name: z.string().min(1).max(200),
311
+ description: z.string().min(1).max(2000),
312
+ endDate: z.string().datetime(),
313
+ categories: z.array(z.string()).min(1)
314
+ })
315
+
316
+ export async function POST(request: Request) {
317
+ const body = await request.json()
318
+
319
+ try {
320
+ const validated = CreateMarketSchema.parse(body)
321
+ // Proceed with validated data
322
+ } catch (error) {
323
+ if (error instanceof z.ZodError) {
324
+ return NextResponse.json({
325
+ success: false,
326
+ error: 'Validation failed',
327
+ details: error.issues
328
+ }, { status: 400 })
329
+ }
330
+ }
331
+ }
332
+ ```
333
+
334
+ ## File Organization
335
+
336
+ ### Project Structure
337
+
338
+ ```
339
+ src/
340
+ ├── app/ # Next.js App Router
341
+ │ ├── api/ # API routes
342
+ │ ├── markets/ # Market pages
343
+ │ └── (auth)/ # Auth pages (route groups)
344
+ ├── components/ # React components
345
+ │ ├── ui/ # Generic UI components
346
+ │ ├── forms/ # Form components
347
+ │ └── layouts/ # Layout components
348
+ ├── hooks/ # Custom React hooks
349
+ ├── lib/ # Utilities and configs
350
+ │ ├── api/ # API clients
351
+ │ ├── utils/ # Helper functions
352
+ │ └── constants/ # Constants
353
+ ├── types/ # TypeScript types
354
+ └── styles/ # Global styles
355
+ ```
356
+
357
+ ### File Naming
358
+
359
+ ```
360
+ components/Button.tsx # PascalCase for components
361
+ hooks/useAuth.ts # camelCase with 'use' prefix
362
+ lib/formatDate.ts # camelCase for utilities
363
+ types/market.types.ts # camelCase with .types suffix
364
+ ```
365
+
366
+ ## Comments & Documentation
367
+
368
+ ### When to Comment
369
+
370
+ ```typescript
371
+ // PASS: GOOD: Explain WHY, not WHAT
372
+ // Use exponential backoff to avoid overwhelming the API during outages
373
+ const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
374
+
375
+ // Deliberately using mutation here for performance with large arrays
376
+ items.push(newItem)
377
+
378
+ // FAIL: BAD: Stating the obvious
379
+ // Increment counter by 1
380
+ count++
381
+
382
+ // Set name to user's name
383
+ name = user.name
384
+ ```
385
+
386
+ ### JSDoc for Public APIs
387
+
388
+ ```typescript
389
+ /**
390
+ * Searches markets using semantic similarity.
391
+ *
392
+ * @param query - Natural language search query
393
+ * @param limit - Maximum number of results (default: 10)
394
+ * @returns Array of markets sorted by similarity score
395
+ * @throws {Error} If OpenAI API fails or Redis unavailable
396
+ *
397
+ * @example
398
+ * ```typescript
399
+ * const results = await searchMarkets('election', 5)
400
+ * console.log(results[0].name) // "Trump vs Biden"
401
+ * ```
402
+ */
403
+ export async function searchMarkets(
404
+ query: string,
405
+ limit: number = 10
406
+ ): Promise<Market[]> {
407
+ // Implementation
408
+ }
409
+ ```
410
+
411
+ ## Performance Best Practices
412
+
413
+ ### Memoization
414
+
415
+ ```typescript
416
+ import { useMemo, useCallback } from 'react'
417
+
418
+ // PASS: GOOD: Memoize expensive computations
419
+ // Copy before sorting - Array.prototype.sort mutates in place
420
+ const sortedMarkets = useMemo(() => {
421
+ return [...markets].sort((a, b) => b.volume - a.volume)
422
+ }, [markets])
423
+
424
+ // PASS: GOOD: Memoize callbacks
425
+ const handleSearch = useCallback((query: string) => {
426
+ setSearchQuery(query)
427
+ }, [])
428
+ ```
429
+
430
+ ### Lazy Loading
431
+
432
+ ```typescript
433
+ import { lazy, Suspense } from 'react'
434
+
435
+ // PASS: GOOD: Lazy load heavy components
436
+ const HeavyChart = lazy(() => import('./HeavyChart'))
437
+
438
+ export function Dashboard() {
439
+ return (
440
+ <Suspense fallback={<Spinner />}>
441
+ <HeavyChart />
442
+ </Suspense>
443
+ )
444
+ }
445
+ ```
446
+
447
+ ### Database Queries
448
+
449
+ ```typescript
450
+ // PASS: GOOD: Select only needed columns
451
+ const { data } = await supabase
452
+ .from('markets')
453
+ .select('id, name, status')
454
+ .limit(10)
455
+
456
+ // FAIL: BAD: Select everything
457
+ const { data } = await supabase
458
+ .from('markets')
459
+ .select('*')
460
+ ```
461
+
462
+ ## Testing Standards
463
+
464
+ ### Test Structure (AAA Pattern)
465
+
466
+ ```typescript
467
+ test('calculates similarity correctly', () => {
468
+ // Arrange
469
+ const vector1 = [1, 0, 0]
470
+ const vector2 = [0, 1, 0]
471
+
472
+ // Act
473
+ const similarity = calculateCosineSimilarity(vector1, vector2)
474
+
475
+ // Assert
476
+ expect(similarity).toBe(0)
477
+ })
478
+ ```
479
+
480
+ ### Test Naming
481
+
482
+ ```typescript
483
+ // PASS: GOOD: Descriptive test names
484
+ test('returns empty array when no markets match query', () => { })
485
+ test('throws error when OpenAI API key is missing', () => { })
486
+ test('falls back to substring search when Redis unavailable', () => { })
487
+
488
+ // FAIL: BAD: Vague test names
489
+ test('works', () => { })
490
+ test('test search', () => { })
491
+ ```
492
+
493
+ ## Code Smell Detection
494
+
495
+ Watch for these anti-patterns:
496
+
497
+ ### 1. Long Functions
498
+ ```typescript
499
+ // FAIL: BAD: Function > 50 lines
500
+ function processMarketData() {
501
+ // 100 lines of code
502
+ }
503
+
504
+ // PASS: GOOD: Split into smaller functions
505
+ function processMarketData() {
506
+ const validated = validateData()
507
+ const transformed = transformData(validated)
508
+ return saveData(transformed)
509
+ }
510
+ ```
511
+
512
+ ### 2. Deep Nesting
513
+ ```typescript
514
+ // FAIL: BAD: 5+ levels of nesting
515
+ if (user) {
516
+ if (user.isAdmin) {
517
+ if (market) {
518
+ if (market.isActive) {
519
+ if (hasPermission) {
520
+ // Do something
521
+ }
522
+ }
523
+ }
524
+ }
525
+ }
526
+
527
+ // PASS: GOOD: Early returns
528
+ if (!user) return
529
+ if (!user.isAdmin) return
530
+ if (!market) return
531
+ if (!market.isActive) return
532
+ if (!hasPermission) return
533
+
534
+ // Do something
535
+ ```
536
+
537
+ ### 3. Magic Numbers
538
+ ```typescript
539
+ // FAIL: BAD: Unexplained numbers
540
+ if (retryCount > 3) { }
541
+ setTimeout(callback, 500)
542
+
543
+ // PASS: GOOD: Named constants
544
+ const MAX_RETRIES = 3
545
+ const DEBOUNCE_DELAY_MS = 500
546
+
547
+ if (retryCount > MAX_RETRIES) { }
548
+ setTimeout(callback, DEBOUNCE_DELAY_MS)
549
+ ```
550
+
551
+ **Remember**: Code quality is not negotiable. Clear, maintainable code enables rapid development and confident refactoring.