@funnycode/myclaude 0.1.67 → 0.1.68

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 (497) hide show
  1. package/LICENSE +21 -21
  2. package/dist/myclaude.js +15090 -12419
  3. package/dist/myclaude.mjs +15090 -12419
  4. package/package.json +125 -125
  5. package/seed/marketplaces/ecc/.claude/commands/add-language-rules.md +39 -0
  6. package/seed/marketplaces/ecc/.claude/commands/database-migration.md +36 -0
  7. package/seed/marketplaces/ecc/.claude/commands/feature-development.md +38 -0
  8. package/seed/marketplaces/ecc/.claude/ecc-tools.json +334 -0
  9. package/seed/marketplaces/ecc/.claude/enterprise/controls.md +15 -0
  10. package/seed/marketplaces/ecc/.claude/homunculus/instincts/inherited/everything-claude-code-instincts.yaml +162 -0
  11. package/seed/marketplaces/ecc/.claude/identity.json +14 -0
  12. package/seed/marketplaces/ecc/.claude/package-manager.json +4 -0
  13. package/seed/marketplaces/ecc/.claude/research/everything-claude-code-research-playbook.md +21 -0
  14. package/seed/marketplaces/ecc/.claude/rules/everything-claude-code-guardrails.md +43 -0
  15. package/seed/marketplaces/ecc/.claude/rules/node.md +56 -0
  16. package/seed/marketplaces/ecc/.claude/skills/everything-claude-code/SKILL.md +442 -0
  17. package/seed/marketplaces/ecc/.claude/team/everything-claude-code-team-config.json +15 -0
  18. package/seed/marketplaces/ecc/.opencode/package-lock.json +169 -169
  19. package/seed/marketplaces/ecc/.vscode/settings.json +17 -0
  20. package/seed/marketplaces/ecc/commands/aside.md +164 -164
  21. package/seed/marketplaces/ecc/commands/auto-update.md +28 -28
  22. package/seed/marketplaces/ecc/commands/build-fix.md +66 -66
  23. package/seed/marketplaces/ecc/commands/checkpoint.md +78 -78
  24. package/seed/marketplaces/ecc/commands/code-review.md +289 -289
  25. package/seed/marketplaces/ecc/commands/cost-report.md +107 -107
  26. package/seed/marketplaces/ecc/commands/cpp-build.md +173 -173
  27. package/seed/marketplaces/ecc/commands/cpp-review.md +132 -132
  28. package/seed/marketplaces/ecc/commands/cpp-test.md +251 -251
  29. package/seed/marketplaces/ecc/commands/ecc-guide.md +93 -93
  30. package/seed/marketplaces/ecc/commands/evolve.md +178 -178
  31. package/seed/marketplaces/ecc/commands/fastapi-review.md +39 -39
  32. package/seed/marketplaces/ecc/commands/feature-dev.md +49 -49
  33. package/seed/marketplaces/ecc/commands/flutter-build.md +164 -164
  34. package/seed/marketplaces/ecc/commands/flutter-review.md +116 -116
  35. package/seed/marketplaces/ecc/commands/flutter-test.md +144 -144
  36. package/seed/marketplaces/ecc/commands/gan-build.md +103 -103
  37. package/seed/marketplaces/ecc/commands/gan-design.md +39 -39
  38. package/seed/marketplaces/ecc/commands/go-build.md +183 -183
  39. package/seed/marketplaces/ecc/commands/go-review.md +148 -148
  40. package/seed/marketplaces/ecc/commands/go-test.md +268 -268
  41. package/seed/marketplaces/ecc/commands/gradle-build.md +70 -70
  42. package/seed/marketplaces/ecc/commands/harness-audit.md +84 -84
  43. package/seed/marketplaces/ecc/commands/hookify-configure.md +14 -14
  44. package/seed/marketplaces/ecc/commands/hookify-help.md +46 -46
  45. package/seed/marketplaces/ecc/commands/hookify-list.md +21 -21
  46. package/seed/marketplaces/ecc/commands/hookify.md +50 -50
  47. package/seed/marketplaces/ecc/commands/instinct-export.md +66 -66
  48. package/seed/marketplaces/ecc/commands/instinct-import.md +114 -114
  49. package/seed/marketplaces/ecc/commands/instinct-status.md +59 -59
  50. package/seed/marketplaces/ecc/commands/jira.md +106 -106
  51. package/seed/marketplaces/ecc/commands/kotlin-build.md +174 -174
  52. package/seed/marketplaces/ecc/commands/kotlin-review.md +140 -140
  53. package/seed/marketplaces/ecc/commands/kotlin-test.md +312 -312
  54. package/seed/marketplaces/ecc/commands/learn-eval.md +116 -116
  55. package/seed/marketplaces/ecc/commands/learn.md +74 -74
  56. package/seed/marketplaces/ecc/commands/loop-start.md +36 -36
  57. package/seed/marketplaces/ecc/commands/loop-status.md +77 -77
  58. package/seed/marketplaces/ecc/commands/marketing-campaign.md +129 -129
  59. package/seed/marketplaces/ecc/commands/model-route.md +30 -30
  60. package/seed/marketplaces/ecc/commands/multi-backend.md +162 -162
  61. package/seed/marketplaces/ecc/commands/multi-execute.md +319 -319
  62. package/seed/marketplaces/ecc/commands/multi-frontend.md +162 -162
  63. package/seed/marketplaces/ecc/commands/multi-plan.md +272 -272
  64. package/seed/marketplaces/ecc/commands/multi-workflow.md +195 -195
  65. package/seed/marketplaces/ecc/commands/plan-prd.md +160 -160
  66. package/seed/marketplaces/ecc/commands/plan.md +200 -200
  67. package/seed/marketplaces/ecc/commands/pm2.md +276 -276
  68. package/seed/marketplaces/ecc/commands/pr.md +184 -184
  69. package/seed/marketplaces/ecc/commands/project-init.md +86 -86
  70. package/seed/marketplaces/ecc/commands/projects.md +39 -39
  71. package/seed/marketplaces/ecc/commands/promote.md +41 -41
  72. package/seed/marketplaces/ecc/commands/prp-commit.md +112 -112
  73. package/seed/marketplaces/ecc/commands/prp-implement.md +385 -385
  74. package/seed/marketplaces/ecc/commands/prp-plan.md +502 -502
  75. package/seed/marketplaces/ecc/commands/prp-pr.md +184 -184
  76. package/seed/marketplaces/ecc/commands/prp-prd.md +447 -447
  77. package/seed/marketplaces/ecc/commands/prune.md +31 -31
  78. package/seed/marketplaces/ecc/commands/python-review.md +297 -297
  79. package/seed/marketplaces/ecc/commands/quality-gate.md +33 -33
  80. package/seed/marketplaces/ecc/commands/refactor-clean.md +84 -84
  81. package/seed/marketplaces/ecc/commands/resume-session.md +156 -156
  82. package/seed/marketplaces/ecc/commands/review-pr.md +37 -37
  83. package/seed/marketplaces/ecc/commands/rust-build.md +187 -187
  84. package/seed/marketplaces/ecc/commands/rust-review.md +142 -142
  85. package/seed/marketplaces/ecc/commands/rust-test.md +308 -308
  86. package/seed/marketplaces/ecc/commands/santa-loop.md +175 -175
  87. package/seed/marketplaces/ecc/commands/save-session.md +275 -275
  88. package/seed/marketplaces/ecc/commands/security-scan.md +92 -92
  89. package/seed/marketplaces/ecc/commands/sessions.md +339 -339
  90. package/seed/marketplaces/ecc/commands/setup-pm.md +80 -80
  91. package/seed/marketplaces/ecc/commands/skill-create.md +174 -174
  92. package/seed/marketplaces/ecc/commands/skill-health.md +54 -54
  93. package/seed/marketplaces/ecc/commands/test-coverage.md +73 -73
  94. package/seed/marketplaces/ecc/commands/update-codemaps.md +76 -76
  95. package/seed/marketplaces/ecc/commands/update-docs.md +88 -88
  96. package/seed/marketplaces/ecc/skills/accessibility/SKILL.md +146 -146
  97. package/seed/marketplaces/ecc/skills/agent-architecture-audit/SKILL.md +256 -256
  98. package/seed/marketplaces/ecc/skills/agent-eval/SKILL.md +145 -145
  99. package/seed/marketplaces/ecc/skills/agent-harness-construction/SKILL.md +73 -73
  100. package/seed/marketplaces/ecc/skills/agent-introspection-debugging/SKILL.md +153 -153
  101. package/seed/marketplaces/ecc/skills/agent-payment-x402/SKILL.md +224 -224
  102. package/seed/marketplaces/ecc/skills/agent-sort/SKILL.md +215 -215
  103. package/seed/marketplaces/ecc/skills/agentic-engineering/SKILL.md +63 -63
  104. package/seed/marketplaces/ecc/skills/agentic-os/SKILL.md +387 -387
  105. package/seed/marketplaces/ecc/skills/ai-first-engineering/SKILL.md +51 -51
  106. package/seed/marketplaces/ecc/skills/ai-regression-testing/SKILL.md +385 -385
  107. package/seed/marketplaces/ecc/skills/android-clean-architecture/SKILL.md +339 -339
  108. package/seed/marketplaces/ecc/skills/angular-developer/SKILL.md +154 -154
  109. package/seed/marketplaces/ecc/skills/angular-developer/references/angular-animations.md +160 -160
  110. package/seed/marketplaces/ecc/skills/angular-developer/references/angular-aria.md +410 -410
  111. package/seed/marketplaces/ecc/skills/angular-developer/references/cli.md +86 -86
  112. package/seed/marketplaces/ecc/skills/angular-developer/references/component-harnesses.md +59 -59
  113. package/seed/marketplaces/ecc/skills/angular-developer/references/component-styling.md +91 -91
  114. package/seed/marketplaces/ecc/skills/angular-developer/references/components.md +117 -117
  115. package/seed/marketplaces/ecc/skills/angular-developer/references/creating-services.md +97 -97
  116. package/seed/marketplaces/ecc/skills/angular-developer/references/data-resolvers.md +69 -69
  117. package/seed/marketplaces/ecc/skills/angular-developer/references/define-routes.md +67 -67
  118. package/seed/marketplaces/ecc/skills/angular-developer/references/defining-providers.md +72 -72
  119. package/seed/marketplaces/ecc/skills/angular-developer/references/di-fundamentals.md +120 -120
  120. package/seed/marketplaces/ecc/skills/angular-developer/references/e2e-testing.md +56 -56
  121. package/seed/marketplaces/ecc/skills/angular-developer/references/effects.md +83 -83
  122. package/seed/marketplaces/ecc/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  123. package/seed/marketplaces/ecc/skills/angular-developer/references/host-elements.md +80 -80
  124. package/seed/marketplaces/ecc/skills/angular-developer/references/injection-context.md +63 -63
  125. package/seed/marketplaces/ecc/skills/angular-developer/references/inputs.md +101 -101
  126. package/seed/marketplaces/ecc/skills/angular-developer/references/linked-signal.md +59 -59
  127. package/seed/marketplaces/ecc/skills/angular-developer/references/loading-strategies.md +61 -61
  128. package/seed/marketplaces/ecc/skills/angular-developer/references/mcp.md +108 -108
  129. package/seed/marketplaces/ecc/skills/angular-developer/references/navigate-to-routes.md +69 -69
  130. package/seed/marketplaces/ecc/skills/angular-developer/references/outputs.md +86 -86
  131. package/seed/marketplaces/ecc/skills/angular-developer/references/reactive-forms.md +122 -122
  132. package/seed/marketplaces/ecc/skills/angular-developer/references/rendering-strategies.md +44 -44
  133. package/seed/marketplaces/ecc/skills/angular-developer/references/resource.md +77 -77
  134. package/seed/marketplaces/ecc/skills/angular-developer/references/route-animations.md +56 -56
  135. package/seed/marketplaces/ecc/skills/angular-developer/references/route-guards.md +52 -52
  136. package/seed/marketplaces/ecc/skills/angular-developer/references/router-lifecycle.md +45 -45
  137. package/seed/marketplaces/ecc/skills/angular-developer/references/router-testing.md +87 -87
  138. package/seed/marketplaces/ecc/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  139. package/seed/marketplaces/ecc/skills/angular-developer/references/signal-forms.md +795 -795
  140. package/seed/marketplaces/ecc/skills/angular-developer/references/signals-overview.md +94 -94
  141. package/seed/marketplaces/ecc/skills/angular-developer/references/tailwind-css.md +69 -69
  142. package/seed/marketplaces/ecc/skills/angular-developer/references/template-driven-forms.md +114 -114
  143. package/seed/marketplaces/ecc/skills/angular-developer/references/testing-fundamentals.md +65 -65
  144. package/seed/marketplaces/ecc/skills/api-connector-builder/SKILL.md +120 -120
  145. package/seed/marketplaces/ecc/skills/api-design/SKILL.md +523 -523
  146. package/seed/marketplaces/ecc/skills/architecture-decision-records/SKILL.md +179 -179
  147. package/seed/marketplaces/ecc/skills/article-writing/SKILL.md +79 -79
  148. package/seed/marketplaces/ecc/skills/automation-audit-ops/SKILL.md +142 -142
  149. package/seed/marketplaces/ecc/skills/autonomous-agent-harness/SKILL.md +273 -273
  150. package/seed/marketplaces/ecc/skills/autonomous-loops/SKILL.md +610 -610
  151. package/seed/marketplaces/ecc/skills/backend-patterns/SKILL.md +561 -561
  152. package/seed/marketplaces/ecc/skills/benchmark/SKILL.md +93 -93
  153. package/seed/marketplaces/ecc/skills/benchmark-optimization-loop/SKILL.md +69 -69
  154. package/seed/marketplaces/ecc/skills/blender-motion-state-inspection/SKILL.md +164 -164
  155. package/seed/marketplaces/ecc/skills/blueprint/SKILL.md +105 -105
  156. package/seed/marketplaces/ecc/skills/brand-voice/SKILL.md +97 -97
  157. package/seed/marketplaces/ecc/skills/brand-voice/references/voice-profile-schema.md +55 -55
  158. package/seed/marketplaces/ecc/skills/browser-qa/SKILL.md +87 -87
  159. package/seed/marketplaces/ecc/skills/bun-runtime/SKILL.md +84 -84
  160. package/seed/marketplaces/ecc/skills/canary-watch/SKILL.md +107 -107
  161. package/seed/marketplaces/ecc/skills/carrier-relationship-management/SKILL.md +212 -212
  162. package/seed/marketplaces/ecc/skills/cisco-ios-patterns/SKILL.md +163 -163
  163. package/seed/marketplaces/ecc/skills/ck/SKILL.md +147 -147
  164. package/seed/marketplaces/ecc/skills/ck/commands/forget.mjs +44 -44
  165. package/seed/marketplaces/ecc/skills/ck/commands/info.mjs +24 -24
  166. package/seed/marketplaces/ecc/skills/ck/commands/init.mjs +143 -143
  167. package/seed/marketplaces/ecc/skills/ck/commands/list.mjs +40 -40
  168. package/seed/marketplaces/ecc/skills/ck/commands/migrate.mjs +202 -202
  169. package/seed/marketplaces/ecc/skills/ck/commands/resume.mjs +36 -36
  170. package/seed/marketplaces/ecc/skills/ck/commands/save.mjs +210 -210
  171. package/seed/marketplaces/ecc/skills/ck/commands/shared.mjs +387 -387
  172. package/seed/marketplaces/ecc/skills/ck/hooks/session-start.mjs +224 -224
  173. package/seed/marketplaces/ecc/skills/claude-devfleet/SKILL.md +103 -103
  174. package/seed/marketplaces/ecc/skills/click-path-audit/SKILL.md +244 -244
  175. package/seed/marketplaces/ecc/skills/clickhouse-io/SKILL.md +439 -439
  176. package/seed/marketplaces/ecc/skills/code-tour/SKILL.md +236 -236
  177. package/seed/marketplaces/ecc/skills/codebase-onboarding/SKILL.md +233 -233
  178. package/seed/marketplaces/ecc/skills/coding-standards/SKILL.md +549 -549
  179. package/seed/marketplaces/ecc/skills/compose-multiplatform-patterns/SKILL.md +299 -299
  180. package/seed/marketplaces/ecc/skills/configure-ecc/SKILL.md +384 -384
  181. package/seed/marketplaces/ecc/skills/connections-optimizer/SKILL.md +189 -189
  182. package/seed/marketplaces/ecc/skills/content-engine/SKILL.md +131 -131
  183. package/seed/marketplaces/ecc/skills/content-hash-cache-pattern/SKILL.md +161 -161
  184. package/seed/marketplaces/ecc/skills/context-budget/SKILL.md +135 -135
  185. package/seed/marketplaces/ecc/skills/continuous-agent-loop/SKILL.md +45 -45
  186. package/seed/marketplaces/ecc/skills/continuous-learning/SKILL.md +131 -131
  187. package/seed/marketplaces/ecc/skills/continuous-learning/config.json +18 -18
  188. package/seed/marketplaces/ecc/skills/continuous-learning/evaluate-session.sh +69 -69
  189. package/seed/marketplaces/ecc/skills/continuous-learning-v2/SKILL.md +360 -360
  190. package/seed/marketplaces/ecc/skills/continuous-learning-v2/agents/observer-loop.sh +322 -322
  191. package/seed/marketplaces/ecc/skills/continuous-learning-v2/agents/observer.md +198 -198
  192. package/seed/marketplaces/ecc/skills/continuous-learning-v2/agents/session-guardian.sh +150 -150
  193. package/seed/marketplaces/ecc/skills/continuous-learning-v2/agents/start-observer.sh +248 -248
  194. package/seed/marketplaces/ecc/skills/continuous-learning-v2/config.json +8 -8
  195. package/seed/marketplaces/ecc/skills/continuous-learning-v2/hooks/observe.sh +498 -498
  196. package/seed/marketplaces/ecc/skills/continuous-learning-v2/scripts/detect-project.sh +322 -322
  197. package/seed/marketplaces/ecc/skills/continuous-learning-v2/scripts/instinct-cli.py +1826 -1826
  198. package/seed/marketplaces/ecc/skills/continuous-learning-v2/scripts/lib/homunculus-dir.sh +31 -31
  199. package/seed/marketplaces/ecc/skills/continuous-learning-v2/scripts/migrate-homunculus.sh +62 -62
  200. package/seed/marketplaces/ecc/skills/continuous-learning-v2/scripts/test_parse_instinct.py +1018 -1018
  201. package/seed/marketplaces/ecc/skills/cost-aware-llm-pipeline/SKILL.md +183 -183
  202. package/seed/marketplaces/ecc/skills/cost-tracking/SKILL.md +147 -147
  203. package/seed/marketplaces/ecc/skills/council/SKILL.md +203 -203
  204. package/seed/marketplaces/ecc/skills/cpp-coding-standards/SKILL.md +723 -723
  205. package/seed/marketplaces/ecc/skills/cpp-testing/SKILL.md +324 -324
  206. package/seed/marketplaces/ecc/skills/crosspost/SKILL.md +111 -111
  207. package/seed/marketplaces/ecc/skills/csharp-testing/SKILL.md +321 -321
  208. package/seed/marketplaces/ecc/skills/customer-billing-ops/SKILL.md +140 -140
  209. package/seed/marketplaces/ecc/skills/customs-trade-compliance/SKILL.md +263 -263
  210. package/seed/marketplaces/ecc/skills/dart-flutter-patterns/SKILL.md +563 -563
  211. package/seed/marketplaces/ecc/skills/dashboard-builder/SKILL.md +108 -108
  212. package/seed/marketplaces/ecc/skills/data-scraper-agent/SKILL.md +764 -764
  213. package/seed/marketplaces/ecc/skills/data-throughput-accelerator/SKILL.md +72 -72
  214. package/seed/marketplaces/ecc/skills/database-migrations/SKILL.md +429 -429
  215. package/seed/marketplaces/ecc/skills/deep-research/SKILL.md +159 -159
  216. package/seed/marketplaces/ecc/skills/defi-amm-security/SKILL.md +166 -166
  217. package/seed/marketplaces/ecc/skills/deployment-patterns/SKILL.md +427 -427
  218. package/seed/marketplaces/ecc/skills/design-system/SKILL.md +82 -82
  219. package/seed/marketplaces/ecc/skills/django-celery/SKILL.md +457 -457
  220. package/seed/marketplaces/ecc/skills/django-patterns/SKILL.md +734 -734
  221. package/seed/marketplaces/ecc/skills/django-security/SKILL.md +593 -593
  222. package/seed/marketplaces/ecc/skills/django-tdd/SKILL.md +729 -729
  223. package/seed/marketplaces/ecc/skills/django-verification/SKILL.md +469 -469
  224. package/seed/marketplaces/ecc/skills/dmux-workflows/SKILL.md +191 -191
  225. package/seed/marketplaces/ecc/skills/docker-patterns/SKILL.md +364 -364
  226. package/seed/marketplaces/ecc/skills/documentation-lookup/SKILL.md +90 -90
  227. package/seed/marketplaces/ecc/skills/dotnet-patterns/SKILL.md +321 -321
  228. package/seed/marketplaces/ecc/skills/e2e-testing/SKILL.md +326 -326
  229. package/seed/marketplaces/ecc/skills/ecc-guide/SKILL.md +189 -189
  230. package/seed/marketplaces/ecc/skills/ecc-tools-cost-audit/SKILL.md +160 -160
  231. package/seed/marketplaces/ecc/skills/email-ops/SKILL.md +121 -121
  232. package/seed/marketplaces/ecc/skills/energy-procurement/SKILL.md +228 -228
  233. package/seed/marketplaces/ecc/skills/enterprise-agent-ops/SKILL.md +50 -50
  234. package/seed/marketplaces/ecc/skills/error-handling/SKILL.md +376 -376
  235. package/seed/marketplaces/ecc/skills/eval-harness/SKILL.md +270 -270
  236. package/seed/marketplaces/ecc/skills/evm-token-decimals/SKILL.md +130 -130
  237. package/seed/marketplaces/ecc/skills/exa-search/SKILL.md +107 -107
  238. package/seed/marketplaces/ecc/skills/fal-ai-media/SKILL.md +288 -288
  239. package/seed/marketplaces/ecc/skills/fastapi-patterns/SKILL.md +327 -327
  240. package/seed/marketplaces/ecc/skills/finance-billing-ops/SKILL.md +127 -127
  241. package/seed/marketplaces/ecc/skills/flox-environments/SKILL.md +496 -496
  242. package/seed/marketplaces/ecc/skills/flutter-dart-code-review/SKILL.md +435 -435
  243. package/seed/marketplaces/ecc/skills/foundation-models-on-device/SKILL.md +243 -243
  244. package/seed/marketplaces/ecc/skills/frontend-a11y/SKILL.md +446 -446
  245. package/seed/marketplaces/ecc/skills/frontend-design-direction/SKILL.md +92 -92
  246. package/seed/marketplaces/ecc/skills/frontend-patterns/SKILL.md +642 -642
  247. package/seed/marketplaces/ecc/skills/frontend-slides/SKILL.md +184 -184
  248. package/seed/marketplaces/ecc/skills/frontend-slides/STYLE_PRESETS.md +330 -330
  249. package/seed/marketplaces/ecc/skills/frontend-slides/animation-patterns.md +122 -122
  250. package/seed/marketplaces/ecc/skills/frontend-slides/html-template.md +419 -419
  251. package/seed/marketplaces/ecc/skills/frontend-slides/scripts/export-pdf.sh +418 -418
  252. package/seed/marketplaces/ecc/skills/frontend-slides/scripts/extract-pptx.py +96 -96
  253. package/seed/marketplaces/ecc/skills/frontend-slides/viewport-base.css +153 -153
  254. package/seed/marketplaces/ecc/skills/fsharp-testing/SKILL.md +280 -280
  255. package/seed/marketplaces/ecc/skills/gan-style-harness/SKILL.md +278 -278
  256. package/seed/marketplaces/ecc/skills/gateguard/SKILL.md +125 -125
  257. package/seed/marketplaces/ecc/skills/git-workflow/SKILL.md +715 -715
  258. package/seed/marketplaces/ecc/skills/github-ops/SKILL.md +144 -144
  259. package/seed/marketplaces/ecc/skills/golang-patterns/SKILL.md +674 -674
  260. package/seed/marketplaces/ecc/skills/golang-testing/SKILL.md +720 -720
  261. package/seed/marketplaces/ecc/skills/google-workspace-ops/SKILL.md +95 -95
  262. package/seed/marketplaces/ecc/skills/healthcare-cdss-patterns/SKILL.md +245 -245
  263. package/seed/marketplaces/ecc/skills/healthcare-emr-patterns/SKILL.md +159 -159
  264. package/seed/marketplaces/ecc/skills/healthcare-eval-harness/SKILL.md +207 -207
  265. package/seed/marketplaces/ecc/skills/healthcare-phi-compliance/SKILL.md +145 -145
  266. package/seed/marketplaces/ecc/skills/hermes-imports/SKILL.md +88 -88
  267. package/seed/marketplaces/ecc/skills/hexagonal-architecture/SKILL.md +276 -276
  268. package/seed/marketplaces/ecc/skills/hipaa-compliance/SKILL.md +78 -78
  269. package/seed/marketplaces/ecc/skills/homelab-network-readiness/SKILL.md +169 -169
  270. package/seed/marketplaces/ecc/skills/homelab-network-setup/SKILL.md +129 -129
  271. package/seed/marketplaces/ecc/skills/homelab-pihole-dns/SKILL.md +274 -274
  272. package/seed/marketplaces/ecc/skills/homelab-vlan-segmentation/SKILL.md +311 -311
  273. package/seed/marketplaces/ecc/skills/homelab-wireguard-vpn/SKILL.md +305 -305
  274. package/seed/marketplaces/ecc/skills/hookify-rules/SKILL.md +128 -128
  275. package/seed/marketplaces/ecc/skills/inventory-demand-planning/SKILL.md +247 -247
  276. package/seed/marketplaces/ecc/skills/investor-materials/SKILL.md +96 -96
  277. package/seed/marketplaces/ecc/skills/investor-outreach/SKILL.md +91 -91
  278. package/seed/marketplaces/ecc/skills/ios-icon-gen/SKILL.md +157 -157
  279. package/seed/marketplaces/ecc/skills/ios-icon-gen/scripts/generate_icons.swift +258 -258
  280. package/seed/marketplaces/ecc/skills/ios-icon-gen/scripts/iconify_gen.sh +235 -235
  281. package/seed/marketplaces/ecc/skills/iterative-retrieval/SKILL.md +211 -211
  282. package/seed/marketplaces/ecc/skills/ito-basket-compare/SKILL.md +63 -63
  283. package/seed/marketplaces/ecc/skills/ito-data-atlas-agent/SKILL.md +63 -63
  284. package/seed/marketplaces/ecc/skills/ito-market-intelligence/SKILL.md +60 -60
  285. package/seed/marketplaces/ecc/skills/ito-trade-planner/SKILL.md +67 -67
  286. package/seed/marketplaces/ecc/skills/java-coding-standards/SKILL.md +383 -383
  287. package/seed/marketplaces/ecc/skills/jira-integration/SKILL.md +293 -293
  288. package/seed/marketplaces/ecc/skills/jpa-patterns/SKILL.md +151 -151
  289. package/seed/marketplaces/ecc/skills/knowledge-ops/SKILL.md +154 -154
  290. package/seed/marketplaces/ecc/skills/kotlin-coroutines-flows/SKILL.md +284 -284
  291. package/seed/marketplaces/ecc/skills/kotlin-exposed-patterns/SKILL.md +719 -719
  292. package/seed/marketplaces/ecc/skills/kotlin-ktor-patterns/SKILL.md +689 -689
  293. package/seed/marketplaces/ecc/skills/kotlin-patterns/SKILL.md +711 -711
  294. package/seed/marketplaces/ecc/skills/kotlin-testing/SKILL.md +824 -824
  295. package/seed/marketplaces/ecc/skills/laravel-patterns/SKILL.md +415 -415
  296. package/seed/marketplaces/ecc/skills/laravel-plugin-discovery/SKILL.md +229 -229
  297. package/seed/marketplaces/ecc/skills/laravel-security/SKILL.md +285 -285
  298. package/seed/marketplaces/ecc/skills/laravel-tdd/SKILL.md +283 -283
  299. package/seed/marketplaces/ecc/skills/laravel-verification/SKILL.md +179 -179
  300. package/seed/marketplaces/ecc/skills/latency-critical-systems/SKILL.md +73 -73
  301. package/seed/marketplaces/ecc/skills/lead-intelligence/SKILL.md +321 -321
  302. package/seed/marketplaces/ecc/skills/lead-intelligence/agents/enrichment-agent.md +85 -85
  303. package/seed/marketplaces/ecc/skills/lead-intelligence/agents/mutual-mapper.md +75 -75
  304. package/seed/marketplaces/ecc/skills/lead-intelligence/agents/outreach-drafter.md +98 -98
  305. package/seed/marketplaces/ecc/skills/lead-intelligence/agents/signal-scorer.md +60 -60
  306. package/seed/marketplaces/ecc/skills/liquid-glass-design/SKILL.md +279 -279
  307. package/seed/marketplaces/ecc/skills/llm-trading-agent-security/SKILL.md +146 -146
  308. package/seed/marketplaces/ecc/skills/logistics-exception-management/SKILL.md +222 -222
  309. package/seed/marketplaces/ecc/skills/make-interfaces-feel-better/SKILL.md +151 -151
  310. package/seed/marketplaces/ecc/skills/manim-video/SKILL.md +89 -89
  311. package/seed/marketplaces/ecc/skills/manim-video/assets/network_graph_scene.py +52 -52
  312. package/seed/marketplaces/ecc/skills/market-research/SKILL.md +75 -75
  313. package/seed/marketplaces/ecc/skills/marketing-campaign/SKILL.md +113 -113
  314. package/seed/marketplaces/ecc/skills/mcp-server-patterns/SKILL.md +69 -69
  315. package/seed/marketplaces/ecc/skills/messages-ops/SKILL.md +104 -104
  316. package/seed/marketplaces/ecc/skills/mle-workflow/SKILL.md +346 -346
  317. package/seed/marketplaces/ecc/skills/motion-advanced/SKILL.md +596 -596
  318. package/seed/marketplaces/ecc/skills/motion-foundations/SKILL.md +299 -299
  319. package/seed/marketplaces/ecc/skills/motion-patterns/SKILL.md +435 -435
  320. package/seed/marketplaces/ecc/skills/motion-ui/SKILL.md +575 -575
  321. package/seed/marketplaces/ecc/skills/mysql-patterns/SKILL.md +412 -412
  322. package/seed/marketplaces/ecc/skills/nanoclaw-repl/SKILL.md +33 -33
  323. package/seed/marketplaces/ecc/skills/nestjs-patterns/SKILL.md +230 -230
  324. package/seed/marketplaces/ecc/skills/netmiko-ssh-automation/SKILL.md +173 -173
  325. package/seed/marketplaces/ecc/skills/network-bgp-diagnostics/SKILL.md +167 -167
  326. package/seed/marketplaces/ecc/skills/network-config-validation/SKILL.md +210 -210
  327. package/seed/marketplaces/ecc/skills/network-interface-health/SKILL.md +152 -152
  328. package/seed/marketplaces/ecc/skills/nextjs-turbopack/SKILL.md +57 -57
  329. package/seed/marketplaces/ecc/skills/nodejs-keccak256/SKILL.md +102 -102
  330. package/seed/marketplaces/ecc/skills/nutrient-document-processing/SKILL.md +167 -167
  331. package/seed/marketplaces/ecc/skills/nuxt4-patterns/SKILL.md +100 -100
  332. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/SKILL.md +288 -288
  333. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/gacha.py +224 -224
  334. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/gacha.sh +5 -5
  335. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  336. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  337. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  338. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  339. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  340. package/seed/marketplaces/ecc/skills/openclaw-persona-forge/references/output-template.md +166 -166
  341. package/seed/marketplaces/ecc/skills/opensource-pipeline/SKILL.md +255 -255
  342. package/seed/marketplaces/ecc/skills/parallel-execution-optimizer/SKILL.md +72 -72
  343. package/seed/marketplaces/ecc/skills/perl-patterns/SKILL.md +504 -504
  344. package/seed/marketplaces/ecc/skills/perl-security/SKILL.md +503 -503
  345. package/seed/marketplaces/ecc/skills/perl-testing/SKILL.md +475 -475
  346. package/seed/marketplaces/ecc/skills/plan-orchestrate/SKILL.md +262 -262
  347. package/seed/marketplaces/ecc/skills/plankton-code-quality/SKILL.md +236 -236
  348. package/seed/marketplaces/ecc/skills/postgres-patterns/SKILL.md +147 -147
  349. package/seed/marketplaces/ecc/skills/prediction-market-oracle-research/SKILL.md +63 -63
  350. package/seed/marketplaces/ecc/skills/prediction-market-risk-review/SKILL.md +60 -60
  351. package/seed/marketplaces/ecc/skills/prisma-patterns/SKILL.md +371 -371
  352. package/seed/marketplaces/ecc/skills/product-capability/SKILL.md +141 -141
  353. package/seed/marketplaces/ecc/skills/product-lens/SKILL.md +92 -92
  354. package/seed/marketplaces/ecc/skills/production-audit/SKILL.md +206 -206
  355. package/seed/marketplaces/ecc/skills/production-scheduling/SKILL.md +238 -238
  356. package/seed/marketplaces/ecc/skills/project-flow-ops/SKILL.md +111 -111
  357. package/seed/marketplaces/ecc/skills/prompt-optimizer/SKILL.md +398 -398
  358. package/seed/marketplaces/ecc/skills/python-patterns/SKILL.md +750 -750
  359. package/seed/marketplaces/ecc/skills/python-testing/SKILL.md +816 -816
  360. package/seed/marketplaces/ecc/skills/pytorch-patterns/SKILL.md +396 -396
  361. package/seed/marketplaces/ecc/skills/quality-nonconformance/SKILL.md +260 -260
  362. package/seed/marketplaces/ecc/skills/quarkus-patterns/SKILL.md +722 -722
  363. package/seed/marketplaces/ecc/skills/quarkus-security/SKILL.md +467 -467
  364. package/seed/marketplaces/ecc/skills/quarkus-tdd/SKILL.md +811 -811
  365. package/seed/marketplaces/ecc/skills/quarkus-verification/SKILL.md +479 -479
  366. package/seed/marketplaces/ecc/skills/ralphinho-rfc-pipeline/SKILL.md +67 -67
  367. package/seed/marketplaces/ecc/skills/recsys-pipeline-architect/SKILL.md +114 -114
  368. package/seed/marketplaces/ecc/skills/recursive-decision-ledger/SKILL.md +79 -79
  369. package/seed/marketplaces/ecc/skills/redis-patterns/SKILL.md +403 -403
  370. package/seed/marketplaces/ecc/skills/regex-vs-llm-structured-text/SKILL.md +220 -220
  371. package/seed/marketplaces/ecc/skills/remotion-video-creation/SKILL.md +43 -43
  372. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/3d.md +86 -86
  373. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/animations.md +29 -29
  374. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/assets/charts-bar-chart.tsx +173 -173
  375. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/assets/text-animations-typewriter.tsx +100 -100
  376. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/assets/text-animations-word-highlight.tsx +108 -108
  377. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/assets.md +78 -78
  378. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/audio.md +172 -172
  379. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/calculate-metadata.md +104 -104
  380. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/can-decode.md +75 -75
  381. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/charts.md +58 -58
  382. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/compositions.md +146 -146
  383. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/display-captions.md +126 -126
  384. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/extract-frames.md +229 -229
  385. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/fonts.md +152 -152
  386. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/get-audio-duration.md +58 -58
  387. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/get-video-dimensions.md +68 -68
  388. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/get-video-duration.md +58 -58
  389. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/gifs.md +138 -138
  390. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/images.md +130 -130
  391. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/import-srt-captions.md +67 -67
  392. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/lottie.md +67 -67
  393. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/measuring-dom-nodes.md +34 -34
  394. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/measuring-text.md +143 -143
  395. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/sequencing.md +106 -106
  396. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/tailwind.md +11 -11
  397. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/text-animations.md +20 -20
  398. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/timing.md +179 -179
  399. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/transcribe-captions.md +19 -19
  400. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/transitions.md +122 -122
  401. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/trimming.md +52 -52
  402. package/seed/marketplaces/ecc/skills/remotion-video-creation/rules/videos.md +171 -171
  403. package/seed/marketplaces/ecc/skills/repo-scan/SKILL.md +78 -78
  404. package/seed/marketplaces/ecc/skills/research-ops/SKILL.md +112 -112
  405. package/seed/marketplaces/ecc/skills/returns-reverse-logistics/SKILL.md +240 -240
  406. package/seed/marketplaces/ecc/skills/rules-distill/SKILL.md +264 -264
  407. package/seed/marketplaces/ecc/skills/rules-distill/scripts/scan-rules.sh +58 -58
  408. package/seed/marketplaces/ecc/skills/rules-distill/scripts/scan-skills.sh +129 -129
  409. package/seed/marketplaces/ecc/skills/rust-patterns/SKILL.md +499 -499
  410. package/seed/marketplaces/ecc/skills/rust-testing/SKILL.md +500 -500
  411. package/seed/marketplaces/ecc/skills/safety-guard/SKILL.md +75 -75
  412. package/seed/marketplaces/ecc/skills/santa-method/SKILL.md +306 -306
  413. package/seed/marketplaces/ecc/skills/scientific-db-pubmed-database/SKILL.md +175 -175
  414. package/seed/marketplaces/ecc/skills/scientific-db-uspto-database/SKILL.md +177 -177
  415. package/seed/marketplaces/ecc/skills/scientific-pkg-gget/SKILL.md +166 -166
  416. package/seed/marketplaces/ecc/skills/scientific-thinking-literature-review/SKILL.md +192 -192
  417. package/seed/marketplaces/ecc/skills/scientific-thinking-scholar-evaluation/SKILL.md +160 -160
  418. package/seed/marketplaces/ecc/skills/search-first/SKILL.md +182 -182
  419. package/seed/marketplaces/ecc/skills/security-bounty-hunter/SKILL.md +99 -99
  420. package/seed/marketplaces/ecc/skills/security-review/SKILL.md +503 -503
  421. package/seed/marketplaces/ecc/skills/security-review/cloud-infrastructure-security.md +361 -361
  422. package/seed/marketplaces/ecc/skills/security-scan/SKILL.md +165 -165
  423. package/seed/marketplaces/ecc/skills/seo/SKILL.md +154 -154
  424. package/seed/marketplaces/ecc/skills/skill-comply/SKILL.md +58 -58
  425. package/seed/marketplaces/ecc/skills/skill-comply/fixtures/compliant_trace.jsonl +5 -5
  426. package/seed/marketplaces/ecc/skills/skill-comply/fixtures/noncompliant_trace.jsonl +3 -3
  427. package/seed/marketplaces/ecc/skills/skill-comply/fixtures/tdd_spec.yaml +44 -44
  428. package/seed/marketplaces/ecc/skills/skill-comply/prompts/classifier.md +24 -24
  429. package/seed/marketplaces/ecc/skills/skill-comply/prompts/scenario_generator.md +62 -62
  430. package/seed/marketplaces/ecc/skills/skill-comply/prompts/spec_generator.md +42 -42
  431. package/seed/marketplaces/ecc/skills/skill-comply/pyproject.toml +15 -15
  432. package/seed/marketplaces/ecc/skills/skill-comply/scripts/classifier.py +85 -85
  433. package/seed/marketplaces/ecc/skills/skill-comply/scripts/grader.py +124 -124
  434. package/seed/marketplaces/ecc/skills/skill-comply/scripts/parser.py +107 -107
  435. package/seed/marketplaces/ecc/skills/skill-comply/scripts/report.py +170 -170
  436. package/seed/marketplaces/ecc/skills/skill-comply/scripts/run.py +127 -127
  437. package/seed/marketplaces/ecc/skills/skill-comply/scripts/runner.py +186 -186
  438. package/seed/marketplaces/ecc/skills/skill-comply/scripts/scenario_generator.py +70 -70
  439. package/seed/marketplaces/ecc/skills/skill-comply/scripts/spec_generator.py +72 -72
  440. package/seed/marketplaces/ecc/skills/skill-comply/scripts/utils.py +13 -13
  441. package/seed/marketplaces/ecc/skills/skill-comply/tests/test_grader.py +197 -197
  442. package/seed/marketplaces/ecc/skills/skill-comply/tests/test_parser.py +90 -90
  443. package/seed/marketplaces/ecc/skills/skill-comply/tests/test_runner.py +172 -172
  444. package/seed/marketplaces/ecc/skills/skill-scout/SKILL.md +140 -140
  445. package/seed/marketplaces/ecc/skills/skill-stocktake/SKILL.md +194 -194
  446. package/seed/marketplaces/ecc/skills/skill-stocktake/scripts/quick-diff.sh +87 -87
  447. package/seed/marketplaces/ecc/skills/skill-stocktake/scripts/save-results.sh +56 -56
  448. package/seed/marketplaces/ecc/skills/skill-stocktake/scripts/scan.sh +170 -170
  449. package/seed/marketplaces/ecc/skills/social-graph-ranker/SKILL.md +154 -154
  450. package/seed/marketplaces/ecc/skills/social-publisher/SKILL.md +115 -115
  451. package/seed/marketplaces/ecc/skills/springboot-patterns/SKILL.md +314 -314
  452. package/seed/marketplaces/ecc/skills/springboot-security/SKILL.md +272 -272
  453. package/seed/marketplaces/ecc/skills/springboot-tdd/SKILL.md +158 -158
  454. package/seed/marketplaces/ecc/skills/springboot-verification/SKILL.md +231 -231
  455. package/seed/marketplaces/ecc/skills/strategic-compact/SKILL.md +131 -131
  456. package/seed/marketplaces/ecc/skills/swift-actor-persistence/SKILL.md +143 -143
  457. package/seed/marketplaces/ecc/skills/swift-concurrency-6-2/SKILL.md +216 -216
  458. package/seed/marketplaces/ecc/skills/swift-protocol-di-testing/SKILL.md +190 -190
  459. package/seed/marketplaces/ecc/skills/swiftui-patterns/SKILL.md +259 -259
  460. package/seed/marketplaces/ecc/skills/tdd-workflow/SKILL.md +463 -463
  461. package/seed/marketplaces/ecc/skills/team-builder/SKILL.md +168 -168
  462. package/seed/marketplaces/ecc/skills/terminal-ops/SKILL.md +109 -109
  463. package/seed/marketplaces/ecc/skills/tinystruct-patterns/SKILL.md +203 -203
  464. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/architecture.md +90 -90
  465. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/data-handling.md +60 -60
  466. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/database.md +99 -99
  467. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/routing.md +64 -64
  468. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/system-usage.md +97 -97
  469. package/seed/marketplaces/ecc/skills/tinystruct-patterns/references/testing.md +72 -72
  470. package/seed/marketplaces/ecc/skills/token-budget-advisor/SKILL.md +133 -133
  471. package/seed/marketplaces/ecc/skills/ui-demo/SKILL.md +465 -465
  472. package/seed/marketplaces/ecc/skills/ui-to-vue/SKILL.md +134 -134
  473. package/seed/marketplaces/ecc/skills/uncloud/SKILL.md +343 -343
  474. package/seed/marketplaces/ecc/skills/unified-notifications-ops/SKILL.md +187 -187
  475. package/seed/marketplaces/ecc/skills/verification-loop/SKILL.md +126 -126
  476. package/seed/marketplaces/ecc/skills/video-editing/SKILL.md +310 -310
  477. package/seed/marketplaces/ecc/skills/videodb/SKILL.md +374 -374
  478. package/seed/marketplaces/ecc/skills/videodb/reference/api-reference.md +550 -550
  479. package/seed/marketplaces/ecc/skills/videodb/reference/capture-reference.md +407 -407
  480. package/seed/marketplaces/ecc/skills/videodb/reference/capture.md +101 -101
  481. package/seed/marketplaces/ecc/skills/videodb/reference/editor.md +443 -443
  482. package/seed/marketplaces/ecc/skills/videodb/reference/generative.md +331 -331
  483. package/seed/marketplaces/ecc/skills/videodb/reference/rtstream-reference.md +564 -564
  484. package/seed/marketplaces/ecc/skills/videodb/reference/rtstream.md +65 -65
  485. package/seed/marketplaces/ecc/skills/videodb/reference/search.md +230 -230
  486. package/seed/marketplaces/ecc/skills/videodb/reference/streaming.md +406 -406
  487. package/seed/marketplaces/ecc/skills/videodb/reference/use-cases.md +118 -118
  488. package/seed/marketplaces/ecc/skills/videodb/scripts/ws_listener.py +282 -282
  489. package/seed/marketplaces/ecc/skills/visa-doc-translate/README.md +86 -86
  490. package/seed/marketplaces/ecc/skills/visa-doc-translate/SKILL.md +117 -117
  491. package/seed/marketplaces/ecc/skills/vite-patterns/SKILL.md +449 -449
  492. package/seed/marketplaces/ecc/skills/windows-desktop-e2e/SKILL.md +887 -887
  493. package/seed/marketplaces/ecc/skills/workspace-surface-audit/SKILL.md +125 -125
  494. package/seed/marketplaces/ecc/skills/x-api/SKILL.md +234 -234
  495. package/dist/SKILL-r7zmg5v7.md +0 -3
  496. package/dist/cli-mvr5k580.md +0 -3
  497. package/dist/server-zyhc2a9z.md +0 -3
