@haposoft/cafekit 0.16.0-rc.8 → 0.16.1
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.
- package/README.md +117 -28
- package/bin/__tests__/codex-hooks-ownership.test.js +239 -0
- package/bin/__tests__/codex-hooks.test.js +175 -0
- package/bin/__tests__/codex-native.test.js +1882 -70
- package/bin/__tests__/develop-contract.test.js +442 -23
- package/bin/__tests__/grok-envelope.test.js +271 -0
- package/bin/__tests__/grok-platform.test.js +133 -0
- package/bin/__tests__/hook-payload.test.js +194 -0
- package/bin/__tests__/installer-safety.test.js +3 -3
- package/bin/__tests__/omp-bridge.test.js +168 -0
- package/bin/__tests__/omp-hooks.test.js +178 -0
- package/bin/__tests__/omp-runtime.test.js +150 -0
- package/bin/__tests__/optional-skill-inventory.test.js +249 -0
- package/bin/__tests__/output-styles.test.js +214 -0
- package/bin/__tests__/package-inventory.test.js +1735 -98
- package/bin/__tests__/runtime-dir.test.js +158 -0
- package/bin/__tests__/runtime-schema.test.js +113 -0
- package/bin/__tests__/secret-output-guardrail.test.js +122 -0
- package/bin/__tests__/skill-routing-source.test.js +172 -0
- package/bin/__tests__/specs-v2-execution-closeout.test.js +28 -1
- package/bin/install.js +15 -5
- package/bin/lib/codex-install.js +170 -5
- package/bin/lib/context.js +64 -3
- package/bin/lib/i18n.js +15 -36
- package/bin/lib/skill-deps.js +5 -5
- package/bin/phases/claude-runtime.js +23 -0
- package/bin/phases/claude-settings.js +8 -0
- package/bin/phases/codex-hooks.js +156 -0
- package/bin/phases/codex-runtime.js +29 -38
- package/bin/phases/copy-payload.js +15 -2
- package/bin/phases/omp-runtime.js +140 -0
- package/bin/phases/root-config.js +3 -0
- package/bin/phases/select-platform.js +22 -1
- package/bin/phases/select-skill-bundles.js +96 -0
- package/bin/phases/skill-inventory.js +71 -0
- package/bin/phases/skills-setup.js +9 -2
- package/bin/phases/summary.js +0 -4
- package/bin/phases/write-metadata.js +8 -5
- package/package.json +8 -2
- package/src/claude/CLAUDE.md +3 -3
- package/src/claude/agents/brainstormer.md +52 -69
- package/src/claude/agents/code-auditor.md +32 -14
- package/src/claude/agents/debugger.md +35 -20
- package/src/claude/agents/deployer.md +12 -5
- package/src/claude/agents/docs-keeper.md +11 -1
- package/src/claude/agents/implementer.md +25 -13
- package/src/claude/agents/inspector.md +6 -3
- package/src/claude/agents/project-manager.md +1 -1
- package/src/claude/agents/researcher.md +26 -55
- package/src/claude/agents/spec-maker.md +12 -7
- package/src/claude/agents/strategist.md +52 -0
- package/src/claude/agents/test-runner.md +117 -132
- package/src/claude/agents/ui-ux-designer.md +1 -1
- package/src/claude/hooks/__tests__/fixtures/statusline-default.golden +1 -0
- package/src/claude/hooks/__tests__/precompact.test.js +158 -0
- package/src/claude/hooks/__tests__/semantic-review-authority.test.js +2 -0
- package/src/claude/hooks/__tests__/spec-gate.test.js +348 -3
- package/src/claude/hooks/__tests__/state.test.js +7 -0
- package/src/claude/hooks/__tests__/statusline.test.js +196 -0
- package/src/claude/hooks/agent.cjs +13 -8
- package/src/claude/hooks/completion-authority.cjs +10 -4
- package/src/claude/hooks/docs-sync.cjs +14 -11
- package/src/claude/hooks/inspect-block.cjs +28 -8
- package/src/claude/hooks/lib/config.cjs +8 -2
- package/src/claude/hooks/lib/counter.cjs +7 -5
- package/src/claude/hooks/lib/hook-payload.cjs +160 -0
- package/src/claude/hooks/lib/hook-state-dir.cjs +39 -0
- package/src/claude/hooks/lib/runtime-dir.cjs +49 -0
- package/src/claude/hooks/lib/secret-keywords.cjs +42 -0
- package/src/claude/hooks/precompact.cjs +106 -0
- package/src/claude/hooks/privacy-block.cjs +4 -2
- package/src/claude/hooks/rules.cjs +5 -3
- package/src/claude/hooks/secret-output-guardrail.cjs +44 -0
- package/src/claude/hooks/semantic-review-authority.cjs +6 -4
- package/src/claude/hooks/session.cjs +37 -9
- package/src/claude/hooks/spec-gate.cjs +21 -11
- package/src/claude/hooks/spec-state.cjs +11 -7
- package/src/claude/hooks/state.cjs +7 -5
- package/src/claude/hooks/task-scaffold-guard.cjs +30 -9
- package/src/claude/hooks/usage.cjs +6 -5
- package/src/claude/migration-manifest.json +31 -15
- package/src/claude/output-styles/coding-level-0-eli5.md +103 -0
- package/src/claude/output-styles/coding-level-1-junior.md +124 -0
- package/src/claude/output-styles/coding-level-2-mid.md +146 -0
- package/src/claude/output-styles/coding-level-3-senior.md +148 -0
- package/src/claude/output-styles/coding-level-4-lead.md +159 -0
- package/src/claude/output-styles/coding-level-5-god.md +91 -0
- package/src/claude/references/debugger/core-philosophy.md +5 -3
- package/src/claude/references/debugger/frontend-verification.md +2 -2
- package/src/claude/references/debugger/log-ci-analysis.md +13 -1
- package/src/claude/references/debugger/parallel-agent-hydration.md +19 -34
- package/src/claude/references/debugger/performance-diagnostics.md +2 -2
- package/src/claude/references/debugger/root-cause-tracing.md +37 -6
- package/src/claude/references/debugger/side-effect-gate.md +3 -1
- package/src/claude/references/debugger/verification-protocol.md +13 -12
- package/src/claude/rules/orchestrator.md +7 -1
- package/src/claude/rules/process-management.md +39 -0
- package/src/claude/rules/review-audit-self-decision.md +48 -0
- package/src/claude/rules/skill-domain-routing.md +26 -24
- package/src/claude/rules/skill-workflow-routing.md +22 -14
- package/src/claude/rules/state-sync.md +7 -1
- package/src/claude/rules/workflow.md +5 -3
- package/src/claude/runtime.json +1 -0
- package/src/claude/runtime.schema.json +205 -0
- package/src/claude/scripts/generate-skill-catalog.cjs +156 -122
- package/src/claude/scripts/provenance.cjs +29 -9
- package/src/claude/scripts/spec-receipt.cjs +65 -4
- package/src/claude/scripts/workflow-policy.cjs +1 -1
- package/src/claude/settings/settings.json +16 -0
- package/src/claude/skills/agent-browser/SKILL.md +1 -1
- package/src/claude/skills/ai-multimodal/SKILL.md +1 -1
- package/src/claude/skills/brainstorm/SKILL.md +193 -172
- package/src/claude/skills/brainstorm/references/question-framework.md +105 -167
- package/src/claude/skills/chrome-devtools/SKILL.md +1 -1
- package/src/claude/skills/code-review/SKILL.md +43 -25
- package/src/claude/skills/code-review/references/spec-compliance-review.md +3 -4
- package/src/claude/skills/code-review/references/verification-gate.md +1 -1
- package/src/claude/skills/debug/SKILL.md +48 -19
- package/src/claude/skills/delegate/SKILL.md +1 -1
- package/src/claude/skills/develop/SKILL.md +92 -65
- package/src/claude/skills/develop/references/parallel-waves.md +36 -63
- package/src/claude/skills/develop/references/quality-gate.md +31 -4
- package/src/claude/skills/develop/references/subagent-patterns.md +21 -7
- package/src/claude/skills/docs/SKILL.md +42 -23
- package/src/claude/skills/docs/references/init-workflow.md +4 -4
- package/src/claude/skills/docs/references/reconstruct-workflow.md +6 -6
- package/src/claude/skills/docs/references/standard-docs-workflow.md +6 -2
- package/src/claude/skills/docs/references/summarize-workflow.md +2 -2
- package/src/claude/skills/docs/references/update-workflow.md +9 -7
- package/src/claude/skills/docs/templates/requirements-as-is.md +1 -1
- package/src/claude/skills/docx/SKILL.md +1 -1
- package/src/claude/skills/git/SKILL.md +1 -1
- package/src/claude/skills/git/references/commit-protocols.md +1 -1
- package/src/claude/skills/git/references/finish-branch.md +1 -1
- package/src/claude/skills/hotfix/SKILL.md +159 -170
- package/src/claude/skills/hotfix/references/diagnosis-protocol.md +14 -9
- package/src/claude/skills/hotfix/references/parallel-patterns.md +27 -13
- package/src/claude/skills/hotfix/references/prevention-gate.md +5 -0
- package/src/claude/skills/hotfix/references/review-cycle.md +21 -15
- package/src/claude/skills/hotfix/references/workflow-specialized.md +53 -21
- package/src/claude/skills/inspect/SKILL.md +55 -46
- package/src/claude/skills/inspect/references/internal-inspection.md +21 -5
- package/src/claude/skills/loop/SKILL.md +114 -0
- package/src/claude/skills/loop/references/bounded-loop-protocol.md +104 -0
- package/src/claude/skills/loop/references/metric-and-guard-contract.md +76 -0
- package/src/claude/skills/pdf/SKILL.md +1 -1
- package/src/claude/skills/pptx/SKILL.md +1 -1
- package/src/claude/skills/question/SKILL.md +16 -13
- package/src/claude/skills/research/SKILL.md +70 -43
- package/src/claude/skills/route/SKILL.md +94 -0
- package/src/claude/skills/route/references/agent-timing.md +46 -0
- package/src/claude/skills/route/references/chaining-patterns.md +53 -0
- package/src/claude/skills/route/references/task-taxonomy.md +48 -0
- package/src/claude/skills/specs/SKILL.md +51 -71
- package/src/claude/skills/specs/references/review.md +11 -8
- package/src/claude/skills/specs/references/templates.md +34 -18
- package/src/claude/skills/specs/templates/requirements-init.md +1 -1
- package/src/claude/skills/specs/templates/research.md +2 -2
- package/src/claude/skills/sync/SKILL.md +6 -6
- package/src/claude/skills/sync/references/sync-protocols.md +1 -1
- package/src/claude/skills/test/SKILL.md +120 -120
- package/src/claude/skills/test/references/execution-strategy.md +208 -361
- package/src/claude/skills/test/references/failure-triage.md +55 -121
- package/src/claude/skills/test/references/test-memory.md +20 -34
- package/src/claude/skills/ui-ux-pro-max/SKILL.md +1 -1
- package/src/claude/skills/web-testing/SKILL.md +1 -1
- package/src/claude/skills/xlsx/SKILL.md +1 -1
- package/src/claude/status.cjs +135 -33
- package/src/codex/AGENTS.md +14 -4
- package/src/codex/hooks/docs-sync.cjs +8 -3
- package/src/codex/hooks/lib/hook-context.cjs +18 -4
- package/src/codex/hooks/rules.cjs +29 -1
- package/src/codex/hooks/secret-output-guardrail.cjs +30 -0
- package/src/codex/hooks/spec-gate.cjs +3 -8
- package/src/codex/hooks/spec-state.cjs +3 -2
- package/src/codex/hooks.json +5 -0
- package/src/codex/rules/state-sync.md +7 -1
- package/src/codex/runtime.json +2 -0
- package/src/common/.env.example +1 -1
- package/src/omp/extensions/cafekit-bridge.mjs +233 -0
- package/src/omp/hooks/privacy-block.cjs +250 -0
- package/src/omp/runtime.json +33 -0
- package/bin/lib/rtk-run.js +0 -28
- package/bin/phases/setup-rtk.js +0 -159
- package/src/claude/skills/backend-development/SKILL.md +0 -101
- package/src/claude/skills/backend-development/references/backend-api-design.md +0 -495
- package/src/claude/skills/backend-development/references/backend-architecture.md +0 -454
- package/src/claude/skills/backend-development/references/backend-authentication.md +0 -338
- package/src/claude/skills/backend-development/references/backend-code-quality.md +0 -659
- package/src/claude/skills/backend-development/references/backend-debugging.md +0 -904
- package/src/claude/skills/backend-development/references/backend-devops.md +0 -491
- package/src/claude/skills/backend-development/references/backend-mindset.md +0 -387
- package/src/claude/skills/backend-development/references/backend-performance.md +0 -397
- package/src/claude/skills/backend-development/references/backend-security.md +0 -342
- package/src/claude/skills/backend-development/references/backend-technologies.md +0 -256
- package/src/claude/skills/backend-development/references/backend-testing.md +0 -429
- package/src/claude/skills/devops/.env.example +0 -76
- package/src/claude/skills/devops/SKILL.md +0 -102
- package/src/claude/skills/devops/references/browser-rendering.md +0 -305
- package/src/claude/skills/devops/references/cloudflare-d1-kv.md +0 -123
- package/src/claude/skills/devops/references/cloudflare-platform.md +0 -271
- package/src/claude/skills/devops/references/cloudflare-r2-storage.md +0 -280
- package/src/claude/skills/devops/references/cloudflare-workers-advanced.md +0 -312
- package/src/claude/skills/devops/references/cloudflare-workers-apis.md +0 -309
- package/src/claude/skills/devops/references/cloudflare-workers-basics.md +0 -418
- package/src/claude/skills/devops/references/docker-basics.md +0 -297
- package/src/claude/skills/devops/references/docker-compose.md +0 -292
- package/src/claude/skills/devops/references/gcloud-platform.md +0 -297
- package/src/claude/skills/devops/references/gcloud-services.md +0 -304
- package/src/claude/skills/devops/references/kubernetes-basics.md +0 -95
- package/src/claude/skills/devops/references/kubernetes-helm-advanced.md +0 -70
- package/src/claude/skills/devops/references/kubernetes-helm.md +0 -81
- package/src/claude/skills/devops/references/kubernetes-kubectl.md +0 -74
- package/src/claude/skills/devops/references/kubernetes-security-advanced.md +0 -94
- package/src/claude/skills/devops/references/kubernetes-security.md +0 -89
- package/src/claude/skills/devops/references/kubernetes-troubleshooting-advanced.md +0 -74
- package/src/claude/skills/devops/references/kubernetes-troubleshooting.md +0 -49
- package/src/claude/skills/devops/references/kubernetes-workflows-advanced.md +0 -75
- package/src/claude/skills/devops/references/kubernetes-workflows.md +0 -76
- package/src/claude/skills/devops/scripts/cloudflare_deploy.py +0 -269
- package/src/claude/skills/devops/scripts/docker_optimize.py +0 -332
- package/src/claude/skills/devops/scripts/requirements.txt +0 -20
- package/src/claude/skills/devops/scripts/tests/requirements.txt +0 -3
- package/src/claude/skills/devops/scripts/tests/test_cloudflare_deploy.py +0 -285
- package/src/claude/skills/devops/scripts/tests/test_docker_optimize.py +0 -436
- package/src/claude/skills/frontend-design/SKILL.md +0 -135
- package/src/claude/skills/frontend-design/references/ai-multimodal-overview.md +0 -165
- package/src/claude/skills/frontend-design/references/analysis-best-practices.md +0 -80
- package/src/claude/skills/frontend-design/references/analysis-prompts.md +0 -141
- package/src/claude/skills/frontend-design/references/analysis-techniques.md +0 -118
- package/src/claude/skills/frontend-design/references/animejs.md +0 -396
- package/src/claude/skills/frontend-design/references/anti-slop-rules.md +0 -103
- package/src/claude/skills/frontend-design/references/asset-generation.md +0 -337
- package/src/claude/skills/frontend-design/references/bento-motion-engine.md +0 -142
- package/src/claude/skills/frontend-design/references/design-extraction-overview.md +0 -71
- package/src/claude/skills/frontend-design/references/extraction-best-practices.md +0 -141
- package/src/claude/skills/frontend-design/references/extraction-output-templates.md +0 -162
- package/src/claude/skills/frontend-design/references/extraction-prompts.md +0 -127
- package/src/claude/skills/frontend-design/references/magicui-components.md +0 -129
- package/src/claude/skills/frontend-design/references/performance-guardrails.md +0 -169
- package/src/claude/skills/frontend-design/references/premium-design-patterns.md +0 -93
- package/src/claude/skills/frontend-design/references/redesign-audit-checklist.md +0 -114
- package/src/claude/skills/frontend-design/references/technical-accessibility.md +0 -119
- package/src/claude/skills/frontend-design/references/technical-best-practices.md +0 -97
- package/src/claude/skills/frontend-design/references/technical-optimization.md +0 -44
- package/src/claude/skills/frontend-design/references/technical-overview.md +0 -90
- package/src/claude/skills/frontend-design/references/technical-workflows.md +0 -150
- package/src/claude/skills/frontend-design/references/visual-analysis-overview.md +0 -95
- package/src/claude/skills/frontend-design/references/workflow-3d.md +0 -102
- package/src/claude/skills/frontend-design/references/workflow-describe.md +0 -87
- package/src/claude/skills/frontend-design/references/workflow-immersive.md +0 -87
- package/src/claude/skills/frontend-design/references/workflow-quick.md +0 -57
- package/src/claude/skills/frontend-design/references/workflow-screenshot.md +0 -63
- package/src/claude/skills/frontend-design/references/workflow-video.md +0 -74
- package/src/claude/skills/frontend-development/SKILL.md +0 -406
- package/src/claude/skills/frontend-development/resources/common-patterns.md +0 -331
- package/src/claude/skills/frontend-development/resources/complete-examples.md +0 -872
- package/src/claude/skills/frontend-development/resources/component-patterns.md +0 -502
- package/src/claude/skills/frontend-development/resources/data-fetching.md +0 -767
- package/src/claude/skills/frontend-development/resources/file-organization.md +0 -502
- package/src/claude/skills/frontend-development/resources/loading-and-error-states.md +0 -501
- package/src/claude/skills/frontend-development/resources/performance.md +0 -406
- package/src/claude/skills/frontend-development/resources/routing-guide.md +0 -364
- package/src/claude/skills/frontend-development/resources/styling-guide.md +0 -428
- package/src/claude/skills/frontend-development/resources/typescript-standards.md +0 -418
- package/src/claude/skills/mobile-development/SKILL.md +0 -218
- package/src/claude/skills/mobile-development/references/mobile-android.md +0 -604
- package/src/claude/skills/mobile-development/references/mobile-best-practices.md +0 -544
- package/src/claude/skills/mobile-development/references/mobile-debugging.md +0 -1089
- package/src/claude/skills/mobile-development/references/mobile-frameworks.md +0 -465
- package/src/claude/skills/mobile-development/references/mobile-ios.md +0 -496
- package/src/claude/skills/mobile-development/references/mobile-mindset.md +0 -542
- package/src/claude/skills/react-best-practices/AGENTS.md +0 -2249
- package/src/claude/skills/react-best-practices/README.md +0 -123
- package/src/claude/skills/react-best-practices/SKILL.md +0 -128
- package/src/claude/skills/react-best-practices/metadata.json +0 -15
- package/src/claude/skills/react-best-practices/rules/_sections.md +0 -46
- package/src/claude/skills/react-best-practices/rules/_template.md +0 -28
- package/src/claude/skills/react-best-practices/rules/advanced-event-handler-refs.md +0 -55
- package/src/claude/skills/react-best-practices/rules/advanced-use-latest.md +0 -49
- package/src/claude/skills/react-best-practices/rules/async-api-routes.md +0 -38
- package/src/claude/skills/react-best-practices/rules/async-defer-await.md +0 -80
- package/src/claude/skills/react-best-practices/rules/async-dependencies.md +0 -36
- package/src/claude/skills/react-best-practices/rules/async-parallel.md +0 -28
- package/src/claude/skills/react-best-practices/rules/async-suspense-boundaries.md +0 -99
- package/src/claude/skills/react-best-practices/rules/bundle-barrel-imports.md +0 -59
- package/src/claude/skills/react-best-practices/rules/bundle-conditional.md +0 -31
- package/src/claude/skills/react-best-practices/rules/bundle-defer-third-party.md +0 -49
- package/src/claude/skills/react-best-practices/rules/bundle-dynamic-imports.md +0 -35
- package/src/claude/skills/react-best-practices/rules/bundle-preload.md +0 -50
- package/src/claude/skills/react-best-practices/rules/client-event-listeners.md +0 -74
- package/src/claude/skills/react-best-practices/rules/client-swr-dedup.md +0 -56
- package/src/claude/skills/react-best-practices/rules/js-batch-dom-css.md +0 -82
- package/src/claude/skills/react-best-practices/rules/js-cache-function-results.md +0 -80
- package/src/claude/skills/react-best-practices/rules/js-cache-property-access.md +0 -28
- package/src/claude/skills/react-best-practices/rules/js-cache-storage.md +0 -70
- package/src/claude/skills/react-best-practices/rules/js-combine-iterations.md +0 -32
- package/src/claude/skills/react-best-practices/rules/js-early-exit.md +0 -50
- package/src/claude/skills/react-best-practices/rules/js-hoist-regexp.md +0 -45
- package/src/claude/skills/react-best-practices/rules/js-index-maps.md +0 -37
- package/src/claude/skills/react-best-practices/rules/js-length-check-first.md +0 -49
- package/src/claude/skills/react-best-practices/rules/js-min-max-loop.md +0 -82
- package/src/claude/skills/react-best-practices/rules/js-set-map-lookups.md +0 -24
- package/src/claude/skills/react-best-practices/rules/js-tosorted-immutable.md +0 -57
- package/src/claude/skills/react-best-practices/rules/rendering-activity.md +0 -26
- package/src/claude/skills/react-best-practices/rules/rendering-animate-svg-wrapper.md +0 -47
- package/src/claude/skills/react-best-practices/rules/rendering-conditional-render.md +0 -40
- package/src/claude/skills/react-best-practices/rules/rendering-content-visibility.md +0 -38
- package/src/claude/skills/react-best-practices/rules/rendering-hoist-jsx.md +0 -46
- package/src/claude/skills/react-best-practices/rules/rendering-hydration-no-flicker.md +0 -82
- package/src/claude/skills/react-best-practices/rules/rendering-svg-precision.md +0 -28
- package/src/claude/skills/react-best-practices/rules/rerender-defer-reads.md +0 -39
- package/src/claude/skills/react-best-practices/rules/rerender-dependencies.md +0 -45
- package/src/claude/skills/react-best-practices/rules/rerender-derived-state.md +0 -29
- package/src/claude/skills/react-best-practices/rules/rerender-functional-setstate.md +0 -74
- package/src/claude/skills/react-best-practices/rules/rerender-lazy-state-init.md +0 -58
- package/src/claude/skills/react-best-practices/rules/rerender-memo.md +0 -44
- package/src/claude/skills/react-best-practices/rules/rerender-transitions.md +0 -40
- package/src/claude/skills/react-best-practices/rules/server-after-nonblocking.md +0 -73
- package/src/claude/skills/react-best-practices/rules/server-cache-lru.md +0 -41
- package/src/claude/skills/react-best-practices/rules/server-cache-react.md +0 -26
- package/src/claude/skills/react-best-practices/rules/server-parallel-fetching.md +0 -79
- package/src/claude/skills/react-best-practices/rules/server-serialization.md +0 -38
|
@@ -1,428 +0,0 @@
|
|
|
1
|
-
# Styling Guide
|
|
2
|
-
|
|
3
|
-
Modern styling patterns for using MUI v7 sx prop, inline styles, and theme integration.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Inline vs Separate Styles
|
|
8
|
-
|
|
9
|
-
### Decision Threshold
|
|
10
|
-
|
|
11
|
-
**<100 lines: Inline styles at top of component**
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import type { SxProps, Theme } from '@mui/material';
|
|
15
|
-
|
|
16
|
-
const componentStyles: Record<string, SxProps<Theme>> = {
|
|
17
|
-
container: {
|
|
18
|
-
p: 2,
|
|
19
|
-
display: 'flex',
|
|
20
|
-
flexDirection: 'column',
|
|
21
|
-
},
|
|
22
|
-
header: {
|
|
23
|
-
mb: 2,
|
|
24
|
-
borderBottom: '1px solid',
|
|
25
|
-
borderColor: 'divider',
|
|
26
|
-
},
|
|
27
|
-
// ... more styles
|
|
28
|
-
};
|
|
29
|
-
|
|
30
|
-
export const MyComponent: React.FC = () => {
|
|
31
|
-
return (
|
|
32
|
-
<Box sx={componentStyles.container}>
|
|
33
|
-
<Box sx={componentStyles.header}>
|
|
34
|
-
<h2>Title</h2>
|
|
35
|
-
</Box>
|
|
36
|
-
</Box>
|
|
37
|
-
);
|
|
38
|
-
};
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**>100 lines: Separate `.styles.ts` file**
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
// MyComponent.styles.ts
|
|
45
|
-
import type { SxProps, Theme } from '@mui/material';
|
|
46
|
-
|
|
47
|
-
export const componentStyles: Record<string, SxProps<Theme>> = {
|
|
48
|
-
container: { ... },
|
|
49
|
-
header: { ... },
|
|
50
|
-
// ... 100+ lines of styles
|
|
51
|
-
};
|
|
52
|
-
|
|
53
|
-
// MyComponent.tsx
|
|
54
|
-
import { componentStyles } from './MyComponent.styles';
|
|
55
|
-
|
|
56
|
-
export const MyComponent: React.FC = () => {
|
|
57
|
-
return <Box sx={componentStyles.container}>...</Box>;
|
|
58
|
-
};
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Real Example: UnifiedForm.tsx
|
|
62
|
-
|
|
63
|
-
**Lines 48-126**: 78 lines of inline styles (acceptable)
|
|
64
|
-
|
|
65
|
-
```typescript
|
|
66
|
-
const formStyles: Record<string, SxProps<Theme>> = {
|
|
67
|
-
gridContainer: {
|
|
68
|
-
height: '100%',
|
|
69
|
-
maxHeight: 'calc(100vh - 220px)',
|
|
70
|
-
},
|
|
71
|
-
section: {
|
|
72
|
-
height: '100%',
|
|
73
|
-
maxHeight: 'calc(100vh - 220px)',
|
|
74
|
-
overflow: 'auto',
|
|
75
|
-
p: 4,
|
|
76
|
-
},
|
|
77
|
-
// ... 15 more style objects
|
|
78
|
-
};
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**Guideline**: User is comfortable with ~80 lines inline. Use your judgment around 100 lines.
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## sx Prop Patterns
|
|
86
|
-
|
|
87
|
-
### Basic Usage
|
|
88
|
-
|
|
89
|
-
```typescript
|
|
90
|
-
<Box sx={{ p: 2, mb: 3, display: 'flex' }}>
|
|
91
|
-
Content
|
|
92
|
-
</Box>
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### With Theme Access
|
|
96
|
-
|
|
97
|
-
```typescript
|
|
98
|
-
<Box
|
|
99
|
-
sx={{
|
|
100
|
-
p: 2,
|
|
101
|
-
backgroundColor: (theme) => theme.palette.primary.main,
|
|
102
|
-
color: (theme) => theme.palette.primary.contrastText,
|
|
103
|
-
borderRadius: (theme) => theme.shape.borderRadius,
|
|
104
|
-
}}
|
|
105
|
-
>
|
|
106
|
-
Themed Box
|
|
107
|
-
</Box>
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### Responsive Styles
|
|
111
|
-
|
|
112
|
-
```typescript
|
|
113
|
-
<Box
|
|
114
|
-
sx={{
|
|
115
|
-
p: { xs: 1, sm: 2, md: 3 },
|
|
116
|
-
width: { xs: '100%', md: '50%' },
|
|
117
|
-
flexDirection: { xs: 'column', md: 'row' },
|
|
118
|
-
}}
|
|
119
|
-
>
|
|
120
|
-
Responsive Layout
|
|
121
|
-
</Box>
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Pseudo-Selectors
|
|
125
|
-
|
|
126
|
-
```typescript
|
|
127
|
-
<Box
|
|
128
|
-
sx={{
|
|
129
|
-
p: 2,
|
|
130
|
-
'&:hover': {
|
|
131
|
-
backgroundColor: 'rgba(0,0,0,0.05)',
|
|
132
|
-
},
|
|
133
|
-
'&:active': {
|
|
134
|
-
backgroundColor: 'rgba(0,0,0,0.1)',
|
|
135
|
-
},
|
|
136
|
-
'& .child-class': {
|
|
137
|
-
color: 'primary.main',
|
|
138
|
-
},
|
|
139
|
-
}}
|
|
140
|
-
>
|
|
141
|
-
Interactive Box
|
|
142
|
-
</Box>
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
## MUI v7 Patterns
|
|
148
|
-
|
|
149
|
-
### Grid Component (v7 Syntax)
|
|
150
|
-
|
|
151
|
-
```typescript
|
|
152
|
-
import { Grid } from '@mui/material';
|
|
153
|
-
|
|
154
|
-
// ✅ CORRECT - v7 syntax with size prop
|
|
155
|
-
<Grid container spacing={2}>
|
|
156
|
-
<Grid size={{ xs: 12, md: 6 }}>
|
|
157
|
-
Left Column
|
|
158
|
-
</Grid>
|
|
159
|
-
<Grid size={{ xs: 12, md: 6 }}>
|
|
160
|
-
Right Column
|
|
161
|
-
</Grid>
|
|
162
|
-
</Grid>
|
|
163
|
-
|
|
164
|
-
// ❌ WRONG - Old v6 syntax
|
|
165
|
-
<Grid container spacing={2}>
|
|
166
|
-
<Grid xs={12} md={6}> {/* OLD - Don't use */}
|
|
167
|
-
Content
|
|
168
|
-
</Grid>
|
|
169
|
-
</Grid>
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
**Key Change**: `size={{ xs: 12, md: 6 }}` instead of `xs={12} md={6}`
|
|
173
|
-
|
|
174
|
-
### Responsive Grid
|
|
175
|
-
|
|
176
|
-
```typescript
|
|
177
|
-
<Grid container spacing={3}>
|
|
178
|
-
<Grid size={{ xs: 12, sm: 6, md: 4, lg: 3 }}>
|
|
179
|
-
Responsive Column
|
|
180
|
-
</Grid>
|
|
181
|
-
</Grid>
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Nested Grids
|
|
185
|
-
|
|
186
|
-
```typescript
|
|
187
|
-
<Grid container spacing={2}>
|
|
188
|
-
<Grid size={{ xs: 12, md: 8 }}>
|
|
189
|
-
<Grid container spacing={1}>
|
|
190
|
-
<Grid size={{ xs: 12, sm: 6 }}>
|
|
191
|
-
Nested 1
|
|
192
|
-
</Grid>
|
|
193
|
-
<Grid size={{ xs: 12, sm: 6 }}>
|
|
194
|
-
Nested 2
|
|
195
|
-
</Grid>
|
|
196
|
-
</Grid>
|
|
197
|
-
</Grid>
|
|
198
|
-
|
|
199
|
-
<Grid size={{ xs: 12, md: 4 }}>
|
|
200
|
-
Sidebar
|
|
201
|
-
</Grid>
|
|
202
|
-
</Grid>
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## Type-Safe Styles
|
|
208
|
-
|
|
209
|
-
### Style Object Type
|
|
210
|
-
|
|
211
|
-
```typescript
|
|
212
|
-
import type { SxProps, Theme } from '@mui/material';
|
|
213
|
-
|
|
214
|
-
// Type-safe styles
|
|
215
|
-
const styles: Record<string, SxProps<Theme>> = {
|
|
216
|
-
container: {
|
|
217
|
-
p: 2,
|
|
218
|
-
// Autocomplete and type checking work here
|
|
219
|
-
},
|
|
220
|
-
};
|
|
221
|
-
|
|
222
|
-
// Or individual style
|
|
223
|
-
const containerStyle: SxProps<Theme> = {
|
|
224
|
-
p: 2,
|
|
225
|
-
display: 'flex',
|
|
226
|
-
};
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
### Theme-Aware Styles
|
|
230
|
-
|
|
231
|
-
```typescript
|
|
232
|
-
const styles: Record<string, SxProps<Theme>> = {
|
|
233
|
-
primary: {
|
|
234
|
-
color: (theme) => theme.palette.primary.main,
|
|
235
|
-
backgroundColor: (theme) => theme.palette.primary.light,
|
|
236
|
-
'&:hover': {
|
|
237
|
-
backgroundColor: (theme) => theme.palette.primary.dark,
|
|
238
|
-
},
|
|
239
|
-
},
|
|
240
|
-
customSpacing: {
|
|
241
|
-
padding: (theme) => theme.spacing(2),
|
|
242
|
-
margin: (theme) => theme.spacing(1, 2), // top/bottom: 1, left/right: 2
|
|
243
|
-
},
|
|
244
|
-
};
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
---
|
|
248
|
-
|
|
249
|
-
## What NOT to Use
|
|
250
|
-
|
|
251
|
-
### ❌ makeStyles (MUI v4 pattern)
|
|
252
|
-
|
|
253
|
-
```typescript
|
|
254
|
-
// ❌ AVOID - Old Material-UI v4 pattern
|
|
255
|
-
import { makeStyles } from '@mui/styles';
|
|
256
|
-
|
|
257
|
-
const useStyles = makeStyles((theme) => ({
|
|
258
|
-
root: {
|
|
259
|
-
padding: theme.spacing(2),
|
|
260
|
-
},
|
|
261
|
-
}));
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
**Why avoid**: Deprecated, v7 doesn't support it well
|
|
265
|
-
|
|
266
|
-
### ❌ styled() Components
|
|
267
|
-
|
|
268
|
-
```typescript
|
|
269
|
-
// ❌ AVOID - styled-components pattern
|
|
270
|
-
import { styled } from '@mui/material/styles';
|
|
271
|
-
|
|
272
|
-
const StyledBox = styled(Box)(({ theme }) => ({
|
|
273
|
-
padding: theme.spacing(2),
|
|
274
|
-
}));
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
**Why avoid**: sx prop is more flexible and doesn't create new components
|
|
278
|
-
|
|
279
|
-
### ✅ Use sx Prop Instead
|
|
280
|
-
|
|
281
|
-
```typescript
|
|
282
|
-
// ✅ PREFERRED
|
|
283
|
-
<Box
|
|
284
|
-
sx={{
|
|
285
|
-
p: 2,
|
|
286
|
-
backgroundColor: 'primary.main',
|
|
287
|
-
}}
|
|
288
|
-
>
|
|
289
|
-
Content
|
|
290
|
-
</Box>
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
---
|
|
294
|
-
|
|
295
|
-
## Code Style Standards
|
|
296
|
-
|
|
297
|
-
### Indentation
|
|
298
|
-
|
|
299
|
-
**4 spaces** (not 2, not tabs)
|
|
300
|
-
|
|
301
|
-
```typescript
|
|
302
|
-
const styles: Record<string, SxProps<Theme>> = {
|
|
303
|
-
container: {
|
|
304
|
-
p: 2,
|
|
305
|
-
display: 'flex',
|
|
306
|
-
flexDirection: 'column',
|
|
307
|
-
},
|
|
308
|
-
};
|
|
309
|
-
```
|
|
310
|
-
|
|
311
|
-
### Quotes
|
|
312
|
-
|
|
313
|
-
**Single quotes** for strings (project standard)
|
|
314
|
-
|
|
315
|
-
```typescript
|
|
316
|
-
// ✅ CORRECT
|
|
317
|
-
const color = 'primary.main';
|
|
318
|
-
import { Box } from '@mui/material';
|
|
319
|
-
|
|
320
|
-
// ❌ WRONG
|
|
321
|
-
const color = "primary.main";
|
|
322
|
-
import { Box } from "@mui/material";
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
### Trailing Commas
|
|
326
|
-
|
|
327
|
-
**Always use trailing commas** in objects and arrays
|
|
328
|
-
|
|
329
|
-
```typescript
|
|
330
|
-
// ✅ CORRECT
|
|
331
|
-
const styles = {
|
|
332
|
-
container: { p: 2 },
|
|
333
|
-
header: { mb: 1 }, // Trailing comma
|
|
334
|
-
};
|
|
335
|
-
|
|
336
|
-
const items = [
|
|
337
|
-
'item1',
|
|
338
|
-
'item2', // Trailing comma
|
|
339
|
-
];
|
|
340
|
-
|
|
341
|
-
// ❌ WRONG - No trailing comma
|
|
342
|
-
const styles = {
|
|
343
|
-
container: { p: 2 },
|
|
344
|
-
header: { mb: 1 } // Missing comma
|
|
345
|
-
};
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
---
|
|
349
|
-
|
|
350
|
-
## Common Style Patterns
|
|
351
|
-
|
|
352
|
-
### Flexbox Layout
|
|
353
|
-
|
|
354
|
-
```typescript
|
|
355
|
-
const styles = {
|
|
356
|
-
flexRow: {
|
|
357
|
-
display: 'flex',
|
|
358
|
-
flexDirection: 'row',
|
|
359
|
-
alignItems: 'center',
|
|
360
|
-
gap: 2,
|
|
361
|
-
},
|
|
362
|
-
flexColumn: {
|
|
363
|
-
display: 'flex',
|
|
364
|
-
flexDirection: 'column',
|
|
365
|
-
gap: 1,
|
|
366
|
-
},
|
|
367
|
-
spaceBetween: {
|
|
368
|
-
display: 'flex',
|
|
369
|
-
justifyContent: 'space-between',
|
|
370
|
-
alignItems: 'center',
|
|
371
|
-
},
|
|
372
|
-
};
|
|
373
|
-
```
|
|
374
|
-
|
|
375
|
-
### Spacing
|
|
376
|
-
|
|
377
|
-
```typescript
|
|
378
|
-
// Padding
|
|
379
|
-
p: 2 // All sides
|
|
380
|
-
px: 2 // Horizontal (left + right)
|
|
381
|
-
py: 2 // Vertical (top + bottom)
|
|
382
|
-
pt: 2, pr: 1 // Specific sides
|
|
383
|
-
|
|
384
|
-
// Margin
|
|
385
|
-
m: 2, mx: 2, my: 2, mt: 2, mr: 1
|
|
386
|
-
|
|
387
|
-
// Units: 1 = 8px (theme.spacing(1))
|
|
388
|
-
p: 2 // = 16px
|
|
389
|
-
p: 0.5 // = 4px
|
|
390
|
-
```
|
|
391
|
-
|
|
392
|
-
### Positioning
|
|
393
|
-
|
|
394
|
-
```typescript
|
|
395
|
-
const styles = {
|
|
396
|
-
relative: {
|
|
397
|
-
position: 'relative',
|
|
398
|
-
},
|
|
399
|
-
absolute: {
|
|
400
|
-
position: 'absolute',
|
|
401
|
-
top: 0,
|
|
402
|
-
right: 0,
|
|
403
|
-
},
|
|
404
|
-
sticky: {
|
|
405
|
-
position: 'sticky',
|
|
406
|
-
top: 0,
|
|
407
|
-
zIndex: 1000,
|
|
408
|
-
},
|
|
409
|
-
};
|
|
410
|
-
```
|
|
411
|
-
|
|
412
|
-
---
|
|
413
|
-
|
|
414
|
-
## Summary
|
|
415
|
-
|
|
416
|
-
**Styling Checklist:**
|
|
417
|
-
- ✅ Use `sx` prop for MUI styling
|
|
418
|
-
- ✅ Type-safe with `SxProps<Theme>`
|
|
419
|
-
- ✅ <100 lines: inline; >100 lines: separate file
|
|
420
|
-
- ✅ MUI v7 Grid: `size={{ xs: 12 }}`
|
|
421
|
-
- ✅ 4 space indentation
|
|
422
|
-
- ✅ Single quotes
|
|
423
|
-
- ✅ Trailing commas
|
|
424
|
-
- ❌ No makeStyles or styled()
|
|
425
|
-
|
|
426
|
-
**See Also:**
|
|
427
|
-
- [component-patterns.md](component-patterns.md) - Component structure
|
|
428
|
-
- [complete-examples.md](complete-examples.md) - Full styling examples
|