codeply-cli 0.5.5 → 0.6.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 (429) hide show
  1. package/LICENSE +21 -21
  2. package/THIRD_PARTY_NOTICES.md +65 -65
  3. package/bin/codeply.js +8 -3
  4. package/lib/agent.mjs +2596 -2268
  5. package/lib/ai.js +135 -27
  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/autopilot.js +84 -0
  12. package/lib/bot-mail.js +46 -0
  13. package/lib/bots.js +142 -15
  14. package/lib/brain.js +914 -0
  15. package/lib/call-assist.js +120 -0
  16. package/lib/chatgpt.js +282 -282
  17. package/lib/cloud-browser.mjs +143 -143
  18. package/lib/cloud.mjs +1396 -1312
  19. package/lib/commands.js +103 -103
  20. package/lib/computer.js +136 -0
  21. package/lib/design-library/assemble-artifact.mjs +21 -21
  22. package/lib/design-library/cleanup.mjs +45 -45
  23. package/lib/design-library/index.json +22379 -22379
  24. package/lib/design-library/make-table-data.mjs +39 -39
  25. package/lib/design-tools.mjs +173 -0
  26. package/lib/diagnostics.js +192 -192
  27. package/lib/dsh-acp.mjs +444 -0
  28. package/lib/edit-engine.js +364 -364
  29. package/lib/github-agent.mjs +326 -326
  30. package/lib/handoff.mjs +245 -0
  31. package/lib/history.js +78 -75
  32. package/lib/life-sources.js +319 -0
  33. package/lib/life-store.js +356 -0
  34. package/lib/life-triggers.js +286 -0
  35. package/lib/life.js +487 -0
  36. package/lib/mail-watch.js +3 -3
  37. package/lib/mcp.js +258 -258
  38. package/lib/native-tools.mjs +17 -5
  39. package/lib/oauth-connectors.js +76 -21
  40. package/lib/permissions.js +109 -109
  41. package/lib/plugins.js +356 -353
  42. package/lib/reach.js +67 -67
  43. package/lib/render-md.mjs +647 -617
  44. package/lib/screen.js +77 -0
  45. package/lib/server.mjs +458 -457
  46. package/lib/session-db.js +220 -220
  47. package/lib/share.js +208 -168
  48. package/lib/skills.js +4 -1
  49. package/lib/snapshot.js +146 -146
  50. package/lib/subagents.js +4 -2
  51. package/lib/telemetry.js +105 -105
  52. package/lib/terminal-hints.js +154 -154
  53. package/lib/textarea.mjs +264 -258
  54. package/lib/tools.mjs +326 -40
  55. package/lib/tui.mjs +1459 -1086
  56. package/lib/typecheck-worker.js +147 -147
  57. package/lib/web-tools.js +209 -209
  58. package/package.json +1 -1
  59. package/skills/SOURCE.md +58 -58
  60. package/skills/accessibility/SKILL.md +147 -147
  61. package/skills/agent-architecture-audit/SKILL.md +257 -257
  62. package/skills/agent-eval/SKILL.md +147 -147
  63. package/skills/agent-harness-construction/SKILL.md +74 -74
  64. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  65. package/skills/agent-payment-x402/SKILL.md +225 -225
  66. package/skills/agent-self-evaluation/SKILL.md +182 -182
  67. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  68. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  69. package/skills/agent-sort/SKILL.md +216 -216
  70. package/skills/agentic-engineering/SKILL.md +64 -64
  71. package/skills/agentic-os/SKILL.md +388 -388
  72. package/skills/ai-first-engineering/SKILL.md +52 -52
  73. package/skills/ai-regression-testing/SKILL.md +386 -386
  74. package/skills/android-clean-architecture/SKILL.md +340 -340
  75. package/skills/angular-developer/SKILL.md +155 -155
  76. package/skills/angular-developer/references/angular-animations.md +160 -160
  77. package/skills/angular-developer/references/angular-aria.md +410 -410
  78. package/skills/angular-developer/references/cli.md +86 -86
  79. package/skills/angular-developer/references/component-harnesses.md +59 -59
  80. package/skills/angular-developer/references/component-styling.md +91 -91
  81. package/skills/angular-developer/references/components.md +117 -117
  82. package/skills/angular-developer/references/creating-services.md +97 -97
  83. package/skills/angular-developer/references/data-resolvers.md +69 -69
  84. package/skills/angular-developer/references/define-routes.md +67 -67
  85. package/skills/angular-developer/references/defining-providers.md +72 -72
  86. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  87. package/skills/angular-developer/references/e2e-testing.md +56 -56
  88. package/skills/angular-developer/references/effects.md +83 -83
  89. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  90. package/skills/angular-developer/references/host-elements.md +80 -80
  91. package/skills/angular-developer/references/injection-context.md +63 -63
  92. package/skills/angular-developer/references/inputs.md +101 -101
  93. package/skills/angular-developer/references/linked-signal.md +59 -59
  94. package/skills/angular-developer/references/loading-strategies.md +61 -61
  95. package/skills/angular-developer/references/mcp.md +108 -108
  96. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  97. package/skills/angular-developer/references/outputs.md +86 -86
  98. package/skills/angular-developer/references/reactive-forms.md +122 -122
  99. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  100. package/skills/angular-developer/references/resource.md +77 -77
  101. package/skills/angular-developer/references/route-animations.md +56 -56
  102. package/skills/angular-developer/references/route-guards.md +52 -52
  103. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  104. package/skills/angular-developer/references/router-testing.md +87 -87
  105. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  106. package/skills/angular-developer/references/signal-forms.md +795 -795
  107. package/skills/angular-developer/references/signals-overview.md +94 -94
  108. package/skills/angular-developer/references/tailwind-css.md +69 -69
  109. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  110. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  111. package/skills/api-connector-builder/SKILL.md +121 -121
  112. package/skills/api-design/SKILL.md +524 -524
  113. package/skills/architecture-decision-records/SKILL.md +180 -180
  114. package/skills/article-writing/SKILL.md +80 -80
  115. package/skills/automation-audit-ops/SKILL.md +143 -143
  116. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  117. package/skills/autonomous-loops/SKILL.md +611 -611
  118. package/skills/backend-patterns/SKILL.md +562 -562
  119. package/skills/benchmark/SKILL.md +95 -95
  120. package/skills/benchmark-methodology/SKILL.md +191 -191
  121. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  122. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  123. package/skills/blueprint/SKILL.md +106 -106
  124. package/skills/brand-discovery/SKILL.md +145 -145
  125. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  126. package/skills/brand-discovery/references/20_positioning.md +44 -44
  127. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  128. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  129. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  130. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  131. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  132. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  133. package/skills/brand-voice/SKILL.md +98 -98
  134. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  135. package/skills/browser-qa/SKILL.md +105 -105
  136. package/skills/bun-runtime/SKILL.md +85 -85
  137. package/skills/canary-watch/SKILL.md +108 -108
  138. package/skills/carrier-relationship-management/SKILL.md +212 -212
  139. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  140. package/skills/ck/SKILL.md +148 -148
  141. package/skills/claude-devfleet/SKILL.md +112 -112
  142. package/skills/click-path-audit/SKILL.md +245 -245
  143. package/skills/clickhouse-io/SKILL.md +445 -445
  144. package/skills/code-tour/SKILL.md +254 -254
  145. package/skills/codebase-onboarding/SKILL.md +234 -234
  146. package/skills/codehealth-mcp/SKILL.md +167 -167
  147. package/skills/codeply-taste/LICENSE +21 -0
  148. package/skills/codeply-taste/SKILL.md +100 -0
  149. package/skills/codeply-taste/SOURCE.md +10 -0
  150. package/skills/codeply-taste/assets/base.css +100 -0
  151. package/skills/codeply-taste/assets/base.js +37 -0
  152. package/skills/codeply-taste/library/directions.json +1078 -0
  153. package/skills/codeply-taste/library/heroes.json +894 -0
  154. package/skills/codeply-taste/library/motions.json +57 -0
  155. package/skills/codeply-taste/library/palettes.json +1485 -0
  156. package/skills/codeply-taste/library/photos.json +7240 -0
  157. package/skills/codeply-taste/library/sections.json +4136 -0
  158. package/skills/codeply-taste/library/sites.json +7274 -0
  159. package/skills/codeply-taste/library/type.json +2024 -0
  160. package/skills/codeply-taste/references/colour.md +141 -0
  161. package/skills/codeply-taste/references/copy.md +177 -0
  162. package/skills/codeply-taste/references/critique.md +171 -0
  163. package/skills/codeply-taste/references/imagery.md +377 -0
  164. package/skills/codeply-taste/references/layout.md +178 -0
  165. package/skills/codeply-taste/references/motion.md +292 -0
  166. package/skills/codeply-taste/references/research.md +306 -0
  167. package/skills/codeply-taste/references/tells.md +115 -0
  168. package/skills/codeply-taste/references/type.md +170 -0
  169. package/skills/codeply-taste/scripts/assets.mjs +865 -0
  170. package/skills/codeply-taste/scripts/draw.mjs +525 -0
  171. package/skills/codeply-taste/scripts/inspect.mjs +205 -0
  172. package/skills/codeply-taste/scripts/lib/cdp.mjs +205 -0
  173. package/skills/codeply-taste/scripts/lib/probe.mjs +569 -0
  174. package/skills/codeply-taste/scripts/lib/rules.mjs +137 -0
  175. package/skills/codeply-taste/scripts/lint.mjs +108 -0
  176. package/skills/coding-standards/SKILL.md +551 -551
  177. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  178. package/skills/competitive-report-structure/SKILL.md +162 -162
  179. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  180. package/skills/config-gc/SKILL.md +120 -120
  181. package/skills/configure-ecc/SKILL.md +385 -385
  182. package/skills/connections-optimizer/SKILL.md +190 -190
  183. package/skills/content-engine/SKILL.md +132 -132
  184. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  185. package/skills/context-budget/SKILL.md +136 -136
  186. package/skills/continuous-agent-loop/SKILL.md +46 -46
  187. package/skills/continuous-learning/SKILL.md +132 -132
  188. package/skills/continuous-learning-v2/SKILL.md +361 -361
  189. package/skills/contract-first/SKILL.md +287 -287
  190. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  191. package/skills/cost-tracking/SKILL.md +97 -97
  192. package/skills/council/SKILL.md +204 -204
  193. package/skills/cpp-coding-standards/SKILL.md +724 -724
  194. package/skills/cpp-testing/SKILL.md +325 -325
  195. package/skills/crosspost/SKILL.md +112 -112
  196. package/skills/csharp-testing/SKILL.md +322 -322
  197. package/skills/customer-billing-ops/SKILL.md +141 -141
  198. package/skills/customs-trade-compliance/SKILL.md +263 -263
  199. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  200. package/skills/dashboard-builder/SKILL.md +109 -109
  201. package/skills/data-scraper-agent/SKILL.md +765 -765
  202. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  203. package/skills/database-migrations/SKILL.md +430 -430
  204. package/skills/deep-research/SKILL.md +160 -160
  205. package/skills/defi-amm-security/SKILL.md +167 -167
  206. package/skills/delivery-gate/SKILL.md +126 -126
  207. package/skills/deployment-patterns/SKILL.md +428 -428
  208. package/skills/design-system/SKILL.md +83 -83
  209. package/skills/django-celery/SKILL.md +458 -458
  210. package/skills/django-patterns/SKILL.md +735 -735
  211. package/skills/django-security/SKILL.md +644 -644
  212. package/skills/django-tdd/SKILL.md +730 -730
  213. package/skills/django-verification/SKILL.md +470 -470
  214. package/skills/dmux-workflows/SKILL.md +192 -192
  215. package/skills/docker-patterns/SKILL.md +365 -365
  216. package/skills/documentation-lookup/SKILL.md +91 -91
  217. package/skills/dotnet-patterns/SKILL.md +322 -322
  218. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  219. package/skills/e2e-testing/SKILL.md +327 -327
  220. package/skills/ecc-guide/SKILL.md +190 -190
  221. package/skills/ecc-recipes/SKILL.md +149 -149
  222. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  223. package/skills/email-ops/SKILL.md +122 -122
  224. package/skills/energy-procurement/SKILL.md +228 -228
  225. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  226. package/skills/error-handling/SKILL.md +377 -377
  227. package/skills/eval-harness/SKILL.md +271 -271
  228. package/skills/evm-token-decimals/SKILL.md +131 -131
  229. package/skills/exa-search/SKILL.md +108 -108
  230. package/skills/fal-ai-media/SKILL.md +289 -289
  231. package/skills/fastapi-patterns/SKILL.md +514 -514
  232. package/skills/finance-billing-ops/SKILL.md +128 -128
  233. package/skills/flox-environments/SKILL.md +497 -497
  234. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  235. package/skills/foundation-models-on-device/SKILL.md +243 -243
  236. package/skills/frontend-a11y/SKILL.md +446 -446
  237. package/skills/frontend-design-direction/SKILL.md +93 -93
  238. package/skills/frontend-patterns/SKILL.md +657 -657
  239. package/skills/frontend-slides/SKILL.md +185 -185
  240. package/skills/fsharp-testing/SKILL.md +281 -281
  241. package/skills/gan-style-harness/SKILL.md +279 -279
  242. package/skills/gateguard/SKILL.md +133 -133
  243. package/skills/generating-python-installer/SKILL.md +820 -820
  244. package/skills/git-workflow/SKILL.md +716 -716
  245. package/skills/github-ops/SKILL.md +145 -145
  246. package/skills/golang-patterns/SKILL.md +676 -676
  247. package/skills/golang-testing/SKILL.md +721 -721
  248. package/skills/google-workspace-ops/SKILL.md +96 -96
  249. package/skills/growth-log/SKILL.md +128 -128
  250. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  251. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  252. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  253. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  254. package/skills/hermes-imports/SKILL.md +89 -89
  255. package/skills/hexagonal-architecture/SKILL.md +277 -277
  256. package/skills/hipaa-compliance/SKILL.md +79 -79
  257. package/skills/homelab-network-readiness/SKILL.md +170 -170
  258. package/skills/homelab-network-setup/SKILL.md +130 -130
  259. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  260. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  261. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  262. package/skills/hookify-rules/SKILL.md +128 -128
  263. package/skills/inherit-legacy-style/SKILL.md +157 -157
  264. package/skills/intent-driven-development/SKILL.md +360 -360
  265. package/skills/inventory-demand-planning/SKILL.md +247 -247
  266. package/skills/investor-materials/SKILL.md +97 -97
  267. package/skills/investor-outreach/SKILL.md +92 -92
  268. package/skills/ios-icon-gen/SKILL.md +158 -158
  269. package/skills/iterative-retrieval/SKILL.md +212 -212
  270. package/skills/ito-basket-compare/SKILL.md +64 -64
  271. package/skills/ito-compute/SKILL.md +129 -129
  272. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  273. package/skills/ito-market-intelligence/SKILL.md +61 -61
  274. package/skills/ito-trade-planner/SKILL.md +68 -68
  275. package/skills/java-coding-standards/SKILL.md +384 -384
  276. package/skills/jira-integration/SKILL.md +303 -303
  277. package/skills/jpa-patterns/SKILL.md +152 -152
  278. package/skills/knowledge-ops/SKILL.md +155 -155
  279. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  280. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  281. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  282. package/skills/kotlin-patterns/SKILL.md +712 -712
  283. package/skills/kotlin-testing/SKILL.md +825 -825
  284. package/skills/kubernetes-patterns/SKILL.md +756 -756
  285. package/skills/laravel-patterns/SKILL.md +416 -416
  286. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  287. package/skills/laravel-security/SKILL.md +948 -948
  288. package/skills/laravel-tdd/SKILL.md +675 -675
  289. package/skills/laravel-verification/SKILL.md +180 -180
  290. package/skills/latency-critical-systems/SKILL.md +75 -75
  291. package/skills/lead-intelligence/SKILL.md +322 -322
  292. package/skills/liquid-glass-design/SKILL.md +279 -279
  293. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  294. package/skills/logistics-exception-management/SKILL.md +222 -222
  295. package/skills/loop-design-check/SKILL.md +143 -143
  296. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  297. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  298. package/skills/manim-video/SKILL.md +90 -90
  299. package/skills/market-research/SKILL.md +76 -76
  300. package/skills/marketing-campaign/SKILL.md +114 -114
  301. package/skills/mcp-server-patterns/SKILL.md +70 -70
  302. package/skills/messages-ops/SKILL.md +105 -105
  303. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  304. package/skills/mle-workflow/SKILL.md +348 -348
  305. package/skills/motion-advanced/SKILL.md +596 -596
  306. package/skills/motion-foundations/SKILL.md +299 -299
  307. package/skills/motion-patterns/SKILL.md +434 -434
  308. package/skills/motion-ui/SKILL.md +576 -576
  309. package/skills/mysql-patterns/SKILL.md +413 -413
  310. package/skills/nanoclaw-repl/SKILL.md +34 -34
  311. package/skills/nestjs-patterns/SKILL.md +231 -231
  312. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  313. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  314. package/skills/network-config-validation/SKILL.md +211 -211
  315. package/skills/network-interface-health/SKILL.md +153 -153
  316. package/skills/nextjs-turbopack/SKILL.md +58 -58
  317. package/skills/nodejs-keccak256/SKILL.md +103 -103
  318. package/skills/nutrient-document-processing/SKILL.md +168 -168
  319. package/skills/nuxt4-patterns/SKILL.md +101 -101
  320. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  321. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  322. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  323. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  324. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  325. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  326. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  327. package/skills/opensource-pipeline/SKILL.md +256 -256
  328. package/skills/orch-add-feature/SKILL.md +45 -45
  329. package/skills/orch-build-mvp/SKILL.md +49 -49
  330. package/skills/orch-change-feature/SKILL.md +43 -43
  331. package/skills/orch-fix-defect/SKILL.md +43 -43
  332. package/skills/orch-pipeline/SKILL.md +121 -121
  333. package/skills/orch-refine-code/SKILL.md +44 -44
  334. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  335. package/skills/perl-patterns/SKILL.md +505 -505
  336. package/skills/perl-security/SKILL.md +504 -504
  337. package/skills/perl-testing/SKILL.md +476 -476
  338. package/skills/plan-canvas/SKILL.md +153 -153
  339. package/skills/plan-orchestrate/SKILL.md +263 -263
  340. package/skills/plankton-code-quality/SKILL.md +237 -237
  341. package/skills/postgres-patterns/SKILL.md +148 -148
  342. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  343. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  344. package/skills/premium-web-design/SKILL.md +154 -154
  345. package/skills/prisma-patterns/SKILL.md +401 -401
  346. package/skills/product-capability/SKILL.md +142 -142
  347. package/skills/product-lens/SKILL.md +93 -93
  348. package/skills/production-audit/SKILL.md +207 -207
  349. package/skills/production-scheduling/SKILL.md +238 -238
  350. package/skills/project-flow-ops/SKILL.md +112 -112
  351. package/skills/prompt-optimizer/SKILL.md +398 -398
  352. package/skills/python-patterns/SKILL.md +751 -751
  353. package/skills/python-testing/SKILL.md +817 -817
  354. package/skills/pytorch-patterns/SKILL.md +397 -397
  355. package/skills/quality-nonconformance/SKILL.md +260 -260
  356. package/skills/quarkus-patterns/SKILL.md +723 -723
  357. package/skills/quarkus-security/SKILL.md +468 -468
  358. package/skills/quarkus-tdd/SKILL.md +812 -812
  359. package/skills/quarkus-verification/SKILL.md +480 -480
  360. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  361. package/skills/react-native-patterns/SKILL.md +326 -326
  362. package/skills/react-patterns/SKILL.md +342 -342
  363. package/skills/react-performance/SKILL.md +575 -575
  364. package/skills/react-testing/SKILL.md +424 -424
  365. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  366. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  367. package/skills/redis-patterns/SKILL.md +404 -404
  368. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  369. package/skills/remotion-video-creation/SKILL.md +43 -43
  370. package/skills/repo-scan/SKILL.md +79 -79
  371. package/skills/research-ops/SKILL.md +113 -113
  372. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  373. package/skills/rules-distill/SKILL.md +265 -265
  374. package/skills/rust-patterns/SKILL.md +500 -500
  375. package/skills/rust-testing/SKILL.md +501 -501
  376. package/skills/safety-guard/SKILL.md +76 -76
  377. package/skills/santa-method/SKILL.md +307 -307
  378. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  379. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  380. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  381. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  382. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  383. package/skills/search-first/SKILL.md +183 -183
  384. package/skills/security-bounty-hunter/SKILL.md +100 -100
  385. package/skills/security-review/SKILL.md +504 -504
  386. package/skills/security-scan/SKILL.md +166 -166
  387. package/skills/seo/SKILL.md +155 -155
  388. package/skills/skill-comply/SKILL.md +59 -59
  389. package/skills/skill-scout/SKILL.md +141 -141
  390. package/skills/skill-stocktake/SKILL.md +195 -195
  391. package/skills/social-graph-ranker/SKILL.md +155 -155
  392. package/skills/social-publisher/SKILL.md +130 -130
  393. package/skills/springboot-patterns/SKILL.md +315 -315
  394. package/skills/springboot-security/SKILL.md +273 -273
  395. package/skills/springboot-tdd/SKILL.md +159 -159
  396. package/skills/springboot-verification/SKILL.md +232 -232
  397. package/skills/strategic-compact/SKILL.md +142 -142
  398. package/skills/swift-actor-persistence/SKILL.md +144 -144
  399. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  400. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  401. package/skills/swiftui-patterns/SKILL.md +259 -259
  402. package/skills/taste/SKILL.md +264 -264
  403. package/skills/taste/references/genre-taxonomy.md +87 -87
  404. package/skills/tdd-workflow/SKILL.md +583 -583
  405. package/skills/team-agent-orchestration/SKILL.md +111 -111
  406. package/skills/team-builder/SKILL.md +169 -169
  407. package/skills/terminal-ops/SKILL.md +110 -110
  408. package/skills/tinystruct-patterns/SKILL.md +279 -279
  409. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  410. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  411. package/skills/tinystruct-patterns/references/database.md +99 -99
  412. package/skills/tinystruct-patterns/references/routing.md +64 -64
  413. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  414. package/skills/tinystruct-patterns/references/testing.md +72 -72
  415. package/skills/token-budget-advisor/SKILL.md +134 -134
  416. package/skills/ui-demo/SKILL.md +466 -466
  417. package/skills/ui-to-vue/SKILL.md +135 -135
  418. package/skills/uncloud/SKILL.md +344 -344
  419. package/skills/unified-memory/SKILL.md +170 -170
  420. package/skills/unified-notifications-ops/SKILL.md +188 -188
  421. package/skills/verification-loop/SKILL.md +129 -129
  422. package/skills/video-editing/SKILL.md +311 -311
  423. package/skills/videodb/SKILL.md +375 -375
  424. package/skills/visa-doc-translate/SKILL.md +117 -117
  425. package/skills/vite-patterns/SKILL.md +450 -450
  426. package/skills/vue-patterns/SKILL.md +471 -471
  427. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  428. package/skills/workspace-surface-audit/SKILL.md +126 -126
  429. package/skills/x-api/SKILL.md +235 -235