@@ -1,723 +1,723 @@
1
- ---
2
- name: cpp-coding-standards
3
- description: C++ coding standards based on the C++ Core Guidelines (isocpp.github.io). Use when writing, reviewing, or refactoring C++ code to enforce modern, safe, and idiomatic practices.
4
- origin: ECC
5
- ---
6
-
7
- # C++ Coding Standards (C++ Core Guidelines)
8
-
9
- Comprehensive coding standards for modern C++ (C++17/20/23) derived from the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). Enforces type safety, resource safety, immutability, and clarity.
10
-
11
- ## When to Use
12
-
13
- - Writing new C++ code (classes, functions, templates)
14
- - Reviewing or refactoring existing C++ code
15
- - Making architectural decisions in C++ projects
16
- - Enforcing consistent style across a C++ codebase
17
- - Choosing between language features (e.g., `enum` vs `enum class`, raw pointer vs smart pointer)
18
-
19
- ### When NOT to Use
20
-
21
- - Non-C++ projects
22
- - Legacy C codebases that cannot adopt modern C++ features
23
- - Embedded/bare-metal contexts where specific guidelines conflict with hardware constraints (adapt selectively)
24
-
25
- ## Cross-Cutting Principles
26
-
27
- These themes recur across the entire guidelines and form the foundation:
28
-
29
- 1. **RAII everywhere** (P.8, R.1, E.6, CP.20): Bind resource lifetime to object lifetime
30
- 2. **Immutability by default** (P.10, Con.1-5, ES.25): Start with `const`/`constexpr`; mutability is the exception
31
- 3. **Type safety** (P.4, I.4, ES.46-49, Enum.3): Use the type system to prevent errors at compile time
32
- 4. **Express intent** (P.3, F.1, NL.1-2, T.10): Names, types, and concepts should communicate purpose
33
- 5. **Minimize complexity** (F.2-3, ES.5, Per.4-5): Simple code is correct code
34
- 6. **Value semantics over pointer semantics** (C.10, R.3-5, F.20, CP.31): Prefer returning by value and scoped objects
35
-
36
- ## Philosophy & Interfaces (P.*, I.*)
37
-
38
- ### Key Rules
39
-
40
- | Rule | Summary |
41
- |------|---------|
42
- | **P.1** | Express ideas directly in code |
43
- | **P.3** | Express intent |
44
- | **P.4** | Ideally, a program should be statically type safe |
45
- | **P.5** | Prefer compile-time checking to run-time checking |
46
- | **P.8** | Don't leak any resources |
47
- | **P.10** | Prefer immutable data to mutable data |
48
- | **I.1** | Make interfaces explicit |
49
- | **I.2** | Avoid non-const global variables |
50
- | **I.4** | Make interfaces precisely and strongly typed |
51
- | **I.11** | Never transfer ownership by a raw pointer or reference |
52
- | **I.23** | Keep the number of function arguments low |
53
-
54
- ### DO
55
-
56
- ```cpp
57
- // P.10 + I.4: Immutable, strongly typed interface
58
- struct Temperature {
59
- double kelvin;
60
- };
61
-
62
- Temperature boil(const Temperature& water);
63
- ```
64
-
65
- ### DON'T
66
-
67
- ```cpp
68
- // Weak interface: unclear ownership, unclear units
69
- double boil(double* temp);
70
-
71
- // Non-const global variable
72
- int g_counter = 0; // I.2 violation
73
- ```
74
-
75
- ## Functions (F.*)
76
-
77
- ### Key Rules
78
-
79
- | Rule | Summary |
80
- |------|---------|
81
- | **F.1** | Package meaningful operations as carefully named functions |
82
- | **F.2** | A function should perform a single logical operation |
83
- | **F.3** | Keep functions short and simple |
84
- | **F.4** | If a function might be evaluated at compile time, declare it `constexpr` |
85
- | **F.6** | If your function must not throw, declare it `noexcept` |
86
- | **F.8** | Prefer pure functions |
87
- | **F.16** | For "in" parameters, pass cheaply-copied types by value and others by `const&` |
88
- | **F.20** | For "out" values, prefer return values to output parameters |
89
- | **F.21** | To return multiple "out" values, prefer returning a struct |
90
- | **F.43** | Never return a pointer or reference to a local object |
91
-
92
- ### Parameter Passing
93
-
94
- ```cpp
95
- // F.16: Cheap types by value, others by const&
96
- void print(int x); // cheap: by value
97
- void analyze(const std::string& data); // expensive: by const&
98
- void transform(std::string s); // sink: by value (will move)
99
-
100
- // F.20 + F.21: Return values, not output parameters
101
- struct ParseResult {
102
- std::string token;
103
- int position;
104
- };
105
-
106
- ParseResult parse(std::string_view input); // GOOD: return struct
107
-
108
- // BAD: output parameters
109
- void parse(std::string_view input,
110
- std::string& token, int& pos); // avoid this
111
- ```
112
-
113
- ### Pure Functions and constexpr
114
-
115
- ```cpp
116
- // F.4 + F.8: Pure, constexpr where possible
117
- constexpr int factorial(int n) noexcept {
118
- return (n <= 1) ? 1 : n * factorial(n - 1);
119
- }
120
-
121
- static_assert(factorial(5) == 120);
122
- ```
123
-
124
- ### Anti-Patterns
125
-
126
- - Returning `T&&` from functions (F.45)
127
- - Using `va_arg` / C-style variadics (F.55)
128
- - Capturing by reference in lambdas passed to other threads (F.53)
129
- - Returning `const T` which inhibits move semantics (F.49)
130
-
131
- ## Classes & Class Hierarchies (C.*)
132
-
133
- ### Key Rules
134
-
135
- | Rule | Summary |
136
- |------|---------|
137
- | **C.2** | Use `class` if invariant exists; `struct` if data members vary independently |
138
- | **C.9** | Minimize exposure of members |
139
- | **C.20** | If you can avoid defining default operations, do (Rule of Zero) |
140
- | **C.21** | If you define or `=delete` any copy/move/destructor, handle them all (Rule of Five) |
141
- | **C.35** | Base class destructor: public virtual or protected non-virtual |
142
- | **C.41** | A constructor should create a fully initialized object |
143
- | **C.46** | Declare single-argument constructors `explicit` |
144
- | **C.67** | A polymorphic class should suppress public copy/move |
145
- | **C.128** | Virtual functions: specify exactly one of `virtual`, `override`, or `final` |
146
-
147
- ### Rule of Zero
148
-
149
- ```cpp
150
- // C.20: Let the compiler generate special members
151
- struct Employee {
152
- std::string name;
153
- std::string department;
154
- int id;
155
- // No destructor, copy/move constructors, or assignment operators needed
156
- };
157
- ```
158
-
159
- ### Rule of Five
160
-
161
- ```cpp
162
- // C.21: If you must manage a resource, define all five
163
- class Buffer {
164
- public:
165
- explicit Buffer(std::size_t size)
166
- : data_(std::make_unique<char[]>(size)), size_(size) {}
167
-
168
- ~Buffer() = default;
169
-
170
- Buffer(const Buffer& other)
171
- : data_(std::make_unique<char[]>(other.size_)), size_(other.size_) {
172
- std::copy_n(other.data_.get(), size_, data_.get());
173
- }
174
-
175
- Buffer& operator=(const Buffer& other) {
176
- if (this != &other) {
177
- auto new_data = std::make_unique<char[]>(other.size_);
178
- std::copy_n(other.data_.get(), other.size_, new_data.get());
179
- data_ = std::move(new_data);
180
- size_ = other.size_;
181
- }
182
- return *this;
183
- }
184
-
185
- Buffer(Buffer&&) noexcept = default;
186
- Buffer& operator=(Buffer&&) noexcept = default;
187
-
188
- private:
189
- std::unique_ptr<char[]> data_;
190
- std::size_t size_;
191
- };
192
- ```
193
-
194
- ### Class Hierarchy
195
-
196
- ```cpp
197
- // C.35 + C.128: Virtual destructor, use override
198
- class Shape {
199
- public:
200
- virtual ~Shape() = default;
201
- virtual double area() const = 0; // C.121: pure interface
202
- };
203
-
204
- class Circle : public Shape {
205
- public:
206
- explicit Circle(double r) : radius_(r) {}
207
- double area() const override { return 3.14159 * radius_ * radius_; }
208
-
209
- private:
210
- double radius_;
211
- };
212
- ```
213
-
214
- ### Anti-Patterns
215
-
216
- - Calling virtual functions in constructors/destructors (C.82)
217
- - Using `memset`/`memcpy` on non-trivial types (C.90)
218
- - Providing different default arguments for virtual function and overrider (C.140)
219
- - Making data members `const` or references, which suppresses move/copy (C.12)
220
-
221
- ## Resource Management (R.*)
222
-
223
- ### Key Rules
224
-
225
- | Rule | Summary |
226
- |------|---------|
227
- | **R.1** | Manage resources automatically using RAII |
228
- | **R.3** | A raw pointer (`T*`) is non-owning |
229
- | **R.5** | Prefer scoped objects; don't heap-allocate unnecessarily |
230
- | **R.10** | Avoid `malloc()`/`free()` |
231
- | **R.11** | Avoid calling `new` and `delete` explicitly |
232
- | **R.20** | Use `unique_ptr` or `shared_ptr` to represent ownership |
233
- | **R.21** | Prefer `unique_ptr` over `shared_ptr` unless sharing ownership |
234
- | **R.22** | Use `make_shared()` to make `shared_ptr`s |
235
-
236
- ### Smart Pointer Usage
237
-
238
- ```cpp
239
- // R.11 + R.20 + R.21: RAII with smart pointers
240
- auto widget = std::make_unique<Widget>("config"); // unique ownership
241
- auto cache = std::make_shared<Cache>(1024); // shared ownership
242
-
243
- // R.3: Raw pointer = non-owning observer
244
- void render(const Widget* w) { // does NOT own w
245
- if (w) w->draw();
246
- }
247
-
248
- render(widget.get());
249
- ```
250
-
251
- ### RAII Pattern
252
-
253
- ```cpp
254
- // R.1: Resource acquisition is initialization
255
- class FileHandle {
256
- public:
257
- explicit FileHandle(const std::string& path)
258
- : handle_(std::fopen(path.c_str(), "r")) {
259
- if (!handle_) throw std::runtime_error("Failed to open: " + path);
260
- }
261
-
262
- ~FileHandle() {
263
- if (handle_) std::fclose(handle_);
264
- }
265
-
266
- FileHandle(const FileHandle&) = delete;
267
- FileHandle& operator=(const FileHandle&) = delete;
268
- FileHandle(FileHandle&& other) noexcept
269
- : handle_(std::exchange(other.handle_, nullptr)) {}
270
- FileHandle& operator=(FileHandle&& other) noexcept {
271
- if (this != &other) {
272
- if (handle_) std::fclose(handle_);
273
- handle_ = std::exchange(other.handle_, nullptr);
274
- }
275
- return *this;
276
- }
277
-
278
- private:
279
- std::FILE* handle_;
280
- };
281
- ```
282
-
283
- ### Anti-Patterns
284
-
285
- - Naked `new`/`delete` (R.11)
286
- - `malloc()`/`free()` in C++ code (R.10)
287
- - Multiple resource allocations in a single expression (R.13 -- exception safety hazard)
288
- - `shared_ptr` where `unique_ptr` suffices (R.21)
289
-
290
- ## Expressions & Statements (ES.*)
291
-
292
- ### Key Rules
293
-
294
- | Rule | Summary |
295
- |------|---------|
296
- | **ES.5** | Keep scopes small |
297
- | **ES.20** | Always initialize an object |
298
- | **ES.23** | Prefer `{}` initializer syntax |
299
- | **ES.25** | Declare objects `const` or `constexpr` unless modification is intended |
300
- | **ES.28** | Use lambdas for complex initialization of `const` variables |
301
- | **ES.45** | Avoid magic constants; use symbolic constants |
302
- | **ES.46** | Avoid narrowing/lossy arithmetic conversions |
303
- | **ES.47** | Use `nullptr` rather than `0` or `NULL` |
304
- | **ES.48** | Avoid casts |
305
- | **ES.50** | Don't cast away `const` |
306
-
307
- ### Initialization
308
-
309
- ```cpp
310
- // ES.20 + ES.23 + ES.25: Always initialize, prefer {}, default to const
311
- const int max_retries{3};
312
- const std::string name{"widget"};
313
- const std::vector<int> primes{2, 3, 5, 7, 11};
314
-
315
- // ES.28: Lambda for complex const initialization
316
- const auto config = [&] {
317
- Config c;
318
- c.timeout = std::chrono::seconds{30};
319
- c.retries = max_retries;
320
- c.verbose = debug_mode;
321
- return c;
322
- }();
323
- ```
324
-
325
- ### Anti-Patterns
326
-
327
- - Uninitialized variables (ES.20)
328
- - Using `0` or `NULL` as pointer (ES.47 -- use `nullptr`)
329
- - C-style casts (ES.48 -- use `static_cast`, `const_cast`, etc.)
330
- - Casting away `const` (ES.50)
331
- - Magic numbers without named constants (ES.45)
332
- - Mixing signed and unsigned arithmetic (ES.100)
333
- - Reusing names in nested scopes (ES.12)
334
-
335
- ## Error Handling (E.*)
336
-
337
- ### Key Rules
338
-
339
- | Rule | Summary |
340
- |------|---------|
341
- | **E.1** | Develop an error-handling strategy early in a design |
342
- | **E.2** | Throw an exception to signal that a function can't perform its assigned task |
343
- | **E.6** | Use RAII to prevent leaks |
344
- | **E.12** | Use `noexcept` when throwing is impossible or unacceptable |
345
- | **E.14** | Use purpose-designed user-defined types as exceptions |
346
- | **E.15** | Throw by value, catch by reference |
347
- | **E.16** | Destructors, deallocation, and swap must never fail |
348
- | **E.17** | Don't try to catch every exception in every function |
349
-
350
- ### Exception Hierarchy
351
-
352
- ```cpp
353
- // E.14 + E.15: Custom exception types, throw by value, catch by reference
354
- class AppError : public std::runtime_error {
355
- public:
356
- using std::runtime_error::runtime_error;
357
- };
358
-
359
- class NetworkError : public AppError {
360
- public:
361
- NetworkError(const std::string& msg, int code)
362
- : AppError(msg), status_code(code) {}
363
- int status_code;
364
- };
365
-
366
- void fetch_data(const std::string& url) {
367
- // E.2: Throw to signal failure
368
- throw NetworkError("connection refused", 503);
369
- }
370
-
371
- void run() {
372
- try {
373
- fetch_data("https://api.example.com");
374
- } catch (const NetworkError& e) {
375
- log_error(e.what(), e.status_code);
376
- } catch (const AppError& e) {
377
- log_error(e.what());
378
- }
379
- // E.17: Don't catch everything here -- let unexpected errors propagate
380
- }
381
- ```
382
-
383
- ### Anti-Patterns
384
-
385
- - Throwing built-in types like `int` or string literals (E.14)
386
- - Catching by value (slicing risk) (E.15)
387
- - Empty catch blocks that silently swallow errors
388
- - Using exceptions for flow control (E.3)
389
- - Error handling based on global state like `errno` (E.28)
390
-
391
- ## Constants & Immutability (Con.*)
392
-
393
- ### All Rules
394
-
395
- | Rule | Summary |
396
- |------|---------|
397
- | **Con.1** | By default, make objects immutable |
398
- | **Con.2** | By default, make member functions `const` |
399
- | **Con.3** | By default, pass pointers and references to `const` |
400
- | **Con.4** | Use `const` for values that don't change after construction |
401
- | **Con.5** | Use `constexpr` for values computable at compile time |
402
-
403
- ```cpp
404
- // Con.1 through Con.5: Immutability by default
405
- class Sensor {
406
- public:
407
- explicit Sensor(std::string id) : id_(std::move(id)) {}
408
-
409
- // Con.2: const member functions by default
410
- const std::string& id() const { return id_; }
411
- double last_reading() const { return reading_; }
412
-
413
- // Only non-const when mutation is required
414
- void record(double value) { reading_ = value; }
415
-
416
- private:
417
- const std::string id_; // Con.4: never changes after construction
418
- double reading_{0.0};
419
- };
420
-
421
- // Con.3: Pass by const reference
422
- void display(const Sensor& s) {
423
- std::cout << s.id() << ": " << s.last_reading() << '\n';
424
- }
425
-
426
- // Con.5: Compile-time constants
427
- constexpr double PI = 3.14159265358979;
428
- constexpr int MAX_SENSORS = 256;
429
- ```
430
-
431
- ## Concurrency & Parallelism (CP.*)
432
-
433
- ### Key Rules
434
-
435
- | Rule | Summary |
436
- |------|---------|
437
- | **CP.2** | Avoid data races |
438
- | **CP.3** | Minimize explicit sharing of writable data |
439
- | **CP.4** | Think in terms of tasks, rather than threads |
440
- | **CP.8** | Don't use `volatile` for synchronization |
441
- | **CP.20** | Use RAII, never plain `lock()`/`unlock()` |
442
- | **CP.21** | Use `std::scoped_lock` to acquire multiple mutexes |
443
- | **CP.22** | Never call unknown code while holding a lock |
444
- | **CP.42** | Don't wait without a condition |
445
- | **CP.44** | Remember to name your `lock_guard`s and `unique_lock`s |
446
- | **CP.100** | Don't use lock-free programming unless you absolutely have to |
447
-
448
- ### Safe Locking
449
-
450
- ```cpp
451
- // CP.20 + CP.44: RAII locks, always named
452
- class ThreadSafeQueue {
453
- public:
454
- void push(int value) {
455
- std::lock_guard<std::mutex> lock(mutex_); // CP.44: named!
456
- queue_.push(value);
457
- cv_.notify_one();
458
- }
459
-
460
- int pop() {
461
- std::unique_lock<std::mutex> lock(mutex_);
462
- // CP.42: Always wait with a condition
463
- cv_.wait(lock, [this] { return !queue_.empty(); });
464
- const int value = queue_.front();
465
- queue_.pop();
466
- return value;
467
- }
468
-
469
- private:
470
- std::mutex mutex_; // CP.50: mutex with its data
471
- std::condition_variable cv_;
472
- std::queue<int> queue_;
473
- };
474
- ```
475
-
476
- ### Multiple Mutexes
477
-
478
- ```cpp
479
- // CP.21: std::scoped_lock for multiple mutexes (deadlock-free)
480
- void transfer(Account& from, Account& to, double amount) {
481
- std::scoped_lock lock(from.mutex_, to.mutex_);
482
- from.balance_ -= amount;
483
- to.balance_ += amount;
484
- }
485
- ```
486
-
487
- ### Anti-Patterns
488
-
489
- - `volatile` for synchronization (CP.8 -- it's for hardware I/O only)
490
- - Detaching threads (CP.26 -- lifetime management becomes nearly impossible)
491
- - Unnamed lock guards: `std::lock_guard<std::mutex>(m);` destroys immediately (CP.44)
492
- - Holding locks while calling callbacks (CP.22 -- deadlock risk)
493
- - Lock-free programming without deep expertise (CP.100)
494
-
495
- ## Templates & Generic Programming (T.*)
496
-
497
- ### Key Rules
498
-
499
- | Rule | Summary |
500
- |------|---------|
501
- | **T.1** | Use templates to raise the level of abstraction |
502
- | **T.2** | Use templates to express algorithms for many argument types |
503
- | **T.10** | Specify concepts for all template arguments |
504
- | **T.11** | Use standard concepts whenever possible |
505
- | **T.13** | Prefer shorthand notation for simple concepts |
506
- | **T.43** | Prefer `using` over `typedef` |
507
- | **T.120** | Use template metaprogramming only when you really need to |
508
- | **T.144** | Don't specialize function templates (overload instead) |
509
-
510
- ### Concepts (C++20)
511
-
512
- ```cpp
513
- #include <concepts>
514
-
515
- // T.10 + T.11: Constrain templates with standard concepts
516
- template<std::integral T>
517
- T gcd(T a, T b) {
518
- while (b != 0) {
519
- a = std::exchange(b, a % b);
520
- }
521
- return a;
522
- }
523
-
524
- // T.13: Shorthand concept syntax
525
- void sort(std::ranges::random_access_range auto& range) {
526
- std::ranges::sort(range);
527
- }
528
-
529
- // Custom concept for domain-specific constraints
530
- template<typename T>
531
- concept Serializable = requires(const T& t) {
532
- { t.serialize() } -> std::convertible_to<std::string>;
533
- };
534
-
535
- template<Serializable T>
536
- void save(const T& obj, const std::string& path);
537
- ```
538
-
539
- ### Anti-Patterns
540
-
541
- - Unconstrained templates in visible namespaces (T.47)
542
- - Specializing function templates instead of overloading (T.144)
543
- - Template metaprogramming where `constexpr` suffices (T.120)
544
- - `typedef` instead of `using` (T.43)
545
-
546
- ## Standard Library (SL.*)
547
-
548
- ### Key Rules
549
-
550
- | Rule | Summary |
551
- |------|---------|
552
- | **SL.1** | Use libraries wherever possible |
553
- | **SL.2** | Prefer the standard library to other libraries |
554
- | **SL.con.1** | Prefer `std::array` or `std::vector` over C arrays |
555
- | **SL.con.2** | Prefer `std::vector` by default |
556
- | **SL.str.1** | Use `std::string` to own character sequences |
557
- | **SL.str.2** | Use `std::string_view` to refer to character sequences |
558
- | **SL.io.50** | Avoid `endl` (use `'\n'` -- `endl` forces a flush) |
559
-
560
- ```cpp
561
- // SL.con.1 + SL.con.2: Prefer vector/array over C arrays
562
- const std::array<int, 4> fixed_data{1, 2, 3, 4};
563
- std::vector<std::string> dynamic_data;
564
-
565
- // SL.str.1 + SL.str.2: string owns, string_view observes
566
- std::string build_greeting(std::string_view name) {
567
- return "Hello, " + std::string(name) + "!";
568
- }
569
-
570
- // SL.io.50: Use '\n' not endl
571
- std::cout << "result: " << value << '\n';
572
- ```
573
-
574
- ## Enumerations (Enum.*)
575
-
576
- ### Key Rules
577
-
578
- | Rule | Summary |
579
- |------|---------|
580
- | **Enum.1** | Prefer enumerations over macros |
581
- | **Enum.3** | Prefer `enum class` over plain `enum` |
582
- | **Enum.5** | Don't use ALL_CAPS for enumerators |
583
- | **Enum.6** | Avoid unnamed enumerations |
584
-
585
- ```cpp
586
- // Enum.3 + Enum.5: Scoped enum, no ALL_CAPS
587
- enum class Color { red, green, blue };
588
- enum class LogLevel { debug, info, warning, error };
589
-
590
- // BAD: plain enum leaks names, ALL_CAPS clashes with macros
591
- enum { RED, GREEN, BLUE }; // Enum.3 + Enum.5 + Enum.6 violation
592
- #define MAX_SIZE 100 // Enum.1 violation -- use constexpr
593
- ```
594
-
595
- ## Source Files & Naming (SF.*, NL.*)
596
-
597
- ### Key Rules
598
-
599
- | Rule | Summary |
600
- |------|---------|
601
- | **SF.1** | Use `.cpp` for code files and `.h` for interface files |
602
- | **SF.7** | Don't write `using namespace` at global scope in a header |
603
- | **SF.8** | Use `#include` guards for all `.h` files |
604
- | **SF.11** | Header files should be self-contained |
605
- | **NL.5** | Avoid encoding type information in names (no Hungarian notation) |
606
- | **NL.8** | Use a consistent naming style |
607
- | **NL.9** | Use ALL_CAPS for macro names only |
608
- | **NL.10** | Prefer `underscore_style` names |
609
-
610
- ### Header Guard
611
-
612
- ```cpp
613
- // SF.8: Include guard (or #pragma once)
614
- #ifndef PROJECT_MODULE_WIDGET_H
615
- #define PROJECT_MODULE_WIDGET_H
616
-
617
- // SF.11: Self-contained -- include everything this header needs
618
- #include <string>
619
- #include <vector>
620
-
621
- namespace project::module {
622
-
623
- class Widget {
624
- public:
625
- explicit Widget(std::string name);
626
- const std::string& name() const;
627
-
628
- private:
629
- std::string name_;
630
- };
631
-
632
- } // namespace project::module
633
-
634
- #endif // PROJECT_MODULE_WIDGET_H
635
- ```
636
-
637
- ### Naming Conventions
638
-
639
- ```cpp
640
- // NL.8 + NL.10: Consistent underscore_style
641
- namespace my_project {
642
-
643
- constexpr int max_buffer_size = 4096; // NL.9: not ALL_CAPS (it's not a macro)
644
-
645
- class tcp_connection { // underscore_style class
646
- public:
647
- void send_message(std::string_view msg);
648
- bool is_connected() const;
649
-
650
- private:
651
- std::string host_; // trailing underscore for members
652
- int port_;
653
- };
654
-
655
- } // namespace my_project
656
- ```
657
-
658
- ### Anti-Patterns
659
-
660
- - `using namespace std;` in a header at global scope (SF.7)
661
- - Headers that depend on inclusion order (SF.10, SF.11)
662
- - Hungarian notation like `strName`, `iCount` (NL.5)
663
- - ALL_CAPS for anything other than macros (NL.9)
664
-
665
- ## Performance (Per.*)
666
-
667
- ### Key Rules
668
-
669
- | Rule | Summary |
670
- |------|---------|
671
- | **Per.1** | Don't optimize without reason |
672
- | **Per.2** | Don't optimize prematurely |
673
- | **Per.6** | Don't make claims about performance without measurements |
674
- | **Per.7** | Design to enable optimization |
675
- | **Per.10** | Rely on the static type system |
676
- | **Per.11** | Move computation from run time to compile time |
677
- | **Per.19** | Access memory predictably |
678
-
679
- ### Guidelines
680
-
681
- ```cpp
682
- // Per.11: Compile-time computation where possible
683
- constexpr auto lookup_table = [] {
684
- std::array<int, 256> table{};
685
- for (int i = 0; i < 256; ++i) {
686
- table[i] = i * i;
687
- }
688
- return table;
689
- }();
690
-
691
- // Per.19: Prefer contiguous data for cache-friendliness
692
- std::vector<Point> points; // GOOD: contiguous
693
- std::vector<std::unique_ptr<Point>> indirect_points; // BAD: pointer chasing
694
- ```
695
-
696
- ### Anti-Patterns
697
-
698
- - Optimizing without profiling data (Per.1, Per.6)
699
- - Choosing "clever" low-level code over clear abstractions (Per.4, Per.5)
700
- - Ignoring data layout and cache behavior (Per.19)
701
-
702
- ## Quick Reference Checklist
703
-
704
- Before marking C++ work complete:
705
-
706
- - [ ] No raw `new`/`delete` -- use smart pointers or RAII (R.11)
707
- - [ ] Objects initialized at declaration (ES.20)
708
- - [ ] Variables are `const`/`constexpr` by default (Con.1, ES.25)
709
- - [ ] Member functions are `const` where possible (Con.2)
710
- - [ ] `enum class` instead of plain `enum` (Enum.3)
711
- - [ ] `nullptr` instead of `0`/`NULL` (ES.47)
712
- - [ ] No narrowing conversions (ES.46)
713
- - [ ] No C-style casts (ES.48)
714
- - [ ] Single-argument constructors are `explicit` (C.46)
715
- - [ ] Rule of Zero or Rule of Five applied (C.20, C.21)
716
- - [ ] Base class destructors are public virtual or protected non-virtual (C.35)
717
- - [ ] Templates are constrained with concepts (T.10)
718
- - [ ] No `using namespace` in headers at global scope (SF.7)
719
- - [ ] Headers have include guards and are self-contained (SF.8, SF.11)
720
- - [ ] Locks use RAII (`scoped_lock`/`lock_guard`) (CP.20)
721
- - [ ] Exceptions are custom types, thrown by value, caught by reference (E.14, E.15)
722
- - [ ] `'\n'` instead of `std::endl` (SL.io.50)
723
- - [ ] No magic numbers (ES.45)
1
+ ---
2
+ name: cpp-coding-standards
3
+ description: C++ coding standards based on the C++ Core Guidelines (isocpp.github.io). Use when writing, reviewing, or refactoring C++ code to enforce modern, safe, and idiomatic practices.
4
+ origin: ECC
5
+ ---
6
+
7
+ # C++ Coding Standards (C++ Core Guidelines)
8
+
9
+ Comprehensive coding standards for modern C++ (C++17/20/23) derived from the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). Enforces type safety, resource safety, immutability, and clarity.
10
+
11
+ ## When to Use
12
+
13
+ - Writing new C++ code (classes, functions, templates)
14
+ - Reviewing or refactoring existing C++ code
15
+ - Making architectural decisions in C++ projects
16
+ - Enforcing consistent style across a C++ codebase
17
+ - Choosing between language features (e.g., `enum` vs `enum class`, raw pointer vs smart pointer)
18
+
19
+ ### When NOT to Use
20
+
21
+ - Non-C++ projects
22
+ - Legacy C codebases that cannot adopt modern C++ features
23
+ - Embedded/bare-metal contexts where specific guidelines conflict with hardware constraints (adapt selectively)
24
+
25
+ ## Cross-Cutting Principles
26
+
27
+ These themes recur across the entire guidelines and form the foundation:
28
+
29
+ 1. **RAII everywhere** (P.8, R.1, E.6, CP.20): Bind resource lifetime to object lifetime
30
+ 2. **Immutability by default** (P.10, Con.1-5, ES.25): Start with `const`/`constexpr`; mutability is the exception
31
+ 3. **Type safety** (P.4, I.4, ES.46-49, Enum.3): Use the type system to prevent errors at compile time
32
+ 4. **Express intent** (P.3, F.1, NL.1-2, T.10): Names, types, and concepts should communicate purpose
33
+ 5. **Minimize complexity** (F.2-3, ES.5, Per.4-5): Simple code is correct code
34
+ 6. **Value semantics over pointer semantics** (C.10, R.3-5, F.20, CP.31): Prefer returning by value and scoped objects
35
+
36
+ ## Philosophy & Interfaces (P.*, I.*)
37
+
38
+ ### Key Rules
39
+
40
+ | Rule | Summary |
41
+ |------|---------|
42
+ | **P.1** | Express ideas directly in code |
43
+ | **P.3** | Express intent |
44
+ | **P.4** | Ideally, a program should be statically type safe |
45
+ | **P.5** | Prefer compile-time checking to run-time checking |
46
+ | **P.8** | Don't leak any resources |
47
+ | **P.10** | Prefer immutable data to mutable data |
48
+ | **I.1** | Make interfaces explicit |
49
+ | **I.2** | Avoid non-const global variables |
50
+ | **I.4** | Make interfaces precisely and strongly typed |
51
+ | **I.11** | Never transfer ownership by a raw pointer or reference |
52
+ | **I.23** | Keep the number of function arguments low |
53
+
54
+ ### DO
55
+
56
+ ```cpp
57
+ // P.10 + I.4: Immutable, strongly typed interface
58
+ struct Temperature {
59
+ double kelvin;
60
+ };
61
+
62
+ Temperature boil(const Temperature& water);
63
+ ```
64
+
65
+ ### DON'T
66
+
67
+ ```cpp
68
+ // Weak interface: unclear ownership, unclear units
69
+ double boil(double* temp);
70
+
71
+ // Non-const global variable
72
+ int g_counter = 0; // I.2 violation
73
+ ```
74
+
75
+ ## Functions (F.*)
76
+
77
+ ### Key Rules
78
+
79
+ | Rule | Summary |
80
+ |------|---------|
81
+ | **F.1** | Package meaningful operations as carefully named functions |
82
+ | **F.2** | A function should perform a single logical operation |
83
+ | **F.3** | Keep functions short and simple |
84
+ | **F.4** | If a function might be evaluated at compile time, declare it `constexpr` |
85
+ | **F.6** | If your function must not throw, declare it `noexcept` |
86
+ | **F.8** | Prefer pure functions |
87
+ | **F.16** | For "in" parameters, pass cheaply-copied types by value and others by `const&` |
88
+ | **F.20** | For "out" values, prefer return values to output parameters |
89
+ | **F.21** | To return multiple "out" values, prefer returning a struct |
90
+ | **F.43** | Never return a pointer or reference to a local object |
91
+
92
+ ### Parameter Passing
93
+
94
+ ```cpp
95
+ // F.16: Cheap types by value, others by const&
96
+ void print(int x); // cheap: by value
97
+ void analyze(const std::string& data); // expensive: by const&
98
+ void transform(std::string s); // sink: by value (will move)
99
+
100
+ // F.20 + F.21: Return values, not output parameters
101
+ struct ParseResult {
102
+ std::string token;
103
+ int position;
104
+ };
105
+
106
+ ParseResult parse(std::string_view input); // GOOD: return struct
107
+
108
+ // BAD: output parameters
109
+ void parse(std::string_view input,
110
+ std::string& token, int& pos); // avoid this
111
+ ```
112
+
113
+ ### Pure Functions and constexpr
114
+
115
+ ```cpp
116
+ // F.4 + F.8: Pure, constexpr where possible
117
+ constexpr int factorial(int n) noexcept {
118
+ return (n <= 1) ? 1 : n * factorial(n - 1);
119
+ }
120
+
121
+ static_assert(factorial(5) == 120);
122
+ ```
123
+
124
+ ### Anti-Patterns
125
+
126
+ - Returning `T&&` from functions (F.45)
127
+ - Using `va_arg` / C-style variadics (F.55)
128
+ - Capturing by reference in lambdas passed to other threads (F.53)
129
+ - Returning `const T` which inhibits move semantics (F.49)
130
+
131
+ ## Classes & Class Hierarchies (C.*)
132
+
133
+ ### Key Rules
134
+
135
+ | Rule | Summary |
136
+ |------|---------|
137
+ | **C.2** | Use `class` if invariant exists; `struct` if data members vary independently |
138
+ | **C.9** | Minimize exposure of members |
139
+ | **C.20** | If you can avoid defining default operations, do (Rule of Zero) |
140
+ | **C.21** | If you define or `=delete` any copy/move/destructor, handle them all (Rule of Five) |
141
+ | **C.35** | Base class destructor: public virtual or protected non-virtual |
142
+ | **C.41** | A constructor should create a fully initialized object |
143
+ | **C.46** | Declare single-argument constructors `explicit` |
144
+ | **C.67** | A polymorphic class should suppress public copy/move |
145
+ | **C.128** | Virtual functions: specify exactly one of `virtual`, `override`, or `final` |
146
+
147
+ ### Rule of Zero
148
+
149
+ ```cpp
150
+ // C.20: Let the compiler generate special members
151
+ struct Employee {
152
+ std::string name;
153
+ std::string department;
154
+ int id;
155
+ // No destructor, copy/move constructors, or assignment operators needed
156
+ };
157
+ ```
158
+
159
+ ### Rule of Five
160
+
161
+ ```cpp
162
+ // C.21: If you must manage a resource, define all five
163
+ class Buffer {
164
+ public:
165
+ explicit Buffer(std::size_t size)
166
+ : data_(std::make_unique<char[]>(size)), size_(size) {}
167
+
168
+ ~Buffer() = default;
169
+
170
+ Buffer(const Buffer& other)
171
+ : data_(std::make_unique<char[]>(other.size_)), size_(other.size_) {
172
+ std::copy_n(other.data_.get(), size_, data_.get());
173
+ }
174
+
175
+ Buffer& operator=(const Buffer& other) {
176
+ if (this != &other) {
177
+ auto new_data = std::make_unique<char[]>(other.size_);
178
+ std::copy_n(other.data_.get(), other.size_, new_data.get());
179
+ data_ = std::move(new_data);
180
+ size_ = other.size_;
181
+ }
182
+ return *this;
183
+ }
184
+
185
+ Buffer(Buffer&&) noexcept = default;
186
+ Buffer& operator=(Buffer&&) noexcept = default;
187
+
188
+ private:
189
+ std::unique_ptr<char[]> data_;
190
+ std::size_t size_;
191
+ };
192
+ ```
193
+
194
+ ### Class Hierarchy
195
+
196
+ ```cpp
197
+ // C.35 + C.128: Virtual destructor, use override
198
+ class Shape {
199
+ public:
200
+ virtual ~Shape() = default;
201
+ virtual double area() const = 0; // C.121: pure interface
202
+ };
203
+
204
+ class Circle : public Shape {
205
+ public:
206
+ explicit Circle(double r) : radius_(r) {}
207
+ double area() const override { return 3.14159 * radius_ * radius_; }
208
+
209
+ private:
210
+ double radius_;
211
+ };
212
+ ```
213
+
214
+ ### Anti-Patterns
215
+
216
+ - Calling virtual functions in constructors/destructors (C.82)
217
+ - Using `memset`/`memcpy` on non-trivial types (C.90)
218
+ - Providing different default arguments for virtual function and overrider (C.140)
219
+ - Making data members `const` or references, which suppresses move/copy (C.12)
220
+
221
+ ## Resource Management (R.*)
222
+
223
+ ### Key Rules
224
+
225
+ | Rule | Summary |
226
+ |------|---------|
227
+ | **R.1** | Manage resources automatically using RAII |
228
+ | **R.3** | A raw pointer (`T*`) is non-owning |
229
+ | **R.5** | Prefer scoped objects; don't heap-allocate unnecessarily |
230
+ | **R.10** | Avoid `malloc()`/`free()` |
231
+ | **R.11** | Avoid calling `new` and `delete` explicitly |
232
+ | **R.20** | Use `unique_ptr` or `shared_ptr` to represent ownership |
233
+ | **R.21** | Prefer `unique_ptr` over `shared_ptr` unless sharing ownership |
234
+ | **R.22** | Use `make_shared()` to make `shared_ptr`s |
235
+
236
+ ### Smart Pointer Usage
237
+
238
+ ```cpp
239
+ // R.11 + R.20 + R.21: RAII with smart pointers
240
+ auto widget = std::make_unique<Widget>("config"); // unique ownership
241
+ auto cache = std::make_shared<Cache>(1024); // shared ownership
242
+
243
+ // R.3: Raw pointer = non-owning observer
244
+ void render(const Widget* w) { // does NOT own w
245
+ if (w) w->draw();
246
+ }
247
+
248
+ render(widget.get());
249
+ ```
250
+
251
+ ### RAII Pattern
252
+
253
+ ```cpp
254
+ // R.1: Resource acquisition is initialization
255
+ class FileHandle {
256
+ public:
257
+ explicit FileHandle(const std::string& path)
258
+ : handle_(std::fopen(path.c_str(), "r")) {
259
+ if (!handle_) throw std::runtime_error("Failed to open: " + path);
260
+ }
261
+
262
+ ~FileHandle() {
263
+ if (handle_) std::fclose(handle_);
264
+ }
265
+
266
+ FileHandle(const FileHandle&) = delete;
267
+ FileHandle& operator=(const FileHandle&) = delete;
268
+ FileHandle(FileHandle&& other) noexcept
269
+ : handle_(std::exchange(other.handle_, nullptr)) {}
270
+ FileHandle& operator=(FileHandle&& other) noexcept {
271
+ if (this != &other) {
272
+ if (handle_) std::fclose(handle_);
273
+ handle_ = std::exchange(other.handle_, nullptr);
274
+ }
275
+ return *this;
276
+ }
277
+
278
+ private:
279
+ std::FILE* handle_;
280
+ };
281
+ ```
282
+
283
+ ### Anti-Patterns
284
+
285
+ - Naked `new`/`delete` (R.11)
286
+ - `malloc()`/`free()` in C++ code (R.10)
287
+ - Multiple resource allocations in a single expression (R.13 -- exception safety hazard)
288
+ - `shared_ptr` where `unique_ptr` suffices (R.21)
289
+
290
+ ## Expressions & Statements (ES.*)
291
+
292
+ ### Key Rules
293
+
294
+ | Rule | Summary |
295
+ |------|---------|
296
+ | **ES.5** | Keep scopes small |
297
+ | **ES.20** | Always initialize an object |
298
+ | **ES.23** | Prefer `{}` initializer syntax |
299
+ | **ES.25** | Declare objects `const` or `constexpr` unless modification is intended |
300
+ | **ES.28** | Use lambdas for complex initialization of `const` variables |
301
+ | **ES.45** | Avoid magic constants; use symbolic constants |
302
+ | **ES.46** | Avoid narrowing/lossy arithmetic conversions |
303
+ | **ES.47** | Use `nullptr` rather than `0` or `NULL` |
304
+ | **ES.48** | Avoid casts |
305
+ | **ES.50** | Don't cast away `const` |
306
+
307
+ ### Initialization
308
+
309
+ ```cpp
310
+ // ES.20 + ES.23 + ES.25: Always initialize, prefer {}, default to const
311
+ const int max_retries{3};
312
+ const std::string name{"widget"};
313
+ const std::vector<int> primes{2, 3, 5, 7, 11};
314
+
315
+ // ES.28: Lambda for complex const initialization
316
+ const auto config = [&] {
317
+ Config c;
318
+ c.timeout = std::chrono::seconds{30};
319
+ c.retries = max_retries;
320
+ c.verbose = debug_mode;
321
+ return c;
322
+ }();
323
+ ```
324
+
325
+ ### Anti-Patterns
326
+
327
+ - Uninitialized variables (ES.20)
328
+ - Using `0` or `NULL` as pointer (ES.47 -- use `nullptr`)
329
+ - C-style casts (ES.48 -- use `static_cast`, `const_cast`, etc.)
330
+ - Casting away `const` (ES.50)
331
+ - Magic numbers without named constants (ES.45)
332
+ - Mixing signed and unsigned arithmetic (ES.100)
333
+ - Reusing names in nested scopes (ES.12)
334
+
335
+ ## Error Handling (E.*)
336
+
337
+ ### Key Rules
338
+
339
+ | Rule | Summary |
340
+ |------|---------|
341
+ | **E.1** | Develop an error-handling strategy early in a design |
342
+ | **E.2** | Throw an exception to signal that a function can't perform its assigned task |
343
+ | **E.6** | Use RAII to prevent leaks |
344
+ | **E.12** | Use `noexcept` when throwing is impossible or unacceptable |
345
+ | **E.14** | Use purpose-designed user-defined types as exceptions |
346
+ | **E.15** | Throw by value, catch by reference |
347
+ | **E.16** | Destructors, deallocation, and swap must never fail |
348
+ | **E.17** | Don't try to catch every exception in every function |
349
+
350
+ ### Exception Hierarchy
351
+
352
+ ```cpp
353
+ // E.14 + E.15: Custom exception types, throw by value, catch by reference
354
+ class AppError : public std::runtime_error {
355
+ public:
356
+ using std::runtime_error::runtime_error;
357
+ };
358
+
359
+ class NetworkError : public AppError {
360
+ public:
361
+ NetworkError(const std::string& msg, int code)
362
+ : AppError(msg), status_code(code) {}
363
+ int status_code;
364
+ };
365
+
366
+ void fetch_data(const std::string& url) {
367
+ // E.2: Throw to signal failure
368
+ throw NetworkError("connection refused", 503);
369
+ }
370
+
371
+ void run() {
372
+ try {
373
+ fetch_data("https://api.example.com");
374
+ } catch (const NetworkError& e) {
375
+ log_error(e.what(), e.status_code);
376
+ } catch (const AppError& e) {
377
+ log_error(e.what());
378
+ }
379
+ // E.17: Don't catch everything here -- let unexpected errors propagate
380
+ }
381
+ ```
382
+
383
+ ### Anti-Patterns
384
+
385
+ - Throwing built-in types like `int` or string literals (E.14)
386
+ - Catching by value (slicing risk) (E.15)
387
+ - Empty catch blocks that silently swallow errors
388
+ - Using exceptions for flow control (E.3)
389
+ - Error handling based on global state like `errno` (E.28)
390
+
391
+ ## Constants & Immutability (Con.*)
392
+
393
+ ### All Rules
394
+
395
+ | Rule | Summary |
396
+ |------|---------|
397
+ | **Con.1** | By default, make objects immutable |
398
+ | **Con.2** | By default, make member functions `const` |
399
+ | **Con.3** | By default, pass pointers and references to `const` |
400
+ | **Con.4** | Use `const` for values that don't change after construction |
401
+ | **Con.5** | Use `constexpr` for values computable at compile time |
402
+
403
+ ```cpp
404
+ // Con.1 through Con.5: Immutability by default
405
+ class Sensor {
406
+ public:
407
+ explicit Sensor(std::string id) : id_(std::move(id)) {}
408
+
409
+ // Con.2: const member functions by default
410
+ const std::string& id() const { return id_; }
411
+ double last_reading() const { return reading_; }
412
+
413
+ // Only non-const when mutation is required
414
+ void record(double value) { reading_ = value; }
415
+
416
+ private:
417
+ const std::string id_; // Con.4: never changes after construction
418
+ double reading_{0.0};
419
+ };
420
+
421
+ // Con.3: Pass by const reference
422
+ void display(const Sensor& s) {
423
+ std::cout << s.id() << ": " << s.last_reading() << '\n';
424
+ }
425
+
426
+ // Con.5: Compile-time constants
427
+ constexpr double PI = 3.14159265358979;
428
+ constexpr int MAX_SENSORS = 256;
429
+ ```
430
+
431
+ ## Concurrency & Parallelism (CP.*)
432
+
433
+ ### Key Rules
434
+
435
+ | Rule | Summary |
436
+ |------|---------|
437
+ | **CP.2** | Avoid data races |
438
+ | **CP.3** | Minimize explicit sharing of writable data |
439
+ | **CP.4** | Think in terms of tasks, rather than threads |
440
+ | **CP.8** | Don't use `volatile` for synchronization |
441
+ | **CP.20** | Use RAII, never plain `lock()`/`unlock()` |
442
+ | **CP.21** | Use `std::scoped_lock` to acquire multiple mutexes |
443
+ | **CP.22** | Never call unknown code while holding a lock |
444
+ | **CP.42** | Don't wait without a condition |
445
+ | **CP.44** | Remember to name your `lock_guard`s and `unique_lock`s |
446
+ | **CP.100** | Don't use lock-free programming unless you absolutely have to |
447
+
448
+ ### Safe Locking
449
+
450
+ ```cpp
451
+ // CP.20 + CP.44: RAII locks, always named
452
+ class ThreadSafeQueue {
453
+ public:
454
+ void push(int value) {
455
+ std::lock_guard<std::mutex> lock(mutex_); // CP.44: named!
456
+ queue_.push(value);
457
+ cv_.notify_one();
458
+ }
459
+
460
+ int pop() {
461
+ std::unique_lock<std::mutex> lock(mutex_);
462
+ // CP.42: Always wait with a condition
463
+ cv_.wait(lock, [this] { return !queue_.empty(); });
464
+ const int value = queue_.front();
465
+ queue_.pop();
466
+ return value;
467
+ }
468
+
469
+ private:
470
+ std::mutex mutex_; // CP.50: mutex with its data
471
+ std::condition_variable cv_;
472
+ std::queue<int> queue_;
473
+ };
474
+ ```
475
+
476
+ ### Multiple Mutexes
477
+
478
+ ```cpp
479
+ // CP.21: std::scoped_lock for multiple mutexes (deadlock-free)
480
+ void transfer(Account& from, Account& to, double amount) {
481
+ std::scoped_lock lock(from.mutex_, to.mutex_);
482
+ from.balance_ -= amount;
483
+ to.balance_ += amount;
484
+ }
485
+ ```
486
+
487
+ ### Anti-Patterns
488
+
489
+ - `volatile` for synchronization (CP.8 -- it's for hardware I/O only)
490
+ - Detaching threads (CP.26 -- lifetime management becomes nearly impossible)
491
+ - Unnamed lock guards: `std::lock_guard<std::mutex>(m);` destroys immediately (CP.44)
492
+ - Holding locks while calling callbacks (CP.22 -- deadlock risk)
493
+ - Lock-free programming without deep expertise (CP.100)
494
+
495
+ ## Templates & Generic Programming (T.*)
496
+
497
+ ### Key Rules
498
+
499
+ | Rule | Summary |
500
+ |------|---------|
501
+ | **T.1** | Use templates to raise the level of abstraction |
502
+ | **T.2** | Use templates to express algorithms for many argument types |
503
+ | **T.10** | Specify concepts for all template arguments |
504
+ | **T.11** | Use standard concepts whenever possible |
505
+ | **T.13** | Prefer shorthand notation for simple concepts |
506
+ | **T.43** | Prefer `using` over `typedef` |
507
+ | **T.120** | Use template metaprogramming only when you really need to |
508
+ | **T.144** | Don't specialize function templates (overload instead) |
509
+
510
+ ### Concepts (C++20)
511
+
512
+ ```cpp
513
+ #include <concepts>
514
+
515
+ // T.10 + T.11: Constrain templates with standard concepts
516
+ template<std::integral T>
517
+ T gcd(T a, T b) {
518
+ while (b != 0) {
519
+ a = std::exchange(b, a % b);
520
+ }
521
+ return a;
522
+ }
523
+
524
+ // T.13: Shorthand concept syntax
525
+ void sort(std::ranges::random_access_range auto& range) {
526
+ std::ranges::sort(range);
527
+ }
528
+
529
+ // Custom concept for domain-specific constraints
530
+ template<typename T>
531
+ concept Serializable = requires(const T& t) {
532
+ { t.serialize() } -> std::convertible_to<std::string>;
533
+ };
534
+
535
+ template<Serializable T>
536
+ void save(const T& obj, const std::string& path);
537
+ ```
538
+
539
+ ### Anti-Patterns
540
+
541
+ - Unconstrained templates in visible namespaces (T.47)
542
+ - Specializing function templates instead of overloading (T.144)
543
+ - Template metaprogramming where `constexpr` suffices (T.120)
544
+ - `typedef` instead of `using` (T.43)
545
+
546
+ ## Standard Library (SL.*)
547
+
548
+ ### Key Rules
549
+
550
+ | Rule | Summary |
551
+ |------|---------|
552
+ | **SL.1** | Use libraries wherever possible |
553
+ | **SL.2** | Prefer the standard library to other libraries |
554
+ | **SL.con.1** | Prefer `std::array` or `std::vector` over C arrays |
555
+ | **SL.con.2** | Prefer `std::vector` by default |
556
+ | **SL.str.1** | Use `std::string` to own character sequences |
557
+ | **SL.str.2** | Use `std::string_view` to refer to character sequences |
558
+ | **SL.io.50** | Avoid `endl` (use `'\n'` -- `endl` forces a flush) |
559
+
560
+ ```cpp
561
+ // SL.con.1 + SL.con.2: Prefer vector/array over C arrays
562
+ const std::array<int, 4> fixed_data{1, 2, 3, 4};
563
+ std::vector<std::string> dynamic_data;
564
+
565
+ // SL.str.1 + SL.str.2: string owns, string_view observes
566
+ std::string build_greeting(std::string_view name) {
567
+ return "Hello, " + std::string(name) + "!";
568
+ }
569
+
570
+ // SL.io.50: Use '\n' not endl
571
+ std::cout << "result: " << value << '\n';
572
+ ```
573
+
574
+ ## Enumerations (Enum.*)
575
+
576
+ ### Key Rules
577
+
578
+ | Rule | Summary |
579
+ |------|---------|
580
+ | **Enum.1** | Prefer enumerations over macros |
581
+ | **Enum.3** | Prefer `enum class` over plain `enum` |
582
+ | **Enum.5** | Don't use ALL_CAPS for enumerators |
583
+ | **Enum.6** | Avoid unnamed enumerations |
584
+
585
+ ```cpp
586
+ // Enum.3 + Enum.5: Scoped enum, no ALL_CAPS
587
+ enum class Color { red, green, blue };
588
+ enum class LogLevel { debug, info, warning, error };
589
+
590
+ // BAD: plain enum leaks names, ALL_CAPS clashes with macros
591
+ enum { RED, GREEN, BLUE }; // Enum.3 + Enum.5 + Enum.6 violation
592
+ #define MAX_SIZE 100 // Enum.1 violation -- use constexpr
593
+ ```
594
+
595
+ ## Source Files & Naming (SF.*, NL.*)
596
+
597
+ ### Key Rules
598
+
599
+ | Rule | Summary |
600
+ |------|---------|
601
+ | **SF.1** | Use `.cpp` for code files and `.h` for interface files |
602
+ | **SF.7** | Don't write `using namespace` at global scope in a header |
603
+ | **SF.8** | Use `#include` guards for all `.h` files |
604
+ | **SF.11** | Header files should be self-contained |
605
+ | **NL.5** | Avoid encoding type information in names (no Hungarian notation) |
606
+ | **NL.8** | Use a consistent naming style |
607
+ | **NL.9** | Use ALL_CAPS for macro names only |
608
+ | **NL.10** | Prefer `underscore_style` names |
609
+
610
+ ### Header Guard
611
+
612
+ ```cpp
613
+ // SF.8: Include guard (or #pragma once)
614
+ #ifndef PROJECT_MODULE_WIDGET_H
615
+ #define PROJECT_MODULE_WIDGET_H
616
+
617
+ // SF.11: Self-contained -- include everything this header needs
618
+ #include <string>
619
+ #include <vector>
620
+
621
+ namespace project::module {
622
+
623
+ class Widget {
624
+ public:
625
+ explicit Widget(std::string name);
626
+ const std::string& name() const;
627
+
628
+ private:
629
+ std::string name_;
630
+ };
631
+
632
+ } // namespace project::module
633
+
634
+ #endif // PROJECT_MODULE_WIDGET_H
635
+ ```
636
+
637
+ ### Naming Conventions
638
+
639
+ ```cpp
640
+ // NL.8 + NL.10: Consistent underscore_style
641
+ namespace my_project {
642
+
643
+ constexpr int max_buffer_size = 4096; // NL.9: not ALL_CAPS (it's not a macro)
644
+
645
+ class tcp_connection { // underscore_style class
646
+ public:
647
+ void send_message(std::string_view msg);
648
+ bool is_connected() const;
649
+
650
+ private:
651
+ std::string host_; // trailing underscore for members
652
+ int port_;
653
+ };
654
+
655
+ } // namespace my_project
656
+ ```
657
+
658
+ ### Anti-Patterns
659
+
660
+ - `using namespace std;` in a header at global scope (SF.7)
661
+ - Headers that depend on inclusion order (SF.10, SF.11)
662
+ - Hungarian notation like `strName`, `iCount` (NL.5)
663
+ - ALL_CAPS for anything other than macros (NL.9)
664
+
665
+ ## Performance (Per.*)
666
+
667
+ ### Key Rules
668
+
669
+ | Rule | Summary |
670
+ |------|---------|
671
+ | **Per.1** | Don't optimize without reason |
672
+ | **Per.2** | Don't optimize prematurely |
673
+ | **Per.6** | Don't make claims about performance without measurements |
674
+ | **Per.7** | Design to enable optimization |
675
+ | **Per.10** | Rely on the static type system |
676
+ | **Per.11** | Move computation from run time to compile time |
677
+ | **Per.19** | Access memory predictably |
678
+
679
+ ### Guidelines
680
+
681
+ ```cpp
682
+ // Per.11: Compile-time computation where possible
683
+ constexpr auto lookup_table = [] {
684
+ std::array<int, 256> table{};
685
+ for (int i = 0; i < 256; ++i) {
686
+ table[i] = i * i;
687
+ }
688
+ return table;
689
+ }();
690
+
691
+ // Per.19: Prefer contiguous data for cache-friendliness
692
+ std::vector<Point> points; // GOOD: contiguous
693
+ std::vector<std::unique_ptr<Point>> indirect_points; // BAD: pointer chasing
694
+ ```
695
+
696
+ ### Anti-Patterns
697
+
698
+ - Optimizing without profiling data (Per.1, Per.6)
699
+ - Choosing "clever" low-level code over clear abstractions (Per.4, Per.5)
700
+ - Ignoring data layout and cache behavior (Per.19)
701
+
702
+ ## Quick Reference Checklist
703
+
704
+ Before marking C++ work complete:
705
+
706
+ - [ ] No raw `new`/`delete` -- use smart pointers or RAII (R.11)
707
+ - [ ] Objects initialized at declaration (ES.20)
708
+ - [ ] Variables are `const`/`constexpr` by default (Con.1, ES.25)
709
+ - [ ] Member functions are `const` where possible (Con.2)
710
+ - [ ] `enum class` instead of plain `enum` (Enum.3)
711
+ - [ ] `nullptr` instead of `0`/`NULL` (ES.47)
712
+ - [ ] No narrowing conversions (ES.46)
713
+ - [ ] No C-style casts (ES.48)
714
+ - [ ] Single-argument constructors are `explicit` (C.46)
715
+ - [ ] Rule of Zero or Rule of Five applied (C.20, C.21)
716
+ - [ ] Base class destructors are public virtual or protected non-virtual (C.35)
717
+ - [ ] Templates are constrained with concepts (T.10)
718
+ - [ ] No `using namespace` in headers at global scope (SF.7)
719
+ - [ ] Headers have include guards and are self-contained (SF.8, SF.11)
720
+ - [ ] Locks use RAII (`scoped_lock`/`lock_guard`) (CP.20)
721
+ - [ ] Exceptions are custom types, thrown by value, caught by reference (E.14, E.15)
722
+ - [ ] `'\n'` instead of `std::endl` (SL.io.50)
723
+ - [ ] No magic numbers (ES.45)