@haposoft/cafekit 0.16.0-rc.7 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +116 -27
- package/bin/__tests__/codex-hooks-ownership.test.js +239 -0
- package/bin/__tests__/codex-hooks.test.js +295 -0
- package/bin/__tests__/codex-native.test.js +2289 -34
- package/bin/__tests__/develop-contract.test.js +400 -23
- package/bin/__tests__/installer-safety.test.js +3 -3
- 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 +2131 -16
- package/bin/__tests__/runtime-schema.test.js +111 -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 +1 -1
- package/bin/install.js +10 -0
- package/bin/lib/codex-install.js +170 -5
- package/bin/lib/context.js +14 -0
- package/bin/lib/i18n.js +12 -6
- 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 +8 -2
- 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/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 +24 -13
- 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__/spec-gate.test.js +87 -4
- package/src/claude/hooks/__tests__/state.test.js +254 -3
- package/src/claude/hooks/__tests__/statusline.test.js +196 -0
- package/src/claude/hooks/agent.cjs +1 -1
- package/src/claude/hooks/docs-sync.cjs +12 -10
- package/src/claude/hooks/inspect-block.cjs +1 -1
- package/src/claude/hooks/lib/config.cjs +3 -0
- package/src/claude/hooks/lib/hook-state-dir.cjs +39 -0
- package/src/claude/hooks/lib/secret-keywords.cjs +42 -0
- package/src/claude/hooks/precompact.cjs +105 -0
- package/src/claude/hooks/rules.cjs +1 -1
- package/src/claude/hooks/secret-output-guardrail.cjs +43 -0
- package/src/claude/hooks/session.cjs +27 -1
- package/src/claude/hooks/spec-gate.cjs +3 -3
- package/src/claude/hooks/spec-state.cjs +32 -5
- package/src/claude/hooks/state.cjs +1 -1
- package/src/claude/hooks/task-scaffold-guard.cjs +1 -1
- package/src/claude/hooks/usage.cjs +1 -1
- package/src/claude/migration-manifest.json +29 -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/workflow.md +3 -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 +18 -5
- package/src/claude/scripts/spec-receipt.cjs +76 -21
- package/src/claude/scripts/spec-resolver.cjs +144 -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 +48 -57
- package/src/claude/skills/specs/references/review.md +26 -8
- package/src/claude/skills/specs/references/templates.md +76 -31
- 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 +34 -5
- package/src/codex/hooks.json +5 -0
- package/src/codex/runtime.json +2 -0
- package/src/common/.env.example +1 -1
- 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,364 +0,0 @@
|
|
|
1
|
-
# Routing Guide
|
|
2
|
-
|
|
3
|
-
TanStack Router implementation with folder-based routing and lazy loading patterns.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## TanStack Router Overview
|
|
8
|
-
|
|
9
|
-
**TanStack Router** with file-based routing:
|
|
10
|
-
- Folder structure defines routes
|
|
11
|
-
- Lazy loading for code splitting
|
|
12
|
-
- Type-safe routing
|
|
13
|
-
- Breadcrumb loaders
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Folder-Based Routing
|
|
18
|
-
|
|
19
|
-
### Directory Structure
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
routes/
|
|
23
|
-
__root.tsx # Root layout
|
|
24
|
-
index.tsx # Home route (/)
|
|
25
|
-
posts/
|
|
26
|
-
index.tsx # /posts
|
|
27
|
-
create/
|
|
28
|
-
index.tsx # /posts/create
|
|
29
|
-
$postId.tsx # /posts/:postId (dynamic)
|
|
30
|
-
comments/
|
|
31
|
-
index.tsx # /comments
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
**Pattern**:
|
|
35
|
-
- `index.tsx` = Route at that path
|
|
36
|
-
- `$param.tsx` = Dynamic parameter
|
|
37
|
-
- Nested folders = Nested routes
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## Basic Route Pattern
|
|
42
|
-
|
|
43
|
-
### Example from posts/index.tsx
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
/**
|
|
47
|
-
* Posts route component
|
|
48
|
-
* Displays the main blog posts list
|
|
49
|
-
*/
|
|
50
|
-
|
|
51
|
-
import { createFileRoute } from '@tanstack/react-router';
|
|
52
|
-
import { lazy } from 'react';
|
|
53
|
-
|
|
54
|
-
// Lazy load the page component
|
|
55
|
-
const PostsList = lazy(() =>
|
|
56
|
-
import('@/features/posts/components/PostsList').then(
|
|
57
|
-
(module) => ({ default: module.PostsList }),
|
|
58
|
-
),
|
|
59
|
-
);
|
|
60
|
-
|
|
61
|
-
export const Route = createFileRoute('/posts/')({
|
|
62
|
-
component: PostsPage,
|
|
63
|
-
// Define breadcrumb data
|
|
64
|
-
loader: () => ({
|
|
65
|
-
crumb: 'Posts',
|
|
66
|
-
}),
|
|
67
|
-
});
|
|
68
|
-
|
|
69
|
-
function PostsPage() {
|
|
70
|
-
return (
|
|
71
|
-
<PostsList
|
|
72
|
-
title='All Posts'
|
|
73
|
-
showFilters={true}
|
|
74
|
-
/>
|
|
75
|
-
);
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export default PostsPage;
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**Key Points:**
|
|
82
|
-
- Lazy load heavy components
|
|
83
|
-
- `createFileRoute` with route path
|
|
84
|
-
- `loader` for breadcrumb data
|
|
85
|
-
- Page component renders content
|
|
86
|
-
- Export both Route and component
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## Lazy Loading Routes
|
|
91
|
-
|
|
92
|
-
### Named Export Pattern
|
|
93
|
-
|
|
94
|
-
```typescript
|
|
95
|
-
import { lazy } from 'react';
|
|
96
|
-
|
|
97
|
-
// For named exports, use .then() to map to default
|
|
98
|
-
const MyPage = lazy(() =>
|
|
99
|
-
import('@/features/my-feature/components/MyPage').then(
|
|
100
|
-
(module) => ({ default: module.MyPage })
|
|
101
|
-
)
|
|
102
|
-
);
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### Default Export Pattern
|
|
106
|
-
|
|
107
|
-
```typescript
|
|
108
|
-
import { lazy } from 'react';
|
|
109
|
-
|
|
110
|
-
// For default exports, simpler syntax
|
|
111
|
-
const MyPage = lazy(() => import('@/features/my-feature/components/MyPage'));
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Why Lazy Load Routes?
|
|
115
|
-
|
|
116
|
-
- Code splitting - smaller initial bundle
|
|
117
|
-
- Faster initial page load
|
|
118
|
-
- Load route code only when navigated to
|
|
119
|
-
- Better performance
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
## createFileRoute
|
|
124
|
-
|
|
125
|
-
### Basic Configuration
|
|
126
|
-
|
|
127
|
-
```typescript
|
|
128
|
-
export const Route = createFileRoute('/my-route/')({
|
|
129
|
-
component: MyRoutePage,
|
|
130
|
-
});
|
|
131
|
-
|
|
132
|
-
function MyRoutePage() {
|
|
133
|
-
return <div>My Route Content</div>;
|
|
134
|
-
}
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### With Breadcrumb Loader
|
|
138
|
-
|
|
139
|
-
```typescript
|
|
140
|
-
export const Route = createFileRoute('/my-route/')({
|
|
141
|
-
component: MyRoutePage,
|
|
142
|
-
loader: () => ({
|
|
143
|
-
crumb: 'My Route Title',
|
|
144
|
-
}),
|
|
145
|
-
});
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
Breadcrumb appears in navigation/app bar automatically.
|
|
149
|
-
|
|
150
|
-
### With Data Loader
|
|
151
|
-
|
|
152
|
-
```typescript
|
|
153
|
-
export const Route = createFileRoute('/my-route/')({
|
|
154
|
-
component: MyRoutePage,
|
|
155
|
-
loader: async () => {
|
|
156
|
-
// Can prefetch data here
|
|
157
|
-
const data = await api.getData();
|
|
158
|
-
return { crumb: 'My Route', data };
|
|
159
|
-
},
|
|
160
|
-
});
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
### With Search Params
|
|
164
|
-
|
|
165
|
-
```typescript
|
|
166
|
-
export const Route = createFileRoute('/search/')({
|
|
167
|
-
component: SearchPage,
|
|
168
|
-
validateSearch: (search: Record<string, unknown>) => {
|
|
169
|
-
return {
|
|
170
|
-
query: (search.query as string) || '',
|
|
171
|
-
page: Number(search.page) || 1,
|
|
172
|
-
};
|
|
173
|
-
},
|
|
174
|
-
});
|
|
175
|
-
|
|
176
|
-
function SearchPage() {
|
|
177
|
-
const { query, page } = Route.useSearch();
|
|
178
|
-
// Use query and page
|
|
179
|
-
}
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
---
|
|
183
|
-
|
|
184
|
-
## Dynamic Routes
|
|
185
|
-
|
|
186
|
-
### Parameter Routes
|
|
187
|
-
|
|
188
|
-
```typescript
|
|
189
|
-
// routes/users/$userId.tsx
|
|
190
|
-
|
|
191
|
-
export const Route = createFileRoute('/users/$userId')({
|
|
192
|
-
component: UserPage,
|
|
193
|
-
});
|
|
194
|
-
|
|
195
|
-
function UserPage() {
|
|
196
|
-
const { userId } = Route.useParams();
|
|
197
|
-
|
|
198
|
-
return <UserProfile userId={userId} />;
|
|
199
|
-
}
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Multiple Parameters
|
|
203
|
-
|
|
204
|
-
```typescript
|
|
205
|
-
// routes/posts/$postId/comments/$commentId.tsx
|
|
206
|
-
|
|
207
|
-
export const Route = createFileRoute('/posts/$postId/comments/$commentId')({
|
|
208
|
-
component: CommentPage,
|
|
209
|
-
});
|
|
210
|
-
|
|
211
|
-
function CommentPage() {
|
|
212
|
-
const { postId, commentId } = Route.useParams();
|
|
213
|
-
|
|
214
|
-
return <CommentEditor postId={postId} commentId={commentId} />;
|
|
215
|
-
}
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
---
|
|
219
|
-
|
|
220
|
-
## Navigation
|
|
221
|
-
|
|
222
|
-
### Programmatic Navigation
|
|
223
|
-
|
|
224
|
-
```typescript
|
|
225
|
-
import { useNavigate } from '@tanstack/react-router';
|
|
226
|
-
|
|
227
|
-
export const MyComponent: React.FC = () => {
|
|
228
|
-
const navigate = useNavigate();
|
|
229
|
-
|
|
230
|
-
const handleClick = () => {
|
|
231
|
-
navigate({ to: '/posts' });
|
|
232
|
-
};
|
|
233
|
-
|
|
234
|
-
return <Button onClick={handleClick}>View Posts</Button>;
|
|
235
|
-
};
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
### With Parameters
|
|
239
|
-
|
|
240
|
-
```typescript
|
|
241
|
-
const handleNavigate = () => {
|
|
242
|
-
navigate({
|
|
243
|
-
to: '/users/$userId',
|
|
244
|
-
params: { userId: '123' },
|
|
245
|
-
});
|
|
246
|
-
};
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
### With Search Params
|
|
250
|
-
|
|
251
|
-
```typescript
|
|
252
|
-
const handleSearch = () => {
|
|
253
|
-
navigate({
|
|
254
|
-
to: '/search',
|
|
255
|
-
search: { query: 'test', page: 1 },
|
|
256
|
-
});
|
|
257
|
-
};
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
---
|
|
261
|
-
|
|
262
|
-
## Route Layout Pattern
|
|
263
|
-
|
|
264
|
-
### Root Layout (__root.tsx)
|
|
265
|
-
|
|
266
|
-
```typescript
|
|
267
|
-
import { createRootRoute, Outlet } from '@tanstack/react-router';
|
|
268
|
-
import { Box } from '@mui/material';
|
|
269
|
-
import { CustomAppBar } from '~components/CustomAppBar';
|
|
270
|
-
|
|
271
|
-
export const Route = createRootRoute({
|
|
272
|
-
component: RootLayout,
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
function RootLayout() {
|
|
276
|
-
return (
|
|
277
|
-
<Box>
|
|
278
|
-
<CustomAppBar />
|
|
279
|
-
<Box sx={{ p: 2 }}>
|
|
280
|
-
<Outlet /> {/* Child routes render here */}
|
|
281
|
-
</Box>
|
|
282
|
-
</Box>
|
|
283
|
-
);
|
|
284
|
-
}
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
### Nested Layouts
|
|
288
|
-
|
|
289
|
-
```typescript
|
|
290
|
-
// routes/dashboard/index.tsx
|
|
291
|
-
export const Route = createFileRoute('/dashboard/')({
|
|
292
|
-
component: DashboardLayout,
|
|
293
|
-
});
|
|
294
|
-
|
|
295
|
-
function DashboardLayout() {
|
|
296
|
-
return (
|
|
297
|
-
<Box>
|
|
298
|
-
<DashboardSidebar />
|
|
299
|
-
<Box sx={{ flex: 1 }}>
|
|
300
|
-
<Outlet /> {/* Nested routes */}
|
|
301
|
-
</Box>
|
|
302
|
-
</Box>
|
|
303
|
-
);
|
|
304
|
-
}
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
## Complete Route Example
|
|
310
|
-
|
|
311
|
-
```typescript
|
|
312
|
-
/**
|
|
313
|
-
* User profile route
|
|
314
|
-
* Path: /users/:userId
|
|
315
|
-
*/
|
|
316
|
-
|
|
317
|
-
import { createFileRoute } from '@tanstack/react-router';
|
|
318
|
-
import { lazy } from 'react';
|
|
319
|
-
import { SuspenseLoader } from '~components/SuspenseLoader';
|
|
320
|
-
|
|
321
|
-
// Lazy load heavy component
|
|
322
|
-
const UserProfile = lazy(() =>
|
|
323
|
-
import('@/features/users/components/UserProfile').then(
|
|
324
|
-
(module) => ({ default: module.UserProfile })
|
|
325
|
-
)
|
|
326
|
-
);
|
|
327
|
-
|
|
328
|
-
export const Route = createFileRoute('/users/$userId')({
|
|
329
|
-
component: UserPage,
|
|
330
|
-
loader: () => ({
|
|
331
|
-
crumb: 'User Profile',
|
|
332
|
-
}),
|
|
333
|
-
});
|
|
334
|
-
|
|
335
|
-
function UserPage() {
|
|
336
|
-
const { userId } = Route.useParams();
|
|
337
|
-
|
|
338
|
-
return (
|
|
339
|
-
<SuspenseLoader>
|
|
340
|
-
<UserProfile userId={userId} />
|
|
341
|
-
</SuspenseLoader>
|
|
342
|
-
);
|
|
343
|
-
}
|
|
344
|
-
|
|
345
|
-
export default UserPage;
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
---
|
|
349
|
-
|
|
350
|
-
## Summary
|
|
351
|
-
|
|
352
|
-
**Routing Checklist:**
|
|
353
|
-
- ✅ Folder-based: `routes/my-route/index.tsx`
|
|
354
|
-
- ✅ Lazy load components: `React.lazy(() => import())`
|
|
355
|
-
- ✅ Use `createFileRoute` with route path
|
|
356
|
-
- ✅ Add breadcrumb in `loader` function
|
|
357
|
-
- ✅ Wrap in `SuspenseLoader` for loading states
|
|
358
|
-
- ✅ Use `Route.useParams()` for dynamic params
|
|
359
|
-
- ✅ Use `useNavigate()` for programmatic navigation
|
|
360
|
-
|
|
361
|
-
**See Also:**
|
|
362
|
-
- [component-patterns.md](component-patterns.md) - Lazy loading patterns
|
|
363
|
-
- [loading-and-error-states.md](loading-and-error-states.md) - SuspenseLoader usage
|
|
364
|
-
- [complete-examples.md](complete-examples.md) - Full route examples
|