@cbartens/bkit 0.0.0-stage → 5.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/.bkit/README.md +421 -0
- package/.bkit/core/.agents/context.md +95 -0
- package/.bkit/core/.agents/docs.md +62 -0
- package/.bkit/core/.agents/rules.md +147 -0
- package/.bkit/core/.agents/skills.md +43 -0
- package/.bkit/core/.bkit/LICENSE.md +151 -0
- package/.bkit/core/.bkit/README.md +421 -0
- package/.bkit/core/.bkit/cloud.md +502 -0
- package/.bkit/core/.bkit/comparison.md +318 -0
- package/.bkit/core/.bkit/install.md +496 -0
- package/.bkit/core/.bkit/jsonl.md +497 -0
- package/.bkit/core/.bkit/prompts.md +474 -0
- package/.bkit/core/.bkit/providers.md +598 -0
- package/.bkit/core/.bkit/templates.md +471 -0
- package/.bkit/core/.bkit/trackers.md +95 -0
- package/.bkit/core/.bkit/workflows.md +1546 -0
- package/.bkit/core/.claude/hooks/bkit-gateguard.cjs +82 -0
- package/.bkit/core/.claude/hooks/bkit-guardrails.cjs +93 -0
- package/.bkit/core/.claude/hooks/bkit-preflight.sh +74 -0
- package/.bkit/core/.codex/hooks/bkit-gateguard.cjs +115 -0
- package/.bkit/core/.codex/hooks/bkit-guardrails.cjs +135 -0
- package/.bkit/core/.cursor/hooks/bkit-gateguard.cjs +111 -0
- package/.bkit/core/.cursor/hooks/bkit-guardrails.cjs +169 -0
- package/.bkit/core/.cursor/hooks/bkit-preflight.sh +63 -0
- package/.bkit/core/.opencode/plugin/bkit-gateguard.js +225 -0
- package/.bkit/core/AGENTS.md +77 -0
- package/.bkit/core/LICENSE.md +149 -0
- package/.bkit/core/docs/templates/bkit-audit-accessibility.md +272 -0
- package/.bkit/core/docs/templates/bkit-audit-adoption.md +223 -0
- package/.bkit/core/docs/templates/bkit-audit-agents.md +230 -0
- package/.bkit/core/docs/templates/bkit-audit-aio-seo.md +227 -0
- package/.bkit/core/docs/templates/bkit-audit-analytics.md +266 -0
- package/.bkit/core/docs/templates/bkit-audit-annotations.md +230 -0
- package/.bkit/core/docs/templates/bkit-audit-app-performance.md +270 -0
- package/.bkit/core/docs/templates/bkit-audit-app-store.md +254 -0
- package/.bkit/core/docs/templates/bkit-audit-architecture.md +221 -0
- package/.bkit/core/docs/templates/bkit-audit-ci-performance.md +241 -0
- package/.bkit/core/docs/templates/bkit-audit-config.md +230 -0
- package/.bkit/core/docs/templates/bkit-audit-cost.md +218 -0
- package/.bkit/core/docs/templates/bkit-audit-coverage.md +221 -0
- package/.bkit/core/docs/templates/bkit-audit-database.md +229 -0
- package/.bkit/core/docs/templates/bkit-audit-dead-code.md +251 -0
- package/.bkit/core/docs/templates/bkit-audit-deferrals.md +283 -0
- package/.bkit/core/docs/templates/bkit-audit-dependencies.md +268 -0
- package/.bkit/core/docs/templates/bkit-audit-documentation.md +280 -0
- package/.bkit/core/docs/templates/bkit-audit-duplication.md +253 -0
- package/.bkit/core/docs/templates/bkit-audit-failures.md +259 -0
- package/.bkit/core/docs/templates/bkit-audit-flakes.md +237 -0
- package/.bkit/core/docs/templates/bkit-audit-gates.md +250 -0
- package/.bkit/core/docs/templates/bkit-audit-issues.md +273 -0
- package/.bkit/core/docs/templates/bkit-audit-llm.md +239 -0
- package/.bkit/core/docs/templates/bkit-audit-logs.md +266 -0
- package/.bkit/core/docs/templates/bkit-audit-models.md +210 -0
- package/.bkit/core/docs/templates/bkit-audit-privacy.md +211 -0
- package/.bkit/core/docs/templates/bkit-audit-prompts.md +216 -0
- package/.bkit/core/docs/templates/bkit-audit-red-team.md +220 -0
- package/.bkit/core/docs/templates/bkit-audit-reliability.md +222 -0
- package/.bkit/core/docs/templates/bkit-audit-repo.md +224 -0
- package/.bkit/core/docs/templates/bkit-audit-security.md +274 -0
- package/.bkit/core/docs/templates/bkit-audit-slop.md +200 -0
- package/.bkit/core/docs/templates/bkit-audit-testing.md +270 -0
- package/.bkit/core/docs/templates/bkit-audit-usability.md +237 -0
- package/.bkit/core/docs/templates/bkit-plan.md +476 -0
- package/.bkit/core/engine/checks/after/auth.ts +247 -0
- package/.bkit/core/engine/checks/after/ci-yml.ts +739 -0
- package/.bkit/core/engine/checks/after/github.ts +424 -0
- package/.bkit/core/engine/checks/after/index.ts +556 -0
- package/.bkit/core/engine/checks/after/managed.ts +217 -0
- package/.bkit/core/engine/checks/after/tools.ts +427 -0
- package/.bkit/core/engine/checks/after/vercel.ts +101 -0
- package/.bkit/core/engine/checks/before/context-fetch.ts +429 -0
- package/.bkit/core/engine/checks/before/env.ts +201 -0
- package/.bkit/core/engine/checks/before/files.ts +202 -0
- package/.bkit/core/engine/checks/before/index.ts +206 -0
- package/.bkit/core/engine/checks/before/mcp.ts +127 -0
- package/.bkit/core/engine/checks/before/repo.ts +77 -0
- package/.bkit/core/engine/checks/before/version.ts +67 -0
- package/.bkit/core/engine/checks/status-holes.ts +479 -0
- package/.bkit/core/engine/cli.ts +871 -0
- package/.bkit/core/engine/commands/analysis.ts +550 -0
- package/.bkit/core/engine/commands/ci/ci.ts +483 -0
- package/.bkit/core/engine/commands/comply.ts +415 -0
- package/.bkit/core/engine/commands/harvest.ts +459 -0
- package/.bkit/core/engine/commands/install/check.ts +70 -0
- package/.bkit/core/engine/commands/install/doctor.ts +247 -0
- package/.bkit/core/engine/commands/install/install.ts +528 -0
- package/.bkit/core/engine/commands/install/uninstall.ts +972 -0
- package/.bkit/core/engine/commands/install/upgrade.ts +1026 -0
- package/.bkit/core/engine/commands/launch.ts +139 -0
- package/.bkit/core/engine/commands/lib.ts +494 -0
- package/.bkit/core/engine/commands/registry.ts +53 -0
- package/.bkit/core/engine/commands/setup/setup.ts +184 -0
- package/.bkit/core/engine/commands/telemetry.ts +32 -0
- package/.bkit/core/engine/commands/workflow/branches.ts +1514 -0
- package/.bkit/core/engine/commands/workflow/context.ts +961 -0
- package/.bkit/core/engine/commands/workflow/counters.ts +268 -0
- package/.bkit/core/engine/commands/workflow/fids.ts +243 -0
- package/.bkit/core/engine/commands/workflow/issues.ts +675 -0
- package/.bkit/core/engine/commands/workflow/ledgers.ts +575 -0
- package/.bkit/core/engine/commands/workflow/locks.ts +478 -0
- package/.bkit/core/engine/commands/workflow/prs.ts +1087 -0
- package/.bkit/core/engine/commands/workflow/repo.ts +220 -0
- package/.bkit/core/engine/commands/workflow/roadmap.ts +576 -0
- package/.bkit/core/engine/commands/workflow/runs.ts +2140 -0
- package/.bkit/core/engine/commands/workflow/runtime.ts +300 -0
- package/.bkit/core/engine/commands/workflow/skills.ts +118 -0
- package/.bkit/core/engine/commands/workflow/status.ts +455 -0
- package/.bkit/core/engine/commands/workflow/steps.ts +1300 -0
- package/.bkit/core/engine/commands/workflow/tests.ts +161 -0
- package/.bkit/core/engine/commands/workflow/workflows.ts +1573 -0
- package/.bkit/core/engine/commands/workflow/workstreams.ts +164 -0
- package/.bkit/core/engine/commands/workflow/worktrees.ts +534 -0
- package/.bkit/core/engine/install/cloud-env.ts +925 -0
- package/.bkit/core/engine/install/managed-block.ts +212 -0
- package/.bkit/core/engine/install/manifest.ts +448 -0
- package/.bkit/core/engine/install/modules/claude.ts +362 -0
- package/.bkit/core/engine/install/modules/cloud.ts +174 -0
- package/.bkit/core/engine/install/modules/codex.ts +219 -0
- package/.bkit/core/engine/install/modules/core.ts +600 -0
- package/.bkit/core/engine/install/modules/cursor.ts +231 -0
- package/.bkit/core/engine/install/modules/index.ts +242 -0
- package/.bkit/core/engine/install/modules/opencode.ts +573 -0
- package/.bkit/core/engine/install/placeholders.ts +108 -0
- package/.bkit/core/engine/install/template-copies.ts +119 -0
- package/.bkit/core/engine/install/version-file.ts +284 -0
- package/.bkit/core/engine/install/write.ts +467 -0
- package/.bkit/core/engine/ledgers/clamp-log.ts +32 -0
- package/.bkit/core/engine/ledgers/status.ts +213 -0
- package/.bkit/core/engine/ledgers/telemetry.ts +1143 -0
- package/.bkit/core/engine/render/hosts.ts +372 -0
- package/.bkit/core/engine/render/models.ts +323 -0
- package/.bkit/core/engine/render/parts.ts +38 -0
- package/.bkit/core/engine/render/trackers.ts +170 -0
- package/.bkit/core/engine/shared/egress.ts +345 -0
- package/.bkit/core/engine/shared/json.ts +16 -0
- package/.bkit/core/engine/shared/log-prefix.ts +9 -0
- package/.bkit/core/engine/shared/package-json.ts +29 -0
- package/.bkit/core/engine/shared/package-manager.ts +38 -0
- package/.bkit/core/engine/shared/package-roots.ts +163 -0
- package/.bkit/core/engine/shared/protected-paths.ts +164 -0
- package/.bkit/core/engine/shared/settings.ts +72 -0
- package/.bkit/core/engine/shared/timeouts.ts +20 -0
- package/.bkit/core/engine/tools/wording.ts +748 -0
- package/.bkit/core/hooks/gateguard-edit-payload.js +18 -0
- package/.bkit/core/hooks/gateguard-engine.js +193 -0
- package/.bkit/core/hooks/guardrails-shell.js +154 -0
- package/.bkit/core/hooks/guardrails-tiers.js +68 -0
- package/.bkit/core/hooks/preflight-linear.sh +73 -0
- package/.bkit/core/prompts/bkit-audit-generate.md +66 -0
- package/.bkit/core/prompts/bkit-build-challenge-1.md +79 -0
- package/.bkit/core/prompts/bkit-build-challenge-2.md +81 -0
- package/.bkit/core/prompts/bkit-build-challenge-reconcile.md +68 -0
- package/.bkit/core/prompts/bkit-build-challenge-remediate.md +70 -0
- package/.bkit/core/prompts/bkit-build-challenge-tests.md +73 -0
- package/.bkit/core/prompts/bkit-build-install-skills.md +67 -0
- package/.bkit/core/prompts/bkit-build-plan-current.md +75 -0
- package/.bkit/core/prompts/bkit-build-plan-execute.md +72 -0
- package/.bkit/core/prompts/bkit-build-plan-gaps-remediate.md +73 -0
- package/.bkit/core/prompts/bkit-build-plan-verify.md +88 -0
- package/.bkit/core/prompts/bkit-build-summary.md +93 -0
- package/.bkit/core/prompts/bkit-debug-abort-handover.md +90 -0
- package/.bkit/core/prompts/bkit-debug-failure-diagnose.md +151 -0
- package/.bkit/core/prompts/bkit-debug-failure-remediate.md +78 -0
- package/.bkit/core/prompts/bkit-debug-failure-soak.md +73 -0
- package/.bkit/core/prompts/bkit-debug-summary.md +95 -0
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-1.md +72 -0
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-2.md +72 -0
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-3.md +75 -0
- package/.bkit/core/prompts/bkit-design-generate.md +110 -0
- package/.bkit/core/prompts/bkit-design-organise.md +85 -0
- package/.bkit/core/prompts/bkit-design-review-1.md +121 -0
- package/.bkit/core/prompts/bkit-design-review-2.md +111 -0
- package/.bkit/core/prompts/bkit-design-spike.md +97 -0
- package/.bkit/core/prompts/bkit-design-summary.md +106 -0
- package/.bkit/core/prompts/bkit-design-update.md +66 -0
- package/.bkit/core/prompts/bkit-plan-complexity-check.md +66 -0
- package/.bkit/core/prompts/bkit-plan-complexity-split.md +87 -0
- package/.bkit/core/prompts/bkit-plan-generate.md +74 -0
- package/.bkit/core/prompts/bkit-plan-review-1.md +90 -0
- package/.bkit/core/prompts/bkit-plan-review-2.md +80 -0
- package/.bkit/core/prompts/bkit-plan-review-3.md +92 -0
- package/.bkit/core/prompts/bkit-plan-scope-check-1.md +84 -0
- package/.bkit/core/prompts/bkit-plan-scope-check-2.md +84 -0
- package/.bkit/core/prompts/bkit-plan-summary.md +106 -0
- package/.bkit/core/prompts/bkit-plan-update.md +68 -0
- package/.bkit/core/prompts/bkit-ship-conflict-resolve.md +90 -0
- package/.bkit/core/prompts/bkit-ship-deferred-sweep.md +94 -0
- package/.bkit/core/prompts/bkit-ship-summary.md +77 -0
- package/.bkit/core/prompts/bkit-ship-update-docs.md +71 -0
- package/.bkit/core/prompts/bkit-utility-compress-markdown.md +91 -0
- package/.bkit/core/prompts/bkit-utility-update-decisions.md +75 -0
- package/.bkit/core/prompts/bkit-utility-update-deferrals.md +76 -0
- package/.bkit/core/prompts/bkit-utility-update-documentation.md +61 -0
- package/.bkit/core/prompts/bkit-utility-update-failures.md +76 -0
- package/.bkit/core/prompts/bkit-utility-update-knowledge.md +75 -0
- package/.bkit/core/prompts/bkit-utility-update-roadmap.md +82 -0
- package/.bkit/core/workflows/bkit-auto.md +121 -0
- package/.bkit/core/workflows/bkit-build.md +802 -0
- package/.bkit/core/workflows/bkit-debug.md +642 -0
- package/.bkit/core/workflows/bkit-design.md +495 -0
- package/.bkit/core/workflows/bkit-plan.md +510 -0
- package/.bkit/core/workflows/bkit-ship.md +650 -0
- package/.bkit/shared/.bkit/.env.example +108 -0
- package/.bkit/shared/.claude/bkit-cloud.md +117 -0
- package/.bkit/shared/.claude/settings.json +88 -0
- package/.bkit/shared/.codex/hooks.json +26 -0
- package/.bkit/shared/.cursor/bkit-cloud.md +84 -0
- package/.bkit/shared/.cursor/hooks.json +26 -0
- package/.bkit/shared/.cursor/mcp.json +15 -0
- package/.bkit/shared/.cursor/rules/bkit-rules.mdc +12 -0
- package/.bkit/shared/.gitattributes +37 -0
- package/.bkit/shared/.mcp.json +16 -0
- package/.bkit/shared/.opencode/opencode.json +62 -0
- package/.bkit/shared/CLAUDE.md +11 -0
- package/.bkit/shared/LICENSE.md +22 -0
- package/.bkit/shared/docs/architecture.md +19 -0
- package/.bkit/shared/docs/data-schema.md +19 -0
- package/.bkit/shared/docs/deployments.md +438 -0
- package/.bkit/shared/docs/design.md +39 -0
- package/.bkit/shared/docs/noise.md +19 -0
- package/.bkit/shared/docs/observability.md +25 -0
- package/.bkit/shared/docs/security.md +42 -0
- package/.bkit/shared/docs/setup.md +30 -0
- package/.bkit/shared/docs/technology.md +18 -0
- package/.bkit/shared/docs/testing.md +413 -0
- package/.bkit/shared/gitignore +92 -0
- package/.bkit/templates/.claude/hooks/bkit-cloud-bootstrap.sh +192 -0
- package/.bkit/templates/.cursor/Dockerfile +68 -0
- package/.bkit/templates/.cursor/environment.json +6 -0
- package/.bkit/templates/.cursor/settings.json +11 -0
- package/.bkit/templates/.envrc +7 -0
- package/.bkit/templates/.github/dependabot.yml +52 -0
- package/.bkit/templates/.github/renovate.json5 +239 -0
- package/.bkit/templates/.github/workflows/bkit-ci.yml +1082 -0
- package/.bkit/templates/.github/workflows/bkit-cloud.yml +566 -0
- package/.bkit/templates/.github/workflows/bkit-renovate.yml +107 -0
- package/.bkit/templates/.graphifyignore +108 -0
- package/.bkit/templates/.husky/pre-commit +16 -0
- package/.bkit/templates/.husky/pre-push +91 -0
- package/.bkit/templates/.lintstagedrc.json +3 -0
- package/.bkit/templates/.prettierignore +41 -0
- package/.bkit/templates/.serena/project.yml +243 -0
- package/.bkit/templates/.vale/styles/House/Filler.yml +11 -0
- package/.bkit/templates/.vale/styles/House/Hedging.yml +12 -0
- package/.bkit/templates/.vale/styles/House/LLMSlop.yml +13 -0
- package/.bkit/templates/.vale/styles/House/Verbose.yml +12 -0
- package/.bkit/templates/.vale.ini +67 -0
- package/.bkit/templates/LICENSE.md +22 -0
- package/.bkit/templates/context/bkit-cloudrun.md +84 -0
- package/.bkit/templates/context/bkit-expo.md +186 -0
- package/.bkit/templates/context/bkit-github.md +79 -0
- package/.bkit/templates/context/bkit-inngest.md +45 -0
- package/.bkit/templates/context/bkit-maestro.md +76 -0
- package/.bkit/templates/context/bkit-playwright.md +62 -0
- package/.bkit/templates/context/bkit-resend.md +36 -0
- package/.bkit/templates/context/bkit-sentry.md +65 -0
- package/.bkit/templates/context/bkit-serena.md +33 -0
- package/.bkit/templates/context/bkit-stripe.md +36 -0
- package/.bkit/templates/context/bkit-supabase.md +59 -0
- package/.bkit/templates/context/bkit-tavily.md +49 -0
- package/.bkit/templates/context/bkit-vercel.md +64 -0
- package/.bkit/templates/docs/capabilities.md +72 -0
- package/.bkit/templates/scripts/ci/accepted-divergences.json +21 -0
- package/.bkit/templates/scripts/ci/check-accepted-divergences.mjs +152 -0
- package/.bkit/templates/scripts/ci/check-accepted-divergences.test.mjs +130 -0
- package/.bkit/templates/scripts/ci/lanes/resolve-push-base.mjs +98 -0
- package/.bkit/templates/scripts/ci/lanes/resolve-push-base.test.mjs +86 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-drift-rules.json +23 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-drift.py +208 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-eager-rules.json +35 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-eager.py +236 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-external-rules.json +17 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-imports.py +290 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-pre-push.sh +19 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-repair.py +120 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-surface.py +232 -0
- package/.bkit/templates/scripts/graphify/bkit-graphify-graphml.py +36 -0
- package/.bkit/templates/scripts/graphify/bkit-graphify-rollup.py +927 -0
- package/.bkit/templates/scripts/graphify/bkit-graphify.sh +351 -0
- package/.bkit/templates/scripts/launchd/ai.bkit.launchd.plist +26 -0
- package/.bkit/templates/scripts/launchd/bkit-launchd-env.sh +53 -0
- package/.bkit/templates/scripts/launchd/launchd.env.example +13 -0
- package/.bkit/templates/scripts/prettier/bkit-insert-ignore.mjs +275 -0
- package/.bkit/templates/scripts/secrets/bkit-secrets.config.mjs +66 -0
- package/.bkit/templates/scripts/secrets/bkit-secrets.mjs +785 -0
- package/.bkit/templates/scripts/serena/bkit-serena-mcp.sh +30 -0
- package/.bkit/templates/scripts/serena/bkit-serena.mcp.json +9 -0
- package/.bkit/templates/scripts/slop/bkit-slop-type-suppression.mjs +286 -0
- package/.bkit/templates/slop-scan.config.json +120 -0
- package/CHANGELOG.md +1486 -0
- package/LICENSE.md +161 -0
- package/README.md +185 -2
- package/dist/checks/after/auth.js +232 -0
- package/dist/checks/after/ci-yml.js +718 -0
- package/dist/checks/after/github.js +400 -0
- package/dist/checks/after/index.js +447 -0
- package/dist/checks/after/managed.js +187 -0
- package/dist/checks/after/tools.js +351 -0
- package/dist/checks/after/vercel.js +102 -0
- package/dist/checks/before/context-fetch.js +426 -0
- package/dist/checks/before/env.js +173 -0
- package/dist/checks/before/files.js +185 -0
- package/dist/checks/before/index.js +162 -0
- package/dist/checks/before/mcp.js +111 -0
- package/dist/checks/before/repo.js +71 -0
- package/dist/checks/before/version.js +60 -0
- package/dist/checks/status-holes.js +393 -0
- package/dist/cli.js +692 -0
- package/dist/commands/analysis.js +325 -0
- package/dist/commands/ci/ci.js +438 -0
- package/dist/commands/comply.js +310 -0
- package/dist/commands/harvest.js +354 -0
- package/dist/commands/install/check.js +61 -0
- package/dist/commands/install/doctor.js +207 -0
- package/dist/commands/install/install.js +461 -0
- package/dist/commands/install/uninstall.js +815 -0
- package/dist/commands/install/upgrade.js +771 -0
- package/dist/commands/launch.js +118 -0
- package/dist/commands/lib.js +362 -0
- package/dist/commands/registry.js +50 -0
- package/dist/commands/setup/setup.js +158 -0
- package/dist/commands/telemetry.js +29 -0
- package/dist/commands/workflow/branches.js +1265 -0
- package/dist/commands/workflow/context.js +846 -0
- package/dist/commands/workflow/counters.js +227 -0
- package/dist/commands/workflow/fids.js +224 -0
- package/dist/commands/workflow/issues.js +585 -0
- package/dist/commands/workflow/ledgers.js +472 -0
- package/dist/commands/workflow/locks.js +364 -0
- package/dist/commands/workflow/prs.js +904 -0
- package/dist/commands/workflow/repo.js +199 -0
- package/dist/commands/workflow/roadmap.js +495 -0
- package/dist/commands/workflow/runs.js +1717 -0
- package/dist/commands/workflow/runtime.js +257 -0
- package/dist/commands/workflow/skills.js +110 -0
- package/dist/commands/workflow/status.js +392 -0
- package/dist/commands/workflow/steps.js +1093 -0
- package/dist/commands/workflow/tests.js +144 -0
- package/dist/commands/workflow/workflows.js +1342 -0
- package/dist/commands/workflow/workstreams.js +141 -0
- package/dist/commands/workflow/worktrees.js +473 -0
- package/dist/install/cloud-env.js +819 -0
- package/dist/install/managed-block.js +182 -0
- package/dist/install/manifest.js +376 -0
- package/dist/install/modules/claude.js +288 -0
- package/dist/install/modules/cloud.js +152 -0
- package/dist/install/modules/codex.js +193 -0
- package/dist/install/modules/core.js +511 -0
- package/dist/install/modules/cursor.js +186 -0
- package/dist/install/modules/index.js +152 -0
- package/dist/install/modules/opencode.js +504 -0
- package/dist/install/placeholders.js +87 -0
- package/dist/install/template-copies.js +106 -0
- package/dist/install/version-file.js +204 -0
- package/dist/install/write.js +342 -0
- package/dist/ledgers/clamp-log.js +27 -0
- package/dist/ledgers/status.js +156 -0
- package/dist/ledgers/telemetry.js +637 -0
- package/dist/render/hosts.js +339 -0
- package/dist/render/models.js +288 -0
- package/dist/render/parts.js +33 -0
- package/dist/render/trackers.js +135 -0
- package/dist/shared/egress.js +299 -0
- package/dist/shared/json.js +16 -0
- package/dist/shared/log-prefix.js +7 -0
- package/dist/shared/package-json.js +22 -0
- package/dist/shared/package-manager.js +32 -0
- package/dist/shared/package-roots.js +145 -0
- package/dist/shared/protected-paths.js +153 -0
- package/dist/shared/settings.js +44 -0
- package/dist/shared/timeouts.js +19 -0
- package/dist/tools/wording.js +680 -0
- package/package.json +101 -4
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
// checks/before/env.ts — local env: `.bkit/.env` missing or with blank keys, direnv missing or
|
|
2
|
+
// not allowed.
|
|
3
|
+
|
|
4
|
+
import * as fs from "node:fs";
|
|
5
|
+
import * as path from "node:path";
|
|
6
|
+
import { spawnSync } from "node:child_process";
|
|
7
|
+
import type { IssueTracker } from "../../install/manifest.js";
|
|
8
|
+
import type { PreflightFinding } from "./index.js";
|
|
9
|
+
|
|
10
|
+
// ---------------------------------------------------------------------------
|
|
11
|
+
// [mcp-env] advisories — direnv + .bkit/.env setup (BAR-260)
|
|
12
|
+
// ---------------------------------------------------------------------------
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Advisory: .bkit/.env.example exists but .bkit/.env does not.
|
|
16
|
+
* Consumer ran `bkit install` (which seeds .env.example) but has not yet
|
|
17
|
+
* copied it to .bkit/.env and filled in their tokens.
|
|
18
|
+
*/
|
|
19
|
+
// `tracker` controls whether `BKIT_LINEAR_API_KEY` appears in the token prose (Linear
|
|
20
|
+
// tracker only). Defaults to `linear` (the superset: every token); the real Phase-3
|
|
21
|
+
// caller passes the consumer's resolved `bkit.issueTracker`.
|
|
22
|
+
export function detectMissingDotenv(
|
|
23
|
+
cwd: string,
|
|
24
|
+
tracker: IssueTracker = "linear",
|
|
25
|
+
): PreflightFinding | null {
|
|
26
|
+
const examplePath = path.join(cwd, ".bkit", ".env.example");
|
|
27
|
+
const envPath = path.join(cwd, ".bkit", ".env");
|
|
28
|
+
if (!fs.existsSync(examplePath)) return null;
|
|
29
|
+
if (fs.existsSync(envPath)) return null;
|
|
30
|
+
const tokens =
|
|
31
|
+
tracker === "linear"
|
|
32
|
+
? "BKIT_GH_TOKEN, BKIT_GH_TOKEN_INSTALL, BKIT_LINEAR_API_KEY"
|
|
33
|
+
: "BKIT_GH_TOKEN, BKIT_GH_TOKEN_INSTALL";
|
|
34
|
+
return {
|
|
35
|
+
id: "mcp-env-missing-dotenv",
|
|
36
|
+
severity: "advisory",
|
|
37
|
+
detect: `.bkit/.env.example exists but .bkit/.env does not. MCP servers and agent tooling will not have access to ${tokens}.`,
|
|
38
|
+
action: `[mcp-env] Copy .bkit/.env.example to .bkit/.env and fill in your tokens (${tokens}). Then run \`direnv allow\` to auto-export them into your shell. .bkit/.env is gitignored and safe to commit-skip.`,
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Advisory: .bkit/.env exists but one or more required keys are blank or absent.
|
|
44
|
+
* Returns one finding per missing/blank key.
|
|
45
|
+
*/
|
|
46
|
+
export function detectBlankDotenvKeys(
|
|
47
|
+
cwd: string,
|
|
48
|
+
tracker: IssueTracker = "linear",
|
|
49
|
+
): PreflightFinding[] {
|
|
50
|
+
const envPath = path.join(cwd, ".bkit", ".env");
|
|
51
|
+
if (!fs.existsSync(envPath)) return [];
|
|
52
|
+
|
|
53
|
+
const content = fs.readFileSync(envPath, "utf-8");
|
|
54
|
+
const lines = content.split("\n");
|
|
55
|
+
|
|
56
|
+
// Build a map of key → value from the .env file (ignore comments and blank lines)
|
|
57
|
+
const kvMap = new Map<string, string>();
|
|
58
|
+
for (const line of lines) {
|
|
59
|
+
const trimmed = line.trim();
|
|
60
|
+
if (!trimmed || trimmed.startsWith("#")) continue;
|
|
61
|
+
const eqIdx = trimmed.indexOf("=");
|
|
62
|
+
if (eqIdx === -1) continue;
|
|
63
|
+
const key = trimmed.slice(0, eqIdx).trim();
|
|
64
|
+
const value = trimmed.slice(eqIdx + 1).trim();
|
|
65
|
+
kvMap.set(key, value);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const REQUIRED_KEYS: Array<{ key: string; description: string }> = [
|
|
69
|
+
{
|
|
70
|
+
key: "BKIT_GH_TOKEN",
|
|
71
|
+
description:
|
|
72
|
+
"fine-grained PAT for the GitHub MCP server (Contents, Pull requests, Issues, Actions, Workflows, Metadata — read/write)",
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
key: "BKIT_GH_TOKEN_INSTALL",
|
|
76
|
+
description:
|
|
77
|
+
"classic PAT with read:packages scope for authenticating to the GitHub Packages npm registry (@cbartens/* packages)",
|
|
78
|
+
},
|
|
79
|
+
// BKIT_LINEAR_API_KEY is required only under the Linear tracker.
|
|
80
|
+
...(tracker === "linear"
|
|
81
|
+
? [
|
|
82
|
+
{
|
|
83
|
+
key: "BKIT_LINEAR_API_KEY",
|
|
84
|
+
description:
|
|
85
|
+
"Linear personal API key for the Linear MCP server and the Linear preflight hook (generate at https://linear.app/settings/api)",
|
|
86
|
+
},
|
|
87
|
+
]
|
|
88
|
+
: []),
|
|
89
|
+
];
|
|
90
|
+
|
|
91
|
+
const findings: PreflightFinding[] = [];
|
|
92
|
+
for (const { key, description } of REQUIRED_KEYS) {
|
|
93
|
+
const value = kvMap.get(key);
|
|
94
|
+
if (value !== undefined && value !== "") continue;
|
|
95
|
+
const reason =
|
|
96
|
+
value === undefined
|
|
97
|
+
? `${key} is absent from .bkit/.env`
|
|
98
|
+
: `${key} is set but has an empty value in .bkit/.env`;
|
|
99
|
+
findings.push({
|
|
100
|
+
id: `mcp-env-blank-key-${key.toLowerCase()}`,
|
|
101
|
+
severity: "advisory",
|
|
102
|
+
detect: `${reason}. The associated service will not authenticate.`,
|
|
103
|
+
action: `[mcp-env] Set ${key} in .bkit/.env — ${description}. After editing, run \`direnv allow\` (or re-enter the directory) to reload the env.`,
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
return findings;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Returns true when running in a cloud/CI environment where direnv is not
|
|
111
|
+
* applicable (agent reads env vars from the platform dashboard instead).
|
|
112
|
+
*/
|
|
113
|
+
export function isCloudOrCi(): boolean {
|
|
114
|
+
return !!(process.env.CI || process.env.CLAUDE_CODE_REMOTE || process.env.CURSOR_REMOTE_AGENT);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* Advisory: direnv is not installed.
|
|
119
|
+
* Short-circuits in CI / cloud environments where direnv is irrelevant.
|
|
120
|
+
*/
|
|
121
|
+
export function detectDirenvMissing(
|
|
122
|
+
cwd: string,
|
|
123
|
+
tracker: IssueTracker = "linear",
|
|
124
|
+
): PreflightFinding | null {
|
|
125
|
+
if (isCloudOrCi()) return null;
|
|
126
|
+
// Only meaningful when .envrc exists (the consumer's copy of bkit's template)
|
|
127
|
+
const envrcPath = path.join(cwd, ".envrc");
|
|
128
|
+
if (!fs.existsSync(envrcPath)) return null;
|
|
129
|
+
|
|
130
|
+
const result = spawnSync("which", ["direnv"], { encoding: "utf-8" });
|
|
131
|
+
if (result.status === 0 && result.stdout.trim()) return null;
|
|
132
|
+
// BKIT_LINEAR_API_KEY is required only under the Linear tracker.
|
|
133
|
+
const editKeys =
|
|
134
|
+
tracker === "linear"
|
|
135
|
+
? "BKIT_GH_TOKEN_INSTALL, BKIT_GH_TOKEN, BKIT_LINEAR_API_KEY"
|
|
136
|
+
: "BKIT_GH_TOKEN_INSTALL, BKIT_GH_TOKEN";
|
|
137
|
+
const exportKeys =
|
|
138
|
+
tracker === "linear"
|
|
139
|
+
? "BKIT_GH_TOKEN_INSTALL / BKIT_GH_TOKEN / BKIT_LINEAR_API_KEY"
|
|
140
|
+
: "BKIT_GH_TOKEN_INSTALL / BKIT_GH_TOKEN";
|
|
141
|
+
return {
|
|
142
|
+
id: "mcp-env-direnv-missing",
|
|
143
|
+
severity: "advisory",
|
|
144
|
+
detect:
|
|
145
|
+
".envrc exists but direnv is not installed. .bkit/.env will not be auto-loaded into your shell.",
|
|
146
|
+
action:
|
|
147
|
+
"[mcp-env] direnv auto-loads .bkit/.env into your shell on cd, so tokens stay scoped to the repo. Set it up:\n\n" +
|
|
148
|
+
" # 1. One-time per machine — install direnv\n" +
|
|
149
|
+
" brew install direnv # macOS\n" +
|
|
150
|
+
" # Linux / other: https://direnv.net/docs/installation.html\n\n" +
|
|
151
|
+
" # 2. One-time per machine — add the shell hook, then reload\n" +
|
|
152
|
+
" echo 'eval \"$(direnv hook zsh)\"' >> ~/.zshrc && source ~/.zshrc\n" +
|
|
153
|
+
" # bash: echo 'eval \"$(direnv hook bash)\"' >> ~/.bashrc && source ~/.bashrc\n\n" +
|
|
154
|
+
" # 3. One-time per repo — copy the example, fill in tokens, allow\n" +
|
|
155
|
+
" cp .bkit/.env.example .bkit/.env # if not already done\n" +
|
|
156
|
+
` # edit .bkit/.env: set ${editKeys}\n` +
|
|
157
|
+
" direnv allow\n\n" +
|
|
158
|
+
`After step 3, restart Claude Code / Cursor sessions in this repo so the new env reaches their MCP servers. Alternative if you do not want direnv: export ${exportKeys} in ~/.zshrc or ~/.bashrc directly — works but leaks tokens into every shell on this machine.`,
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Advisory: direnv is installed but the .envrc is blocked (not allowed).
|
|
164
|
+
* Short-circuits in CI / cloud environments.
|
|
165
|
+
*/
|
|
166
|
+
export function detectDirenvNotAllowed(
|
|
167
|
+
cwd: string,
|
|
168
|
+
tracker: IssueTracker = "linear",
|
|
169
|
+
): PreflightFinding | null {
|
|
170
|
+
if (isCloudOrCi()) return null;
|
|
171
|
+
// Only meaningful when .envrc exists
|
|
172
|
+
const envrcPath = path.join(cwd, ".envrc");
|
|
173
|
+
if (!fs.existsSync(envrcPath)) return null;
|
|
174
|
+
|
|
175
|
+
// Check direnv is installed first
|
|
176
|
+
const whichResult = spawnSync("which", ["direnv"], { encoding: "utf-8" });
|
|
177
|
+
if (whichResult.status !== 0 || !whichResult.stdout.trim()) return null;
|
|
178
|
+
|
|
179
|
+
// Run `direnv status` and check whether the .envrc is allowed
|
|
180
|
+
const statusResult = spawnSync("direnv", ["status"], {
|
|
181
|
+
cwd,
|
|
182
|
+
encoding: "utf-8",
|
|
183
|
+
timeout: 5000,
|
|
184
|
+
});
|
|
185
|
+
const statusOutput = (statusResult.stdout ?? "") + (statusResult.stderr ?? "");
|
|
186
|
+
// direnv status reports "Found RC allowed false" or "Found RC path ... Blocked" when not allowed
|
|
187
|
+
if (
|
|
188
|
+
/Found RC\s+allowed\s+false/i.test(statusOutput) ||
|
|
189
|
+
/state:\s*blocked/i.test(statusOutput) ||
|
|
190
|
+
/not allowed/i.test(statusOutput)
|
|
191
|
+
) {
|
|
192
|
+
return {
|
|
193
|
+
id: "mcp-env-direnv-not-allowed",
|
|
194
|
+
severity: "advisory",
|
|
195
|
+
detect:
|
|
196
|
+
"direnv is installed but the .envrc in this repo is blocked. .bkit/.env is not being auto-loaded.",
|
|
197
|
+
action: `[mcp-env] Run \`direnv allow\` in this repo to trust the .envrc and enable auto-load of .bkit/.env. direnv will then export ${tracker === "linear" ? "BKIT_GH_TOKEN, BKIT_GH_TOKEN_INSTALL, and BKIT_LINEAR_API_KEY" : "BKIT_GH_TOKEN and BKIT_GH_TOKEN_INSTALL"} into your shell whenever you cd into the repo.`,
|
|
198
|
+
};
|
|
199
|
+
}
|
|
200
|
+
return null;
|
|
201
|
+
}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
// checks/before/files.ts — consumer files bkit shares: `.gitignore` block duplicates, a hostile
|
|
2
|
+
// Playwright reporter, managed-text and managed-JSON drift.
|
|
3
|
+
|
|
4
|
+
import * as fs from "node:fs";
|
|
5
|
+
import * as path from "node:path";
|
|
6
|
+
import { deepContains, type JsonValue } from "../../install/write.js";
|
|
7
|
+
import { extractManagedBlock, stripManagedBlock } from "../../install/managed-block.js";
|
|
8
|
+
import { readTemplate } from "../../render/parts.js";
|
|
9
|
+
import { findTemplateSource, getPkgRoot } from "../../shared/package-roots.js";
|
|
10
|
+
import { parseJson } from "../../shared/json.js";
|
|
11
|
+
import type { PreflightFinding } from "./index.js";
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Strip out content inside bkit-managed block markers (HTML and slash style).
|
|
15
|
+
* Used by detectors that need to inspect only consumer-owned content.
|
|
16
|
+
*
|
|
17
|
+
* Uses line-anchored marker detection (via stripManagedBlock from install/managed-block.ts; KN-8).
|
|
18
|
+
* Applies both marker styles sequentially: `<!-- bkit:start -->` and `// bkit:start`.
|
|
19
|
+
*/
|
|
20
|
+
export function stripBkitBlock(content: string): string {
|
|
21
|
+
return stripManagedBlock(stripManagedBlock(content, "html-comment"), "slash-comment");
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Detect when a line bkit's .gitignore managed block contributes is already
|
|
26
|
+
* present elsewhere in the file. Benign (git ignores duplicates) but worth
|
|
27
|
+
* surfacing — the bkit-managed block should be the single source of truth.
|
|
28
|
+
*/
|
|
29
|
+
const BKIT_GITIGNORE_LINES = [
|
|
30
|
+
".worktrees/",
|
|
31
|
+
"docs/plans/*/logs/**/raw/",
|
|
32
|
+
"docs/plans/*/logs/**/.lock",
|
|
33
|
+
".husky/_",
|
|
34
|
+
".bkit/advisories.md",
|
|
35
|
+
".bkit/.env",
|
|
36
|
+
];
|
|
37
|
+
|
|
38
|
+
export function detectGitignoreBlockDuplicates(cwd: string): PreflightFinding | null {
|
|
39
|
+
const gitignorePath = path.join(cwd, ".gitignore");
|
|
40
|
+
if (!fs.existsSync(gitignorePath)) return null;
|
|
41
|
+
const content = fs.readFileSync(gitignorePath, "utf-8");
|
|
42
|
+
|
|
43
|
+
const outsideBkit = stripBkitBlock(content);
|
|
44
|
+
const outsideLines = outsideBkit
|
|
45
|
+
.split("\n")
|
|
46
|
+
.map((l) => l.trim())
|
|
47
|
+
.filter(Boolean);
|
|
48
|
+
|
|
49
|
+
const dupes = BKIT_GITIGNORE_LINES.filter((bl) => outsideLines.includes(bl));
|
|
50
|
+
if (dupes.length === 0) return null;
|
|
51
|
+
|
|
52
|
+
return {
|
|
53
|
+
id: "gitignore-block-duplicates",
|
|
54
|
+
severity: "advisory",
|
|
55
|
+
detect: `.gitignore lists [${dupes.join(", ")}] both inside the bkit-managed block and outside it (consumer-owned region).`,
|
|
56
|
+
action: `Git ignores duplicates harmlessly, but cleaner to remove the consumer-side line(s) so the bkit-managed block is the single source of truth. Affected lines: ${dupes.join(", ")}.`,
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// ---------------------------------------------------------------------------
|
|
61
|
+
// Phase 1 JSON advisories / blockers (BAR-167)
|
|
62
|
+
// ---------------------------------------------------------------------------
|
|
63
|
+
|
|
64
|
+
// ---------------------------------------------------------------------------
|
|
65
|
+
// [verbose ci] marker advisories (BAR-224)
|
|
66
|
+
// ---------------------------------------------------------------------------
|
|
67
|
+
|
|
68
|
+
// No presence detector for the bkit-ci.yml verbose-CI `env:`: bkit-ci.yml is the
|
|
69
|
+
// consumer's copy of a template, so bkit never checks it.
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Advisory: consumer's Playwright invocation passes `--reporter=line`, which
|
|
73
|
+
* overrides the configured reporter chain in `playwright.config.ts`. Under
|
|
74
|
+
* `[verbose ci]` with `--trace=on`, this writes trace artifacts that no reporter
|
|
75
|
+
* surfaces — pure cost (artifact upload + storage) with zero diagnostic payoff.
|
|
76
|
+
*
|
|
77
|
+
* "Hostile" gap per the BAR-224 signal-vs-noise classification. Reads the consumer's
|
|
78
|
+
* own bkit-ci.yml, active lines only: YAML comment lines are dropped first, so a commented
|
|
79
|
+
* template stub or a commented-out example never fires.
|
|
80
|
+
*/
|
|
81
|
+
export function detectPlaywrightReporterHostile(cwd: string): PreflightFinding | null {
|
|
82
|
+
const ciPath = path.join(cwd, ".github", "workflows", "bkit-ci.yml");
|
|
83
|
+
if (!fs.existsSync(ciPath)) return null;
|
|
84
|
+
const content = fs.readFileSync(ciPath, "utf-8");
|
|
85
|
+
// Filter out YAML comment lines (those starting with optional whitespace + `#`) before
|
|
86
|
+
// matching: bkit-shipped commented stubs and commented-out consumer examples never fire.
|
|
87
|
+
// Not `stripBkitBlock`: its strict line-anchored marker detection misses indented YAML
|
|
88
|
+
// markers.
|
|
89
|
+
const activeContent = content
|
|
90
|
+
.split("\n")
|
|
91
|
+
.filter((line) => !/^\s*#/.test(line))
|
|
92
|
+
.join("\n");
|
|
93
|
+
// Match a literal `playwright test` invocation followed (anywhere) by `--reporter=line`.
|
|
94
|
+
// Both substrings must appear in active (non-comment) content. Heuristic but conservative.
|
|
95
|
+
if (!/playwright\s+test/.test(activeContent)) return null;
|
|
96
|
+
if (!/--reporter[= ]line\b/.test(activeContent)) return null;
|
|
97
|
+
return {
|
|
98
|
+
id: "playwright-reporter-line-override-hostile",
|
|
99
|
+
severity: "advisory",
|
|
100
|
+
detect:
|
|
101
|
+
".github/workflows/bkit-ci.yml has a `playwright test` invocation that passes `--reporter=line`. Under `[verbose ci]` with `--trace=on`, trace artifacts are written but no reporter surfaces them — pure cost.",
|
|
102
|
+
action:
|
|
103
|
+
'Drop the `--reporter=line` flag so `playwright.config.ts`\'s configured reporter chain runs (typically `[list, html, github, json]`). Verbose-aware pattern: have `test:e2e` read `VERBOSE_CI` and append `--trace=on` to its own `playwright test` call (e.g. `TRACE=; [ "$VERBOSE_CI" = "1" ] && TRACE=--trace=on; playwright test $TRACE`), then run it plainly as `pnpm test:e2e` — do NOT pass `--trace=on` through a turbo / pnpm `-- --trace=on` passthrough, which appends to the script string and breaks any test:e2e ending in a bash construct (fi / done / esac). Never pass `--reporter`. Note that `--video` and `--screenshot` are NOT Playwright CLI flags (they\'re `use:` keys in playwright.config.ts); the trace.zip already captures snapshots / network / console / source. Default-mode output stays clean via the config\'s `list` reporter.',
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Advisory: detect when a JSON file is missing content the template owns.
|
|
109
|
+
* Runs deepContains(template, consumerFile) — fires when ok=false.
|
|
110
|
+
* Severity: advisory.
|
|
111
|
+
*/
|
|
112
|
+
export function detectTier2JsonDrift(cwd: string, relPath: string): PreflightFinding | null {
|
|
113
|
+
const absPath = path.join(cwd, relPath);
|
|
114
|
+
const templatePath = findTemplateSource(relPath);
|
|
115
|
+
if (!fs.existsSync(absPath) || templatePath === null || !fs.existsSync(templatePath)) return null;
|
|
116
|
+
// Malformed JSON on either side is handled elsewhere; a parse failure is not drift.
|
|
117
|
+
const consumerParsed = parseJson(fs.readFileSync(absPath, "utf-8"));
|
|
118
|
+
const templateParsed = parseJson(fs.readFileSync(templatePath, "utf-8"));
|
|
119
|
+
if (!consumerParsed.ok || !templateParsed.ok) return null;
|
|
120
|
+
const consumerDoc = consumerParsed.value as JsonValue;
|
|
121
|
+
const templateDoc = templateParsed.value as JsonValue;
|
|
122
|
+
const result = deepContains(templateDoc, consumerDoc);
|
|
123
|
+
if (result.ok) return null;
|
|
124
|
+
const details = [
|
|
125
|
+
...result.missing.map((p) => `missing: ${p}`),
|
|
126
|
+
...result.mismatched.map((p) => `mismatched: ${p}`),
|
|
127
|
+
]
|
|
128
|
+
.slice(0, 5)
|
|
129
|
+
.join("; ");
|
|
130
|
+
return {
|
|
131
|
+
id: `tier2-json-drift`,
|
|
132
|
+
severity: "advisory",
|
|
133
|
+
detect: `${relPath} is missing bkit-owned content: ${details}.`,
|
|
134
|
+
action:
|
|
135
|
+
"Run `pnpm bkit install` to restore the bkit-owned scope. Consumer-only keys outside the template tree will be preserved.",
|
|
136
|
+
};
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Advisory: detect when a markered-text file's bkit-managed block is missing a line the
|
|
141
|
+
* template's block carries.
|
|
142
|
+
*
|
|
143
|
+
* Fires when the consumer file and the template both carry a bkit-managed block and the
|
|
144
|
+
* consumer block lacks a required template line. A consumer file without markers is
|
|
145
|
+
* consumer-owned and never flagged. Content outside the markers is never compared.
|
|
146
|
+
*/
|
|
147
|
+
export function detectTier2TextDrift(cwd: string, relPath: string): PreflightFinding | null {
|
|
148
|
+
const absPath = path.join(cwd, relPath);
|
|
149
|
+
const templatePath = findTemplateSource(relPath);
|
|
150
|
+
if (!fs.existsSync(absPath) || templatePath === null || !fs.existsSync(templatePath)) return null;
|
|
151
|
+
|
|
152
|
+
const templateBlock = extractManagedBlock(readTemplate(templatePath));
|
|
153
|
+
if (templateBlock === null) return null;
|
|
154
|
+
const consumerBlock = extractManagedBlock(fs.readFileSync(absPath, "utf-8"));
|
|
155
|
+
if (consumerBlock === null) return null;
|
|
156
|
+
|
|
157
|
+
// Significant lines = load-bearing block content: non-blank, non-comment, trimmed (indentation
|
|
158
|
+
// is not semantic). Comment lines never trip drift.
|
|
159
|
+
const significantLines = (body: string): string[] =>
|
|
160
|
+
body
|
|
161
|
+
.split("\n")
|
|
162
|
+
.map((l) => l.trim())
|
|
163
|
+
.filter(
|
|
164
|
+
(t) => t !== "" && !t.startsWith("#") && !t.startsWith("//") && !t.startsWith("<!--"),
|
|
165
|
+
);
|
|
166
|
+
|
|
167
|
+
// A required line is real bkit content the consumer must retain. A bare YAML mapping key (`env:`)
|
|
168
|
+
// is structural scaffolding. A `{{TOKEN}}` line renders per-consumer, so it can never be matched
|
|
169
|
+
// literally. Neither counts as content for drift. (`${{ … }}` is a GitHub Actions expression,
|
|
170
|
+
// NOT a bkit token — the negative lookbehind keeps those enforced.)
|
|
171
|
+
const isStructural = (line: string): boolean => /^[A-Za-z0-9_.-]+:$/.test(line);
|
|
172
|
+
const hasBkitToken = (line: string): boolean => /(?<!\$)\{\{[^}]+\}\}/.test(line);
|
|
173
|
+
|
|
174
|
+
// Subset / presence: the block drifts only if the consumer is MISSING a required bkit line.
|
|
175
|
+
// Extras, reordering, re-indentation and comments are all fine.
|
|
176
|
+
const consumerLines = new Set(significantLines(consumerBlock));
|
|
177
|
+
const dropped = significantLines(templateBlock).filter(
|
|
178
|
+
(l) => !isStructural(l) && !hasBkitToken(l) && !consumerLines.has(l),
|
|
179
|
+
);
|
|
180
|
+
if (dropped.length === 0) return null;
|
|
181
|
+
|
|
182
|
+
return {
|
|
183
|
+
id: "tier2-text-drift",
|
|
184
|
+
severity: "advisory",
|
|
185
|
+
detect: `${relPath} has a bkit-managed block missing ${dropped.length} line(s) of the shipped template.`,
|
|
186
|
+
action:
|
|
187
|
+
`Re-sync the bkit-managed block in ${relPath} from ${path.relative(getPkgRoot(), templatePath)} ` +
|
|
188
|
+
"(run `pnpm bkit install`, or copy the block between its `bkit:start`/`bkit:end` markers). " +
|
|
189
|
+
"Content outside the markers is preserved.",
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Consumer files whose bkit-managed blocks `detectTier2TextDrift` compares (partial
|
|
195
|
+
* ownership: bkit's block, the consumer's rest). Templates are the consumer's files and
|
|
196
|
+
* are never compared. Exported so tests can reference it without duplication.
|
|
197
|
+
*/
|
|
198
|
+
export const MARKERED_TEXT_DRIFT_PATHS: readonly string[] = [
|
|
199
|
+
"AGENTS.md",
|
|
200
|
+
"CLAUDE.md",
|
|
201
|
+
".gitignore",
|
|
202
|
+
];
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
// checks/before/index.ts — Phase 1: read-only detection BEFORE any writes. runPreflight calls
|
|
2
|
+
// the detectors in this folder (one file per group of findings) in a fixed order.
|
|
3
|
+
// Nothing in checks/before/ imports install/modules/ — preflight is upstream of module dispatch.
|
|
4
|
+
//
|
|
5
|
+
// Allow-list for cross-module imports (BAR-167 Phase 1+2):
|
|
6
|
+
// readBkitVersion — from install/version-file.ts (version pin reader)
|
|
7
|
+
// deepContains — from install/write.ts (JSON containment primitive)
|
|
8
|
+
// extractManagedBlock — from install/managed-block.ts (marker block extraction)
|
|
9
|
+
// findTemplateSource — from shared/package-roots.ts (dest → payload source, the dotfile remap)
|
|
10
|
+
// parseIssueTracker — from install/manifest.ts (pure data, no cycle)
|
|
11
|
+
// readTemplate — from render/parts.ts (template with its shared parts spliced in)
|
|
12
|
+
|
|
13
|
+
import * as fs from "node:fs";
|
|
14
|
+
import * as path from "node:path";
|
|
15
|
+
import type { ModuleFlag } from "../../cli.js";
|
|
16
|
+
import { getPkgRoot } from "../../shared/package-roots.js";
|
|
17
|
+
import {
|
|
18
|
+
parseIssueTracker,
|
|
19
|
+
DEFAULT_ISSUE_TRACKER,
|
|
20
|
+
type IssueTracker,
|
|
21
|
+
} from "../../install/manifest.js";
|
|
22
|
+
import {
|
|
23
|
+
detectBkitNotOnPath,
|
|
24
|
+
detectMalformedPackageJson,
|
|
25
|
+
detectNoPackageJson,
|
|
26
|
+
detectNotGitRepo,
|
|
27
|
+
} from "./repo.js";
|
|
28
|
+
import {
|
|
29
|
+
MARKERED_TEXT_DRIFT_PATHS,
|
|
30
|
+
detectGitignoreBlockDuplicates,
|
|
31
|
+
detectPlaywrightReporterHostile,
|
|
32
|
+
detectTier2JsonDrift,
|
|
33
|
+
detectTier2TextDrift,
|
|
34
|
+
} from "./files.js";
|
|
35
|
+
import { detectBkitVersionMajorDowngrade, detectBkitVersionPinStale } from "./version.js";
|
|
36
|
+
import {
|
|
37
|
+
detectContextFetchContextMissing,
|
|
38
|
+
detectContextFetchMissing,
|
|
39
|
+
detectContextFetchProvisionMissing,
|
|
40
|
+
detectContextFetchSourceNotEnabled,
|
|
41
|
+
} from "./context-fetch.js";
|
|
42
|
+
import { detectExtraMcpServers, detectMissingMcpServers } from "./mcp.js";
|
|
43
|
+
|
|
44
|
+
// ---------------------------------------------------------------------------
|
|
45
|
+
// Public types
|
|
46
|
+
// ---------------------------------------------------------------------------
|
|
47
|
+
|
|
48
|
+
export interface PreflightFinding {
|
|
49
|
+
id: string;
|
|
50
|
+
severity: "blocker" | "advisory";
|
|
51
|
+
detect: string;
|
|
52
|
+
action: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// ---------------------------------------------------------------------------
|
|
56
|
+
// Internal helper
|
|
57
|
+
// ---------------------------------------------------------------------------
|
|
58
|
+
|
|
59
|
+
// Deduplicate an array of findings by `id`, first occurrence wins.
|
|
60
|
+
export function dedupeById(findings: PreflightFinding[]): PreflightFinding[] {
|
|
61
|
+
const seen = new Set<string>();
|
|
62
|
+
return findings.filter((f) => {
|
|
63
|
+
if (seen.has(f.id)) return false;
|
|
64
|
+
seen.add(f.id);
|
|
65
|
+
return true;
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// ---------------------------------------------------------------------------
|
|
70
|
+
// runPreflight — main Phase 1 entry point
|
|
71
|
+
// ---------------------------------------------------------------------------
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Read `bkit.issueTracker` from the consumer's package.json.
|
|
75
|
+
* Returns the tracker value or the default ("none") when absent / unreadable.
|
|
76
|
+
* Internal helper — not exported; use runPreflight's `issueTracker` param.
|
|
77
|
+
*/
|
|
78
|
+
function readConsumerIssueTrackerForPreflight(cwd: string): IssueTracker {
|
|
79
|
+
const pkgPath = path.join(cwd, "package.json");
|
|
80
|
+
if (!fs.existsSync(pkgPath)) return DEFAULT_ISSUE_TRACKER;
|
|
81
|
+
try {
|
|
82
|
+
const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8")) as Record<string, unknown>;
|
|
83
|
+
const bkitField = pkg.bkit as Record<string, unknown> | undefined;
|
|
84
|
+
const parsed = parseIssueTracker(bkitField?.issueTracker);
|
|
85
|
+
return parsed ?? DEFAULT_ISSUE_TRACKER;
|
|
86
|
+
} catch {
|
|
87
|
+
return DEFAULT_ISSUE_TRACKER;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Run all Phase 1 (read-only) detectors.
|
|
93
|
+
* Returns deduplicated { blockers, advisories } — intra-phase dedup by id,
|
|
94
|
+
* first occurrence wins.
|
|
95
|
+
*
|
|
96
|
+
* cwd defaults to process.cwd(). Pass explicitly in tests.
|
|
97
|
+
* installingVersion: used by detectBkitVersionMajorDowngrade; defaults to the
|
|
98
|
+
* package's own version read from its package.json at runtime.
|
|
99
|
+
* issueTracker: when provided, narrows tracker-specific checks (e.g. MCP server
|
|
100
|
+
* requirements). When omitted, read from consumer's `bkit.issueTracker` in package.json.
|
|
101
|
+
*
|
|
102
|
+
* GitHub tracker gate: when `issueTracker === "github"`, the Linear preflight
|
|
103
|
+
* gate is a no-op — the GitHub gate is enforced by workflow Step 1 via MCP.
|
|
104
|
+
*/
|
|
105
|
+
export function runPreflight(
|
|
106
|
+
modules: Set<ModuleFlag>,
|
|
107
|
+
cwd: string = process.cwd(),
|
|
108
|
+
installingVersion?: string,
|
|
109
|
+
issueTracker?: IssueTracker,
|
|
110
|
+
): { blockers: PreflightFinding[]; advisories: PreflightFinding[] } {
|
|
111
|
+
// Resolve installing version if not provided
|
|
112
|
+
let version = installingVersion;
|
|
113
|
+
if (!version) {
|
|
114
|
+
try {
|
|
115
|
+
const pkgJsonPath = path.join(getPkgRoot(), "package.json");
|
|
116
|
+
if (fs.existsSync(pkgJsonPath)) {
|
|
117
|
+
const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8")) as { version?: string };
|
|
118
|
+
version = pkg.version ?? "0.0.0";
|
|
119
|
+
} else {
|
|
120
|
+
version = "0.0.0";
|
|
121
|
+
}
|
|
122
|
+
} catch {
|
|
123
|
+
version = "0.0.0";
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// Resolve issueTracker: use provided value or read from consumer package.json.
|
|
128
|
+
// GitHub tracker gate: when issueTracker === "github", Linear preflight is a no-op
|
|
129
|
+
// (the GitHub gate is enforced by workflow Step 1 via MCP — hook is no-op).
|
|
130
|
+
const resolvedTracker = issueTracker ?? readConsumerIssueTrackerForPreflight(cwd);
|
|
131
|
+
|
|
132
|
+
const blockers: PreflightFinding[] = [];
|
|
133
|
+
const advisories: PreflightFinding[] = [];
|
|
134
|
+
|
|
135
|
+
// --- Blocker detectors ---
|
|
136
|
+
const noPackageJson = detectNoPackageJson(cwd);
|
|
137
|
+
if (noPackageJson) blockers.push(noPackageJson);
|
|
138
|
+
|
|
139
|
+
const malformedPackageJson = detectMalformedPackageJson(cwd);
|
|
140
|
+
if (malformedPackageJson) blockers.push(malformedPackageJson);
|
|
141
|
+
|
|
142
|
+
const notGitRepo = detectNotGitRepo(cwd, modules);
|
|
143
|
+
if (notGitRepo) blockers.push(notGitRepo);
|
|
144
|
+
|
|
145
|
+
// --- Advisory detectors ---
|
|
146
|
+
// Phase 1: JSON containment drift advisory
|
|
147
|
+
for (const relPath of [".claude/settings.json", ".cursor/hooks.json"]) {
|
|
148
|
+
const driftAdvisory = detectTier2JsonDrift(cwd, relPath);
|
|
149
|
+
if (driftAdvisory) advisories.push(driftAdvisory);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// Phase 2: markered-text block drift advisory (BAR-167)
|
|
153
|
+
for (const relPath of MARKERED_TEXT_DRIFT_PATHS) {
|
|
154
|
+
const textDriftAdvisory = detectTier2TextDrift(cwd, relPath);
|
|
155
|
+
if (textDriftAdvisory) advisories.push(textDriftAdvisory);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
const gitignoreDup = detectGitignoreBlockDuplicates(cwd);
|
|
159
|
+
if (gitignoreDup) advisories.push(gitignoreDup);
|
|
160
|
+
|
|
161
|
+
const versionMajorDowngrade = detectBkitVersionMajorDowngrade(cwd, version);
|
|
162
|
+
if (versionMajorDowngrade) advisories.push(versionMajorDowngrade);
|
|
163
|
+
|
|
164
|
+
const versionPinStale = detectBkitVersionPinStale(cwd);
|
|
165
|
+
if (versionPinStale) advisories.push(versionPinStale);
|
|
166
|
+
|
|
167
|
+
// BAR-224: [verbose ci] marker advisories
|
|
168
|
+
|
|
169
|
+
const playwrightReporterHostile = detectPlaywrightReporterHostile(cwd);
|
|
170
|
+
if (playwrightReporterHostile) advisories.push(playwrightReporterHostile);
|
|
171
|
+
|
|
172
|
+
const contextFetch = detectContextFetchMissing(cwd);
|
|
173
|
+
if (contextFetch) advisories.push(contextFetch);
|
|
174
|
+
|
|
175
|
+
const contextFetchContext = detectContextFetchContextMissing(cwd);
|
|
176
|
+
if (contextFetchContext) advisories.push(contextFetchContext);
|
|
177
|
+
|
|
178
|
+
const contextFetchSource = detectContextFetchSourceNotEnabled(cwd);
|
|
179
|
+
if (contextFetchSource) advisories.push(contextFetchSource);
|
|
180
|
+
|
|
181
|
+
const contextFetchProvision = detectContextFetchProvisionMissing(cwd);
|
|
182
|
+
if (contextFetchProvision) advisories.push(contextFetchProvision);
|
|
183
|
+
|
|
184
|
+
// bkit-not-on-path advisory — suggest the shell alias for local development.
|
|
185
|
+
const bkitNotOnPath = detectBkitNotOnPath();
|
|
186
|
+
if (bkitNotOnPath) advisories.push(bkitNotOnPath);
|
|
187
|
+
|
|
188
|
+
// Missing MCP server advisory — one finding per missing required key, per file.
|
|
189
|
+
// Tracker-aware: when issueTracker === "github", only github MCP server is required
|
|
190
|
+
// (the Linear gate is a no-op on the GitHub tracker; the gate runs in workflow Step 1 via MCP).
|
|
191
|
+
// Extra MCP server advisory — one finding per bkit-managed server that the
|
|
192
|
+
// resolved tracker does not use (e.g. a stale `linear` entry under `github`).
|
|
193
|
+
for (const relPath of [".mcp.json", ".cursor/mcp.json"]) {
|
|
194
|
+
advisories.push(...detectMissingMcpServers(cwd, relPath, resolvedTracker));
|
|
195
|
+
advisories.push(...detectExtraMcpServers(cwd, relPath, resolvedTracker));
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
// [mcp-env] detectors run in Phase 3 (runPostInstallCheck in checks/after/index.ts),
|
|
199
|
+
// not here: the .bkit/.env.example scaffold exists only after writes. Detectors are
|
|
200
|
+
// exported from this file for the postinstall module.
|
|
201
|
+
|
|
202
|
+
return {
|
|
203
|
+
blockers: dedupeById(blockers),
|
|
204
|
+
advisories: dedupeById(advisories),
|
|
205
|
+
};
|
|
206
|
+
}
|