@@ -1,676 +1,676 @@
1
- ---
2
- name: golang-patterns
3
- description: Idiomatic Go patterns, best practices, and conventions for building robust, efficient, and maintainable Go applications.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Go Development Patterns
9
-
10
- Idiomatic Go patterns and best practices for building robust, efficient, and maintainable applications.
11
-
12
- ## When to Activate
13
-
14
- - Writing new Go code
15
- - Reviewing Go code
16
- - Refactoring existing Go code
17
- - Designing Go packages/modules
18
-
19
- ## Core Principles
20
-
21
- ### 1. Simplicity and Clarity
22
-
23
- Go favors simplicity over cleverness. Code should be obvious and easy to read.
24
-
25
- ```go
26
- // Good: Clear and direct
27
- func GetUser(id string) (*User, error) {
28
- user, err := db.FindUser(id)
29
- if err != nil {
30
- return nil, fmt.Errorf("get user %s: %w", id, err)
31
- }
32
- return user, nil
33
- }
34
-
35
- // Bad: Overly clever
36
- func GetUser(id string) (*User, error) {
37
- return func() (*User, error) {
38
- if u, e := db.FindUser(id); e == nil {
39
- return u, nil
40
- } else {
41
- return nil, e
42
- }
43
- }()
44
- }
45
- ```
46
-
47
- ### 2. Make the Zero Value Useful
48
-
49
- Design types so their zero value is immediately usable without initialization.
50
-
51
- ```go
52
- // Good: Zero value is useful
53
- type Counter struct {
54
- mu sync.Mutex
55
- count int // zero value is 0, ready to use
56
- }
57
-
58
- func (c *Counter) Inc() {
59
- c.mu.Lock()
60
- c.count++
61
- c.mu.Unlock()
62
- }
63
-
64
- // Good: bytes.Buffer works with zero value
65
- var buf bytes.Buffer
66
- buf.WriteString("hello")
67
-
68
- // Bad: Requires initialization
69
- type BadCounter struct {
70
- counts map[string]int // nil map will panic
71
- }
72
- ```
73
-
74
- ### 3. Accept Interfaces, Return Structs
75
-
76
- Functions should accept interface parameters and return concrete types.
77
-
78
- ```go
79
- // Good: Accepts interface, returns concrete type
80
- func ProcessData(r io.Reader) (*Result, error) {
81
- data, err := io.ReadAll(r)
82
- if err != nil {
83
- return nil, err
84
- }
85
- return &Result{Data: data}, nil
86
- }
87
-
88
- // Bad: Returns interface (hides implementation details unnecessarily)
89
- func ProcessData(r io.Reader) (io.Reader, error) {
90
- // ...
91
- }
92
- ```
93
-
94
- ## Error Handling Patterns
95
-
96
- ### Error Wrapping with Context
97
-
98
- ```go
99
- // Good: Wrap errors with context
100
- func LoadConfig(path string) (*Config, error) {
101
- data, err := os.ReadFile(path)
102
- if err != nil {
103
- return nil, fmt.Errorf("load config %s: %w", path, err)
104
- }
105
-
106
- var cfg Config
107
- if err := json.Unmarshal(data, &cfg); err != nil {
108
- return nil, fmt.Errorf("parse config %s: %w", path, err)
109
- }
110
-
111
- return &cfg, nil
112
- }
113
- ```
114
-
115
- ### Custom Error Types
116
-
117
- ```go
118
- // Define domain-specific errors
119
- type ValidationError struct {
120
- Field string
121
- Message string
122
- }
123
-
124
- func (e *ValidationError) Error() string {
125
- return fmt.Sprintf("validation failed on %s: %s", e.Field, e.Message)
126
- }
127
-
128
- // Sentinel errors for common cases
129
- var (
130
- ErrNotFound = errors.New("resource not found")
131
- ErrUnauthorized = errors.New("unauthorized")
132
- ErrInvalidInput = errors.New("invalid input")
133
- )
134
- ```
135
-
136
- ### Error Checking with errors.Is and errors.As
137
-
138
- ```go
139
- func HandleError(err error) {
140
- // Check for specific error
141
- if errors.Is(err, sql.ErrNoRows) {
142
- log.Println("No records found")
143
- return
144
- }
145
-
146
- // Check for error type
147
- var validationErr *ValidationError
148
- if errors.As(err, &validationErr) {
149
- log.Printf("Validation error on field %s: %s",
150
- validationErr.Field, validationErr.Message)
151
- return
152
- }
153
-
154
- // Unknown error
155
- log.Printf("Unexpected error: %v", err)
156
- }
157
- ```
158
-
159
- ### Never Ignore Errors
160
-
161
- ```go
162
- // Bad: Ignoring error with blank identifier
163
- result, _ := doSomething()
164
-
165
- // Good: Handle or explicitly document why it's safe to ignore
166
- result, err := doSomething()
167
- if err != nil {
168
- return err
169
- }
170
-
171
- // Acceptable: When error truly doesn't matter (rare)
172
- _ = writer.Close() // Best-effort cleanup, error logged elsewhere
173
- ```
174
-
175
- ## Concurrency Patterns
176
-
177
- ### Worker Pool
178
-
179
- ```go
180
- func WorkerPool(jobs <-chan Job, results chan<- Result, numWorkers int) {
181
- var wg sync.WaitGroup
182
-
183
- for i := 0; i < numWorkers; i++ {
184
- wg.Add(1)
185
- go func() {
186
- defer wg.Done()
187
- for job := range jobs {
188
- results <- process(job)
189
- }
190
- }()
191
- }
192
-
193
- wg.Wait()
194
- close(results)
195
- }
196
- ```
197
-
198
- ### Context for Cancellation and Timeouts
199
-
200
- ```go
201
- func FetchWithTimeout(ctx context.Context, url string) ([]byte, error) {
202
- ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
203
- defer cancel()
204
-
205
- req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
206
- if err != nil {
207
- return nil, fmt.Errorf("create request: %w", err)
208
- }
209
-
210
- resp, err := http.DefaultClient.Do(req)
211
- if err != nil {
212
- return nil, fmt.Errorf("fetch %s: %w", url, err)
213
- }
214
- defer resp.Body.Close()
215
-
216
- return io.ReadAll(resp.Body)
217
- }
218
- ```
219
-
220
- ### Graceful Shutdown
221
-
222
- ```go
223
- func GracefulShutdown(server *http.Server) {
224
- quit := make(chan os.Signal, 1)
225
- signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
226
-
227
- <-quit
228
- log.Println("Shutting down server...")
229
-
230
- ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
231
- defer cancel()
232
-
233
- if err := server.Shutdown(ctx); err != nil {
234
- log.Fatalf("Server forced to shutdown: %v", err)
235
- }
236
-
237
- log.Println("Server exited")
238
- }
239
- ```
240
-
241
- ### errgroup for Coordinated Goroutines
242
-
243
- ```go
244
- import "golang.org/x/sync/errgroup"
245
-
246
- func FetchAll(ctx context.Context, urls []string) ([][]byte, error) {
247
- g, ctx := errgroup.WithContext(ctx)
248
- results := make([][]byte, len(urls))
249
-
250
- for i, url := range urls {
251
- i, url := i, url // Capture loop variables
252
- g.Go(func() error {
253
- data, err := FetchWithTimeout(ctx, url)
254
- if err != nil {
255
- return err
256
- }
257
- results[i] = data
258
- return nil
259
- })
260
- }
261
-
262
- if err := g.Wait(); err != nil {
263
- return nil, err
264
- }
265
- return results, nil
266
- }
267
- ```
268
-
269
- ### Avoiding Goroutine Leaks
270
-
271
- ```go
272
- // Bad: Goroutine leak if context is cancelled
273
- func leakyFetch(ctx context.Context, url string) <-chan []byte {
274
- ch := make(chan []byte)
275
- go func() {
276
- data, _ := fetch(url)
277
- ch <- data // Blocks forever if no receiver
278
- }()
279
- return ch
280
- }
281
-
282
- // Good: Properly handles cancellation
283
- func safeFetch(ctx context.Context, url string) <-chan []byte {
284
- ch := make(chan []byte, 1) // Buffered channel
285
- go func() {
286
- data, err := fetch(url)
287
- if err != nil {
288
- return
289
- }
290
- select {
291
- case ch <- data:
292
- case <-ctx.Done():
293
- }
294
- }()
295
- return ch
296
- }
297
- ```
298
-
299
- ## Interface Design
300
-
301
- ### Small, Focused Interfaces
302
-
303
- ```go
304
- // Good: Single-method interfaces
305
- type Reader interface {
306
- Read(p []byte) (n int, err error)
307
- }
308
-
309
- type Writer interface {
310
- Write(p []byte) (n int, err error)
311
- }
312
-
313
- type Closer interface {
314
- Close() error
315
- }
316
-
317
- // Compose interfaces as needed
318
- type ReadWriteCloser interface {
319
- Reader
320
- Writer
321
- Closer
322
- }
323
- ```
324
-
325
- ### Define Interfaces Where They're Used
326
-
327
- ```go
328
- // In the consumer package, not the provider
329
- package service
330
-
331
- // UserStore defines what this service needs
332
- type UserStore interface {
333
- GetUser(id string) (*User, error)
334
- SaveUser(user *User) error
335
- }
336
-
337
- type Service struct {
338
- store UserStore
339
- }
340
-
341
- // Concrete implementation can be in another package
342
- // It doesn't need to know about this interface
343
- ```
344
-
345
- ### Optional Behavior with Type Assertions
346
-
347
- ```go
348
- type Flusher interface {
349
- Flush() error
350
- }
351
-
352
- func WriteAndFlush(w io.Writer, data []byte) error {
353
- if _, err := w.Write(data); err != nil {
354
- return err
355
- }
356
-
357
- // Flush if supported
358
- if f, ok := w.(Flusher); ok {
359
- return f.Flush()
360
- }
361
- return nil
362
- }
363
- ```
364
-
365
- ## Package Organization
366
-
367
- ### Standard Project Layout
368
-
369
- ```text
370
- myproject/
371
- ├── cmd/
372
- │ └── myapp/
373
- │ └── main.go # Entry point
374
- ├── internal/
375
- │ ├── handler/ # HTTP handlers
376
- │ ├── service/ # Business logic
377
- │ ├── repository/ # Data access
378
- │ └── config/ # Configuration
379
- ├── pkg/
380
- │ └── client/ # Public API client
381
- ├── api/
382
- │ └── v1/ # API definitions (proto, OpenAPI)
383
- ├── testdata/ # Test fixtures
384
- ├── go.mod
385
- ├── go.sum
386
- └── Makefile
387
- ```
388
-
389
- ### Package Naming
390
-
391
- ```go
392
- // Good: Short, lowercase, no underscores
393
- package http
394
- package json
395
- package user
396
-
397
- // Bad: Verbose, mixed case, or redundant
398
- package httpHandler
399
- package json_parser
400
- package userService // Redundant 'Service' suffix
401
- ```
402
-
403
- ### Avoid Package-Level State
404
-
405
- ```go
406
- // Bad: Global mutable state
407
- var db *sql.DB
408
-
409
- func init() {
410
- db, _ = sql.Open("postgres", os.Getenv("DATABASE_URL"))
411
- }
412
-
413
- // Good: Dependency injection
414
- type Server struct {
415
- db *sql.DB
416
- }
417
-
418
- func NewServer(db *sql.DB) *Server {
419
- return &Server{db: db}
420
- }
421
- ```
422
-
423
- ## Struct Design
424
-
425
- ### Functional Options Pattern
426
-
427
- ```go
428
- type Server struct {
429
- addr string
430
- timeout time.Duration
431
- logger *log.Logger
432
- }
433
-
434
- type Option func(*Server)
435
-
436
- func WithTimeout(d time.Duration) Option {
437
- return func(s *Server) {
438
- s.timeout = d
439
- }
440
- }
441
-
442
- func WithLogger(l *log.Logger) Option {
443
- return func(s *Server) {
444
- s.logger = l
445
- }
446
- }
447
-
448
- func NewServer(addr string, opts ...Option) *Server {
449
- s := &Server{
450
- addr: addr,
451
- timeout: 30 * time.Second, // default
452
- logger: log.Default(), // default
453
- }
454
- for _, opt := range opts {
455
- opt(s)
456
- }
457
- return s
458
- }
459
-
460
- // Usage
461
- server := NewServer(":8080",
462
- WithTimeout(60*time.Second),
463
- WithLogger(customLogger),
464
- )
465
- ```
466
-
467
- ### Embedding for Composition
468
-
469
- ```go
470
- type Logger struct {
471
- prefix string
472
- }
473
-
474
- func (l *Logger) Log(msg string) {
475
- fmt.Printf("[%s] %s\n", l.prefix, msg)
476
- }
477
-
478
- type Server struct {
479
- *Logger // Embedding - Server gets Log method
480
- addr string
481
- }
482
-
483
- func NewServer(addr string) *Server {
484
- return &Server{
485
- Logger: &Logger{prefix: "SERVER"},
486
- addr: addr,
487
- }
488
- }
489
-
490
- // Usage
491
- s := NewServer(":8080")
492
- s.Log("Starting...") // Calls embedded Logger.Log
493
- ```
494
-
495
- ## Memory and Performance
496
-
497
- ### Preallocate Slices When Size is Known
498
-
499
- ```go
500
- // Bad: Grows slice multiple times
501
- func processItems(items []Item) []Result {
502
- var results []Result
503
- for _, item := range items {
504
- results = append(results, process(item))
505
- }
506
- return results
507
- }
508
-
509
- // Good: Single allocation
510
- func processItems(items []Item) []Result {
511
- results := make([]Result, 0, len(items))
512
- for _, item := range items {
513
- results = append(results, process(item))
514
- }
515
- return results
516
- }
517
- ```
518
-
519
- ### Use sync.Pool for Frequent Allocations
520
-
521
- ```go
522
- var bufferPool = sync.Pool{
523
- New: func() interface{} {
524
- return new(bytes.Buffer)
525
- },
526
- }
527
-
528
- func ProcessRequest(data []byte) []byte {
529
- buf := bufferPool.Get().(*bytes.Buffer)
530
- defer func() {
531
- buf.Reset()
532
- bufferPool.Put(buf)
533
- }()
534
-
535
- buf.Write(data)
536
- // Process...
537
- return buf.Bytes()
538
- }
539
- ```
540
-
541
- ### Avoid String Concatenation in Loops
542
-
543
- ```go
544
- // Bad: Creates many string allocations
545
- func join(parts []string) string {
546
- var result string
547
- for _, p := range parts {
548
- result += p + ","
549
- }
550
- return result
551
- }
552
-
553
- // Good: Single allocation with strings.Builder
554
- func join(parts []string) string {
555
- var sb strings.Builder
556
- for i, p := range parts {
557
- if i > 0 {
558
- sb.WriteString(",")
559
- }
560
- sb.WriteString(p)
561
- }
562
- return sb.String()
563
- }
564
-
565
- // Best: Use standard library
566
- func join(parts []string) string {
567
- return strings.Join(parts, ",")
568
- }
569
- ```
570
-
571
- ## Go Tooling Integration
572
-
573
- ### Essential Commands
574
-
575
- ```bash
576
- # Build and run
577
- go build ./...
578
- go run ./cmd/myapp
579
-
580
- # Testing
581
- go test ./...
582
- go test -race ./...
583
- go test -cover ./...
584
-
585
- # Static analysis
586
- go vet ./...
587
- staticcheck ./...
588
- golangci-lint run
589
-
590
- # Module management
591
- go mod tidy
592
- go mod verify
593
-
594
- # Formatting
595
- gofmt -w .
596
- goimports -w .
597
- ```
598
-
599
- ### Recommended Linter Configuration (.golangci.yml)
600
-
601
- ```yaml
602
- linters:
603
- enable:
604
- - errcheck
605
- - gosimple
606
- - govet
607
- - ineffassign
608
- - staticcheck
609
- - unused
610
- - gofmt
611
- - goimports
612
- - misspell
613
- - unconvert
614
- - unparam
615
-
616
- linters-settings:
617
- errcheck:
618
- check-type-assertions: true
619
- govet:
620
- enable:
621
- - shadow
622
-
623
- issues:
624
- exclude-use-default: false
625
- ```
626
-
627
- ## Quick Reference: Go Idioms
628
-
629
- | Idiom | Description |
630
- |-------|-------------|
631
- | Accept interfaces, return structs | Functions accept interface params, return concrete types |
632
- | Errors are values | Treat errors as first-class values, not exceptions |
633
- | Don't communicate by sharing memory | Use channels for coordination between goroutines |
634
- | Make the zero value useful | Types should work without explicit initialization |
635
- | A little copying is better than a little dependency | Avoid unnecessary external dependencies |
636
- | Clear is better than clever | Prioritize readability over cleverness |
637
- | gofmt is no one's favorite but everyone's friend | Always format with gofmt/goimports |
638
- | Return early | Handle errors first, keep happy path unindented |
639
-
640
- ## Anti-Patterns to Avoid
641
-
642
- ```go
643
- // Bad: Naked returns in long functions
644
- func process() (result int, err error) {
645
- // ... 50 lines ...
646
- return // What is being returned?
647
- }
648
-
649
- // Bad: Using panic for control flow
650
- func GetUser(id string) *User {
651
- user, err := db.Find(id)
652
- if err != nil {
653
- panic(err) // Don't do this
654
- }
655
- return user
656
- }
657
-
658
- // Bad: Passing context in struct
659
- type Request struct {
660
- ctx context.Context // Context should be first param
661
- ID string
662
- }
663
-
664
- // Good: Context as first parameter
665
- func ProcessRequest(ctx context.Context, id string) error {
666
- // ...
667
- }
668
-
669
- // Bad: Mixing value and pointer receivers
670
- type Counter struct{ n int }
671
- func (c Counter) Value() int { return c.n } // Value receiver
672
- func (c *Counter) Increment() { c.n++ } // Pointer receiver
673
- // Pick one style and be consistent
674
- ```
675
-
676
- **Remember**: Go code should be boring in the best way - predictable, consistent, and easy to understand. When in doubt, keep it simple.
1
+ ---
2
+ name: golang-patterns
3
+ description: Idiomatic Go patterns, best practices, and conventions for building robust, efficient, and maintainable Go applications.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Go Development Patterns
9
+
10
+ Idiomatic Go patterns and best practices for building robust, efficient, and maintainable applications.
11
+
12
+ ## When to Activate
13
+
14
+ - Writing new Go code
15
+ - Reviewing Go code
16
+ - Refactoring existing Go code
17
+ - Designing Go packages/modules
18
+
19
+ ## Core Principles
20
+
21
+ ### 1. Simplicity and Clarity
22
+
23
+ Go favors simplicity over cleverness. Code should be obvious and easy to read.
24
+
25
+ ```go
26
+ // Good: Clear and direct
27
+ func GetUser(id string) (*User, error) {
28
+ user, err := db.FindUser(id)
29
+ if err != nil {
30
+ return nil, fmt.Errorf("get user %s: %w", id, err)
31
+ }
32
+ return user, nil
33
+ }
34
+
35
+ // Bad: Overly clever
36
+ func GetUser(id string) (*User, error) {
37
+ return func() (*User, error) {
38
+ if u, e := db.FindUser(id); e == nil {
39
+ return u, nil
40
+ } else {
41
+ return nil, e
42
+ }
43
+ }()
44
+ }
45
+ ```
46
+
47
+ ### 2. Make the Zero Value Useful
48
+
49
+ Design types so their zero value is immediately usable without initialization.
50
+
51
+ ```go
52
+ // Good: Zero value is useful
53
+ type Counter struct {
54
+ mu sync.Mutex
55
+ count int // zero value is 0, ready to use
56
+ }
57
+
58
+ func (c *Counter) Inc() {
59
+ c.mu.Lock()
60
+ c.count++
61
+ c.mu.Unlock()
62
+ }
63
+
64
+ // Good: bytes.Buffer works with zero value
65
+ var buf bytes.Buffer
66
+ buf.WriteString("hello")
67
+
68
+ // Bad: Requires initialization
69
+ type BadCounter struct {
70
+ counts map[string]int // nil map will panic
71
+ }
72
+ ```
73
+
74
+ ### 3. Accept Interfaces, Return Structs
75
+
76
+ Functions should accept interface parameters and return concrete types.
77
+
78
+ ```go
79
+ // Good: Accepts interface, returns concrete type
80
+ func ProcessData(r io.Reader) (*Result, error) {
81
+ data, err := io.ReadAll(r)
82
+ if err != nil {
83
+ return nil, err
84
+ }
85
+ return &Result{Data: data}, nil
86
+ }
87
+
88
+ // Bad: Returns interface (hides implementation details unnecessarily)
89
+ func ProcessData(r io.Reader) (io.Reader, error) {
90
+ // ...
91
+ }
92
+ ```
93
+
94
+ ## Error Handling Patterns
95
+
96
+ ### Error Wrapping with Context
97
+
98
+ ```go
99
+ // Good: Wrap errors with context
100
+ func LoadConfig(path string) (*Config, error) {
101
+ data, err := os.ReadFile(path)
102
+ if err != nil {
103
+ return nil, fmt.Errorf("load config %s: %w", path, err)
104
+ }
105
+
106
+ var cfg Config
107
+ if err := json.Unmarshal(data, &cfg); err != nil {
108
+ return nil, fmt.Errorf("parse config %s: %w", path, err)
109
+ }
110
+
111
+ return &cfg, nil
112
+ }
113
+ ```
114
+
115
+ ### Custom Error Types
116
+
117
+ ```go
118
+ // Define domain-specific errors
119
+ type ValidationError struct {
120
+ Field string
121
+ Message string
122
+ }
123
+
124
+ func (e *ValidationError) Error() string {
125
+ return fmt.Sprintf("validation failed on %s: %s", e.Field, e.Message)
126
+ }
127
+
128
+ // Sentinel errors for common cases
129
+ var (
130
+ ErrNotFound = errors.New("resource not found")
131
+ ErrUnauthorized = errors.New("unauthorized")
132
+ ErrInvalidInput = errors.New("invalid input")
133
+ )
134
+ ```
135
+
136
+ ### Error Checking with errors.Is and errors.As
137
+
138
+ ```go
139
+ func HandleError(err error) {
140
+ // Check for specific error
141
+ if errors.Is(err, sql.ErrNoRows) {
142
+ log.Println("No records found")
143
+ return
144
+ }
145
+
146
+ // Check for error type
147
+ var validationErr *ValidationError
148
+ if errors.As(err, &validationErr) {
149
+ log.Printf("Validation error on field %s: %s",
150
+ validationErr.Field, validationErr.Message)
151
+ return
152
+ }
153
+
154
+ // Unknown error
155
+ log.Printf("Unexpected error: %v", err)
156
+ }
157
+ ```
158
+
159
+ ### Never Ignore Errors
160
+
161
+ ```go
162
+ // Bad: Ignoring error with blank identifier
163
+ result, _ := doSomething()
164
+
165
+ // Good: Handle or explicitly document why it's safe to ignore
166
+ result, err := doSomething()
167
+ if err != nil {
168
+ return err
169
+ }
170
+
171
+ // Acceptable: When error truly doesn't matter (rare)
172
+ _ = writer.Close() // Best-effort cleanup, error logged elsewhere
173
+ ```
174
+
175
+ ## Concurrency Patterns
176
+
177
+ ### Worker Pool
178
+
179
+ ```go
180
+ func WorkerPool(jobs <-chan Job, results chan<- Result, numWorkers int) {
181
+ var wg sync.WaitGroup
182
+
183
+ for i := 0; i < numWorkers; i++ {
184
+ wg.Add(1)
185
+ go func() {
186
+ defer wg.Done()
187
+ for job := range jobs {
188
+ results <- process(job)
189
+ }
190
+ }()
191
+ }
192
+
193
+ wg.Wait()
194
+ close(results)
195
+ }
196
+ ```
197
+
198
+ ### Context for Cancellation and Timeouts
199
+
200
+ ```go
201
+ func FetchWithTimeout(ctx context.Context, url string) ([]byte, error) {
202
+ ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
203
+ defer cancel()
204
+
205
+ req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
206
+ if err != nil {
207
+ return nil, fmt.Errorf("create request: %w", err)
208
+ }
209
+
210
+ resp, err := http.DefaultClient.Do(req)
211
+ if err != nil {
212
+ return nil, fmt.Errorf("fetch %s: %w", url, err)
213
+ }
214
+ defer resp.Body.Close()
215
+
216
+ return io.ReadAll(resp.Body)
217
+ }
218
+ ```
219
+
220
+ ### Graceful Shutdown
221
+
222
+ ```go
223
+ func GracefulShutdown(server *http.Server) {
224
+ quit := make(chan os.Signal, 1)
225
+ signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
226
+
227
+ <-quit
228
+ log.Println("Shutting down server...")
229
+
230
+ ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
231
+ defer cancel()
232
+
233
+ if err := server.Shutdown(ctx); err != nil {
234
+ log.Fatalf("Server forced to shutdown: %v", err)
235
+ }
236
+
237
+ log.Println("Server exited")
238
+ }
239
+ ```
240
+
241
+ ### errgroup for Coordinated Goroutines
242
+
243
+ ```go
244
+ import "golang.org/x/sync/errgroup"
245
+
246
+ func FetchAll(ctx context.Context, urls []string) ([][]byte, error) {
247
+ g, ctx := errgroup.WithContext(ctx)
248
+ results := make([][]byte, len(urls))
249
+
250
+ for i, url := range urls {
251
+ i, url := i, url // Capture loop variables
252
+ g.Go(func() error {
253
+ data, err := FetchWithTimeout(ctx, url)
254
+ if err != nil {
255
+ return err
256
+ }
257
+ results[i] = data
258
+ return nil
259
+ })
260
+ }
261
+
262
+ if err := g.Wait(); err != nil {
263
+ return nil, err
264
+ }
265
+ return results, nil
266
+ }
267
+ ```
268
+
269
+ ### Avoiding Goroutine Leaks
270
+
271
+ ```go
272
+ // Bad: Goroutine leak if context is cancelled
273
+ func leakyFetch(ctx context.Context, url string) <-chan []byte {
274
+ ch := make(chan []byte)
275
+ go func() {
276
+ data, _ := fetch(url)
277
+ ch <- data // Blocks forever if no receiver
278
+ }()
279
+ return ch
280
+ }
281
+
282
+ // Good: Properly handles cancellation
283
+ func safeFetch(ctx context.Context, url string) <-chan []byte {
284
+ ch := make(chan []byte, 1) // Buffered channel
285
+ go func() {
286
+ data, err := fetch(url)
287
+ if err != nil {
288
+ return
289
+ }
290
+ select {
291
+ case ch <- data:
292
+ case <-ctx.Done():
293
+ }
294
+ }()
295
+ return ch
296
+ }
297
+ ```
298
+
299
+ ## Interface Design
300
+
301
+ ### Small, Focused Interfaces
302
+
303
+ ```go
304
+ // Good: Single-method interfaces
305
+ type Reader interface {
306
+ Read(p []byte) (n int, err error)
307
+ }
308
+
309
+ type Writer interface {
310
+ Write(p []byte) (n int, err error)
311
+ }
312
+
313
+ type Closer interface {
314
+ Close() error
315
+ }
316
+
317
+ // Compose interfaces as needed
318
+ type ReadWriteCloser interface {
319
+ Reader
320
+ Writer
321
+ Closer
322
+ }
323
+ ```
324
+
325
+ ### Define Interfaces Where They're Used
326
+
327
+ ```go
328
+ // In the consumer package, not the provider
329
+ package service
330
+
331
+ // UserStore defines what this service needs
332
+ type UserStore interface {
333
+ GetUser(id string) (*User, error)
334
+ SaveUser(user *User) error
335
+ }
336
+
337
+ type Service struct {
338
+ store UserStore
339
+ }
340
+
341
+ // Concrete implementation can be in another package
342
+ // It doesn't need to know about this interface
343
+ ```
344
+
345
+ ### Optional Behavior with Type Assertions
346
+
347
+ ```go
348
+ type Flusher interface {
349
+ Flush() error
350
+ }
351
+
352
+ func WriteAndFlush(w io.Writer, data []byte) error {
353
+ if _, err := w.Write(data); err != nil {
354
+ return err
355
+ }
356
+
357
+ // Flush if supported
358
+ if f, ok := w.(Flusher); ok {
359
+ return f.Flush()
360
+ }
361
+ return nil
362
+ }
363
+ ```
364
+
365
+ ## Package Organization
366
+
367
+ ### Standard Project Layout
368
+
369
+ ```text
370
+ myproject/
371
+ ├── cmd/
372
+ │ └── myapp/
373
+ │ └── main.go # Entry point
374
+ ├── internal/
375
+ │ ├── handler/ # HTTP handlers
376
+ │ ├── service/ # Business logic
377
+ │ ├── repository/ # Data access
378
+ │ └── config/ # Configuration
379
+ ├── pkg/
380
+ │ └── client/ # Public API client
381
+ ├── api/
382
+ │ └── v1/ # API definitions (proto, OpenAPI)
383
+ ├── testdata/ # Test fixtures
384
+ ├── go.mod
385
+ ├── go.sum
386
+ └── Makefile
387
+ ```
388
+
389
+ ### Package Naming
390
+
391
+ ```go
392
+ // Good: Short, lowercase, no underscores
393
+ package http
394
+ package json
395
+ package user
396
+
397
+ // Bad: Verbose, mixed case, or redundant
398
+ package httpHandler
399
+ package json_parser
400
+ package userService // Redundant 'Service' suffix
401
+ ```
402
+
403
+ ### Avoid Package-Level State
404
+
405
+ ```go
406
+ // Bad: Global mutable state
407
+ var db *sql.DB
408
+
409
+ func init() {
410
+ db, _ = sql.Open("postgres", os.Getenv("DATABASE_URL"))
411
+ }
412
+
413
+ // Good: Dependency injection
414
+ type Server struct {
415
+ db *sql.DB
416
+ }
417
+
418
+ func NewServer(db *sql.DB) *Server {
419
+ return &Server{db: db}
420
+ }
421
+ ```
422
+
423
+ ## Struct Design
424
+
425
+ ### Functional Options Pattern
426
+
427
+ ```go
428
+ type Server struct {
429
+ addr string
430
+ timeout time.Duration
431
+ logger *log.Logger
432
+ }
433
+
434
+ type Option func(*Server)
435
+
436
+ func WithTimeout(d time.Duration) Option {
437
+ return func(s *Server) {
438
+ s.timeout = d
439
+ }
440
+ }
441
+
442
+ func WithLogger(l *log.Logger) Option {
443
+ return func(s *Server) {
444
+ s.logger = l
445
+ }
446
+ }
447
+
448
+ func NewServer(addr string, opts ...Option) *Server {
449
+ s := &Server{
450
+ addr: addr,
451
+ timeout: 30 * time.Second, // default
452
+ logger: log.Default(), // default
453
+ }
454
+ for _, opt := range opts {
455
+ opt(s)
456
+ }
457
+ return s
458
+ }
459
+
460
+ // Usage
461
+ server := NewServer(":8080",
462
+ WithTimeout(60*time.Second),
463
+ WithLogger(customLogger),
464
+ )
465
+ ```
466
+
467
+ ### Embedding for Composition
468
+
469
+ ```go
470
+ type Logger struct {
471
+ prefix string
472
+ }
473
+
474
+ func (l *Logger) Log(msg string) {
475
+ fmt.Printf("[%s] %s\n", l.prefix, msg)
476
+ }
477
+
478
+ type Server struct {
479
+ *Logger // Embedding - Server gets Log method
480
+ addr string
481
+ }
482
+
483
+ func NewServer(addr string) *Server {
484
+ return &Server{
485
+ Logger: &Logger{prefix: "SERVER"},
486
+ addr: addr,
487
+ }
488
+ }
489
+
490
+ // Usage
491
+ s := NewServer(":8080")
492
+ s.Log("Starting...") // Calls embedded Logger.Log
493
+ ```
494
+
495
+ ## Memory and Performance
496
+
497
+ ### Preallocate Slices When Size is Known
498
+
499
+ ```go
500
+ // Bad: Grows slice multiple times
501
+ func processItems(items []Item) []Result {
502
+ var results []Result
503
+ for _, item := range items {
504
+ results = append(results, process(item))
505
+ }
506
+ return results
507
+ }
508
+
509
+ // Good: Single allocation
510
+ func processItems(items []Item) []Result {
511
+ results := make([]Result, 0, len(items))
512
+ for _, item := range items {
513
+ results = append(results, process(item))
514
+ }
515
+ return results
516
+ }
517
+ ```
518
+
519
+ ### Use sync.Pool for Frequent Allocations
520
+
521
+ ```go
522
+ var bufferPool = sync.Pool{
523
+ New: func() interface{} {
524
+ return new(bytes.Buffer)
525
+ },
526
+ }
527
+
528
+ func ProcessRequest(data []byte) []byte {
529
+ buf := bufferPool.Get().(*bytes.Buffer)
530
+ defer func() {
531
+ buf.Reset()
532
+ bufferPool.Put(buf)
533
+ }()
534
+
535
+ buf.Write(data)
536
+ // Process...
537
+ return buf.Bytes()
538
+ }
539
+ ```
540
+
541
+ ### Avoid String Concatenation in Loops
542
+
543
+ ```go
544
+ // Bad: Creates many string allocations
545
+ func join(parts []string) string {
546
+ var result string
547
+ for _, p := range parts {
548
+ result += p + ","
549
+ }
550
+ return result
551
+ }
552
+
553
+ // Good: Single allocation with strings.Builder
554
+ func join(parts []string) string {
555
+ var sb strings.Builder
556
+ for i, p := range parts {
557
+ if i > 0 {
558
+ sb.WriteString(",")
559
+ }
560
+ sb.WriteString(p)
561
+ }
562
+ return sb.String()
563
+ }
564
+
565
+ // Best: Use standard library
566
+ func join(parts []string) string {
567
+ return strings.Join(parts, ",")
568
+ }
569
+ ```
570
+
571
+ ## Go Tooling Integration
572
+
573
+ ### Essential Commands
574
+
575
+ ```bash
576
+ # Build and run
577
+ go build ./...
578
+ go run ./cmd/myapp
579
+
580
+ # Testing
581
+ go test ./...
582
+ go test -race ./...
583
+ go test -cover ./...
584
+
585
+ # Static analysis
586
+ go vet ./...
587
+ staticcheck ./...
588
+ golangci-lint run
589
+
590
+ # Module management
591
+ go mod tidy
592
+ go mod verify
593
+
594
+ # Formatting
595
+ gofmt -w .
596
+ goimports -w .
597
+ ```
598
+
599
+ ### Recommended Linter Configuration (.golangci.yml)
600
+
601
+ ```yaml
602
+ linters:
603
+ enable:
604
+ - errcheck
605
+ - gosimple
606
+ - govet
607
+ - ineffassign
608
+ - staticcheck
609
+ - unused
610
+ - gofmt
611
+ - goimports
612
+ - misspell
613
+ - unconvert
614
+ - unparam
615
+
616
+ linters-settings:
617
+ errcheck:
618
+ check-type-assertions: true
619
+ govet:
620
+ enable:
621
+ - shadow
622
+
623
+ issues:
624
+ exclude-use-default: false
625
+ ```
626
+
627
+ ## Quick Reference: Go Idioms
628
+
629
+ | Idiom | Description |
630
+ |-------|-------------|
631
+ | Accept interfaces, return structs | Functions accept interface params, return concrete types |
632
+ | Errors are values | Treat errors as first-class values, not exceptions |
633
+ | Don't communicate by sharing memory | Use channels for coordination between goroutines |
634
+ | Make the zero value useful | Types should work without explicit initialization |
635
+ | A little copying is better than a little dependency | Avoid unnecessary external dependencies |
636
+ | Clear is better than clever | Prioritize readability over cleverness |
637
+ | gofmt is no one's favorite but everyone's friend | Always format with gofmt/goimports |
638
+ | Return early | Handle errors first, keep happy path unindented |
639
+
640
+ ## Anti-Patterns to Avoid
641
+
642
+ ```go
643
+ // Bad: Naked returns in long functions
644
+ func process() (result int, err error) {
645
+ // ... 50 lines ...
646
+ return // What is being returned?
647
+ }
648
+
649
+ // Bad: Using panic for control flow
650
+ func GetUser(id string) *User {
651
+ user, err := db.Find(id)
652
+ if err != nil {
653
+ panic(err) // Don't do this
654
+ }
655
+ return user
656
+ }
657
+
658
+ // Bad: Passing context in struct
659
+ type Request struct {
660
+ ctx context.Context // Context should be first param
661
+ ID string
662
+ }
663
+
664
+ // Good: Context as first parameter
665
+ func ProcessRequest(ctx context.Context, id string) error {
666
+ // ...
667
+ }
668
+
669
+ // Bad: Mixing value and pointer receivers
670
+ type Counter struct{ n int }
671
+ func (c Counter) Value() int { return c.n } // Value receiver
672
+ func (c *Counter) Increment() { c.n++ } // Pointer receiver
673
+ // Pick one style and be consistent
674
+ ```
675
+
676
+ **Remember**: Go code should be boring in the best way - predictable, consistent, and easy to understand. When in doubt, keep it simple.