@su-record/vibe 2.9.21 → 2.9.23

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 (466) hide show
  1. package/.env.example +37 -37
  2. package/CLAUDE.md +105 -104
  3. package/LICENSE +21 -21
  4. package/agents/architect-low.md +41 -41
  5. package/agents/architect-medium.md +59 -59
  6. package/agents/architect.md +80 -80
  7. package/agents/build-error-resolver.md +115 -115
  8. package/agents/compounder.md +261 -261
  9. package/agents/diagrammer.md +178 -178
  10. package/agents/docs/api-documenter.md +99 -99
  11. package/agents/docs/changelog-writer.md +93 -93
  12. package/agents/e2e-tester.md +294 -294
  13. package/agents/event/event-comms.md +78 -78
  14. package/agents/event/event-content.md +68 -68
  15. package/agents/event/event-image.md +95 -95
  16. package/agents/event/event-ops.md +84 -84
  17. package/agents/event/event-scheduler.md +69 -69
  18. package/agents/event/event-speaker.md +86 -86
  19. package/agents/explorer-low.md +42 -42
  20. package/agents/explorer-medium.md +59 -59
  21. package/agents/explorer.md +48 -48
  22. package/agents/implementer-low.md +43 -43
  23. package/agents/implementer-medium.md +52 -52
  24. package/agents/implementer.md +54 -54
  25. package/agents/junior-mentor.md +141 -141
  26. package/agents/planning/requirements-analyst.md +84 -84
  27. package/agents/planning/ux-advisor.md +83 -83
  28. package/agents/qa/acceptance-tester.md +86 -86
  29. package/agents/qa/edge-case-finder.md +93 -93
  30. package/agents/qa/qa-coordinator.md +131 -131
  31. package/agents/refactor-cleaner.md +143 -143
  32. package/agents/research/best-practices-agent.md +199 -199
  33. package/agents/research/codebase-patterns-agent.md +157 -157
  34. package/agents/research/framework-docs-agent.md +188 -188
  35. package/agents/research/security-advisory-agent.md +213 -213
  36. package/agents/review/architecture-reviewer.md +107 -107
  37. package/agents/review/complexity-reviewer.md +116 -116
  38. package/agents/review/data-integrity-reviewer.md +88 -88
  39. package/agents/review/git-history-reviewer.md +103 -103
  40. package/agents/review/performance-reviewer.md +86 -86
  41. package/agents/review/python-reviewer.md +150 -150
  42. package/agents/review/rails-reviewer.md +139 -139
  43. package/agents/review/react-reviewer.md +144 -144
  44. package/agents/review/security-reviewer.md +80 -80
  45. package/agents/review/simplicity-reviewer.md +140 -140
  46. package/agents/review/test-coverage-reviewer.md +116 -116
  47. package/agents/review/typescript-reviewer.md +127 -127
  48. package/agents/searcher.md +54 -54
  49. package/agents/simplifier.md +120 -120
  50. package/agents/teams/debug-team.md +70 -70
  51. package/agents/teams/dev-team.md +88 -88
  52. package/agents/teams/docs-team.md +80 -80
  53. package/agents/teams/figma/figma-analyst.md +52 -52
  54. package/agents/teams/figma/figma-architect.md +112 -112
  55. package/agents/teams/figma/figma-auditor.md +82 -82
  56. package/agents/teams/figma/figma-builder.md +100 -100
  57. package/agents/teams/figma-team.md +85 -85
  58. package/agents/teams/fullstack-team.md +83 -83
  59. package/agents/teams/lite-team.md +69 -69
  60. package/agents/teams/migration-team.md +78 -78
  61. package/agents/teams/refactor-team.md +94 -94
  62. package/agents/teams/research-team.md +86 -86
  63. package/agents/teams/review-debate-team.md +125 -125
  64. package/agents/teams/security-team.md +81 -81
  65. package/agents/tester.md +49 -49
  66. package/agents/ui/ui-a11y-auditor.md +93 -93
  67. package/agents/ui/ui-antipattern-detector.md +102 -102
  68. package/agents/ui/ui-dataviz-advisor.md +69 -69
  69. package/agents/ui/ui-design-system-gen.md +57 -57
  70. package/agents/ui/ui-industry-analyzer.md +49 -49
  71. package/agents/ui/ui-layout-architect.md +65 -65
  72. package/agents/ui/ui-stack-implementer.md +68 -68
  73. package/agents/ui/ux-compliance-reviewer.md +81 -81
  74. package/agents/ui-previewer.md +258 -258
  75. package/commands/vibe.analyze.md +533 -533
  76. package/commands/vibe.contract.md +105 -105
  77. package/commands/vibe.docs.md +33 -33
  78. package/commands/vibe.event.md +163 -163
  79. package/commands/vibe.figma.md +584 -584
  80. package/commands/vibe.harness.md +177 -177
  81. package/commands/vibe.regress.md +73 -73
  82. package/commands/vibe.review.md +624 -624
  83. package/commands/vibe.run.md +1940 -1940
  84. package/commands/vibe.scaffold.md +195 -195
  85. package/commands/vibe.spec.md +577 -577
  86. package/commands/vibe.test.md +96 -0
  87. package/commands/vibe.trace.md +276 -276
  88. package/commands/vibe.utils.md +413 -413
  89. package/commands/vibe.verify.md +550 -550
  90. package/dist/cli/collaborator.js +52 -52
  91. package/dist/cli/commands/codex-proxy.js +15 -15
  92. package/dist/cli/commands/config.js +9 -9
  93. package/dist/cli/commands/evolution.js +12 -12
  94. package/dist/cli/commands/figma.js +20 -20
  95. package/dist/cli/commands/info.js +52 -52
  96. package/dist/cli/commands/init.d.ts.map +1 -1
  97. package/dist/cli/commands/init.js +16 -5
  98. package/dist/cli/commands/init.js.map +1 -1
  99. package/dist/cli/commands/remove.js +14 -14
  100. package/dist/cli/commands/sentinel.js +27 -27
  101. package/dist/cli/commands/skills.js +5 -5
  102. package/dist/cli/commands/slack.js +10 -10
  103. package/dist/cli/commands/stats.js +6 -6
  104. package/dist/cli/commands/telegram.js +12 -12
  105. package/dist/cli/commands/update.d.ts.map +1 -1
  106. package/dist/cli/commands/update.js +16 -0
  107. package/dist/cli/commands/update.js.map +1 -1
  108. package/dist/cli/detect.js +32 -32
  109. package/dist/cli/index.js +33 -33
  110. package/dist/cli/llm/claude-commands.js +16 -16
  111. package/dist/cli/llm/config.js +18 -18
  112. package/dist/cli/llm/gemini-commands.js +16 -16
  113. package/dist/cli/llm/gpt-commands.js +19 -19
  114. package/dist/cli/llm/help.js +21 -21
  115. package/dist/cli/postinstall/cursor-agents.js +32 -32
  116. package/dist/cli/postinstall/cursor-rules.js +83 -83
  117. package/dist/cli/postinstall/cursor-skills.js +743 -743
  118. package/dist/cli/setup/Provisioner.js +42 -42
  119. package/dist/infra/lib/DeepInit.js +24 -24
  120. package/dist/infra/lib/IterationTracker.js +11 -11
  121. package/dist/infra/lib/PythonParser.js +108 -108
  122. package/dist/infra/lib/ReviewRace.js +96 -96
  123. package/dist/infra/lib/SkillFrontmatter.js +28 -28
  124. package/dist/infra/lib/SkillQualityGate.js +9 -9
  125. package/dist/infra/lib/SkillRepository.js +159 -159
  126. package/dist/infra/lib/UltraQA.js +99 -99
  127. package/dist/infra/lib/autonomy/AuditStore.js +41 -41
  128. package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
  129. package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
  130. package/dist/infra/lib/autonomy/PolicyEngine.d.ts +3 -3
  131. package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
  132. package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
  133. package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
  134. package/dist/infra/lib/embedding/VectorStore.js +22 -22
  135. package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
  136. package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
  137. package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
  138. package/dist/infra/lib/evolution/InsightStore.js +90 -90
  139. package/dist/infra/lib/evolution/ParityTester.js +57 -57
  140. package/dist/infra/lib/evolution/RollbackManager.js +5 -5
  141. package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
  142. package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
  143. package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
  144. package/dist/infra/lib/evolution/UsageTracker.js +28 -28
  145. package/dist/infra/lib/gemini/orchestration.js +5 -5
  146. package/dist/infra/lib/gpt/orchestration.js +4 -4
  147. package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
  148. package/dist/infra/lib/memory/MemorySearch.js +57 -57
  149. package/dist/infra/lib/memory/MemoryStorage.js +181 -181
  150. package/dist/infra/lib/memory/ObservationStore.js +28 -28
  151. package/dist/infra/lib/memory/ReflectionStore.js +30 -30
  152. package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
  153. package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
  154. package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
  155. package/dist/infra/orchestrator/AgentManager.js +12 -12
  156. package/dist/infra/orchestrator/AgentRegistry.js +65 -65
  157. package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
  158. package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
  159. package/dist/infra/orchestrator/parallelResearch.js +24 -24
  160. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  161. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  162. package/dist/tools/memory/createMemoryTimeline.js +10 -10
  163. package/dist/tools/memory/getMemoryGraph.js +12 -12
  164. package/dist/tools/memory/getSessionContext.js +9 -9
  165. package/dist/tools/memory/linkMemories.js +14 -14
  166. package/dist/tools/memory/listMemories.js +4 -4
  167. package/dist/tools/memory/recallMemory.js +4 -4
  168. package/dist/tools/memory/saveMemory.js +4 -4
  169. package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
  170. package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
  171. package/dist/tools/semantic/astGrep.test.js +6 -6
  172. package/dist/tools/spec/prdParser.test.js +171 -171
  173. package/dist/tools/spec/specGenerator.js +169 -169
  174. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  175. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  176. package/hooks/gemini-hooks.json +73 -73
  177. package/hooks/hooks.json +126 -126
  178. package/hooks/scripts/__tests__/keyword-detector.test.js +199 -199
  179. package/hooks/scripts/__tests__/pre-tool-guard.test.js +368 -368
  180. package/hooks/scripts/__tests__/sentinel-guard.test.js +208 -208
  181. package/hooks/scripts/auto-commit.js +97 -97
  182. package/hooks/scripts/auto-format.js +64 -64
  183. package/hooks/scripts/auto-test.js +81 -81
  184. package/hooks/scripts/code-check.js +268 -268
  185. package/hooks/scripts/codex-detect.js +46 -46
  186. package/hooks/scripts/codex-review-gate.js +80 -80
  187. package/hooks/scripts/command-log.js +32 -32
  188. package/hooks/scripts/context-save.js +353 -353
  189. package/hooks/scripts/evolution-engine.js +91 -91
  190. package/hooks/scripts/figma-extract.js +635 -635
  191. package/hooks/scripts/figma-guard.js +219 -219
  192. package/hooks/scripts/figma-refine.js +315 -315
  193. package/hooks/scripts/figma-to-scss.js +394 -394
  194. package/hooks/scripts/figma-validate.js +353 -353
  195. package/hooks/scripts/hud-status.js +321 -321
  196. package/hooks/scripts/keyword-detector.js +214 -214
  197. package/hooks/scripts/lib/scope-from-spec.js +261 -0
  198. package/hooks/scripts/llm-orchestrate.js +645 -645
  199. package/hooks/scripts/post-edit.js +32 -32
  200. package/hooks/scripts/pr-test-gate.js +52 -52
  201. package/hooks/scripts/pre-tool-dispatcher.js +5 -0
  202. package/hooks/scripts/pre-tool-guard.js +254 -254
  203. package/hooks/scripts/prompt-dispatcher.js +190 -190
  204. package/hooks/scripts/scope-guard.js +145 -0
  205. package/hooks/scripts/sentinel-guard.js +130 -130
  206. package/hooks/scripts/session-start.js +186 -177
  207. package/hooks/scripts/skill-injector.js +83 -83
  208. package/hooks/scripts/stop-notify.js +209 -209
  209. package/hooks/scripts/utils.js +257 -257
  210. package/languages/csharp-unity.md +515 -515
  211. package/languages/gdscript-godot.md +470 -470
  212. package/languages/ruby-rails.md +489 -489
  213. package/languages/typescript-angular.md +433 -433
  214. package/languages/typescript-astro.md +416 -416
  215. package/languages/typescript-electron.md +406 -406
  216. package/languages/typescript-nestjs.md +524 -524
  217. package/languages/typescript-svelte.md +407 -407
  218. package/languages/typescript-tauri.md +365 -365
  219. package/package.json +10 -5
  220. package/skills/agents-md/SKILL.md +121 -121
  221. package/skills/agents-md/rubrics/what-to-keep.md +49 -49
  222. package/skills/agents-md/templates/agents-md.md +36 -36
  223. package/skills/arch-guard/SKILL.md +181 -181
  224. package/skills/arch-guard/agents/detector.md +48 -48
  225. package/skills/arch-guard/agents/reporter.md +48 -48
  226. package/skills/arch-guard/agents/rule-generator.md +49 -49
  227. package/skills/arch-guard/agents/violation-checker.md +51 -51
  228. package/skills/arch-guard/frameworks/clean-architecture.md +108 -108
  229. package/skills/arch-guard/frameworks/solid.md +102 -102
  230. package/skills/arch-guard/scripts/check-boundaries.js +90 -90
  231. package/skills/arch-guard/templates/arch-rules.json +47 -47
  232. package/skills/arch-guard/templates/violation-report.md +53 -53
  233. package/skills/brand-assets/SKILL.md +147 -147
  234. package/skills/brand-assets/rubrics/asset-checklist.md +98 -98
  235. package/skills/brand-assets/templates/brand-guide.md +161 -161
  236. package/skills/capability-loop/SKILL.md +272 -272
  237. package/skills/capability-loop/agents/capability-designer.md +61 -61
  238. package/skills/capability-loop/agents/failure-analyst.md +55 -55
  239. package/skills/capability-loop/agents/implementer.md +50 -50
  240. package/skills/capability-loop/agents/tester.md +53 -53
  241. package/skills/capability-loop/templates/capability-spec.md +118 -118
  242. package/skills/capability-loop/templates/failure-analysis.md +118 -118
  243. package/skills/characterization-test/SKILL.md +207 -207
  244. package/skills/characterization-test/agents/behavior-capturer.md +50 -50
  245. package/skills/characterization-test/agents/coverage-checker.md +54 -54
  246. package/skills/characterization-test/agents/reporter.md +50 -50
  247. package/skills/characterization-test/agents/test-writer.md +49 -49
  248. package/skills/characterization-test/rubrics/coverage-criteria.md +53 -53
  249. package/skills/characterization-test/templates/test-template.ts +101 -101
  250. package/skills/chub-usage/SKILL.md +139 -139
  251. package/skills/claude-md-guide/SKILL.md +351 -351
  252. package/skills/claude-md-guide/rubrics/anti-patterns.md +88 -88
  253. package/skills/claude-md-guide/templates/claude-md.md +54 -54
  254. package/skills/commerce-patterns/SKILL.md +64 -64
  255. package/skills/commerce-patterns/rubrics/checkout-flow.md +48 -48
  256. package/skills/commerce-patterns/templates/product-schema.md +85 -85
  257. package/skills/commit-push-pr/SKILL.md +77 -77
  258. package/skills/commit-push-pr/agents/change-analyzer.md +55 -55
  259. package/skills/commit-push-pr/agents/message-writer.md +50 -50
  260. package/skills/commit-push-pr/agents/pr-writer.md +58 -58
  261. package/skills/commit-push-pr/agents/reviewer.md +52 -52
  262. package/skills/commit-push-pr/rubrics/commit-message.md +73 -73
  263. package/skills/commit-push-pr/templates/pr-body.md +63 -63
  264. package/skills/context7-usage/SKILL.md +106 -106
  265. package/skills/context7-usage/rubrics/when-to-use.md +50 -50
  266. package/skills/create-prd/SKILL.md +90 -90
  267. package/skills/create-prd/agents/edge-case-finder.md +48 -48
  268. package/skills/create-prd/agents/prioritizer.md +60 -60
  269. package/skills/create-prd/agents/requirements-writer.md +48 -48
  270. package/skills/create-prd/agents/researcher.md +55 -55
  271. package/skills/create-prd/agents/reviewer.md +54 -54
  272. package/skills/create-prd/frameworks/jobs-to-be-done.md +96 -96
  273. package/skills/create-prd/frameworks/rice-scoring.md +97 -97
  274. package/skills/create-prd/orchestrator.md +70 -70
  275. package/skills/create-prd/rubrics/completeness.md +58 -58
  276. package/skills/create-prd/templates/prd.md +139 -139
  277. package/skills/design-audit/SKILL.md +152 -152
  278. package/skills/design-audit/agents/a11y-auditor.md +43 -43
  279. package/skills/design-audit/agents/performance-auditor.md +46 -46
  280. package/skills/design-audit/agents/responsive-auditor.md +46 -46
  281. package/skills/design-audit/agents/scorer.md +47 -47
  282. package/skills/design-audit/agents/slop-detector.md +47 -47
  283. package/skills/design-audit/frameworks/core-web-vitals.md +107 -107
  284. package/skills/design-audit/frameworks/wcag-checklist.md +64 -64
  285. package/skills/design-audit/orchestrator.md +64 -64
  286. package/skills/design-audit/rubrics/ai-slop-patterns.md +83 -83
  287. package/skills/design-audit/rubrics/scoring.md +63 -63
  288. package/skills/design-audit/templates/report.md +88 -88
  289. package/skills/design-critique/SKILL.md +139 -139
  290. package/skills/design-critique/rubrics/ux-heuristics.md +143 -143
  291. package/skills/design-critique/templates/critique-report.md +86 -86
  292. package/skills/design-distill/SKILL.md +130 -130
  293. package/skills/design-distill/templates/design-system.md +132 -132
  294. package/skills/design-normalize/SKILL.md +133 -133
  295. package/skills/design-normalize/rubrics/token-naming.md +117 -117
  296. package/skills/design-normalize/templates/token-audit.md +89 -89
  297. package/skills/design-polish/SKILL.md +131 -131
  298. package/skills/design-polish/rubrics/polish-checklist.md +68 -68
  299. package/skills/design-polish/templates/polish-report.md +64 -64
  300. package/skills/design-teach/SKILL.md +182 -182
  301. package/skills/design-teach/rubrics/brand-personality.md +73 -73
  302. package/skills/design-teach/templates/design-context.json +36 -36
  303. package/skills/devlog/SKILL.md +143 -143
  304. package/skills/e2e-commerce/SKILL.md +62 -62
  305. package/skills/e2e-commerce/templates/test-scenarios.md +170 -170
  306. package/skills/event-comms/SKILL.md +172 -172
  307. package/skills/event-comms/templates/email-invite.md +99 -99
  308. package/skills/event-comms/templates/sns-post.md +133 -133
  309. package/skills/event-ops/SKILL.md +207 -207
  310. package/skills/event-ops/rubrics/contingency.md +85 -85
  311. package/skills/event-ops/templates/d-day-checklist.md +65 -65
  312. package/skills/event-planning/SKILL.md +144 -144
  313. package/skills/event-planning/rubrics/timeline.md +70 -70
  314. package/skills/event-planning/templates/event-plan.md +91 -91
  315. package/skills/exec-plan/SKILL.md +149 -149
  316. package/skills/exec-plan/agents/decomposer.md +47 -47
  317. package/skills/exec-plan/agents/dependency-mapper.md +44 -44
  318. package/skills/exec-plan/agents/estimator.md +43 -43
  319. package/skills/exec-plan/agents/validator.md +55 -55
  320. package/skills/exec-plan/orchestrator.md +70 -70
  321. package/skills/exec-plan/rubrics/complexity-scoring.md +75 -75
  322. package/skills/exec-plan/templates/plan.md +147 -147
  323. package/skills/git-worktree/SKILL.md +73 -73
  324. package/skills/git-worktree/rubrics/when-to-use.md +55 -55
  325. package/skills/handoff/SKILL.md +110 -110
  326. package/skills/handoff/agents/context-summarizer.md +51 -51
  327. package/skills/handoff/agents/document-writer.md +63 -63
  328. package/skills/handoff/agents/state-collector.md +53 -53
  329. package/skills/handoff/agents/verifier.md +48 -48
  330. package/skills/handoff/rubrics/completeness.md +62 -62
  331. package/skills/handoff/templates/handoff.md +107 -107
  332. package/skills/parallel-research/SKILL.md +104 -104
  333. package/skills/parallel-research/agents/best-practices.md +43 -43
  334. package/skills/parallel-research/agents/codebase-patterns.md +46 -46
  335. package/skills/parallel-research/agents/framework-docs.md +45 -45
  336. package/skills/parallel-research/agents/security-advisory.md +46 -46
  337. package/skills/parallel-research/agents/synthesizer.md +57 -57
  338. package/skills/parallel-research/experts/best-practices.md +50 -50
  339. package/skills/parallel-research/experts/codebase-patterns.md +70 -70
  340. package/skills/parallel-research/experts/framework-docs.md +65 -65
  341. package/skills/parallel-research/experts/security-advisory.md +69 -69
  342. package/skills/parallel-research/orchestrator.md +79 -79
  343. package/skills/parallel-research/templates/awesome-list.md +32 -32
  344. package/skills/parallel-research/templates/paper.md +88 -88
  345. package/skills/parallel-research/templates/synthesis.md +101 -101
  346. package/skills/prioritization-frameworks/SKILL.md +87 -87
  347. package/skills/prioritization-frameworks/rubrics/frameworks.md +79 -79
  348. package/skills/prioritization-frameworks/templates/scoring-matrix.md +69 -69
  349. package/skills/priority-todos/SKILL.md +64 -64
  350. package/skills/priority-todos/rubrics/prioritization.md +70 -70
  351. package/skills/priority-todos/templates/todo-board.md +59 -59
  352. package/skills/seo-checklist/SKILL.md +58 -58
  353. package/skills/seo-checklist/frameworks/structured-data.md +153 -153
  354. package/skills/seo-checklist/rubrics/content-seo.md +42 -42
  355. package/skills/seo-checklist/rubrics/technical-seo.md +48 -48
  356. package/skills/techdebt/SKILL.md +124 -124
  357. package/skills/techdebt/agents/analyzer.md +50 -50
  358. package/skills/techdebt/agents/fixer.md +41 -41
  359. package/skills/techdebt/agents/reviewer.md +47 -47
  360. package/skills/techdebt/agents/scanner.md +44 -44
  361. package/skills/techdebt/orchestrator.md +70 -70
  362. package/skills/techdebt/rubrics/severity.md +51 -51
  363. package/skills/techdebt/scripts/scan.js +90 -90
  364. package/skills/techdebt/templates/report.md +86 -86
  365. package/skills/tool-fallback/SKILL.md +104 -104
  366. package/skills/tool-fallback/rubrics/fallback-chain.md +58 -58
  367. package/skills/typescript-advanced-types/SKILL.md +67 -67
  368. package/skills/typescript-advanced-types/rubrics/type-patterns.md +109 -109
  369. package/skills/ui-ux-pro-max/SKILL.md +236 -236
  370. package/skills/ui-ux-pro-max/reference/color-and-contrast.md +517 -517
  371. package/skills/ui-ux-pro-max/reference/interaction-design.md +544 -544
  372. package/skills/ui-ux-pro-max/reference/motion-design.md +591 -591
  373. package/skills/ui-ux-pro-max/reference/responsive-design.md +463 -463
  374. package/skills/ui-ux-pro-max/reference/spatial-design.md +390 -390
  375. package/skills/ui-ux-pro-max/reference/typography.md +455 -455
  376. package/skills/ui-ux-pro-max/reference/ux-writing.md +469 -469
  377. package/skills/ui-ux-pro-max/rubrics/interaction-states.md +83 -83
  378. package/skills/ui-ux-pro-max/rubrics/responsive-breakpoints.md +99 -99
  379. package/skills/user-personas/SKILL.md +75 -75
  380. package/skills/user-personas/rubrics/research-methods.md +56 -56
  381. package/skills/user-personas/templates/persona.md +89 -89
  382. package/skills/vercel-react-best-practices/SKILL.md +60 -60
  383. package/skills/vercel-react-best-practices/rubrics/performance.md +82 -82
  384. package/skills/vercel-react-best-practices/rubrics/server-components.md +86 -86
  385. package/skills/vibe-contract/SKILL.md +166 -166
  386. package/skills/vibe-docs/templates/architecture.md +80 -80
  387. package/skills/vibe-docs/templates/readme.md +84 -84
  388. package/skills/vibe-docs/templates/release-notes.md +74 -74
  389. package/skills/vibe-figma/SKILL.md +363 -363
  390. package/skills/vibe-figma/rubrics/extraction-checklist.md +51 -51
  391. package/skills/vibe-figma/templates/component-index.md +126 -126
  392. package/skills/vibe-figma/templates/component-spec.md +168 -168
  393. package/skills/vibe-figma/templates/figma-handoff.md +100 -100
  394. package/skills/vibe-figma/templates/remapped-tree.md +277 -277
  395. package/skills/vibe-figma-convert/SKILL.md +235 -235
  396. package/skills/vibe-figma-convert/rubrics/conversion-rules.md +141 -141
  397. package/skills/vibe-figma-convert/templates/component.md +140 -140
  398. package/skills/vibe-figma-extract/SKILL.md +219 -219
  399. package/skills/vibe-figma-extract/rubrics/image-rules.md +157 -157
  400. package/skills/vibe-interview/SKILL.md +358 -358
  401. package/skills/vibe-interview/checklists/api.md +101 -101
  402. package/skills/vibe-interview/checklists/feature.md +88 -88
  403. package/skills/vibe-interview/checklists/library.md +95 -95
  404. package/skills/vibe-interview/checklists/mobile.md +89 -89
  405. package/skills/vibe-interview/checklists/webapp.md +97 -97
  406. package/skills/vibe-interview/checklists/website.md +99 -99
  407. package/skills/vibe-plan/SKILL.md +254 -254
  408. package/skills/vibe-regress/SKILL.md +174 -174
  409. package/skills/vibe-regress/templates/bug.md +44 -44
  410. package/skills/vibe-regress/templates/test-jest.md +29 -29
  411. package/skills/vibe-regress/templates/test-vitest.md +30 -30
  412. package/skills/vibe-spec/SKILL.md +1195 -1195
  413. package/skills/vibe-spec-review/SKILL.md +726 -726
  414. package/skills/vibe-test/SKILL.md +247 -0
  415. package/skills/video-production/SKILL.md +52 -52
  416. package/skills/video-production/rubrics/quality-checklist.md +58 -58
  417. package/skills/video-production/templates/production-plan.md +104 -104
  418. package/vibe/config.json +29 -29
  419. package/vibe/constitution.md +227 -227
  420. package/vibe/rules/principles/communication-guide.md +98 -98
  421. package/vibe/rules/principles/development-philosophy.md +52 -52
  422. package/vibe/rules/principles/quick-start.md +102 -102
  423. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  424. package/vibe/rules/quality/checklist.md +276 -276
  425. package/vibe/rules/quality/performance.md +236 -236
  426. package/vibe/rules/quality/testing-strategy.md +440 -440
  427. package/vibe/rules/standards/anti-patterns.md +541 -541
  428. package/vibe/rules/standards/code-structure.md +291 -291
  429. package/vibe/rules/standards/complexity-metrics.md +313 -313
  430. package/vibe/rules/standards/git-workflow.md +237 -237
  431. package/vibe/rules/standards/naming-conventions.md +198 -198
  432. package/vibe/rules/standards/security.md +305 -305
  433. package/vibe/rules/writing/document-style.md +74 -74
  434. package/vibe/setup.sh +31 -31
  435. package/vibe/templates/claudemd-template.md +74 -74
  436. package/vibe/templates/constitution-template.md +267 -267
  437. package/vibe/templates/contract-backend-template.md +526 -526
  438. package/vibe/templates/contract-frontend-template.md +599 -599
  439. package/vibe/templates/feature-template.md +96 -96
  440. package/vibe/templates/plan-template.md +194 -194
  441. package/vibe/templates/spec-template.md +221 -221
  442. package/vibe/ui-ux-data/charts.csv +26 -26
  443. package/vibe/ui-ux-data/colors.csv +97 -97
  444. package/vibe/ui-ux-data/icons.csv +101 -101
  445. package/vibe/ui-ux-data/landing.csv +31 -31
  446. package/vibe/ui-ux-data/products.csv +96 -96
  447. package/vibe/ui-ux-data/react-performance.csv +45 -45
  448. package/vibe/ui-ux-data/stacks/astro.csv +54 -54
  449. package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
  450. package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
  451. package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
  452. package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
  453. package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
  454. package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
  455. package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
  456. package/vibe/ui-ux-data/stacks/react.csv +54 -54
  457. package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
  458. package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
  459. package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
  460. package/vibe/ui-ux-data/stacks/vue.csv +50 -50
  461. package/vibe/ui-ux-data/styles.csv +68 -68
  462. package/vibe/ui-ux-data/typography.csv +57 -57
  463. package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
  464. package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
  465. package/vibe/ui-ux-data/version.json +31 -31
  466. package/vibe/ui-ux-data/web-interface.csv +31 -31
