@punks/cli 0.1.16 → 1.0.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/AGENTS.md +10 -0
- package/README.md +64 -0
- package/dist/data/AGENTS.md +123 -0
- package/dist/data/catalog/lint.ts +349 -0
- package/dist/data/catalog/packs.ts +44 -0
- package/dist/data/catalog/skills.ts +47 -0
- package/dist/data/catalog/tools.ts +22 -0
- package/dist/data/hooks/format-edited-file.mjs +554 -0
- package/dist/data/hooks/format-edited-file.py +157 -0
- package/dist/data/hooks/format-edited-file.sh +37 -0
- package/dist/data/hooks/require-tests-for-pr.mjs +144 -0
- package/dist/data/scripts/sync-subagents.mjs +420 -0
- package/dist/data/subagents/manifest.mjs +253 -0
- package/dist/index.js +46415 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/SKILL.md +50 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/references/layout.md +167 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/SKILL.md +49 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/references/strategy-matrix.md +34 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/references/test-matrix.md +34 -0
- package/dist/skills/agnostic/docs/docs-maintenance/SKILL.md +193 -0
- package/dist/skills/agnostic/docs/docs-maintenance/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/docs/docs-maintenance/references/concept-pages.md +48 -0
- package/dist/skills/agnostic/docs/docs-maintenance/references/flow-pages.md +41 -0
- package/dist/skills/agnostic/frontend/agent-browser/.clawdhub/origin.json +7 -0
- package/dist/skills/agnostic/frontend/agent-browser/SKILL.md +229 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/authentication.md +202 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/commands.md +259 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/proxy-support.md +188 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/session-management.md +193 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/snapshot-refs.md +194 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/video-recording.md +173 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/authenticated-session.sh +97 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/capture-workflow.sh +69 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/form-automation.sh +62 -0
- package/dist/skills/agnostic/frontend/design-taste-frontend/SKILL.md +226 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/SKILL.md +55 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/references/react/structure.md +102 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/references/structure.md +257 -0
- package/dist/skills/agnostic/frontend/gpt-taste/SKILL.md +74 -0
- package/dist/skills/agnostic/frontend/image-taste-frontend/SKILL.md +1102 -0
- package/dist/skills/agnostic/frontend/redesign-existing-projects/SKILL.md +178 -0
- package/dist/skills/agnostic/planning/create-plan/REFERENCE.md +37 -0
- package/dist/skills/agnostic/planning/create-plan/SKILL.md +69 -0
- package/dist/skills/agnostic/planning/create-plan/references/backlog-sync.md +44 -0
- package/dist/skills/agnostic/planning/create-plan/references/grill-phase.md +86 -0
- package/dist/skills/agnostic/planning/create-plan/references/plan-schema.md +66 -0
- package/dist/skills/agnostic/planning/create-plan/references/planner-phase.md +39 -0
- package/dist/skills/agnostic/planning/create-plan/references/stop-conditions.md +18 -0
- package/dist/skills/agnostic/planning/create-plan/references/tdd-phase.md +26 -0
- package/dist/skills/agnostic/planning/create-spec/SKILL.md +57 -0
- package/dist/skills/agnostic/planning/create-spec/assets/SPEC-TEMPLATE.md +91 -0
- package/dist/skills/agnostic/planning/create-spec/references/discovery.md +44 -0
- package/dist/skills/agnostic/planning/create-spec/references/folder-naming.md +27 -0
- package/dist/skills/agnostic/planning/create-spec/references/handoff.md +47 -0
- package/dist/skills/agnostic/planning/create-spec/references/questioning.md +41 -0
- package/dist/skills/agnostic/planning/create-spec/references/spec-quality-bar.md +58 -0
- package/dist/skills/agnostic/planning/create-spec/references/wiki-bookkeeping.md +26 -0
- package/dist/skills/agnostic/planning/grill-me/SKILL.md +28 -0
- package/dist/skills/agnostic/planning/implement-spec/SKILL.md +72 -0
- package/dist/skills/agnostic/planning/implement-spec/assets/IMPLEMENTATION-NOTES-TEMPLATE.md +47 -0
- package/dist/skills/agnostic/planning/implement-spec/references/lifecycle.md +149 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel-orchestration.md +102 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel-worker-brief.md +65 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel.md +56 -0
- package/dist/skills/agnostic/planning/implement-spec/references/sequential.md +28 -0
- package/dist/skills/agnostic/planning/swarm-planner/SKILL.md +179 -0
- package/dist/skills/agnostic/quality/simplify/SKILL.md +14 -0
- package/dist/skills/agnostic/quality/tdd/SKILL.md +107 -0
- package/dist/skills/agnostic/quality/tdd/deep-modules.md +33 -0
- package/dist/skills/agnostic/quality/tdd/interface-design.md +31 -0
- package/dist/skills/agnostic/quality/tdd/mocking.md +59 -0
- package/dist/skills/agnostic/quality/tdd/refactoring.md +10 -0
- package/dist/skills/agnostic/quality/tdd/tests.md +61 -0
- package/dist/skills/agnostic/requirements/requirements-grill/SKILL.md +42 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/artifact-output.md +73 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/grilling-flow.md +57 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/wiki-output.md +94 -0
- package/dist/skills/agnostic/requirements/write-backlog/EXAMPLES.md +67 -0
- package/dist/skills/agnostic/requirements/write-backlog/REFERENCE.md +253 -0
- package/dist/skills/agnostic/requirements/write-backlog/SKILL.md +68 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/concepts/backlog-model.md +69 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/concepts/story-shape.md +66 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/azure-devops-create-payload.md +63 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/github-issues-create-payload.md +48 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/linear-create-payload.md +76 -0
- package/dist/skills/agnostic/research/improve-codebase-architecture/REFERENCE.md +78 -0
- package/dist/skills/agnostic/research/improve-codebase-architecture/SKILL.md +76 -0
- package/dist/skills/agnostic/research/parallel-research/SKILL.md +68 -0
- package/dist/skills/agnostic/research/parallel-research/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/subagents/swarm-planner/SKILL.md +179 -0
- package/dist/skills/agnostic/write-a-skill/SKILL.md +117 -0
- package/dist/skills/frameworks/better-auth/better-auth-best-practices/SKILL.md +166 -0
- package/dist/skills/frameworks/better-auth/better-auth-security-best-practices/SKILL.MD +432 -0
- package/dist/skills/frameworks/effect/effect-authoring/SKILL.md +116 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/branded-types.md +98 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/effect-atom-patterns.md +257 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/effect-primitives.md +144 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/error-patterns.md +156 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/otel-patterns.md +113 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/test-patterns.md +146 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/SKILL.md +96 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/agents/openai.yaml +4 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/references/layout.md +68 -0
- package/dist/skills/frameworks/effect/effect-best-practices/SKILL.md +517 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/anti-patterns.md +392 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/effect-atom-patterns.md +653 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/error-patterns.md +464 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/language-server.md +287 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/layer-patterns.md +495 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/observability-patterns.md +342 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/rpc-cluster-patterns.md +418 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/schema-patterns.md +353 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/service-patterns.md +299 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/SKILL.md +65 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/agents/openai.yaml +4 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/flow-examples.md +154 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/source-backed-primitives.md +104 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/strategy-matrix.md +34 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/test-matrix.md +36 -0
- package/dist/skills/frameworks/elysia/elysiajs/SKILL.md +475 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/basic.ts +9 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/body-parser.ts +33 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/complex.ts +112 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/cookie.ts +45 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/error.ts +38 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/file.ts +10 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/guard.ts +34 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/map-response.ts +15 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/redirect.ts +6 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/rename.ts +32 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/schema.ts +61 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/state.ts +6 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/upload-file.ts +20 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/websocket.ts +25 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/ai-sdk.md +92 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/astro.md +59 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/better-auth.md +117 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/cloudflare-worker.md +95 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/deno.md +34 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/drizzle.md +258 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/expo.md +95 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nextjs.md +103 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nodejs.md +64 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nuxt.md +67 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/prisma.md +93 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/react-email.md +134 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/sveltekit.md +53 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/tanstack-start.md +87 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/vercel.md +55 -0
- package/dist/skills/frameworks/elysia/elysiajs/patterns/mvc.md +380 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/bearer.md +30 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/cors.md +141 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/cron.md +265 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-apollo.md +90 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-yoga.md +87 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/html.md +188 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/jwt.md +197 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/openapi.md +246 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/opentelemetry.md +167 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/server-timing.md +71 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/static.md +84 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/bun-fullstack-dev-server.md +129 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/cookie.md +187 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/deployment.md +413 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/eden.md +158 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/lifecycle.md +198 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/macro.md +83 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/plugin.md +207 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/route.md +331 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/testing.md +385 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/validation.md +491 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/websocket.md +250 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/.github/workflows/branch-protection.yml +24 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/.github/workflows/deploy.yml +61 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/AGENTS.md +5958 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/SKILL.md +130 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-dto-serialization.md +182 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-interceptors.md +202 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-pipes.md +205 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-versioning.md +191 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-avoid-circular-deps.md +80 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-feature-modules.md +82 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-module-sharing.md +141 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-single-responsibility.md +106 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-use-events.md +108 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-use-repository-pattern.md +97 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-avoid-n-plus-one.md +139 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-use-migrations.md +129 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-use-transactions.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-graceful-shutdown.md +222 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-use-config-module.md +167 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-use-logging.md +232 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-avoid-service-locator.md +104 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-interface-segregation.md +165 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-liskov-substitution.md +221 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-prefer-constructor-injection.md +86 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-scope-awareness.md +94 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-use-interfaces-tokens.md +101 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-handle-async-errors.md +125 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-throw-http-exceptions.md +114 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-use-exception-filters.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-health-checks.md +226 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-patterns.md +167 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-queues.md +252 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-async-hooks.md +109 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-lazy-loading.md +121 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-optimize-database.md +131 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-use-caching.md +128 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-auth-jwt.md +146 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-rate-limiting.md +125 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-sanitize-output.md +139 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-use-guards.md +135 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-validate-all-input.md +150 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-e2e-supertest.md +178 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-mock-external-services.md +179 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-use-testing-module.md +153 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/build-agents.ts +299 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/build.sh +16 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/package-lock.json +237 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/package.json +15 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/SKILL.md +208 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/authentication.md +166 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/controllers-routing.md +111 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/dtos-validation.md +153 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/migration-from-express.md +1237 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/services-di.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/testing-patterns.md +186 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/SKILL.md +153 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/async-patterns.md +87 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/bundling.md +180 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/data-patterns.md +297 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/debug-tricks.md +105 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/directives.md +73 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/error-handling.md +227 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/file-conventions.md +140 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/font.md +245 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/functions.md +108 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/hydration-error.md +91 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/image.md +173 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/metadata.md +301 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/parallel-routes.md +287 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/route-handlers.md +146 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/rsc-boundaries.md +159 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/runtime-selection.md +39 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/scripts.md +141 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/self-hosting.md +371 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/suspense-boundaries.md +67 -0
- package/dist/skills/frameworks/nextjs/next-cache-components/SKILL.md +360 -0
- package/dist/skills/frameworks/react/async-react-patterns/SKILL.md +78 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/AGENTS.md +946 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/SKILL.md +89 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/AGENTS.md +3750 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/SKILL.md +148 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-effect-event-deps.md +56 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-defer-await.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-barrel-imports.md +60 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-flatmap-filter.md +60 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-request-idle-callback.md +105 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-resource-hints.md +85 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-script-defer-async.md +68 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-no-inline-components.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-use-deferred-value.md +59 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-hoist-static-io.md +149 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-no-shared-module-state.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-parallel-nested-fetching.md +34 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/.claude-plugin/plugin.json +12 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/SKILL.md +1058 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/assets/example-template.txt +14 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/best-practices.md +304 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/common-patterns.md +271 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/example-reference.md +26 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/testing.md +282 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/top-errors.md +332 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/typescript-patterns.md +291 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/v4-to-v5-migration.md +231 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/rules/tanstack-query.md +126 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/scripts/example-script.sh +15 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/custom-hooks-pattern.tsx +281 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/devtools-setup.tsx +248 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/error-boundary.tsx +243 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/package.json +31 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/provider-setup.tsx +50 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/query-client-config.ts +72 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-infinite-query.tsx +214 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-mutation-basic.tsx +201 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-mutation-optimistic.tsx +234 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-query-basic.tsx +119 -0
- package/dist/skills/frameworks/trpc/tanstack-query/.claude-plugin/plugin.json +12 -0
- package/dist/skills/frameworks/trpc/tanstack-query/SKILL.md +1058 -0
- package/dist/skills/frameworks/trpc/tanstack-query/assets/example-template.txt +14 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/best-practices.md +304 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/common-patterns.md +271 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/example-reference.md +26 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/testing.md +282 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/top-errors.md +332 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/typescript-patterns.md +291 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/v4-to-v5-migration.md +231 -0
- package/dist/skills/frameworks/trpc/tanstack-query/rules/tanstack-query.md +126 -0
- package/dist/skills/frameworks/trpc/tanstack-query/scripts/example-script.sh +15 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/custom-hooks-pattern.tsx +281 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/devtools-setup.tsx +248 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/error-boundary.tsx +243 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/package.json +31 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/provider-setup.tsx +50 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/query-client-config.ts +72 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-infinite-query.tsx +214 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-mutation-basic.tsx +201 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-mutation-optimistic.tsx +234 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-query-basic.tsx +119 -0
- package/dist/skills/frameworks/turborepo/turborepo/SKILL.md +914 -0
- package/dist/skills/frameworks/turborepo/turborepo/command/turborepo.md +70 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/RULE.md +241 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/dependencies.md +246 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/packages.md +335 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/structure.md +270 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/boundaries/RULE.md +126 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/RULE.md +107 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/gotchas.md +169 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/remote-cache.md +127 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/RULE.md +79 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/github-actions.md +162 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/patterns.md +145 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/vercel.md +103 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/cli/RULE.md +100 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/cli/commands.md +297 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/RULE.md +211 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/global-options.md +187 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/gotchas.md +348 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/tasks.md +285 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/RULE.md +96 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/gotchas.md +141 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/modes.md +101 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/filtering/RULE.md +148 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/filtering/patterns.md +152 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/watch/RULE.md +99 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/docs/README.md +20 -0
- package/docs/reference/dp-requirements.md +210 -0
- package/docs/runbooks/dp-cli-scaffolding.md +187 -0
- package/package.json +24 -50
- package/.eslintignore +0 -4
- package/.eslintrc +0 -127
- package/.prettierignore +0 -4
- package/.prettierrc +0 -7
- package/bin/abstractions/builder.d.ts +0 -4
- package/bin/abstractions/builder.js +0 -7
- package/bin/builders/dotnet/base.d.ts +0 -18
- package/bin/builders/dotnet/base.js +0 -47
- package/bin/builders/dotnet/entity-configuration/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-configuration/index.js +0 -29
- package/bin/builders/dotnet/entity-converter/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-converter/index.js +0 -29
- package/bin/builders/dotnet/entity-model-create/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-create/index.js +0 -29
- package/bin/builders/dotnet/entity-model-dto/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-dto/index.js +0 -29
- package/bin/builders/dotnet/entity-model-list-item-dto/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-list-item-dto/index.js +0 -29
- package/bin/builders/dotnet/entity-model-update/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-update/index.js +0 -29
- package/bin/builders/dotnet/entity-search-parameters/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-search-parameters/index.js +0 -29
- package/bin/builders/dotnet/entity-search-query-builder/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-search-query-builder/index.js +0 -29
- package/bin/builders/dotnet/firestore-connector/index.d.ts +0 -8
- package/bin/builders/dotnet/firestore-connector/index.js +0 -29
- package/bin/builders/dotnet/firestore-mapper/index.d.ts +0 -8
- package/bin/builders/dotnet/firestore-mapper/index.js +0 -29
- package/bin/builders/dotnet/types.d.ts +0 -10
- package/bin/builders/dotnet/types.js +0 -3
- package/bin/commands/entity-add/__test__/dotnet/common.d.ts +0 -2
- package/bin/commands/entity-add/__test__/dotnet/common.js +0 -11
- package/bin/commands/entity-add/__test__/dotnet/render.configuration.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.configuration.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.converter.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.converter.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-connector.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-connector.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-mapper.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-mapper.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-create.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-create.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-dto.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-dto.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-list-item-dto.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-list-item-dto.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-update.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-update.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.search-parameters.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.search-parameters.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.search-query.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.search-query.spec.js +0 -22
- package/bin/commands/entity-add/index.d.ts +0 -26
- package/bin/commands/entity-add/index.js +0 -44
- package/bin/logging/index.d.ts +0 -8
- package/bin/logging/index.js +0 -28
- package/bin/providers/rendering/base.d.ts +0 -3
- package/bin/providers/rendering/base.js +0 -7
- package/bin/providers/rendering/factory.d.ts +0 -5
- package/bin/providers/rendering/factory.js +0 -16
- package/bin/providers/rendering/handlebars.d.ts +0 -4
- package/bin/providers/rendering/handlebars.js +0 -16
- package/bin/renderer/index.d.ts +0 -6
- package/bin/renderer/index.js +0 -27
- package/bin/run.d.ts +0 -2
- package/bin/run.js +0 -70
- package/bin/services/folders.d.ts +0 -1
- package/bin/services/folders.js +0 -31
- package/bin/types/commands.d.ts +0 -5
- package/bin/types/commands.js +0 -3
- package/bin/utils/collections.d.ts +0 -1
- package/bin/utils/collections.js +0 -6
- package/bin/utils/files.d.ts +0 -3
- package/bin/utils/files.js +0 -19
- package/bin/utils/strings.d.ts +0 -4
- package/bin/utils/strings.js +0 -22
- package/bin/utils/text.d.ts +0 -1
- package/bin/utils/text.js +0 -8
- package/em-cli +0 -0
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.configuration.spec.ts.snap +0 -49
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.converter.spec.ts.snap +0 -53
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.firestore-connector.spec.ts.snap +0 -20
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.firestore-mapper.spec.ts.snap +0 -29
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-create.spec.ts.snap +0 -10
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-dto.spec.ts.snap +0 -9
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-list-item-dto.spec.ts.snap +0 -11
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-update.spec.ts.snap +0 -11
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.search-parameters.spec.ts.snap +0 -29
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.search-query.spec.ts.snap +0 -42
- package/templates/dotnet/NewEntity/Configuration/<PluralizedEntity>Configuration.cs.template +0 -48
- package/templates/dotnet/NewEntity/Connectors/<PluralizedEntity>FirestoreConnector.cs.template +0 -15
- package/templates/dotnet/NewEntity/Converters/<PluralizedEntity>Converter.cs.template +0 -48
- package/templates/dotnet/NewEntity/Mappers/<PluralizedEntity>FirestoreMapper.cs.template +0 -25
- package/templates/dotnet/NewEntity/Models/<Entity>CreateInput.cs.template +0 -6
- package/templates/dotnet/NewEntity/Models/<Entity>Dto.cs.template +0 -5
- package/templates/dotnet/NewEntity/Models/<Entity>ListItemDto.cs.template +0 -6
- package/templates/dotnet/NewEntity/Models/<Entity>UpdateInput.cs.template +0 -6
- package/templates/dotnet/NewEntity/Search/<PluralizedEntity>QueryBuilder.cs.template +0 -38
- package/templates/dotnet/NewEntity/Search/<PluralizedEntity>SearchParameters.cs.template +0 -24
- package/tsconfig.json +0 -25
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Error Handling
|
|
2
|
+
|
|
3
|
+
Handle errors gracefully in Next.js applications.
|
|
4
|
+
|
|
5
|
+
Reference: https://nextjs.org/docs/app/getting-started/error-handling
|
|
6
|
+
|
|
7
|
+
## Error Boundaries
|
|
8
|
+
|
|
9
|
+
### `error.tsx`
|
|
10
|
+
|
|
11
|
+
Catches errors in a route segment and its children:
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
'use client'
|
|
15
|
+
|
|
16
|
+
export default function Error({
|
|
17
|
+
error,
|
|
18
|
+
reset,
|
|
19
|
+
}: {
|
|
20
|
+
error: Error & { digest?: string }
|
|
21
|
+
reset: () => void
|
|
22
|
+
}) {
|
|
23
|
+
return (
|
|
24
|
+
<div>
|
|
25
|
+
<h2>Something went wrong!</h2>
|
|
26
|
+
<button onClick={() => reset()}>Try again</button>
|
|
27
|
+
</div>
|
|
28
|
+
)
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Important:** `error.tsx` must be a Client Component.
|
|
33
|
+
|
|
34
|
+
### `global-error.tsx`
|
|
35
|
+
|
|
36
|
+
Catches errors in root layout:
|
|
37
|
+
|
|
38
|
+
```tsx
|
|
39
|
+
'use client'
|
|
40
|
+
|
|
41
|
+
export default function GlobalError({
|
|
42
|
+
error,
|
|
43
|
+
reset,
|
|
44
|
+
}: {
|
|
45
|
+
error: Error & { digest?: string }
|
|
46
|
+
reset: () => void
|
|
47
|
+
}) {
|
|
48
|
+
return (
|
|
49
|
+
<html>
|
|
50
|
+
<body>
|
|
51
|
+
<h2>Something went wrong!</h2>
|
|
52
|
+
<button onClick={() => reset()}>Try again</button>
|
|
53
|
+
</body>
|
|
54
|
+
</html>
|
|
55
|
+
)
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Important:** Must include `<html>` and `<body>` tags.
|
|
60
|
+
|
|
61
|
+
## Server Actions: Navigation API Gotcha
|
|
62
|
+
|
|
63
|
+
**Do NOT wrap navigation APIs in try-catch.** They throw special errors that Next.js handles internally.
|
|
64
|
+
|
|
65
|
+
Reference: https://nextjs.org/docs/app/api-reference/functions/redirect#behavior
|
|
66
|
+
|
|
67
|
+
```tsx
|
|
68
|
+
'use server'
|
|
69
|
+
|
|
70
|
+
import { redirect } from 'next/navigation'
|
|
71
|
+
import { notFound } from 'next/navigation'
|
|
72
|
+
|
|
73
|
+
// Bad: try-catch catches the navigation "error"
|
|
74
|
+
async function createPost(formData: FormData) {
|
|
75
|
+
try {
|
|
76
|
+
const post = await db.post.create({ ... })
|
|
77
|
+
redirect(`/posts/${post.id}`) // This throws!
|
|
78
|
+
} catch (error) {
|
|
79
|
+
// redirect() throw is caught here - navigation fails!
|
|
80
|
+
return { error: 'Failed to create post' }
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// Good: Call navigation APIs outside try-catch
|
|
85
|
+
async function createPost(formData: FormData) {
|
|
86
|
+
let post
|
|
87
|
+
try {
|
|
88
|
+
post = await db.post.create({ ... })
|
|
89
|
+
} catch (error) {
|
|
90
|
+
return { error: 'Failed to create post' }
|
|
91
|
+
}
|
|
92
|
+
redirect(`/posts/${post.id}`) // Outside try-catch
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Good: Re-throw navigation errors
|
|
96
|
+
async function createPost(formData: FormData) {
|
|
97
|
+
try {
|
|
98
|
+
const post = await db.post.create({ ... })
|
|
99
|
+
redirect(`/posts/${post.id}`)
|
|
100
|
+
} catch (error) {
|
|
101
|
+
if (error instanceof Error && error.message === 'NEXT_REDIRECT') {
|
|
102
|
+
throw error // Re-throw navigation errors
|
|
103
|
+
}
|
|
104
|
+
return { error: 'Failed to create post' }
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Same applies to:
|
|
110
|
+
- `redirect()` - 307 temporary redirect
|
|
111
|
+
- `permanentRedirect()` - 308 permanent redirect
|
|
112
|
+
- `notFound()` - 404 not found
|
|
113
|
+
- `forbidden()` - 403 forbidden
|
|
114
|
+
- `unauthorized()` - 401 unauthorized
|
|
115
|
+
|
|
116
|
+
Use `unstable_rethrow()` to re-throw these errors in catch blocks:
|
|
117
|
+
|
|
118
|
+
```tsx
|
|
119
|
+
import { unstable_rethrow } from 'next/navigation'
|
|
120
|
+
|
|
121
|
+
async function action() {
|
|
122
|
+
try {
|
|
123
|
+
// ...
|
|
124
|
+
redirect('/success')
|
|
125
|
+
} catch (error) {
|
|
126
|
+
unstable_rethrow(error) // Re-throws Next.js internal errors
|
|
127
|
+
return { error: 'Something went wrong' }
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Redirects
|
|
133
|
+
|
|
134
|
+
```tsx
|
|
135
|
+
import { redirect, permanentRedirect } from 'next/navigation'
|
|
136
|
+
|
|
137
|
+
// 307 Temporary - use for most cases
|
|
138
|
+
redirect('/new-path')
|
|
139
|
+
|
|
140
|
+
// 308 Permanent - use for URL migrations (cached by browsers)
|
|
141
|
+
permanentRedirect('/new-url')
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Auth Errors
|
|
145
|
+
|
|
146
|
+
Trigger auth-related error pages:
|
|
147
|
+
|
|
148
|
+
```tsx
|
|
149
|
+
import { forbidden, unauthorized } from 'next/navigation'
|
|
150
|
+
|
|
151
|
+
async function Page() {
|
|
152
|
+
const session = await getSession()
|
|
153
|
+
|
|
154
|
+
if (!session) {
|
|
155
|
+
unauthorized() // Renders unauthorized.tsx (401)
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
if (!session.hasAccess) {
|
|
159
|
+
forbidden() // Renders forbidden.tsx (403)
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
return <Dashboard />
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Create corresponding error pages:
|
|
167
|
+
|
|
168
|
+
```tsx
|
|
169
|
+
// app/forbidden.tsx
|
|
170
|
+
export default function Forbidden() {
|
|
171
|
+
return <div>You don't have access to this resource</div>
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
// app/unauthorized.tsx
|
|
175
|
+
export default function Unauthorized() {
|
|
176
|
+
return <div>Please log in to continue</div>
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Not Found
|
|
181
|
+
|
|
182
|
+
### `not-found.tsx`
|
|
183
|
+
|
|
184
|
+
Custom 404 page for a route segment:
|
|
185
|
+
|
|
186
|
+
```tsx
|
|
187
|
+
export default function NotFound() {
|
|
188
|
+
return (
|
|
189
|
+
<div>
|
|
190
|
+
<h2>Not Found</h2>
|
|
191
|
+
<p>Could not find the requested resource</p>
|
|
192
|
+
</div>
|
|
193
|
+
)
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Triggering Not Found
|
|
198
|
+
|
|
199
|
+
```tsx
|
|
200
|
+
import { notFound } from 'next/navigation'
|
|
201
|
+
|
|
202
|
+
export default async function Page({ params }: { params: Promise<{ id: string }> }) {
|
|
203
|
+
const { id } = await params
|
|
204
|
+
const post = await getPost(id)
|
|
205
|
+
|
|
206
|
+
if (!post) {
|
|
207
|
+
notFound() // Renders closest not-found.tsx
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
return <div>{post.title}</div>
|
|
211
|
+
}
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
## Error Hierarchy
|
|
215
|
+
|
|
216
|
+
Errors bubble up to the nearest error boundary:
|
|
217
|
+
|
|
218
|
+
```
|
|
219
|
+
app/
|
|
220
|
+
├── error.tsx # Catches errors from all children
|
|
221
|
+
├── blog/
|
|
222
|
+
│ ├── error.tsx # Catches errors in /blog/*
|
|
223
|
+
│ └── [slug]/
|
|
224
|
+
│ ├── error.tsx # Catches errors in /blog/[slug]
|
|
225
|
+
│ └── page.tsx
|
|
226
|
+
└── layout.tsx # Errors here go to global-error.tsx
|
|
227
|
+
```
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# File Conventions
|
|
2
|
+
|
|
3
|
+
Next.js App Router uses file-based routing with special file conventions.
|
|
4
|
+
|
|
5
|
+
## Project Structure
|
|
6
|
+
|
|
7
|
+
Reference: https://nextjs.org/docs/app/getting-started/project-structure
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
app/
|
|
11
|
+
├── layout.tsx # Root layout (required)
|
|
12
|
+
├── page.tsx # Home page (/)
|
|
13
|
+
├── loading.tsx # Loading UI
|
|
14
|
+
├── error.tsx # Error UI
|
|
15
|
+
├── not-found.tsx # 404 UI
|
|
16
|
+
├── global-error.tsx # Global error UI
|
|
17
|
+
├── route.ts # API endpoint
|
|
18
|
+
├── template.tsx # Re-rendered layout
|
|
19
|
+
├── default.tsx # Parallel route fallback
|
|
20
|
+
├── blog/
|
|
21
|
+
│ ├── page.tsx # /blog
|
|
22
|
+
│ └── [slug]/
|
|
23
|
+
│ └── page.tsx # /blog/:slug
|
|
24
|
+
└── (group)/ # Route group (no URL impact)
|
|
25
|
+
└── page.tsx
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Special Files
|
|
29
|
+
|
|
30
|
+
| File | Purpose |
|
|
31
|
+
|------|---------|
|
|
32
|
+
| `page.tsx` | UI for a route segment |
|
|
33
|
+
| `layout.tsx` | Shared UI for segment and children |
|
|
34
|
+
| `loading.tsx` | Loading UI (Suspense boundary) |
|
|
35
|
+
| `error.tsx` | Error UI (Error boundary) |
|
|
36
|
+
| `not-found.tsx` | 404 UI |
|
|
37
|
+
| `route.ts` | API endpoint |
|
|
38
|
+
| `template.tsx` | Like layout but re-renders on navigation |
|
|
39
|
+
| `default.tsx` | Fallback for parallel routes |
|
|
40
|
+
|
|
41
|
+
## Route Segments
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
app/
|
|
45
|
+
├── blog/ # Static segment: /blog
|
|
46
|
+
├── [slug]/ # Dynamic segment: /:slug
|
|
47
|
+
├── [...slug]/ # Catch-all: /a/b/c
|
|
48
|
+
├── [[...slug]]/ # Optional catch-all: / or /a/b/c
|
|
49
|
+
└── (marketing)/ # Route group (ignored in URL)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Parallel Routes
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
app/
|
|
56
|
+
├── @analytics/
|
|
57
|
+
│ └── page.tsx
|
|
58
|
+
├── @sidebar/
|
|
59
|
+
│ └── page.tsx
|
|
60
|
+
└── layout.tsx # Receives { analytics, sidebar } as props
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Intercepting Routes
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
app/
|
|
67
|
+
├── feed/
|
|
68
|
+
│ └── page.tsx
|
|
69
|
+
├── @modal/
|
|
70
|
+
│ └── (.)photo/[id]/ # Intercepts /photo/[id] from /feed
|
|
71
|
+
│ └── page.tsx
|
|
72
|
+
└── photo/[id]/
|
|
73
|
+
└── page.tsx
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Conventions:
|
|
77
|
+
- `(.)` - same level
|
|
78
|
+
- `(..)` - one level up
|
|
79
|
+
- `(..)(..)` - two levels up
|
|
80
|
+
- `(...)` - from root
|
|
81
|
+
|
|
82
|
+
## Private Folders
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
app/
|
|
86
|
+
├── _components/ # Private folder (not a route)
|
|
87
|
+
│ └── Button.tsx
|
|
88
|
+
└── page.tsx
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Prefix with `_` to exclude from routing.
|
|
92
|
+
|
|
93
|
+
## Middleware / Proxy
|
|
94
|
+
|
|
95
|
+
### Next.js 14-15: `middleware.ts`
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
// middleware.ts (root of project)
|
|
99
|
+
import { NextResponse } from 'next/server';
|
|
100
|
+
import type { NextRequest } from 'next/server';
|
|
101
|
+
|
|
102
|
+
export function middleware(request: NextRequest) {
|
|
103
|
+
// Auth, redirects, rewrites, etc.
|
|
104
|
+
return NextResponse.next();
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export const config = {
|
|
108
|
+
matcher: ['/dashboard/:path*', '/api/:path*'],
|
|
109
|
+
};
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Next.js 16+: `proxy.ts`
|
|
113
|
+
|
|
114
|
+
Renamed for clarity - same capabilities, different names:
|
|
115
|
+
|
|
116
|
+
```ts
|
|
117
|
+
// proxy.ts (root of project)
|
|
118
|
+
import { NextResponse } from 'next/server';
|
|
119
|
+
import type { NextRequest } from 'next/server';
|
|
120
|
+
|
|
121
|
+
export function proxy(request: NextRequest) {
|
|
122
|
+
// Same logic as middleware
|
|
123
|
+
return NextResponse.next();
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export const proxyConfig = {
|
|
127
|
+
matcher: ['/dashboard/:path*', '/api/:path*'],
|
|
128
|
+
};
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
| Version | File | Export | Config |
|
|
132
|
+
|---------|------|--------|--------|
|
|
133
|
+
| v14-15 | `middleware.ts` | `middleware()` | `config` |
|
|
134
|
+
| v16+ | `proxy.ts` | `proxy()` | `proxyConfig` |
|
|
135
|
+
|
|
136
|
+
**Migration**: Run `npx @next/codemod@latest upgrade` to auto-rename.
|
|
137
|
+
|
|
138
|
+
## File Conventions Reference
|
|
139
|
+
|
|
140
|
+
Reference: https://nextjs.org/docs/app/api-reference/file-conventions
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# Font Optimization
|
|
2
|
+
|
|
3
|
+
Use `next/font` for automatic font optimization with zero layout shift.
|
|
4
|
+
|
|
5
|
+
## Google Fonts
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
// app/layout.tsx
|
|
9
|
+
import { Inter } from 'next/font/google'
|
|
10
|
+
|
|
11
|
+
const inter = Inter({ subsets: ['latin'] })
|
|
12
|
+
|
|
13
|
+
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
14
|
+
return (
|
|
15
|
+
<html lang="en" className={inter.className}>
|
|
16
|
+
<body>{children}</body>
|
|
17
|
+
</html>
|
|
18
|
+
)
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Multiple Fonts
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import { Inter, Roboto_Mono } from 'next/font/google'
|
|
26
|
+
|
|
27
|
+
const inter = Inter({
|
|
28
|
+
subsets: ['latin'],
|
|
29
|
+
variable: '--font-inter',
|
|
30
|
+
})
|
|
31
|
+
|
|
32
|
+
const robotoMono = Roboto_Mono({
|
|
33
|
+
subsets: ['latin'],
|
|
34
|
+
variable: '--font-roboto-mono',
|
|
35
|
+
})
|
|
36
|
+
|
|
37
|
+
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
38
|
+
return (
|
|
39
|
+
<html lang="en" className={`${inter.variable} ${robotoMono.variable}`}>
|
|
40
|
+
<body>{children}</body>
|
|
41
|
+
</html>
|
|
42
|
+
)
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Use in CSS:
|
|
47
|
+
```css
|
|
48
|
+
body {
|
|
49
|
+
font-family: var(--font-inter);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
code {
|
|
53
|
+
font-family: var(--font-roboto-mono);
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Font Weights and Styles
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
// Single weight
|
|
61
|
+
const inter = Inter({
|
|
62
|
+
subsets: ['latin'],
|
|
63
|
+
weight: '400',
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
// Multiple weights
|
|
67
|
+
const inter = Inter({
|
|
68
|
+
subsets: ['latin'],
|
|
69
|
+
weight: ['400', '500', '700'],
|
|
70
|
+
})
|
|
71
|
+
|
|
72
|
+
// Variable font (recommended) - includes all weights
|
|
73
|
+
const inter = Inter({
|
|
74
|
+
subsets: ['latin'],
|
|
75
|
+
// No weight needed - variable fonts support all weights
|
|
76
|
+
})
|
|
77
|
+
|
|
78
|
+
// With italic
|
|
79
|
+
const inter = Inter({
|
|
80
|
+
subsets: ['latin'],
|
|
81
|
+
style: ['normal', 'italic'],
|
|
82
|
+
})
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Local Fonts
|
|
86
|
+
|
|
87
|
+
```tsx
|
|
88
|
+
import localFont from 'next/font/local'
|
|
89
|
+
|
|
90
|
+
const myFont = localFont({
|
|
91
|
+
src: './fonts/MyFont.woff2',
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
// Multiple files for different weights
|
|
95
|
+
const myFont = localFont({
|
|
96
|
+
src: [
|
|
97
|
+
{
|
|
98
|
+
path: './fonts/MyFont-Regular.woff2',
|
|
99
|
+
weight: '400',
|
|
100
|
+
style: 'normal',
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
path: './fonts/MyFont-Bold.woff2',
|
|
104
|
+
weight: '700',
|
|
105
|
+
style: 'normal',
|
|
106
|
+
},
|
|
107
|
+
],
|
|
108
|
+
})
|
|
109
|
+
|
|
110
|
+
// Variable font
|
|
111
|
+
const myFont = localFont({
|
|
112
|
+
src: './fonts/MyFont-Variable.woff2',
|
|
113
|
+
variable: '--font-my-font',
|
|
114
|
+
})
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Tailwind CSS Integration
|
|
118
|
+
|
|
119
|
+
```tsx
|
|
120
|
+
// app/layout.tsx
|
|
121
|
+
import { Inter } from 'next/font/google'
|
|
122
|
+
|
|
123
|
+
const inter = Inter({
|
|
124
|
+
subsets: ['latin'],
|
|
125
|
+
variable: '--font-inter',
|
|
126
|
+
})
|
|
127
|
+
|
|
128
|
+
export default function RootLayout({ children }) {
|
|
129
|
+
return (
|
|
130
|
+
<html lang="en" className={inter.variable}>
|
|
131
|
+
<body>{children}</body>
|
|
132
|
+
</html>
|
|
133
|
+
)
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
```js
|
|
138
|
+
// tailwind.config.js
|
|
139
|
+
module.exports = {
|
|
140
|
+
theme: {
|
|
141
|
+
extend: {
|
|
142
|
+
fontFamily: {
|
|
143
|
+
sans: ['var(--font-inter)'],
|
|
144
|
+
},
|
|
145
|
+
},
|
|
146
|
+
},
|
|
147
|
+
}
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Preloading Subsets
|
|
151
|
+
|
|
152
|
+
Only load needed character subsets:
|
|
153
|
+
|
|
154
|
+
```tsx
|
|
155
|
+
// Latin only (most common)
|
|
156
|
+
const inter = Inter({ subsets: ['latin'] })
|
|
157
|
+
|
|
158
|
+
// Multiple subsets
|
|
159
|
+
const inter = Inter({ subsets: ['latin', 'latin-ext', 'cyrillic'] })
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Display Strategy
|
|
163
|
+
|
|
164
|
+
Control font loading behavior:
|
|
165
|
+
|
|
166
|
+
```tsx
|
|
167
|
+
const inter = Inter({
|
|
168
|
+
subsets: ['latin'],
|
|
169
|
+
display: 'swap', // Default - shows fallback, swaps when loaded
|
|
170
|
+
})
|
|
171
|
+
|
|
172
|
+
// Options:
|
|
173
|
+
// 'auto' - browser decides
|
|
174
|
+
// 'block' - short block period, then swap
|
|
175
|
+
// 'swap' - immediate fallback, swap when ready (recommended)
|
|
176
|
+
// 'fallback' - short block, short swap, then fallback
|
|
177
|
+
// 'optional' - short block, no swap (use if font is optional)
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Don't Use Manual Font Links
|
|
181
|
+
|
|
182
|
+
Always use `next/font` instead of `<link>` tags for Google Fonts.
|
|
183
|
+
|
|
184
|
+
```tsx
|
|
185
|
+
// Bad: Manual link tag (blocks rendering, no optimization)
|
|
186
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter" rel="stylesheet" />
|
|
187
|
+
|
|
188
|
+
// Bad: Missing display and preconnect
|
|
189
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter" rel="stylesheet" />
|
|
190
|
+
|
|
191
|
+
// Good: Use next/font (self-hosted, zero layout shift)
|
|
192
|
+
import { Inter } from 'next/font/google'
|
|
193
|
+
|
|
194
|
+
const inter = Inter({ subsets: ['latin'] })
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Common Mistakes
|
|
198
|
+
|
|
199
|
+
```tsx
|
|
200
|
+
// Bad: Importing font in every component
|
|
201
|
+
// components/Button.tsx
|
|
202
|
+
import { Inter } from 'next/font/google'
|
|
203
|
+
const inter = Inter({ subsets: ['latin'] }) // Creates new instance each time!
|
|
204
|
+
|
|
205
|
+
// Good: Import once in layout, use CSS variable
|
|
206
|
+
// app/layout.tsx
|
|
207
|
+
const inter = Inter({ subsets: ['latin'], variable: '--font-inter' })
|
|
208
|
+
|
|
209
|
+
// Bad: Using @import in CSS (blocks rendering)
|
|
210
|
+
/* globals.css */
|
|
211
|
+
@import url('https://fonts.googleapis.com/css2?family=Inter');
|
|
212
|
+
|
|
213
|
+
// Good: Use next/font (self-hosted, no network request)
|
|
214
|
+
import { Inter } from 'next/font/google'
|
|
215
|
+
|
|
216
|
+
// Bad: Loading all weights when only using a few
|
|
217
|
+
const inter = Inter({ subsets: ['latin'] }) // Loads all weights
|
|
218
|
+
|
|
219
|
+
// Good: Specify only needed weights (for non-variable fonts)
|
|
220
|
+
const inter = Inter({ subsets: ['latin'], weight: ['400', '700'] })
|
|
221
|
+
|
|
222
|
+
// Bad: Missing subset - loads all characters
|
|
223
|
+
const inter = Inter({})
|
|
224
|
+
|
|
225
|
+
// Good: Always specify subset
|
|
226
|
+
const inter = Inter({ subsets: ['latin'] })
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
## Font in Specific Components
|
|
230
|
+
|
|
231
|
+
```tsx
|
|
232
|
+
// For component-specific fonts, export from a shared file
|
|
233
|
+
// lib/fonts.ts
|
|
234
|
+
import { Inter, Playfair_Display } from 'next/font/google'
|
|
235
|
+
|
|
236
|
+
export const inter = Inter({ subsets: ['latin'], variable: '--font-inter' })
|
|
237
|
+
export const playfair = Playfair_Display({ subsets: ['latin'], variable: '--font-playfair' })
|
|
238
|
+
|
|
239
|
+
// components/Heading.tsx
|
|
240
|
+
import { playfair } from '@/lib/fonts'
|
|
241
|
+
|
|
242
|
+
export function Heading({ children }) {
|
|
243
|
+
return <h1 className={playfair.className}>{children}</h1>
|
|
244
|
+
}
|
|
245
|
+
```
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# Functions
|
|
2
|
+
|
|
3
|
+
Next.js function APIs.
|
|
4
|
+
|
|
5
|
+
Reference: https://nextjs.org/docs/app/api-reference/functions
|
|
6
|
+
|
|
7
|
+
## Navigation Hooks (Client)
|
|
8
|
+
|
|
9
|
+
| Hook | Purpose | Reference |
|
|
10
|
+
|------|---------|-----------|
|
|
11
|
+
| `useRouter` | Programmatic navigation (`push`, `replace`, `back`, `refresh`) | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-router) |
|
|
12
|
+
| `usePathname` | Get current pathname | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-pathname) |
|
|
13
|
+
| `useSearchParams` | Read URL search parameters | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-search-params) |
|
|
14
|
+
| `useParams` | Access dynamic route parameters | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-params) |
|
|
15
|
+
| `useSelectedLayoutSegment` | Active child segment (one level) | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-selected-layout-segment) |
|
|
16
|
+
| `useSelectedLayoutSegments` | All active segments below layout | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-selected-layout-segments) |
|
|
17
|
+
| `useLinkStatus` | Check link prefetch status | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-link-status) |
|
|
18
|
+
| `useReportWebVitals` | Report Core Web Vitals metrics | [Docs](https://nextjs.org/docs/app/api-reference/functions/use-report-web-vitals) |
|
|
19
|
+
|
|
20
|
+
## Server Functions
|
|
21
|
+
|
|
22
|
+
| Function | Purpose | Reference |
|
|
23
|
+
|----------|---------|-----------|
|
|
24
|
+
| `cookies` | Read/write cookies | [Docs](https://nextjs.org/docs/app/api-reference/functions/cookies) |
|
|
25
|
+
| `headers` | Read request headers | [Docs](https://nextjs.org/docs/app/api-reference/functions/headers) |
|
|
26
|
+
| `draftMode` | Enable preview of unpublished CMS content | [Docs](https://nextjs.org/docs/app/api-reference/functions/draft-mode) |
|
|
27
|
+
| `after` | Run code after response finishes streaming | [Docs](https://nextjs.org/docs/app/api-reference/functions/after) |
|
|
28
|
+
| `connection` | Wait for connection before dynamic rendering | [Docs](https://nextjs.org/docs/app/api-reference/functions/connection) |
|
|
29
|
+
| `userAgent` | Parse User-Agent header | [Docs](https://nextjs.org/docs/app/api-reference/functions/userAgent) |
|
|
30
|
+
|
|
31
|
+
## Generate Functions
|
|
32
|
+
|
|
33
|
+
| Function | Purpose | Reference |
|
|
34
|
+
|----------|---------|-----------|
|
|
35
|
+
| `generateStaticParams` | Pre-render dynamic routes at build time | [Docs](https://nextjs.org/docs/app/api-reference/functions/generate-static-params) |
|
|
36
|
+
| `generateMetadata` | Dynamic metadata | [Docs](https://nextjs.org/docs/app/api-reference/functions/generate-metadata) |
|
|
37
|
+
| `generateViewport` | Dynamic viewport config | [Docs](https://nextjs.org/docs/app/api-reference/functions/generate-viewport) |
|
|
38
|
+
| `generateSitemaps` | Multiple sitemaps for large sites | [Docs](https://nextjs.org/docs/app/api-reference/functions/generate-sitemaps) |
|
|
39
|
+
| `generateImageMetadata` | Multiple OG images per route | [Docs](https://nextjs.org/docs/app/api-reference/functions/generate-image-metadata) |
|
|
40
|
+
|
|
41
|
+
## Request/Response
|
|
42
|
+
|
|
43
|
+
| Function | Purpose | Reference |
|
|
44
|
+
|----------|---------|-----------|
|
|
45
|
+
| `NextRequest` | Extended Request with helpers | [Docs](https://nextjs.org/docs/app/api-reference/functions/next-request) |
|
|
46
|
+
| `NextResponse` | Extended Response with helpers | [Docs](https://nextjs.org/docs/app/api-reference/functions/next-response) |
|
|
47
|
+
| `ImageResponse` | Generate OG images | [Docs](https://nextjs.org/docs/app/api-reference/functions/image-response) |
|
|
48
|
+
|
|
49
|
+
## Common Examples
|
|
50
|
+
|
|
51
|
+
### Navigation
|
|
52
|
+
|
|
53
|
+
Use `next/link` for internal navigation instead of `<a>` tags.
|
|
54
|
+
|
|
55
|
+
```tsx
|
|
56
|
+
// Bad: Plain anchor tag
|
|
57
|
+
<a href="/about">About</a>
|
|
58
|
+
|
|
59
|
+
// Good: Next.js Link
|
|
60
|
+
import Link from 'next/link'
|
|
61
|
+
|
|
62
|
+
<Link href="/about">About</Link>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Active link styling:
|
|
66
|
+
|
|
67
|
+
```tsx
|
|
68
|
+
'use client'
|
|
69
|
+
|
|
70
|
+
import Link from 'next/link'
|
|
71
|
+
import { usePathname } from 'next/navigation'
|
|
72
|
+
|
|
73
|
+
export function NavLink({ href, children }) {
|
|
74
|
+
const pathname = usePathname()
|
|
75
|
+
|
|
76
|
+
return (
|
|
77
|
+
<Link href={href} className={pathname === href ? 'active' : ''}>
|
|
78
|
+
{children}
|
|
79
|
+
</Link>
|
|
80
|
+
)
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Static Generation
|
|
85
|
+
|
|
86
|
+
```tsx
|
|
87
|
+
// app/blog/[slug]/page.tsx
|
|
88
|
+
export async function generateStaticParams() {
|
|
89
|
+
const posts = await getPosts()
|
|
90
|
+
return posts.map((post) => ({ slug: post.slug }))
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### After Response
|
|
95
|
+
|
|
96
|
+
```tsx
|
|
97
|
+
import { after } from 'next/server'
|
|
98
|
+
|
|
99
|
+
export async function POST(request: Request) {
|
|
100
|
+
const data = await processRequest(request)
|
|
101
|
+
|
|
102
|
+
after(async () => {
|
|
103
|
+
await logAnalytics(data)
|
|
104
|
+
})
|
|
105
|
+
|
|
106
|
+
return Response.json({ success: true })
|
|
107
|
+
}
|
|
108
|
+
```
|