opencode-agent-kit 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/README.md +796 -0
- package/bin/commands/init.mjs +221 -0
- package/bin/init.mjs +21 -0
- package/package.json +22 -0
- package/template/.opencode/agent-docs/backend/README.md +0 -0
- package/template/.opencode/agent-docs/backend/node/BACKEND_PATTERNS.md +82 -0
- package/template/.opencode/agent-docs/backend/node/BACKEND_QUICK_START.md +49 -0
- package/template/.opencode/agent-docs/frontend/next/README.md +0 -0
- package/template/.opencode/agent-docs/frontend/nuxt/API_PATTERNS.md +807 -0
- package/template/.opencode/agent-docs/frontend/nuxt/CHEATSHEET.md +676 -0
- package/template/.opencode/agent-docs/frontend/nuxt/COMPLETION_REPORT.md +613 -0
- package/template/.opencode/agent-docs/frontend/nuxt/EXAMPLES.md +956 -0
- package/template/.opencode/agent-docs/frontend/nuxt/INDEX.md +596 -0
- package/template/.opencode/agent-docs/frontend/nuxt/MCP_GUIDE.md +881 -0
- package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_30_DAYS.md +256 -0
- package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_CHECKLIST.md +156 -0
- package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_WEEKLY_ASSIGNMENTS.md +191 -0
- package/template/.opencode/agent-docs/frontend/nuxt/QUICK_START.md +509 -0
- package/template/.opencode/agent-docs/frontend/nuxt/README.md +506 -0
- package/template/.opencode/agent-docs/frontend/nuxt/README_AGENTS.md +140 -0
- package/template/.opencode/agent-docs/frontend/nuxt/README_DOCS.md +65 -0
- package/template/.opencode/agent-docs/frontend/nuxt/SUMMARY.md +474 -0
- package/template/.opencode/agent-docs/frontend/nuxt/TEAM_OPERATING_GUIDE.md +54 -0
- package/template/.opencode/agent-docs/frontend/nuxt/TESTING_GUIDE.md +904 -0
- package/template/.opencode/agent-docs/frontend/nuxt/WORKFLOWS.md +758 -0
- package/template/.opencode/agent-docs/frontend/react/API_PATTERNS.md +187 -0
- package/template/.opencode/agent-docs/frontend/react/CHEATSHEET.md +87 -0
- package/template/.opencode/agent-docs/frontend/react/INDEX.md +45 -0
- package/template/.opencode/agent-docs/frontend/react/QUICK_START.md +43 -0
- package/template/.opencode/agent-docs/frontend/react/README.md +159 -0
- package/template/.opencode/agent-docs/frontend/vue/README.md +0 -0
- package/template/.opencode/agent-docs/mobile/android/README.md +45 -0
- package/template/.opencode/agent-docs/mobile/flutter/README.md +44 -0
- package/template/.opencode/agents/android-developer.md +418 -0
- package/template/.opencode/agents/code-igniter-3-fullstack.md +345 -0
- package/template/.opencode/agents/code-reviewer.md +517 -0
- package/template/.opencode/agents/database-specialist.md +455 -0
- package/template/.opencode/agents/devops-specialist.md +562 -0
- package/template/.opencode/agents/flutter-developer.md +556 -0
- package/template/.opencode/agents/it-leader.md +911 -0
- package/template/.opencode/agents/laravel-advanced.md +691 -0
- package/template/.opencode/agents/node-backend-developer.md +343 -0
- package/template/.opencode/agents/nuxt-frontend-developer-mentor.md +402 -0
- package/template/.opencode/agents/nuxt-frontend-developer.md +1573 -0
- package/template/.opencode/agents/react-frontend-developer.md +1017 -0
- package/template/.opencode/agents/seo-specialist.md +681 -0
- package/template/.opencode/agents/ui-ux-designer.md +783 -0
- package/template/.opencode/commands/android-build/command.md +25 -0
- package/template/.opencode/commands/android-test/command.md +23 -0
- package/template/.opencode/commands/build-fix.md +29 -0
- package/template/.opencode/commands/checkpoint.md +74 -0
- package/template/.opencode/commands/code-review.md +40 -0
- package/template/.opencode/commands/e2e.md +363 -0
- package/template/.opencode/commands/eval.md +120 -0
- package/template/.opencode/commands/evolve.md +193 -0
- package/template/.opencode/commands/flutter-build/command.md +25 -0
- package/template/.opencode/commands/flutter-test/command.md +24 -0
- package/template/.opencode/commands/go-build.md +183 -0
- package/template/.opencode/commands/go-review.md +148 -0
- package/template/.opencode/commands/go-test.md +268 -0
- package/template/.opencode/commands/gpc-release/command.md +30 -0
- package/template/.opencode/commands/instinct-export.md +91 -0
- package/template/.opencode/commands/instinct-import.md +142 -0
- package/template/.opencode/commands/instinct-status.md +86 -0
- package/template/.opencode/commands/learn.md +70 -0
- package/template/.opencode/commands/multi-backend.md +158 -0
- package/template/.opencode/commands/multi-execute.md +310 -0
- package/template/.opencode/commands/multi-frontend.md +158 -0
- package/template/.opencode/commands/multi-plan.md +261 -0
- package/template/.opencode/commands/multi-workflow.md +183 -0
- package/template/.opencode/commands/orchestrate.md +172 -0
- package/template/.opencode/commands/plan.md +113 -0
- package/template/.opencode/commands/pm2.md +271 -0
- package/template/.opencode/commands/python-review.md +297 -0
- package/template/.opencode/commands/refactor-clean.md +28 -0
- package/template/.opencode/commands/sessions.md +305 -0
- package/template/.opencode/commands/setup-pm.md +80 -0
- package/template/.opencode/commands/skill-create.md +174 -0
- package/template/.opencode/commands/tdd.md +326 -0
- package/template/.opencode/commands/test-coverage.md +27 -0
- package/template/.opencode/commands/update-codemaps.md +17 -0
- package/template/.opencode/commands/update-docs.md +31 -0
- package/template/.opencode/commands/verify.md +59 -0
- package/template/.opencode/config.example.json +309 -0
- package/template/.opencode/config.json +341 -0
- package/template/.opencode/contexts/dev.md +20 -0
- package/template/.opencode/contexts/research.md +26 -0
- package/template/.opencode/contexts/review.md +22 -0
- package/template/.opencode/hooks/hooks.json +169 -0
- package/template/.opencode/instructions/INSTRUCTIONS.md +388 -0
- package/template/.opencode/package.json +5 -0
- package/template/.opencode/rules/README.md +82 -0
- package/template/.opencode/rules/android/gradle.md +62 -0
- package/template/.opencode/rules/android/testing.md +27 -0
- package/template/.opencode/rules/common/agents.md +49 -0
- package/template/.opencode/rules/common/coding-style.md +48 -0
- package/template/.opencode/rules/common/git-workflow.md +45 -0
- package/template/.opencode/rules/common/hooks.md +30 -0
- package/template/.opencode/rules/common/patterns.md +31 -0
- package/template/.opencode/rules/common/performance.md +55 -0
- package/template/.opencode/rules/common/security.md +29 -0
- package/template/.opencode/rules/common/testing.md +29 -0
- package/template/.opencode/rules/flutter/state-management.md +57 -0
- package/template/.opencode/rules/flutter/testing.md +42 -0
- package/template/.opencode/rules/golang/coding-style.md +26 -0
- package/template/.opencode/rules/golang/hooks.md +11 -0
- package/template/.opencode/rules/golang/patterns.md +39 -0
- package/template/.opencode/rules/golang/security.md +28 -0
- package/template/.opencode/rules/golang/testing.md +25 -0
- package/template/.opencode/rules/mobile/performance.md +36 -0
- package/template/.opencode/rules/python/coding-style.md +37 -0
- package/template/.opencode/rules/python/hooks.md +14 -0
- package/template/.opencode/rules/python/patterns.md +34 -0
- package/template/.opencode/rules/python/security.md +25 -0
- package/template/.opencode/rules/python/testing.md +33 -0
- package/template/.opencode/rules/typescript/coding-style.md +58 -0
- package/template/.opencode/rules/typescript/hooks.md +15 -0
- package/template/.opencode/rules/typescript/patterns.md +45 -0
- package/template/.opencode/rules/typescript/security.md +21 -0
- package/template/.opencode/rules/typescript/testing.md +11 -0
- package/template/.opencode/skills/api-documentation/SKILL.md +188 -0
- package/template/.opencode/skills/backend-patterns/SKILL.md +587 -0
- package/template/.opencode/skills/building-components/SKILL.md +37 -0
- package/template/.opencode/skills/building-components/references/accessibility.mdx +819 -0
- package/template/.opencode/skills/building-components/references/as-child.mdx +324 -0
- package/template/.opencode/skills/building-components/references/composition.mdx +239 -0
- package/template/.opencode/skills/building-components/references/data-attributes.mdx +413 -0
- package/template/.opencode/skills/building-components/references/definitions.mdx +258 -0
- package/template/.opencode/skills/building-components/references/design-tokens.mdx +57 -0
- package/template/.opencode/skills/building-components/references/docs.mdx +155 -0
- package/template/.opencode/skills/building-components/references/marketplaces.mdx +144 -0
- package/template/.opencode/skills/building-components/references/npm.mdx +166 -0
- package/template/.opencode/skills/building-components/references/polymorphism.mdx +583 -0
- package/template/.opencode/skills/building-components/references/principles.mdx +61 -0
- package/template/.opencode/skills/building-components/references/registry.mdx +169 -0
- package/template/.opencode/skills/building-components/references/state.mdx +99 -0
- package/template/.opencode/skills/building-components/references/styling.mdx +286 -0
- package/template/.opencode/skills/building-components/references/types.mdx +191 -0
- package/template/.opencode/skills/clickhouse-io/SKILL.md +429 -0
- package/template/.opencode/skills/coding-standards/SKILL.md +520 -0
- package/template/.opencode/skills/configure-ecc/SKILL.md +298 -0
- package/template/.opencode/skills/continuous-learning/SKILL.md +110 -0
- package/template/.opencode/skills/continuous-learning/config.json +18 -0
- package/template/.opencode/skills/continuous-learning/evaluate-session.sh +60 -0
- package/template/.opencode/skills/continuous-learning-v2/SKILL.md +284 -0
- package/template/.opencode/skills/continuous-learning-v2/agents/observer.md +137 -0
- package/template/.opencode/skills/continuous-learning-v2/agents/start-observer.sh +134 -0
- package/template/.opencode/skills/continuous-learning-v2/config.json +41 -0
- package/template/.opencode/skills/continuous-learning-v2/hooks/observe.sh +153 -0
- package/template/.opencode/skills/continuous-learning-v2/scripts/instinct-cli.py +489 -0
- package/template/.opencode/skills/continuous-learning-v2/scripts/test_parse_instinct.py +82 -0
- package/template/.opencode/skills/dart-add-unit-test/SKILL.md +122 -0
- package/template/.opencode/skills/dart-build-cli-app/SKILL.md +185 -0
- package/template/.opencode/skills/dart-collect-coverage/SKILL.md +141 -0
- package/template/.opencode/skills/dart-fix-runtime-errors/SKILL.md +166 -0
- package/template/.opencode/skills/dart-generate-test-mocks/SKILL.md +155 -0
- package/template/.opencode/skills/dart-migrate-to-checks-package/SKILL.md +126 -0
- package/template/.opencode/skills/dart-resolve-package-conflicts/SKILL.md +116 -0
- package/template/.opencode/skills/dart-run-static-analysis/SKILL.md +104 -0
- package/template/.opencode/skills/dart-use-pattern-matching/SKILL.md +146 -0
- package/template/.opencode/skills/django-patterns/SKILL.md +733 -0
- package/template/.opencode/skills/django-security/SKILL.md +592 -0
- package/template/.opencode/skills/django-tdd/SKILL.md +728 -0
- package/template/.opencode/skills/django-verification/SKILL.md +460 -0
- package/template/.opencode/skills/eval-harness/SKILL.md +227 -0
- package/template/.opencode/skills/firebase-basics/SKILL.md +103 -0
- package/template/.opencode/skills/firebase-basics/references/additional-skills.md +113 -0
- package/template/.opencode/skills/firebase-basics/references/cli-usage.md +31 -0
- package/template/.opencode/skills/firebase-basics/references/client-library-usage.md +45 -0
- package/template/.opencode/skills/firebase-basics/references/core-concepts.md +61 -0
- package/template/.opencode/skills/firebase-basics/references/iac-usage.md +40 -0
- package/template/.opencode/skills/firebase-basics/references/iam-security.md +74 -0
- package/template/.opencode/skills/firebase-basics/references/mcp-usage.md +63 -0
- package/template/.opencode/skills/flutter/SKILL.md +292 -0
- package/template/.opencode/skills/flutter-add-integration-test/SKILL.md +163 -0
- package/template/.opencode/skills/flutter-add-widget-preview/SKILL.md +145 -0
- package/template/.opencode/skills/flutter-add-widget-test/SKILL.md +154 -0
- package/template/.opencode/skills/flutter-apply-architecture-best-practices/SKILL.md +162 -0
- package/template/.opencode/skills/flutter-build-responsive-layout/SKILL.md +139 -0
- package/template/.opencode/skills/flutter-fix-layout-issues/SKILL.md +130 -0
- package/template/.opencode/skills/flutter-implement-json-serialization/SKILL.md +153 -0
- package/template/.opencode/skills/flutter-setup-declarative-routing/SKILL.md +255 -0
- package/template/.opencode/skills/flutter-setup-localization/SKILL.md +210 -0
- package/template/.opencode/skills/flutter-use-http-package/SKILL.md +174 -0
- package/template/.opencode/skills/frontend-design/SKILL.md +89 -0
- package/template/.opencode/skills/frontend-patterns/SKILL.md +631 -0
- package/template/.opencode/skills/golang-patterns/SKILL.md +673 -0
- package/template/.opencode/skills/golang-testing/SKILL.md +719 -0
- package/template/.opencode/skills/impeccable/SKILL.md +165 -0
- package/template/.opencode/skills/impeccable/agents/impeccable-asset-producer.md +101 -0
- package/template/.opencode/skills/impeccable/reference/adapt.md +190 -0
- package/template/.opencode/skills/impeccable/reference/animate.md +175 -0
- package/template/.opencode/skills/impeccable/reference/audit.md +133 -0
- package/template/.opencode/skills/impeccable/reference/bolder.md +113 -0
- package/template/.opencode/skills/impeccable/reference/brand.md +118 -0
- package/template/.opencode/skills/impeccable/reference/clarify.md +174 -0
- package/template/.opencode/skills/impeccable/reference/codex.md +105 -0
- package/template/.opencode/skills/impeccable/reference/cognitive-load.md +106 -0
- package/template/.opencode/skills/impeccable/reference/color-and-contrast.md +105 -0
- package/template/.opencode/skills/impeccable/reference/colorize.md +154 -0
- package/template/.opencode/skills/impeccable/reference/craft.md +123 -0
- package/template/.opencode/skills/impeccable/reference/critique.md +273 -0
- package/template/.opencode/skills/impeccable/reference/delight.md +302 -0
- package/template/.opencode/skills/impeccable/reference/distill.md +111 -0
- package/template/.opencode/skills/impeccable/reference/document.md +427 -0
- package/template/.opencode/skills/impeccable/reference/extract.md +69 -0
- package/template/.opencode/skills/impeccable/reference/harden.md +347 -0
- package/template/.opencode/skills/impeccable/reference/heuristics-scoring.md +234 -0
- package/template/.opencode/skills/impeccable/reference/interaction-design.md +195 -0
- package/template/.opencode/skills/impeccable/reference/layout.md +141 -0
- package/template/.opencode/skills/impeccable/reference/live.md +622 -0
- package/template/.opencode/skills/impeccable/reference/motion-design.md +109 -0
- package/template/.opencode/skills/impeccable/reference/onboard.md +234 -0
- package/template/.opencode/skills/impeccable/reference/optimize.md +258 -0
- package/template/.opencode/skills/impeccable/reference/overdrive.md +130 -0
- package/template/.opencode/skills/impeccable/reference/personas.md +179 -0
- package/template/.opencode/skills/impeccable/reference/polish.md +242 -0
- package/template/.opencode/skills/impeccable/reference/product.md +62 -0
- package/template/.opencode/skills/impeccable/reference/quieter.md +99 -0
- package/template/.opencode/skills/impeccable/reference/responsive-design.md +114 -0
- package/template/.opencode/skills/impeccable/reference/shape.md +165 -0
- package/template/.opencode/skills/impeccable/reference/spatial-design.md +100 -0
- package/template/.opencode/skills/impeccable/reference/teach.md +156 -0
- package/template/.opencode/skills/impeccable/reference/typeset.md +124 -0
- package/template/.opencode/skills/impeccable/reference/typography.md +159 -0
- package/template/.opencode/skills/impeccable/reference/ux-writing.md +107 -0
- package/template/.opencode/skills/impeccable/scripts/cleanup-deprecated.mjs +284 -0
- package/template/.opencode/skills/impeccable/scripts/command-metadata.json +94 -0
- package/template/.opencode/skills/impeccable/scripts/critique-storage.mjs +242 -0
- package/template/.opencode/skills/impeccable/scripts/design-parser.mjs +820 -0
- package/template/.opencode/skills/impeccable/scripts/detect-csp.mjs +198 -0
- package/template/.opencode/skills/impeccable/scripts/detect.mjs +21 -0
- package/template/.opencode/skills/impeccable/scripts/impeccable-paths.mjs +110 -0
- package/template/.opencode/skills/impeccable/scripts/is-generated.mjs +69 -0
- package/template/.opencode/skills/impeccable/scripts/live-accept.mjs +595 -0
- package/template/.opencode/skills/impeccable/scripts/live-browser-session.js +123 -0
- package/template/.opencode/skills/impeccable/scripts/live-browser.js +4860 -0
- package/template/.opencode/skills/impeccable/scripts/live-complete.mjs +75 -0
- package/template/.opencode/skills/impeccable/scripts/live-completion.mjs +18 -0
- package/template/.opencode/skills/impeccable/scripts/live-inject.mjs +446 -0
- package/template/.opencode/skills/impeccable/scripts/live-poll.mjs +200 -0
- package/template/.opencode/skills/impeccable/scripts/live-resume.mjs +48 -0
- package/template/.opencode/skills/impeccable/scripts/live-server.mjs +838 -0
- package/template/.opencode/skills/impeccable/scripts/live-session-store.mjs +254 -0
- package/template/.opencode/skills/impeccable/scripts/live-status.mjs +47 -0
- package/template/.opencode/skills/impeccable/scripts/live-wrap.mjs +632 -0
- package/template/.opencode/skills/impeccable/scripts/live.mjs +247 -0
- package/template/.opencode/skills/impeccable/scripts/load-context.mjs +141 -0
- package/template/.opencode/skills/impeccable/scripts/modern-screenshot.umd.js +14 -0
- package/template/.opencode/skills/impeccable/scripts/pin.mjs +214 -0
- package/template/.opencode/skills/iterative-retrieval/SKILL.md +202 -0
- package/template/.opencode/skills/java-coding-standards/SKILL.md +138 -0
- package/template/.opencode/skills/jetpack-compose/.skillfish.json +10 -0
- package/template/.opencode/skills/jetpack-compose/SKILL.md +420 -0
- package/template/.opencode/skills/jpa-patterns/SKILL.md +141 -0
- package/template/.opencode/skills/nutrient-document-processing/SKILL.md +165 -0
- package/template/.opencode/skills/nuxt-ui/SKILL.md +334 -0
- package/template/.opencode/skills/nuxt-ui/references/components.md +377 -0
- package/template/.opencode/skills/nuxt-ui/references/composables.md +127 -0
- package/template/.opencode/skills/nuxt-ui/references/layouts/chat.md +266 -0
- package/template/.opencode/skills/nuxt-ui/references/layouts/dashboard.md +220 -0
- package/template/.opencode/skills/nuxt-ui/references/layouts/docs.md +141 -0
- package/template/.opencode/skills/nuxt-ui/references/layouts/editor.md +168 -0
- package/template/.opencode/skills/nuxt-ui/references/layouts/page.md +260 -0
- package/template/.opencode/skills/nuxt-ui/references/theming.md +427 -0
- package/template/.opencode/skills/postgres-patterns/SKILL.md +146 -0
- package/template/.opencode/skills/project-guidelines-example/SKILL.md +345 -0
- package/template/.opencode/skills/python-patterns/SKILL.md +749 -0
- package/template/.opencode/skills/python-testing/SKILL.md +815 -0
- package/template/.opencode/skills/security-review/SKILL.md +494 -0
- package/template/.opencode/skills/security-review/cloud-infrastructure-security.md +361 -0
- package/template/.opencode/skills/shadcn-ui/README.md +248 -0
- package/template/.opencode/skills/shadcn-ui/SKILL.md +326 -0
- package/template/.opencode/skills/shadcn-ui/examples/auth-layout.tsx +177 -0
- package/template/.opencode/skills/shadcn-ui/examples/data-table.tsx +313 -0
- package/template/.opencode/skills/shadcn-ui/examples/form-pattern.tsx +177 -0
- package/template/.opencode/skills/shadcn-ui/resources/component-catalog.md +481 -0
- package/template/.opencode/skills/shadcn-ui/resources/customization-guide.md +516 -0
- package/template/.opencode/skills/shadcn-ui/resources/migration-guide.md +463 -0
- package/template/.opencode/skills/shadcn-ui/resources/setup-guide.md +412 -0
- package/template/.opencode/skills/shadcn-ui/scripts/verify-setup.sh +134 -0
- package/template/.opencode/skills/springboot-patterns/SKILL.md +304 -0
- package/template/.opencode/skills/springboot-security/SKILL.md +119 -0
- package/template/.opencode/skills/springboot-tdd/SKILL.md +157 -0
- package/template/.opencode/skills/springboot-verification/SKILL.md +100 -0
- package/template/.opencode/skills/strategic-compact/SKILL.md +63 -0
- package/template/.opencode/skills/strategic-compact/suggest-compact.sh +52 -0
- package/template/.opencode/skills/tdd-workflow/SKILL.md +409 -0
- package/template/.opencode/skills/vercel-composition-patterns/AGENTS.md +946 -0
- package/template/.opencode/skills/vercel-composition-patterns/SKILL.md +89 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/template/.opencode/skills/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/template/.opencode/skills/vercel-react-best-practices/AGENTS.md +2934 -0
- package/template/.opencode/skills/vercel-react-best-practices/SKILL.md +136 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/async-defer-await.md +80 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +59 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/template/.opencode/skills/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/template/.opencode/skills/verification-loop/SKILL.md +120 -0
- package/template/.opencode/skills/web-design-guidelines/SKILL.md +39 -0
- package/template/AGENTS.md +32 -0
- package/template/opencode.json +354 -0
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Scan a project tree for Content-Security-Policy signals and classify the
|
|
3
|
+
* shape so the agent knows which patch template to propose.
|
|
4
|
+
*
|
|
5
|
+
* Used at first-time `live.mjs` setup. Mechanical (grep-based) — no network,
|
|
6
|
+
* no dev server, no JS evaluation. The classification drives a user-facing
|
|
7
|
+
* consent prompt; the agent does the actual patch writing.
|
|
8
|
+
*
|
|
9
|
+
* Shapes are named by patch mechanism, not framework origin:
|
|
10
|
+
* - "append-arrays": CSP defined as structured directive arrays. Patch
|
|
11
|
+
* appends a dev-only localhost entry. Covers:
|
|
12
|
+
* - Monorepo helpers with additional*Src options
|
|
13
|
+
* (e.g. createBaseNextConfig for Next)
|
|
14
|
+
* - SvelteKit kit.csp.directives
|
|
15
|
+
* - nuxt-security module's contentSecurityPolicy
|
|
16
|
+
* - "append-string": CSP built as a literal value string. Patch splices
|
|
17
|
+
* a dev-only token into script-src and connect-src.
|
|
18
|
+
* Covers:
|
|
19
|
+
* - Inline Next.js headers() with CSP string
|
|
20
|
+
* - Nuxt routeRules / nitro.routeRules CSP headers
|
|
21
|
+
* - "middleware": CSP set dynamically in middleware.{ts,js}.
|
|
22
|
+
* Detected but not auto-patched in v1.
|
|
23
|
+
* - "meta-tag": <meta http-equiv="Content-Security-Policy"> in
|
|
24
|
+
* layout files. Detected but not auto-patched in v1.
|
|
25
|
+
* - null: no CSP signals found; no patch needed.
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
import fs from 'node:fs';
|
|
29
|
+
import path from 'node:path';
|
|
30
|
+
|
|
31
|
+
const SKIP_DIRS = new Set([
|
|
32
|
+
'node_modules',
|
|
33
|
+
'.git',
|
|
34
|
+
'.next',
|
|
35
|
+
'.turbo',
|
|
36
|
+
'.svelte-kit',
|
|
37
|
+
'.nuxt',
|
|
38
|
+
'.astro',
|
|
39
|
+
'dist',
|
|
40
|
+
'build',
|
|
41
|
+
'out',
|
|
42
|
+
'.vercel',
|
|
43
|
+
]);
|
|
44
|
+
|
|
45
|
+
const SCAN_EXTS = new Set(['.js', '.mjs', '.cjs', '.ts', '.mts', '.cts', '.tsx', '.jsx']);
|
|
46
|
+
const LAYOUT_EXTS = new Set(['.tsx', '.jsx', '.astro', '.vue', '.svelte', '.html']);
|
|
47
|
+
const MAX_DEPTH = 6;
|
|
48
|
+
const MAX_READ_BYTES = 64 * 1024;
|
|
49
|
+
|
|
50
|
+
// append-arrays signals: CSP expressed as structured directive arrays
|
|
51
|
+
const MONOREPO_HELPER_SIGNALS = [
|
|
52
|
+
/\bbuildCSPConfig\b/,
|
|
53
|
+
/\bbuildSecurityHeaders\b/,
|
|
54
|
+
/\badditionalScriptSrc\b/,
|
|
55
|
+
/\badditionalConnectSrc\b/,
|
|
56
|
+
/\bcreateBaseNextConfig\b/,
|
|
57
|
+
];
|
|
58
|
+
const SVELTEKIT_CSP_SIGNALS = [
|
|
59
|
+
/\bkit\s*:/,
|
|
60
|
+
/\bcsp\s*:/,
|
|
61
|
+
/\bdirectives\s*:/,
|
|
62
|
+
];
|
|
63
|
+
const NUXT_SECURITY_SIGNALS = [
|
|
64
|
+
/['"]nuxt-security['"]/,
|
|
65
|
+
/\bcontentSecurityPolicy\b/,
|
|
66
|
+
];
|
|
67
|
+
|
|
68
|
+
// append-string signals: CSP written as a literal value string
|
|
69
|
+
const INLINE_HEADER_SIGNALS = [
|
|
70
|
+
/["']Content-Security-Policy["']/i,
|
|
71
|
+
/\bscript-src\b/,
|
|
72
|
+
/\bconnect-src\b/,
|
|
73
|
+
];
|
|
74
|
+
const NUXT_ROUTE_RULES_SIGNALS = [
|
|
75
|
+
/\brouteRules\b/,
|
|
76
|
+
/Content-Security-Policy/i,
|
|
77
|
+
/\bscript-src\b/,
|
|
78
|
+
];
|
|
79
|
+
|
|
80
|
+
const MIDDLEWARE_HINT = /headers\.set\(\s*["']Content-Security-Policy["']/i;
|
|
81
|
+
const META_TAG_HINT = /http-equiv\s*=\s*["']Content-Security-Policy["']/i;
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* @param {string} cwd Project root.
|
|
85
|
+
* @returns {{ shape: string|null, signals: string[] }}
|
|
86
|
+
*/
|
|
87
|
+
export function detectCsp(cwd = process.cwd()) {
|
|
88
|
+
const hits = { appendArrays: [], appendString: [], middleware: [], metaTag: [] };
|
|
89
|
+
|
|
90
|
+
walk(cwd, cwd, 0, (absPath, relPath, body) => {
|
|
91
|
+
const ext = path.extname(absPath);
|
|
92
|
+
const base = path.basename(absPath).toLowerCase();
|
|
93
|
+
const isConfig = (name) =>
|
|
94
|
+
new RegExp('(^|/)' + name + '\\.config\\.').test(relPath);
|
|
95
|
+
|
|
96
|
+
// === append-arrays candidates ===
|
|
97
|
+
|
|
98
|
+
// Monorepo CSP helper: packages/*/src/.../(config|security)/*
|
|
99
|
+
if (SCAN_EXTS.has(ext) &&
|
|
100
|
+
/packages\/[^/]+\/src\/.*(config|next-config|security)/.test(relPath) &&
|
|
101
|
+
MONOREPO_HELPER_SIGNALS.some((re) => re.test(body))) {
|
|
102
|
+
hits.appendArrays.push(relPath);
|
|
103
|
+
return;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// SvelteKit kit.csp.directives
|
|
107
|
+
if (SCAN_EXTS.has(ext) && isConfig('svelte') &&
|
|
108
|
+
SVELTEKIT_CSP_SIGNALS.every((re) => re.test(body))) {
|
|
109
|
+
hits.appendArrays.push(relPath);
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
// Nuxt nuxt-security module
|
|
114
|
+
if (SCAN_EXTS.has(ext) && isConfig('nuxt') &&
|
|
115
|
+
NUXT_SECURITY_SIGNALS.every((re) => re.test(body))) {
|
|
116
|
+
hits.appendArrays.push(relPath);
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// === append-string candidates ===
|
|
121
|
+
|
|
122
|
+
// Inline headers in Next/Nuxt/SvelteKit/Astro/Vite config
|
|
123
|
+
if (SCAN_EXTS.has(ext) &&
|
|
124
|
+
/(^|\/)(next|nuxt|vite|astro|svelte)\.config\./.test(relPath) &&
|
|
125
|
+
INLINE_HEADER_SIGNALS.every((re) => re.test(body))) {
|
|
126
|
+
// Nuxt routeRules is a sub-shape of append-string; we already covered
|
|
127
|
+
// nuxt-security above via return, so any remaining Nuxt CSP match here
|
|
128
|
+
// is a route-rules / inline-headers case. Either way, same patch
|
|
129
|
+
// mechanism.
|
|
130
|
+
hits.appendString.push(relPath);
|
|
131
|
+
return;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// === detect-only shapes ===
|
|
135
|
+
|
|
136
|
+
if ((base === 'middleware.ts' || base === 'middleware.js' || base === 'middleware.mjs') &&
|
|
137
|
+
MIDDLEWARE_HINT.test(body)) {
|
|
138
|
+
hits.middleware.push(relPath);
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
if (LAYOUT_EXTS.has(ext) && META_TAG_HINT.test(body)) {
|
|
142
|
+
hits.metaTag.push(relPath);
|
|
143
|
+
}
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
// Priority: append-arrays > append-string > middleware > meta-tag.
|
|
147
|
+
// Structured patches are safer than string splices; runtime and HTML
|
|
148
|
+
// injection patches are less reliable and v1 doesn't auto-apply them.
|
|
149
|
+
if (hits.appendArrays.length > 0) {
|
|
150
|
+
return { shape: 'append-arrays', signals: hits.appendArrays };
|
|
151
|
+
}
|
|
152
|
+
if (hits.appendString.length > 0) {
|
|
153
|
+
return { shape: 'append-string', signals: hits.appendString };
|
|
154
|
+
}
|
|
155
|
+
if (hits.middleware.length > 0) {
|
|
156
|
+
return { shape: 'middleware', signals: hits.middleware };
|
|
157
|
+
}
|
|
158
|
+
if (hits.metaTag.length > 0) {
|
|
159
|
+
return { shape: 'meta-tag', signals: hits.metaTag };
|
|
160
|
+
}
|
|
161
|
+
return { shape: null, signals: [] };
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
function walk(root, dir, depth, visit) {
|
|
165
|
+
if (depth > MAX_DEPTH) return;
|
|
166
|
+
let entries;
|
|
167
|
+
try { entries = fs.readdirSync(dir, { withFileTypes: true }); }
|
|
168
|
+
catch { return; }
|
|
169
|
+
|
|
170
|
+
for (const entry of entries) {
|
|
171
|
+
const abs = path.join(dir, entry.name);
|
|
172
|
+
if (entry.isDirectory()) {
|
|
173
|
+
if (SKIP_DIRS.has(entry.name)) continue;
|
|
174
|
+
walk(root, abs, depth + 1, visit);
|
|
175
|
+
continue;
|
|
176
|
+
}
|
|
177
|
+
if (!entry.isFile()) continue;
|
|
178
|
+
const ext = path.extname(entry.name);
|
|
179
|
+
if (!SCAN_EXTS.has(ext) && !LAYOUT_EXTS.has(ext)) continue;
|
|
180
|
+
let body;
|
|
181
|
+
try {
|
|
182
|
+
const fd = fs.openSync(abs, 'r');
|
|
183
|
+
try {
|
|
184
|
+
const buf = Buffer.alloc(MAX_READ_BYTES);
|
|
185
|
+
const n = fs.readSync(fd, buf, 0, MAX_READ_BYTES, 0);
|
|
186
|
+
body = buf.slice(0, n).toString('utf-8');
|
|
187
|
+
} finally { fs.closeSync(fd); }
|
|
188
|
+
} catch { continue; }
|
|
189
|
+
visit(abs, path.relative(root, abs), body);
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
// CLI mode
|
|
194
|
+
const _running = process.argv[1];
|
|
195
|
+
if (_running?.endsWith('detect-csp.mjs') || _running?.endsWith('detect-csp.mjs/')) {
|
|
196
|
+
const result = detectCsp(process.cwd());
|
|
197
|
+
console.log(JSON.stringify(result, null, 2));
|
|
198
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import fs from 'node:fs';
|
|
4
|
+
import path from 'node:path';
|
|
5
|
+
import { pathToFileURL, fileURLToPath } from 'node:url';
|
|
6
|
+
|
|
7
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
8
|
+
const candidates = [
|
|
9
|
+
path.join(__dirname, 'detector', 'detect-antipatterns.mjs'),
|
|
10
|
+
path.join(__dirname, '..', '..', 'cli', 'engine', 'detect-antipatterns.mjs'),
|
|
11
|
+
];
|
|
12
|
+
const detectorPath = candidates.find(p => fs.existsSync(p));
|
|
13
|
+
|
|
14
|
+
if (!detectorPath) {
|
|
15
|
+
process.stderr.write('Error: bundled detector not found.\n');
|
|
16
|
+
process.exit(1);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
const { detectCli } = await import(pathToFileURL(detectorPath));
|
|
20
|
+
|
|
21
|
+
await detectCli();
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
|
|
4
|
+
export const IMPECCABLE_DIR = '.impeccable';
|
|
5
|
+
export const LIVE_DIR = 'live';
|
|
6
|
+
export const CRITIQUE_DIR = 'critique';
|
|
7
|
+
|
|
8
|
+
export function getImpeccableDir(cwd = process.cwd()) {
|
|
9
|
+
return path.join(cwd, IMPECCABLE_DIR);
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export function getDesignSidecarPath(cwd = process.cwd()) {
|
|
13
|
+
return path.join(getImpeccableDir(cwd), 'design.json');
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export function getDesignSidecarCandidates(cwd = process.cwd(), contextDir = cwd) {
|
|
17
|
+
const candidates = [
|
|
18
|
+
getDesignSidecarPath(cwd),
|
|
19
|
+
path.join(cwd, 'DESIGN.json'),
|
|
20
|
+
];
|
|
21
|
+
const contextLegacy = path.join(contextDir, 'DESIGN.json');
|
|
22
|
+
if (!candidates.includes(contextLegacy)) candidates.push(contextLegacy);
|
|
23
|
+
return candidates;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export function resolveDesignSidecarPath(cwd = process.cwd(), contextDir = cwd) {
|
|
27
|
+
return firstExisting(getDesignSidecarCandidates(cwd, contextDir));
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export function getLiveDir(cwd = process.cwd()) {
|
|
31
|
+
return path.join(getImpeccableDir(cwd), LIVE_DIR);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export function getLiveConfigPath(cwd = process.cwd()) {
|
|
35
|
+
return path.join(getLiveDir(cwd), 'config.json');
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function getLegacyLiveConfigPath(scriptsDir) {
|
|
39
|
+
return path.join(scriptsDir, 'config.json');
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function resolveLiveConfigPath({ cwd = process.cwd(), scriptsDir, env = process.env } = {}) {
|
|
43
|
+
if (env.IMPECCABLE_LIVE_CONFIG && env.IMPECCABLE_LIVE_CONFIG.trim()) {
|
|
44
|
+
const configured = env.IMPECCABLE_LIVE_CONFIG.trim();
|
|
45
|
+
return path.isAbsolute(configured) ? configured : path.resolve(cwd, configured);
|
|
46
|
+
}
|
|
47
|
+
const primary = getLiveConfigPath(cwd);
|
|
48
|
+
if (fs.existsSync(primary)) return primary;
|
|
49
|
+
if (scriptsDir) {
|
|
50
|
+
const legacy = getLegacyLiveConfigPath(scriptsDir);
|
|
51
|
+
if (fs.existsSync(legacy)) return legacy;
|
|
52
|
+
}
|
|
53
|
+
return primary;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export function getLiveServerPath(cwd = process.cwd()) {
|
|
57
|
+
return path.join(getLiveDir(cwd), 'server.json');
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function getLegacyLiveServerPath(cwd = process.cwd()) {
|
|
61
|
+
return path.join(cwd, '.impeccable-live.json');
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function readLiveServerInfo(cwd = process.cwd()) {
|
|
65
|
+
for (const filePath of [getLiveServerPath(cwd), getLegacyLiveServerPath(cwd)]) {
|
|
66
|
+
try {
|
|
67
|
+
return { info: JSON.parse(fs.readFileSync(filePath, 'utf-8')), path: filePath };
|
|
68
|
+
} catch {
|
|
69
|
+
/* try next */
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return null;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function writeLiveServerInfo(cwd = process.cwd(), info) {
|
|
76
|
+
const filePath = getLiveServerPath(cwd);
|
|
77
|
+
fs.mkdirSync(path.dirname(filePath), { recursive: true });
|
|
78
|
+
fs.writeFileSync(filePath, JSON.stringify(info));
|
|
79
|
+
return filePath;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export function removeLiveServerInfo(cwd = process.cwd()) {
|
|
83
|
+
for (const filePath of [getLiveServerPath(cwd), getLegacyLiveServerPath(cwd)]) {
|
|
84
|
+
try { fs.unlinkSync(filePath); } catch {}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function getLiveSessionsDir(cwd = process.cwd()) {
|
|
89
|
+
return path.join(getLiveDir(cwd), 'sessions');
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function getLegacyLiveSessionsDir(cwd = process.cwd()) {
|
|
93
|
+
return path.join(cwd, '.impeccable-live', 'sessions');
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function getLiveAnnotationsDir(cwd = process.cwd()) {
|
|
97
|
+
return path.join(getLiveDir(cwd), 'annotations');
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export function getCritiqueDir(cwd = process.cwd()) {
|
|
101
|
+
return path.join(getImpeccableDir(cwd), CRITIQUE_DIR);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export function getLegacyLiveAnnotationsDir(cwd = process.cwd()) {
|
|
105
|
+
return path.join(cwd, '.impeccable-live', 'annotations');
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function firstExisting(paths) {
|
|
109
|
+
return paths.find((filePath) => fs.existsSync(filePath)) || null;
|
|
110
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Decide whether a given file is "generated" (regenerated by a build step,
|
|
3
|
+
* unsafe to write variants into) or "source" (safe to edit, changes persist).
|
|
4
|
+
*
|
|
5
|
+
* Why this matters: when the user picks an element on a page whose underlying
|
|
6
|
+
* file is regenerated by a build step (e.g. `scripts/build-sub-pages.js`
|
|
7
|
+
* rewriting `public/docs/*.html`), writing variants or accepted changes into
|
|
8
|
+
* that file is silent data loss — the next build wipes them.
|
|
9
|
+
*
|
|
10
|
+
* Signals, in order of reliability:
|
|
11
|
+
* 1. Git check-ignore: gitignored files are assumed generated.
|
|
12
|
+
* 2. File-header markers ("GENERATED", "DO NOT EDIT", "AUTO-GENERATED")
|
|
13
|
+
* within the first ~300 characters — catches non-git projects.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
import { execSync } from 'node:child_process';
|
|
17
|
+
import fs from 'node:fs';
|
|
18
|
+
import path from 'node:path';
|
|
19
|
+
|
|
20
|
+
const HEADER_SCAN_BYTES = 300;
|
|
21
|
+
const HEADER_MARKERS = [
|
|
22
|
+
/@generated\b/i,
|
|
23
|
+
/\bGENERATED\s+FILE\b/,
|
|
24
|
+
/\bAUTO-?GENERATED\b/i,
|
|
25
|
+
/\bDO\s+NOT\s+EDIT\b/i,
|
|
26
|
+
];
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* @param {string} filePath - absolute or cwd-relative path
|
|
30
|
+
* @param {object} [options]
|
|
31
|
+
* @param {string} [options.cwd] - project root (defaults to process.cwd())
|
|
32
|
+
*/
|
|
33
|
+
export function isGeneratedFile(filePath, options = {}) {
|
|
34
|
+
const cwd = options.cwd || process.cwd();
|
|
35
|
+
const absPath = path.isAbsolute(filePath) ? filePath : path.resolve(cwd, filePath);
|
|
36
|
+
|
|
37
|
+
if (isGitIgnored(absPath, cwd)) return true;
|
|
38
|
+
if (hasGeneratedHeader(absPath)) return true;
|
|
39
|
+
return false;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function isGitIgnored(absPath, cwd) {
|
|
43
|
+
try {
|
|
44
|
+
execSync(`git check-ignore --quiet ${JSON.stringify(absPath)}`, {
|
|
45
|
+
cwd,
|
|
46
|
+
stdio: 'ignore',
|
|
47
|
+
});
|
|
48
|
+
return true; // exit 0 = ignored
|
|
49
|
+
} catch (err) {
|
|
50
|
+
// Exit code 1 = not ignored. Exit code 128 = not a git repo or other error.
|
|
51
|
+
// In both cases, treat as "not known to be ignored."
|
|
52
|
+
return false;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
function hasGeneratedHeader(absPath) {
|
|
57
|
+
let fd;
|
|
58
|
+
try {
|
|
59
|
+
fd = fs.openSync(absPath, 'r');
|
|
60
|
+
const buf = Buffer.alloc(HEADER_SCAN_BYTES);
|
|
61
|
+
const bytesRead = fs.readSync(fd, buf, 0, HEADER_SCAN_BYTES, 0);
|
|
62
|
+
const head = buf.slice(0, bytesRead).toString('utf-8');
|
|
63
|
+
return HEADER_MARKERS.some((re) => re.test(head));
|
|
64
|
+
} catch {
|
|
65
|
+
return false;
|
|
66
|
+
} finally {
|
|
67
|
+
if (fd !== undefined) { try { fs.closeSync(fd); } catch {} }
|
|
68
|
+
}
|
|
69
|
+
}
|