@@ -1,517 +1,517 @@
1
- # Color & Contrast — Deep Reference Guide
2
-
3
- A systematic reference for building accessible, perceptually consistent color systems in web UI. Covers the modern OKLCH color space, token architecture, dark mode strategy, and WCAG compliance patterns.
4
-
5
- ---
6
-
7
- ## OKLCH Color Space
8
-
9
- ### Why OKLCH Over HSL or HEX
10
-
11
- The legacy HSL color space is perceptually non-uniform: a yellow at `hsl(60, 100%, 50%)` and a blue at `hsl(240, 100%, 50%)` have the same nominal lightness value, but the yellow reads dramatically brighter to the human eye. This creates real problems when you want consistent contrast across a palette.
12
-
13
- OKLCH solves this. It maps color to how the human visual system actually perceives brightness, chroma, and hue. Two colors with the same `L` value in OKLCH will appear equally bright to a viewer, regardless of their hue. This makes predictable contrast possible without manual adjustments per hue.
14
-
15
- ### Syntax
16
-
17
- ```css
18
- /* oklch(Lightness Chroma Hue) */
19
- color: oklch(0.62 0.19 145);
20
-
21
- /* With alpha */
22
- color: oklch(0.62 0.19 145 / 0.8);
23
- ```
24
-
25
- - **L** — Lightness, range `0` (black) to `1` (white)
26
- - **C** — Chroma (saturation intensity), roughly `0` to `0.37` in displayable sRGB
27
- - **H** — Hue angle in degrees, `0–360`
28
-
29
- ### Browser Support
30
-
31
- OKLCH is supported in all modern browsers (Chrome 111+, Safari 15.4+, Firefox 113+). For older targets, provide an `@supports` fallback:
32
-
33
- ```css
34
- :root {
35
- --color-primary: #2563eb; /* fallback */
36
- }
37
-
38
- @supports (color: oklch(0 0 0)) {
39
- :root {
40
- --color-primary: oklch(0.55 0.22 264);
41
- }
42
- }
43
- ```
44
-
45
- ### Perceptual Uniformity in Practice
46
-
47
- When generating a 9-step scale (see Palette Generation), OKLCH lets you space lightness values linearly and get visually even steps. With HSL you would need to hand-tune each step because yellow and purple consume lightness differently.
48
-
49
- ```ts
50
- // Generate a 9-step lightness scale for a given hue/chroma
51
- function generateScale(hue: number, chroma: number): string[] {
52
- const steps = [0.95, 0.88, 0.78, 0.66, 0.55, 0.44, 0.33, 0.22, 0.12];
53
- return steps.map((l) => `oklch(${l} ${chroma} ${hue})`);
54
- }
55
- ```
56
-
57
- ---
58
-
59
- ## Tinted Neutrals
60
-
61
- ### The Problem with Pure Gray
62
-
63
- Pure gray (`oklch(L 0 0)`) is chromatic dead weight. It has no relationship to your brand and often reads as clinical or cold, especially in large neutral areas like backgrounds, sidebars, and cards.
64
-
65
- Tinted neutrals solve this by adding a tiny amount of chroma — just enough to feel cohesive with the brand, invisible to untrained eyes, but felt as warmth or coolness throughout the UI.
66
-
67
- ### How to Create Tinted Neutrals
68
-
69
- Start from your primary brand hue. Drop the chroma to `0.01–0.04` (barely perceptible). Use the same hue angle as your primary color.
70
-
71
- ```css
72
- :root {
73
- /* Brand primary: oklch(0.55 0.22 264) — blue-violet */
74
- /* Neutral scale with matching hue, near-zero chroma */
75
- --neutral-50: oklch(0.97 0.01 264);
76
- --neutral-100: oklch(0.93 0.01 264);
77
- --neutral-200: oklch(0.86 0.02 264);
78
- --neutral-300: oklch(0.76 0.02 264);
79
- --neutral-400: oklch(0.62 0.02 264);
80
- --neutral-500: oklch(0.50 0.02 264);
81
- --neutral-600: oklch(0.40 0.02 264);
82
- --neutral-700: oklch(0.30 0.02 264);
83
- --neutral-800: oklch(0.20 0.02 264);
84
- --neutral-900: oklch(0.12 0.01 264);
85
- }
86
- ```
87
-
88
- ### DO / DON'T — Tinted Neutrals
89
-
90
- **DO** use the same hue angle as your primary for harmonious tinting.
91
-
92
- **DON'T** use a complementary hue for neutrals — it creates subtle visual tension and makes the palette look unintentional.
93
-
94
- **DO** keep chroma below `0.04` for backgrounds and surfaces. Higher values stop reading as neutrals.
95
-
96
- **DON'T** use `oklch(L 0 0)` for any neutral in a branded UI — it feels detached and clinical.
97
-
98
- ### Tailwind Configuration
99
-
100
- ```ts
101
- // tailwind.config.ts
102
- import type { Config } from "tailwindcss";
103
-
104
- export default {
105
- theme: {
106
- extend: {
107
- colors: {
108
- neutral: {
109
- 50: "oklch(0.97 0.01 264)",
110
- 100: "oklch(0.93 0.01 264)",
111
- // ...
112
- 900: "oklch(0.12 0.01 264)",
113
- },
114
- },
115
- },
116
- },
117
- } satisfies Config;
118
- ```
119
-
120
- ---
121
-
122
- ## 60-30-10 Rule
123
-
124
- ### The Principle
125
-
126
- The 60-30-10 rule is a composition framework borrowed from interior design and applied to UI color allocation:
127
-
128
- - **60% — Dominant**: Backgrounds, surfaces, large containers. Usually neutrals.
129
- - **30% — Secondary**: Text, borders, cards, secondary surfaces. Mid-range neutrals or a secondary brand color.
130
- - **10% — Accent**: CTAs, active states, highlights, key icons. Your primary brand color.
131
-
132
- This ratio creates visual hierarchy naturally. The accent color has impact precisely because it is rare.
133
-
134
- ### Applied to a React Layout
135
-
136
- ```tsx
137
- // Tailwind + React example
138
- export function AppShell({ children }: { children: React.ReactNode }) {
139
- return (
140
- // 60% — dominant neutral background
141
- <div className="min-h-screen bg-neutral-50 dark:bg-neutral-950">
142
- {/* 30% — secondary surface */}
143
- <nav className="bg-neutral-100 dark:bg-neutral-900 border-b border-neutral-200 dark:border-neutral-800">
144
- <div className="max-w-7xl mx-auto px-4 flex items-center justify-between h-14">
145
- <span className="text-neutral-900 dark:text-neutral-100 font-semibold">
146
- Brand
147
- </span>
148
- {/* 10% — accent CTA */}
149
- <button className="bg-primary-600 hover:bg-primary-700 text-white px-4 py-1.5 rounded-md text-sm font-medium">
150
- Get Started
151
- </button>
152
- </div>
153
- </nav>
154
- <main className="max-w-7xl mx-auto px-4 py-8">{children}</main>
155
- </div>
156
- );
157
- }
158
- ```
159
-
160
- ### DO / DON'T — 60-30-10
161
-
162
- **DO** use the accent color only for the single most important interactive element per view. One primary CTA per screen is the ideal application of that 10%.
163
-
164
- **DON'T** use your accent color for decorative elements, illustrations, or informational icons. It trains users to ignore it.
165
-
166
- **DO** let the 30% tier handle text. Mid-neutral text on a neutral background is readable and calm.
167
-
168
- **DON'T** fill large surfaces (60% territory) with a saturated color. This exhausts the eye and leaves nowhere for emphasis to land.
169
-
170
- ---
171
-
172
- ## Dark Mode
173
-
174
- ### Not an Inversion
175
-
176
- The most common dark mode mistake is inverting the light palette. Inversion produces washed-out, oversaturated text and poor contrast because the perceptual math doesn't hold in reverse.
177
-
178
- Dark mode requires a separate token set that is designed for dark surfaces, not derived from light surfaces.
179
-
180
- ### Surface Elevation with Lighter Shades
181
-
182
- In dark mode, elevation is conveyed through progressively lighter surface colors, not shadows. This mirrors how light scatters in physical space.
183
-
184
- ```css
185
- [data-theme="dark"] {
186
- /* Base surface — darkest */
187
- --surface-base: oklch(0.12 0.01 264);
188
-
189
- /* Elevation 1 — cards, panels */
190
- --surface-raised: oklch(0.16 0.01 264);
191
-
192
- /* Elevation 2 — modals, popovers */
193
- --surface-overlay: oklch(0.20 0.01 264);
194
-
195
- /* Elevation 3 — tooltips, dropdowns */
196
- --surface-float: oklch(0.24 0.01 264);
197
-
198
- /* Text */
199
- --text-primary: oklch(0.93 0.01 264);
200
- --text-secondary: oklch(0.68 0.02 264);
201
- --text-disabled: oklch(0.45 0.01 264);
202
-
203
- /* Accent — slightly desaturated for dark context */
204
- --color-primary: oklch(0.65 0.18 264);
205
- }
206
- ```
207
-
208
- ### Token-Based Dark Mode in React + Tailwind
209
-
210
- ```tsx
211
- // Use CSS custom properties via Tailwind's `[var()]` escape hatch
212
- // or configure Tailwind with semantic token names
213
-
214
- // tailwind.config.ts (semantic tokens)
215
- export default {
216
- theme: {
217
- extend: {
218
- colors: {
219
- surface: {
220
- base: "var(--surface-base)",
221
- raised: "var(--surface-raised)",
222
- overlay: "var(--surface-overlay)",
223
- },
224
- text: {
225
- primary: "var(--text-primary)",
226
- secondary: "var(--text-secondary)",
227
- },
228
- },
229
- },
230
- },
231
- };
232
-
233
- // Component usage — zero dark: variants needed
234
- function Card({ children }: { children: React.ReactNode }) {
235
- return (
236
- <div className="bg-surface-raised rounded-xl p-6 text-text-primary">
237
- {children}
238
- </div>
239
- );
240
- }
241
- ```
242
-
243
- ### DO / DON'T — Dark Mode
244
-
245
- **DO** define a separate token layer for dark mode. Map the same semantic names (`--text-primary`, `--surface-base`) to different raw values.
246
-
247
- **DON'T** rely on Tailwind's `dark:` utility for every color declaration. It creates a proliferation of `dark:` variants that are hard to audit. Use CSS custom properties with a `[data-theme]` attribute instead.
248
-
249
- ---
250
-
251
- ## Accessibility — WCAG 2.1 AA
252
-
253
- ### Contrast Ratios
254
-
255
- WCAG 2.1 Level AA defines two thresholds:
256
-
257
- | Target | Minimum Ratio |
258
- |---|---|
259
- | Normal text (< 18pt / < 14pt bold) | 4.5:1 |
260
- | Large text (≥ 18pt / ≥ 14pt bold) | 3:1 |
261
- | UI components (borders, icons, controls) | 3:1 |
262
- | Decorative elements, disabled states | No requirement |
263
-
264
- ### Checking Contrast in OKLCH
265
-
266
- OKLCH's lightness channel gives a rough guide, but actual contrast must be computed against WCAG's relative luminance formula. Use a tool like `culori` in your design token pipeline:
267
-
268
- ```ts
269
- import { wcagContrast, oklch, formatHex } from "culori";
270
-
271
- function assertContrast(
272
- fg: string,
273
- bg: string,
274
- threshold: 4.5 | 3
275
- ): void {
276
- const ratio = wcagContrast(fg, bg);
277
- if (ratio < threshold) {
278
- throw new Error(
279
- `Contrast ${ratio.toFixed(2)}:1 fails WCAG AA (${threshold}:1) — ${fg} on ${bg}`
280
- );
281
- }
282
- }
283
-
284
- // Run in CI or during token generation
285
- assertContrast("oklch(0.93 0.01 264)", "oklch(0.12 0.01 264)", 4.5);
286
- ```
287
-
288
- ### Designing for Contrast at Token Definition Time
289
-
290
- Rather than checking contrast after the fact, build contrast in during palette generation. Steps 700–900 pass AA on white backgrounds; steps 50–300 pass AA on dark backgrounds. The mid-range (400–600) is unreliable — use with caution and always verify.
291
-
292
- ```css
293
- /* Reliable pairings for AA compliance */
294
- .text-on-light { color: var(--primary-700); } /* ~7:1 on white */
295
- .text-on-dark { color: var(--primary-200); } /* ~8:1 on --neutral-900 */
296
- .badge-accent { color: var(--primary-800); background: var(--primary-100); }
297
- ```
298
-
299
- ### Non-Text Contrast (UI Components)
300
-
301
- Focus rings, form borders, icon buttons, and toggle tracks must meet 3:1 against adjacent backgrounds. This is commonly missed.
302
-
303
- ```tsx
304
- // Accessible focus ring — visible on both light and dark
305
- function FocusableButton({ children }: { children: React.ReactNode }) {
306
- return (
307
- <button
308
- className={[
309
- "px-4 py-2 rounded-md font-medium",
310
- "bg-primary-600 text-white",
311
- // Focus ring: 3px offset with neutral contrast to surface
312
- "focus-visible:outline focus-visible:outline-2",
313
- "focus-visible:outline-offset-2 focus-visible:outline-primary-500",
314
- ].join(" ")}
315
- >
316
- {children}
317
- </button>
318
- );
319
- }
320
- ```
321
-
322
- ---
323
-
324
- ## Palette Generation
325
-
326
- ### 9-Step Lightness Scale
327
-
328
- A well-formed palette for any hue uses 9 steps (50–900 in Tailwind convention, or 1–9 in index convention). The scale follows a non-linear lightness curve to account for perceptual compression at the extremes.
329
-
330
- ```ts
331
- // Recommended OKLCH lightness values per step
332
- const LIGHTNESS_SCALE: Record<string, number> = {
333
- "50": 0.97,
334
- "100": 0.93,
335
- "200": 0.85,
336
- "300": 0.74,
337
- "400": 0.62,
338
- "500": 0.52,
339
- "600": 0.44,
340
- "700": 0.36,
341
- "800": 0.26,
342
- "900": 0.16,
343
- };
344
-
345
- function buildPalette(
346
- hue: number,
347
- chroma: number
348
- ): Record<string, string> {
349
- return Object.fromEntries(
350
- Object.entries(LIGHTNESS_SCALE).map(([step, l]) => [
351
- step,
352
- `oklch(${l} ${chroma} ${hue})`,
353
- ])
354
- );
355
- }
356
-
357
- const blue = buildPalette(264, 0.20);
358
- // { "50": "oklch(0.97 0.20 264)", "100": "oklch(0.93 0.20 264)", ... }
359
- ```
360
-
361
- ### Semantic Colors
362
-
363
- Semantic colors communicate meaning independent of brand. They should be generated from dedicated hues, not borrowed from the brand palette:
364
-
365
- | Semantic Role | Recommended Hue (OKLCH) | Rationale |
366
- |---|---|---|
367
- | Success | `145` (green) | Universal positive association |
368
- | Error | `25` (red-orange) | High visibility, culturally universal |
369
- | Warning | `85` (amber) | Distinct from success, readable |
370
- | Info | `230` (cyan-blue) | Neutral, informational |
371
-
372
- ```css
373
- :root {
374
- /* Success */
375
- --success-50: oklch(0.97 0.05 145);
376
- --success-500: oklch(0.52 0.18 145);
377
- --success-700: oklch(0.36 0.16 145);
378
-
379
- /* Error */
380
- --error-50: oklch(0.97 0.05 25);
381
- --error-500: oklch(0.52 0.21 25);
382
- --error-700: oklch(0.36 0.19 25);
383
-
384
- /* Warning */
385
- --warning-50: oklch(0.97 0.06 85);
386
- --warning-500: oklch(0.72 0.17 85);
387
- --warning-700: oklch(0.50 0.14 85);
388
-
389
- /* Info */
390
- --info-50: oklch(0.97 0.04 230);
391
- --info-500: oklch(0.55 0.17 230);
392
- --info-700: oklch(0.38 0.15 230);
393
- }
394
- ```
395
-
396
- ### Chroma Guidance by Use Case
397
-
398
- - **Brand accent**: `0.18–0.25` — vivid, intentional
399
- - **Semantic colors**: `0.14–0.22` — communicative but not alarming
400
- - **Tinted neutrals**: `0.01–0.04` — imperceptible tinting
401
- - **Disabled states**: `0.01–0.02` — visually receded
402
-
403
- ---
404
-
405
- ## Color Tokens
406
-
407
- ### The Token Hierarchy
408
-
409
- A robust token system has three layers:
410
-
411
- 1. **Primitive tokens** — Raw palette values. Named by position, not role.
412
- 2. **Semantic tokens** — Role-based references to primitives. Context-aware.
413
- 3. **Component tokens** — Component-specific overrides of semantic tokens. Optional.
414
-
415
- ```css
416
- /* Layer 1: Primitives */
417
- :root {
418
- --primitive-blue-500: oklch(0.52 0.20 264);
419
- --primitive-blue-700: oklch(0.36 0.19 264);
420
- --primitive-neutral-50: oklch(0.97 0.01 264);
421
- --primitive-neutral-900: oklch(0.12 0.01 264);
422
- }
423
-
424
- /* Layer 2: Semantic tokens (light mode default) */
425
- :root {
426
- --color-primary: var(--primitive-blue-600);
427
- --color-primary-hover: var(--primitive-blue-700);
428
- --surface-page: var(--primitive-neutral-50);
429
- --text-body: var(--primitive-neutral-900);
430
- --text-muted: var(--primitive-neutral-500);
431
- --border-default: var(--primitive-neutral-200);
432
- }
433
-
434
- /* Layer 2: Semantic tokens (dark mode) */
435
- [data-theme="dark"] {
436
- --color-primary: var(--primitive-blue-400);
437
- --color-primary-hover: var(--primitive-blue-300);
438
- --surface-page: var(--primitive-neutral-950);
439
- --text-body: var(--primitive-neutral-50);
440
- --text-muted: var(--primitive-neutral-400);
441
- --border-default: var(--primitive-neutral-800);
442
- }
443
- ```
444
-
445
- ### Systematic Naming Convention
446
-
447
- Use a `[category]-[variant]-[state]` structure:
448
-
449
- ```
450
- --color-primary → base primary
451
- --color-primary-hover → interactive state
452
- --color-primary-active → pressed state
453
- --color-primary-disabled → disabled state
454
- --surface-page → page background
455
- --surface-raised → card/panel
456
- --text-body → default body text
457
- --text-heading → heading text
458
- --text-muted → secondary/helper text
459
- --border-default → standard border
460
- --border-focus → focus ring
461
- ```
462
-
463
- ### Wiring Tokens into Tailwind
464
-
465
- ```ts
466
- // tailwind.config.ts — wire semantic tokens to Tailwind utilities
467
- export default {
468
- theme: {
469
- extend: {
470
- colors: {
471
- primary: {
472
- DEFAULT: "var(--color-primary)",
473
- hover: "var(--color-primary-hover)",
474
- },
475
- surface: {
476
- page: "var(--surface-page)",
477
- raised: "var(--surface-raised)",
478
- },
479
- text: {
480
- body: "var(--text-body)",
481
- muted: "var(--text-muted)",
482
- heading: "var(--text-heading)",
483
- },
484
- border: {
485
- DEFAULT: "var(--border-default)",
486
- focus: "var(--border-focus)",
487
- },
488
- },
489
- },
490
- },
491
- };
492
- ```
493
-
494
- This setup means components never reference primitive tokens directly. A design decision like "make the brand warmer" changes one variable in the primitive layer and propagates everywhere.
495
-
496
- ### DO / DON'T — Color Tokens
497
-
498
- **DO** reference semantic tokens in components, never primitives. `bg-surface-raised` is correct; `bg-neutral-100` in a component is a smell.
499
-
500
- **DON'T** create tokens for every one-off use. If a color is used fewer than three times, it doesn't need a token — use an inline value or compose from existing tokens.
501
-
502
- **DO** version your token file if it is shared across multiple projects or exported as a package. Breaking token renames are a semver concern.
503
-
504
- ---
505
-
506
- ## Quick Reference Checklist
507
-
508
- Before shipping any new UI surface, verify:
509
-
510
- - [ ] All text passes WCAG AA contrast (4.5:1 normal, 3:1 large)
511
- - [ ] All interactive UI elements (borders, icons) pass 3:1 non-text contrast
512
- - [ ] Focus rings are visible on both light and dark backgrounds
513
- - [ ] Dark mode uses a separate token set, not CSS filter inversion
514
- - [ ] Accent color accounts for no more than ~10% of visible surface area
515
- - [ ] Semantic color tokens are used in components (not primitives)
516
- - [ ] Color palette was generated in OKLCH for perceptual uniformity
517
- - [ ] Tinted neutrals share hue angle with primary brand color
1
+ # Color & Contrast — Deep Reference Guide
2
+
3
+ A systematic reference for building accessible, perceptually consistent color systems in web UI. Covers the modern OKLCH color space, token architecture, dark mode strategy, and WCAG compliance patterns.
4
+
5
+ ---
6
+
7
+ ## OKLCH Color Space
8
+
9
+ ### Why OKLCH Over HSL or HEX
10
+
11
+ The legacy HSL color space is perceptually non-uniform: a yellow at `hsl(60, 100%, 50%)` and a blue at `hsl(240, 100%, 50%)` have the same nominal lightness value, but the yellow reads dramatically brighter to the human eye. This creates real problems when you want consistent contrast across a palette.
12
+
13
+ OKLCH solves this. It maps color to how the human visual system actually perceives brightness, chroma, and hue. Two colors with the same `L` value in OKLCH will appear equally bright to a viewer, regardless of their hue. This makes predictable contrast possible without manual adjustments per hue.
14
+
15
+ ### Syntax
16
+
17
+ ```css
18
+ /* oklch(Lightness Chroma Hue) */
19
+ color: oklch(0.62 0.19 145);
20
+
21
+ /* With alpha */
22
+ color: oklch(0.62 0.19 145 / 0.8);
23
+ ```
24
+
25
+ - **L** — Lightness, range `0` (black) to `1` (white)
26
+ - **C** — Chroma (saturation intensity), roughly `0` to `0.37` in displayable sRGB
27
+ - **H** — Hue angle in degrees, `0–360`
28
+
29
+ ### Browser Support
30
+
31
+ OKLCH is supported in all modern browsers (Chrome 111+, Safari 15.4+, Firefox 113+). For older targets, provide an `@supports` fallback:
32
+
33
+ ```css
34
+ :root {
35
+ --color-primary: #2563eb; /* fallback */
36
+ }
37
+
38
+ @supports (color: oklch(0 0 0)) {
39
+ :root {
40
+ --color-primary: oklch(0.55 0.22 264);
41
+ }
42
+ }
43
+ ```
44
+
45
+ ### Perceptual Uniformity in Practice
46
+
47
+ When generating a 9-step scale (see Palette Generation), OKLCH lets you space lightness values linearly and get visually even steps. With HSL you would need to hand-tune each step because yellow and purple consume lightness differently.
48
+
49
+ ```ts
50
+ // Generate a 9-step lightness scale for a given hue/chroma
51
+ function generateScale(hue: number, chroma: number): string[] {
52
+ const steps = [0.95, 0.88, 0.78, 0.66, 0.55, 0.44, 0.33, 0.22, 0.12];
53
+ return steps.map((l) => `oklch(${l} ${chroma} ${hue})`);
54
+ }
55
+ ```
56
+
57
+ ---
58
+
59
+ ## Tinted Neutrals
60
+
61
+ ### The Problem with Pure Gray
62
+
63
+ Pure gray (`oklch(L 0 0)`) is chromatic dead weight. It has no relationship to your brand and often reads as clinical or cold, especially in large neutral areas like backgrounds, sidebars, and cards.
64
+
65
+ Tinted neutrals solve this by adding a tiny amount of chroma — just enough to feel cohesive with the brand, invisible to untrained eyes, but felt as warmth or coolness throughout the UI.
66
+
67
+ ### How to Create Tinted Neutrals
68
+
69
+ Start from your primary brand hue. Drop the chroma to `0.01–0.04` (barely perceptible). Use the same hue angle as your primary color.
70
+
71
+ ```css
72
+ :root {
73
+ /* Brand primary: oklch(0.55 0.22 264) — blue-violet */
74
+ /* Neutral scale with matching hue, near-zero chroma */
75
+ --neutral-50: oklch(0.97 0.01 264);
76
+ --neutral-100: oklch(0.93 0.01 264);
77
+ --neutral-200: oklch(0.86 0.02 264);
78
+ --neutral-300: oklch(0.76 0.02 264);
79
+ --neutral-400: oklch(0.62 0.02 264);
80
+ --neutral-500: oklch(0.50 0.02 264);
81
+ --neutral-600: oklch(0.40 0.02 264);
82
+ --neutral-700: oklch(0.30 0.02 264);
83
+ --neutral-800: oklch(0.20 0.02 264);
84
+ --neutral-900: oklch(0.12 0.01 264);
85
+ }
86
+ ```
87
+
88
+ ### DO / DON'T — Tinted Neutrals
89
+
90
+ **DO** use the same hue angle as your primary for harmonious tinting.
91
+
92
+ **DON'T** use a complementary hue for neutrals — it creates subtle visual tension and makes the palette look unintentional.
93
+
94
+ **DO** keep chroma below `0.04` for backgrounds and surfaces. Higher values stop reading as neutrals.
95
+
96
+ **DON'T** use `oklch(L 0 0)` for any neutral in a branded UI — it feels detached and clinical.
97
+
98
+ ### Tailwind Configuration
99
+
100
+ ```ts
101
+ // tailwind.config.ts
102
+ import type { Config } from "tailwindcss";
103
+
104
+ export default {
105
+ theme: {
106
+ extend: {
107
+ colors: {
108
+ neutral: {
109
+ 50: "oklch(0.97 0.01 264)",
110
+ 100: "oklch(0.93 0.01 264)",
111
+ // ...
112
+ 900: "oklch(0.12 0.01 264)",
113
+ },
114
+ },
115
+ },
116
+ },
117
+ } satisfies Config;
118
+ ```
119
+
120
+ ---
121
+
122
+ ## 60-30-10 Rule
123
+
124
+ ### The Principle
125
+
126
+ The 60-30-10 rule is a composition framework borrowed from interior design and applied to UI color allocation:
127
+
128
+ - **60% — Dominant**: Backgrounds, surfaces, large containers. Usually neutrals.
129
+ - **30% — Secondary**: Text, borders, cards, secondary surfaces. Mid-range neutrals or a secondary brand color.
130
+ - **10% — Accent**: CTAs, active states, highlights, key icons. Your primary brand color.
131
+
132
+ This ratio creates visual hierarchy naturally. The accent color has impact precisely because it is rare.
133
+
134
+ ### Applied to a React Layout
135
+
136
+ ```tsx
137
+ // Tailwind + React example
138
+ export function AppShell({ children }: { children: React.ReactNode }) {
139
+ return (
140
+ // 60% — dominant neutral background
141
+ <div className="min-h-screen bg-neutral-50 dark:bg-neutral-950">
142
+ {/* 30% — secondary surface */}
143
+ <nav className="bg-neutral-100 dark:bg-neutral-900 border-b border-neutral-200 dark:border-neutral-800">
144
+ <div className="max-w-7xl mx-auto px-4 flex items-center justify-between h-14">
145
+ <span className="text-neutral-900 dark:text-neutral-100 font-semibold">
146
+ Brand
147
+ </span>
148
+ {/* 10% — accent CTA */}
149
+ <button className="bg-primary-600 hover:bg-primary-700 text-white px-4 py-1.5 rounded-md text-sm font-medium">
150
+ Get Started
151
+ </button>
152
+ </div>
153
+ </nav>
154
+ <main className="max-w-7xl mx-auto px-4 py-8">{children}</main>
155
+ </div>
156
+ );
157
+ }
158
+ ```
159
+
160
+ ### DO / DON'T — 60-30-10
161
+
162
+ **DO** use the accent color only for the single most important interactive element per view. One primary CTA per screen is the ideal application of that 10%.
163
+
164
+ **DON'T** use your accent color for decorative elements, illustrations, or informational icons. It trains users to ignore it.
165
+
166
+ **DO** let the 30% tier handle text. Mid-neutral text on a neutral background is readable and calm.
167
+
168
+ **DON'T** fill large surfaces (60% territory) with a saturated color. This exhausts the eye and leaves nowhere for emphasis to land.
169
+
170
+ ---
171
+
172
+ ## Dark Mode
173
+
174
+ ### Not an Inversion
175
+
176
+ The most common dark mode mistake is inverting the light palette. Inversion produces washed-out, oversaturated text and poor contrast because the perceptual math doesn't hold in reverse.
177
+
178
+ Dark mode requires a separate token set that is designed for dark surfaces, not derived from light surfaces.
179
+
180
+ ### Surface Elevation with Lighter Shades
181
+
182
+ In dark mode, elevation is conveyed through progressively lighter surface colors, not shadows. This mirrors how light scatters in physical space.
183
+
184
+ ```css
185
+ [data-theme="dark"] {
186
+ /* Base surface — darkest */
187
+ --surface-base: oklch(0.12 0.01 264);
188
+
189
+ /* Elevation 1 — cards, panels */
190
+ --surface-raised: oklch(0.16 0.01 264);
191
+
192
+ /* Elevation 2 — modals, popovers */
193
+ --surface-overlay: oklch(0.20 0.01 264);
194
+
195
+ /* Elevation 3 — tooltips, dropdowns */
196
+ --surface-float: oklch(0.24 0.01 264);
197
+
198
+ /* Text */
199
+ --text-primary: oklch(0.93 0.01 264);
200
+ --text-secondary: oklch(0.68 0.02 264);
201
+ --text-disabled: oklch(0.45 0.01 264);
202
+
203
+ /* Accent — slightly desaturated for dark context */
204
+ --color-primary: oklch(0.65 0.18 264);
205
+ }
206
+ ```
207
+
208
+ ### Token-Based Dark Mode in React + Tailwind
209
+
210
+ ```tsx
211
+ // Use CSS custom properties via Tailwind's `[var()]` escape hatch
212
+ // or configure Tailwind with semantic token names
213
+
214
+ // tailwind.config.ts (semantic tokens)
215
+ export default {
216
+ theme: {
217
+ extend: {
218
+ colors: {
219
+ surface: {
220
+ base: "var(--surface-base)",
221
+ raised: "var(--surface-raised)",
222
+ overlay: "var(--surface-overlay)",
223
+ },
224
+ text: {
225
+ primary: "var(--text-primary)",
226
+ secondary: "var(--text-secondary)",
227
+ },
228
+ },
229
+ },
230
+ },
231
+ };
232
+
233
+ // Component usage — zero dark: variants needed
234
+ function Card({ children }: { children: React.ReactNode }) {
235
+ return (
236
+ <div className="bg-surface-raised rounded-xl p-6 text-text-primary">
237
+ {children}
238
+ </div>
239
+ );
240
+ }
241
+ ```
242
+
243
+ ### DO / DON'T — Dark Mode
244
+
245
+ **DO** define a separate token layer for dark mode. Map the same semantic names (`--text-primary`, `--surface-base`) to different raw values.
246
+
247
+ **DON'T** rely on Tailwind's `dark:` utility for every color declaration. It creates a proliferation of `dark:` variants that are hard to audit. Use CSS custom properties with a `[data-theme]` attribute instead.
248
+
249
+ ---
250
+
251
+ ## Accessibility — WCAG 2.1 AA
252
+
253
+ ### Contrast Ratios
254
+
255
+ WCAG 2.1 Level AA defines two thresholds:
256
+
257
+ | Target | Minimum Ratio |
258
+ |---|---|
259
+ | Normal text (< 18pt / < 14pt bold) | 4.5:1 |
260
+ | Large text (≥ 18pt / ≥ 14pt bold) | 3:1 |
261
+ | UI components (borders, icons, controls) | 3:1 |
262
+ | Decorative elements, disabled states | No requirement |
263
+
264
+ ### Checking Contrast in OKLCH
265
+
266
+ OKLCH's lightness channel gives a rough guide, but actual contrast must be computed against WCAG's relative luminance formula. Use a tool like `culori` in your design token pipeline:
267
+
268
+ ```ts
269
+ import { wcagContrast, oklch, formatHex } from "culori";
270
+
271
+ function assertContrast(
272
+ fg: string,
273
+ bg: string,
274
+ threshold: 4.5 | 3
275
+ ): void {
276
+ const ratio = wcagContrast(fg, bg);
277
+ if (ratio < threshold) {
278
+ throw new Error(
279
+ `Contrast ${ratio.toFixed(2)}:1 fails WCAG AA (${threshold}:1) — ${fg} on ${bg}`
280
+ );
281
+ }
282
+ }
283
+
284
+ // Run in CI or during token generation
285
+ assertContrast("oklch(0.93 0.01 264)", "oklch(0.12 0.01 264)", 4.5);
286
+ ```
287
+
288
+ ### Designing for Contrast at Token Definition Time
289
+
290
+ Rather than checking contrast after the fact, build contrast in during palette generation. Steps 700–900 pass AA on white backgrounds; steps 50–300 pass AA on dark backgrounds. The mid-range (400–600) is unreliable — use with caution and always verify.
291
+
292
+ ```css
293
+ /* Reliable pairings for AA compliance */
294
+ .text-on-light { color: var(--primary-700); } /* ~7:1 on white */
295
+ .text-on-dark { color: var(--primary-200); } /* ~8:1 on --neutral-900 */
296
+ .badge-accent { color: var(--primary-800); background: var(--primary-100); }
297
+ ```
298
+
299
+ ### Non-Text Contrast (UI Components)
300
+
301
+ Focus rings, form borders, icon buttons, and toggle tracks must meet 3:1 against adjacent backgrounds. This is commonly missed.
302
+
303
+ ```tsx
304
+ // Accessible focus ring — visible on both light and dark
305
+ function FocusableButton({ children }: { children: React.ReactNode }) {
306
+ return (
307
+ <button
308
+ className={[
309
+ "px-4 py-2 rounded-md font-medium",
310
+ "bg-primary-600 text-white",
311
+ // Focus ring: 3px offset with neutral contrast to surface
312
+ "focus-visible:outline focus-visible:outline-2",
313
+ "focus-visible:outline-offset-2 focus-visible:outline-primary-500",
314
+ ].join(" ")}
315
+ >
316
+ {children}
317
+ </button>
318
+ );
319
+ }
320
+ ```
321
+
322
+ ---
323
+
324
+ ## Palette Generation
325
+
326
+ ### 9-Step Lightness Scale
327
+
328
+ A well-formed palette for any hue uses 9 steps (50–900 in Tailwind convention, or 1–9 in index convention). The scale follows a non-linear lightness curve to account for perceptual compression at the extremes.
329
+
330
+ ```ts
331
+ // Recommended OKLCH lightness values per step
332
+ const LIGHTNESS_SCALE: Record<string, number> = {
333
+ "50": 0.97,
334
+ "100": 0.93,
335
+ "200": 0.85,
336
+ "300": 0.74,
337
+ "400": 0.62,
338
+ "500": 0.52,
339
+ "600": 0.44,
340
+ "700": 0.36,
341
+ "800": 0.26,
342
+ "900": 0.16,
343
+ };
344
+
345
+ function buildPalette(
346
+ hue: number,
347
+ chroma: number
348
+ ): Record<string, string> {
349
+ return Object.fromEntries(
350
+ Object.entries(LIGHTNESS_SCALE).map(([step, l]) => [
351
+ step,
352
+ `oklch(${l} ${chroma} ${hue})`,
353
+ ])
354
+ );
355
+ }
356
+
357
+ const blue = buildPalette(264, 0.20);
358
+ // { "50": "oklch(0.97 0.20 264)", "100": "oklch(0.93 0.20 264)", ... }
359
+ ```
360
+
361
+ ### Semantic Colors
362
+
363
+ Semantic colors communicate meaning independent of brand. They should be generated from dedicated hues, not borrowed from the brand palette:
364
+
365
+ | Semantic Role | Recommended Hue (OKLCH) | Rationale |
366
+ |---|---|---|
367
+ | Success | `145` (green) | Universal positive association |
368
+ | Error | `25` (red-orange) | High visibility, culturally universal |
369
+ | Warning | `85` (amber) | Distinct from success, readable |
370
+ | Info | `230` (cyan-blue) | Neutral, informational |
371
+
372
+ ```css
373
+ :root {
374
+ /* Success */
375
+ --success-50: oklch(0.97 0.05 145);
376
+ --success-500: oklch(0.52 0.18 145);
377
+ --success-700: oklch(0.36 0.16 145);
378
+
379
+ /* Error */
380
+ --error-50: oklch(0.97 0.05 25);
381
+ --error-500: oklch(0.52 0.21 25);
382
+ --error-700: oklch(0.36 0.19 25);
383
+
384
+ /* Warning */
385
+ --warning-50: oklch(0.97 0.06 85);
386
+ --warning-500: oklch(0.72 0.17 85);
387
+ --warning-700: oklch(0.50 0.14 85);
388
+
389
+ /* Info */
390
+ --info-50: oklch(0.97 0.04 230);
391
+ --info-500: oklch(0.55 0.17 230);
392
+ --info-700: oklch(0.38 0.15 230);
393
+ }
394
+ ```
395
+
396
+ ### Chroma Guidance by Use Case
397
+
398
+ - **Brand accent**: `0.18–0.25` — vivid, intentional
399
+ - **Semantic colors**: `0.14–0.22` — communicative but not alarming
400
+ - **Tinted neutrals**: `0.01–0.04` — imperceptible tinting
401
+ - **Disabled states**: `0.01–0.02` — visually receded
402
+
403
+ ---
404
+
405
+ ## Color Tokens
406
+
407
+ ### The Token Hierarchy
408
+
409
+ A robust token system has three layers:
410
+
411
+ 1. **Primitive tokens** — Raw palette values. Named by position, not role.
412
+ 2. **Semantic tokens** — Role-based references to primitives. Context-aware.
413
+ 3. **Component tokens** — Component-specific overrides of semantic tokens. Optional.
414
+
415
+ ```css
416
+ /* Layer 1: Primitives */
417
+ :root {
418
+ --primitive-blue-500: oklch(0.52 0.20 264);
419
+ --primitive-blue-700: oklch(0.36 0.19 264);
420
+ --primitive-neutral-50: oklch(0.97 0.01 264);
421
+ --primitive-neutral-900: oklch(0.12 0.01 264);
422
+ }
423
+
424
+ /* Layer 2: Semantic tokens (light mode default) */
425
+ :root {
426
+ --color-primary: var(--primitive-blue-600);
427
+ --color-primary-hover: var(--primitive-blue-700);
428
+ --surface-page: var(--primitive-neutral-50);
429
+ --text-body: var(--primitive-neutral-900);
430
+ --text-muted: var(--primitive-neutral-500);
431
+ --border-default: var(--primitive-neutral-200);
432
+ }
433
+
434
+ /* Layer 2: Semantic tokens (dark mode) */
435
+ [data-theme="dark"] {
436
+ --color-primary: var(--primitive-blue-400);
437
+ --color-primary-hover: var(--primitive-blue-300);
438
+ --surface-page: var(--primitive-neutral-950);
439
+ --text-body: var(--primitive-neutral-50);
440
+ --text-muted: var(--primitive-neutral-400);
441
+ --border-default: var(--primitive-neutral-800);
442
+ }
443
+ ```
444
+
445
+ ### Systematic Naming Convention
446
+
447
+ Use a `[category]-[variant]-[state]` structure:
448
+
449
+ ```
450
+ --color-primary → base primary
451
+ --color-primary-hover → interactive state
452
+ --color-primary-active → pressed state
453
+ --color-primary-disabled → disabled state
454
+ --surface-page → page background
455
+ --surface-raised → card/panel
456
+ --text-body → default body text
457
+ --text-heading → heading text
458
+ --text-muted → secondary/helper text
459
+ --border-default → standard border
460
+ --border-focus → focus ring
461
+ ```
462
+
463
+ ### Wiring Tokens into Tailwind
464
+
465
+ ```ts
466
+ // tailwind.config.ts — wire semantic tokens to Tailwind utilities
467
+ export default {
468
+ theme: {
469
+ extend: {
470
+ colors: {
471
+ primary: {
472
+ DEFAULT: "var(--color-primary)",
473
+ hover: "var(--color-primary-hover)",
474
+ },
475
+ surface: {
476
+ page: "var(--surface-page)",
477
+ raised: "var(--surface-raised)",
478
+ },
479
+ text: {
480
+ body: "var(--text-body)",
481
+ muted: "var(--text-muted)",
482
+ heading: "var(--text-heading)",
483
+ },
484
+ border: {
485
+ DEFAULT: "var(--border-default)",
486
+ focus: "var(--border-focus)",
487
+ },
488
+ },
489
+ },
490
+ },
491
+ };
492
+ ```
493
+
494
+ This setup means components never reference primitive tokens directly. A design decision like "make the brand warmer" changes one variable in the primitive layer and propagates everywhere.
495
+
496
+ ### DO / DON'T — Color Tokens
497
+
498
+ **DO** reference semantic tokens in components, never primitives. `bg-surface-raised` is correct; `bg-neutral-100` in a component is a smell.
499
+
500
+ **DON'T** create tokens for every one-off use. If a color is used fewer than three times, it doesn't need a token — use an inline value or compose from existing tokens.
501
+
502
+ **DO** version your token file if it is shared across multiple projects or exported as a package. Breaking token renames are a semver concern.
503
+
504
+ ---
505
+
506
+ ## Quick Reference Checklist
507
+
508
+ Before shipping any new UI surface, verify:
509
+
510
+ - [ ] All text passes WCAG AA contrast (4.5:1 normal, 3:1 large)
511
+ - [ ] All interactive UI elements (borders, icons) pass 3:1 non-text contrast
512
+ - [ ] Focus rings are visible on both light and dark backgrounds
513
+ - [ ] Dark mode uses a separate token set, not CSS filter inversion
514
+ - [ ] Accent color accounts for no more than ~10% of visible surface area
515
+ - [ ] Semantic color tokens are used in components (not primitives)
516
+ - [ ] Color palette was generated in OKLCH for perceptual uniformity
517
+ - [ ] Tinted neutrals share hue angle with primary brand color