@cbartens/bkit 6.0.0 → 6.1.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 +154 -151
- package/.bkit/core/.agents/context.md +95 -29
- package/.bkit/core/.agents/docs.md +17 -15
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-gateguard.cjs +1 -0
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-guardrails.cjs +6 -5
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-readguard.cjs +1 -0
- package/.bkit/core/.agents/plugins/bkit/hooks/bkit-rules.cjs +65 -0
- package/.bkit/core/.agents/rules.md +108 -107
- package/.bkit/core/.agents/skills.md +63 -15
- package/.bkit/core/.bkit/README.md +154 -151
- package/.bkit/core/.bkit/authoring.md +714 -84
- package/.bkit/core/.bkit/cli.md +407 -0
- package/.bkit/core/.bkit/cloud.md +281 -193
- package/.bkit/core/.bkit/comparison.md +43 -41
- package/.bkit/core/.bkit/install.md +154 -84
- package/.bkit/core/.bkit/jsonl.md +193 -130
- package/.bkit/core/.bkit/pipeline.md +114 -114
- package/.bkit/core/.bkit/prompts.md +272 -165
- package/.bkit/core/.bkit/providers.md +457 -271
- package/.bkit/core/.bkit/router.md +69 -0
- package/.bkit/core/.bkit/templates.md +529 -256
- package/.bkit/core/.bkit/trackers.md +80 -52
- package/.bkit/core/.bkit/workflows.md +589 -504
- package/.bkit/core/.claude/hooks/bkit-gateguard.cjs +2 -2
- package/.bkit/core/.claude/hooks/bkit-guardrails.cjs +3 -3
- package/.bkit/core/.claude/hooks/bkit-preflight.sh +45 -14
- package/.bkit/core/.codex/hooks/bkit-guardrails.cjs +3 -3
- package/.bkit/core/.codex/hooks/bkit-rules.cjs +57 -0
- package/.bkit/core/.cursor/hooks/bkit-guardrails.cjs +7 -7
- package/.bkit/core/.cursor/hooks/bkit-preflight.sh +47 -12
- package/.bkit/core/.opencode/plugin/bkit-rules.js +89 -0
- package/.bkit/core/AGENTS.md +5 -73
- package/.bkit/core/docs/templates/bkit-audit-accessibility.md +127 -105
- package/.bkit/core/docs/templates/bkit-audit-adoption.md +104 -70
- package/.bkit/core/docs/templates/bkit-audit-agents.md +94 -72
- package/.bkit/core/docs/templates/bkit-audit-aio-seo.md +99 -78
- package/.bkit/core/docs/templates/bkit-audit-analytics.md +140 -82
- package/.bkit/core/docs/templates/bkit-audit-annotations.md +98 -72
- package/.bkit/core/docs/templates/bkit-audit-app-performance.md +121 -96
- package/.bkit/core/docs/templates/bkit-audit-app-store.md +157 -76
- package/.bkit/core/docs/templates/bkit-audit-architecture.md +113 -71
- package/.bkit/core/docs/templates/bkit-audit-ci-performance.md +75 -72
- package/.bkit/core/docs/templates/bkit-audit-config.md +122 -76
- package/.bkit/core/docs/templates/bkit-audit-cost.md +85 -74
- package/.bkit/core/docs/templates/bkit-audit-coverage.md +75 -68
- package/.bkit/core/docs/templates/bkit-audit-database.md +101 -70
- package/.bkit/core/docs/templates/bkit-audit-dead-code.md +164 -83
- package/.bkit/core/docs/templates/bkit-audit-deferrals.md +115 -86
- package/.bkit/core/docs/templates/bkit-audit-dependencies.md +264 -88
- package/.bkit/core/docs/templates/bkit-audit-documentation.md +118 -93
- package/.bkit/core/docs/templates/bkit-audit-duplication.md +139 -86
- package/.bkit/core/docs/templates/bkit-audit-failures.md +110 -81
- package/.bkit/core/docs/templates/bkit-audit-flakes.md +99 -74
- package/.bkit/core/docs/templates/bkit-audit-gates.md +105 -77
- package/.bkit/core/docs/templates/bkit-audit-issues.md +104 -80
- package/.bkit/core/docs/templates/bkit-audit-llm.md +131 -58
- package/.bkit/core/docs/templates/bkit-audit-logs.md +123 -100
- package/.bkit/core/docs/templates/bkit-audit-models.md +98 -53
- package/.bkit/core/docs/templates/bkit-audit-privacy.md +56 -52
- package/.bkit/core/docs/templates/bkit-audit-prompts.md +63 -54
- package/.bkit/core/docs/templates/bkit-audit-red-team.md +124 -68
- package/.bkit/core/docs/templates/bkit-audit-reliability.md +95 -70
- package/.bkit/core/docs/templates/bkit-audit-repo.md +169 -73
- package/.bkit/core/docs/templates/bkit-audit-security.md +206 -96
- package/.bkit/core/docs/templates/bkit-audit-slop.md +77 -70
- package/.bkit/core/docs/templates/bkit-audit-testing.md +162 -114
- package/.bkit/core/docs/templates/bkit-audit-usability.md +113 -71
- package/.bkit/core/docs/templates/bkit-plan.md +138 -132
- package/.bkit/core/engine/checks/after/auth.ts +40 -37
- package/.bkit/core/engine/checks/after/ci-yml.ts +65 -2
- package/.bkit/core/engine/checks/after/index.ts +12 -2
- package/.bkit/core/engine/checks/after/tools.ts +80 -33
- package/.bkit/core/engine/checks/before/context-fetch.ts +227 -33
- package/.bkit/core/engine/checks/before/env.ts +1 -1
- package/.bkit/core/engine/checks/before/index.ts +7 -0
- package/.bkit/core/engine/checks/before/repo.ts +40 -0
- package/.bkit/core/engine/checks/status-holes.ts +916 -123
- package/.bkit/core/engine/checks/tips/catalogue.ts +68 -17
- package/.bkit/core/engine/checks/tips/detect.ts +32 -0
- package/.bkit/core/engine/checks/tips/index.ts +47 -6
- package/.bkit/core/engine/cli.ts +238 -84
- package/.bkit/core/engine/commands/analysis.ts +128 -76
- package/.bkit/core/engine/commands/ci/ci.ts +363 -29
- package/.bkit/core/engine/commands/ci/pins.ts +172 -0
- package/.bkit/core/engine/commands/ci/push-gate.ts +223 -0
- package/.bkit/core/engine/commands/install/uninstall.ts +21 -27
- package/.bkit/core/engine/commands/install/upgrade.ts +32 -15
- package/.bkit/core/engine/commands/land.ts +126 -11
- package/.bkit/core/engine/commands/lib.ts +303 -6
- package/.bkit/core/engine/commands/registry.ts +6 -2
- package/.bkit/core/engine/commands/setup/setup.ts +1 -0
- package/.bkit/core/engine/commands/stats.ts +91 -35
- package/.bkit/core/engine/commands/workflow/branches.ts +1477 -117
- package/.bkit/core/engine/commands/workflow/challenge.ts +114 -39
- package/.bkit/core/engine/commands/workflow/completeness.ts +109 -0
- package/.bkit/core/engine/commands/workflow/context.ts +433 -55
- package/.bkit/core/engine/commands/workflow/counters.ts +244 -39
- package/.bkit/core/engine/commands/workflow/decisions.ts +61 -17
- package/.bkit/core/engine/commands/workflow/disk.ts +237 -55
- package/.bkit/core/engine/commands/workflow/fids.ts +19 -1
- package/.bkit/core/engine/commands/workflow/issues.ts +6 -0
- package/.bkit/core/engine/commands/workflow/ledgers.ts +458 -18
- package/.bkit/core/engine/commands/workflow/locks.ts +2 -0
- package/.bkit/core/engine/commands/workflow/plan-blocks.ts +124 -15
- package/.bkit/core/engine/commands/workflow/plans.ts +257 -0
- package/.bkit/core/engine/commands/workflow/prs.ts +12 -3
- package/.bkit/core/engine/commands/workflow/repo.ts +8 -0
- package/.bkit/core/engine/commands/workflow/roadmap.ts +56 -15
- package/.bkit/core/engine/commands/workflow/run-facts.ts +22 -31
- package/.bkit/core/engine/commands/workflow/runs.ts +652 -34
- package/.bkit/core/engine/commands/workflow/runtime.ts +3 -0
- package/.bkit/core/engine/commands/workflow/skills.ts +1 -0
- package/.bkit/core/engine/commands/workflow/status.ts +200 -17
- package/.bkit/core/engine/commands/workflow/step-table.ts +75 -33
- package/.bkit/core/engine/commands/workflow/steps.ts +635 -24
- package/.bkit/core/engine/commands/workflow/summary-findings.ts +177 -0
- package/.bkit/core/engine/commands/workflow/summary.ts +192 -46
- package/.bkit/core/engine/commands/workflow/tasks.ts +409 -0
- package/.bkit/core/engine/commands/workflow/test-blocks.ts +254 -0
- package/.bkit/core/engine/commands/workflow/tests-changed.ts +201 -0
- package/.bkit/core/engine/commands/workflow/tests.ts +1285 -356
- package/.bkit/core/engine/commands/workflow/workflows.ts +228 -43
- package/.bkit/core/engine/commands/workflow/worktrees.ts +389 -47
- package/.bkit/core/engine/install/cloud-env.ts +251 -121
- package/.bkit/core/engine/install/context-ci-workflow.ts +102 -0
- package/.bkit/core/engine/install/manifest.ts +60 -12
- package/.bkit/core/engine/install/modules/antigravity.ts +3 -2
- package/.bkit/core/engine/install/modules/cloud.ts +3 -3
- package/.bkit/core/engine/install/modules/codex.ts +15 -2
- package/.bkit/core/engine/install/modules/core.ts +956 -52
- package/.bkit/core/engine/install/modules/cursor.ts +6 -6
- package/.bkit/core/engine/install/modules/opencode.ts +16 -4
- package/.bkit/core/engine/install/template-notes.ts +130 -0
- package/.bkit/core/engine/install/version-file.ts +3 -2
- package/.bkit/core/engine/install/write.ts +5 -0
- package/.bkit/core/engine/ledgers/compact.ts +124 -0
- package/.bkit/core/engine/ledgers/journal.ts +291 -0
- package/.bkit/core/engine/ledgers/status.ts +160 -9
- package/.bkit/core/engine/ledgers/telemetry.ts +158 -21
- package/.bkit/core/engine/render/hosts.ts +114 -14
- package/.bkit/core/engine/shared/bkit-latest.ts +26 -4
- package/.bkit/core/engine/shared/dep-updater.ts +60 -0
- package/.bkit/core/engine/shared/egress.ts +1 -1
- package/.bkit/core/engine/shared/package-manager.ts +9 -0
- package/.bkit/core/engine/shared/settings.ts +92 -17
- package/.bkit/core/engine/shared/timeouts.ts +2 -0
- package/.bkit/core/engine/tools/cli-doc.ts +111 -0
- package/.bkit/core/engine/tools/grammar-density.ts +1 -1
- package/.bkit/core/engine/tools/instructions-sources.ts +15 -17
- package/.bkit/core/engine/tools/instructions.ts +94 -43
- package/.bkit/core/hooks/antigravity-hook.js +25 -10
- package/.bkit/core/hooks/gateguard-engine.js +53 -29
- package/.bkit/core/hooks/guardrails-shell.js +4 -4
- package/.bkit/core/hooks/guardrails-tiers.js +3 -3
- package/.bkit/core/hooks/preflight-linear.sh +9 -9
- package/.bkit/core/hooks/preflight-rules.sh +8 -0
- package/.bkit/core/hooks/readguard-engine.js +29 -10
- package/.bkit/core/hooks/session-rules-advisory.js +61 -0
- package/.bkit/core/prompts/bkit-audit-generate.md +187 -116
- package/.bkit/core/prompts/bkit-build-challenge-1.md +56 -37
- package/.bkit/core/prompts/bkit-build-challenge-2.md +65 -45
- package/.bkit/core/prompts/bkit-build-install-skills.md +38 -29
- package/.bkit/core/prompts/bkit-build-plan-convert.md +43 -32
- package/.bkit/core/prompts/bkit-build-plan-current.md +49 -39
- package/.bkit/core/prompts/bkit-build-plan-gaps-remediate.md +79 -55
- package/.bkit/core/prompts/bkit-build-plan-tasks.md +149 -0
- package/.bkit/core/prompts/bkit-build-plan-tests.md +120 -0
- package/.bkit/core/prompts/bkit-build-plan-verify.md +87 -50
- package/.bkit/core/prompts/bkit-debug-abort-handover.md +36 -35
- package/.bkit/core/prompts/bkit-debug-failure-diagnose.md +96 -64
- package/.bkit/core/prompts/bkit-debug-failure-remediate.md +54 -45
- package/.bkit/core/prompts/bkit-debug-failure-reproduce.md +42 -33
- package/.bkit/core/prompts/bkit-debug-failure-soak.md +53 -37
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-1.md +35 -30
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-2.md +34 -29
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-3.md +32 -28
- package/.bkit/core/prompts/bkit-design-generate.md +68 -52
- package/.bkit/core/prompts/bkit-design-organise.md +73 -35
- package/.bkit/core/prompts/bkit-design-review-1.md +58 -54
- package/.bkit/core/prompts/bkit-design-review-2.md +54 -50
- package/.bkit/core/prompts/bkit-design-spike.md +54 -47
- package/.bkit/core/prompts/bkit-design-update.md +42 -31
- package/.bkit/core/prompts/bkit-plan-generate.md +76 -58
- package/.bkit/core/prompts/bkit-plan-review-1.md +63 -49
- package/.bkit/core/prompts/bkit-plan-review-2.md +60 -48
- package/.bkit/core/prompts/bkit-plan-scope-check.md +53 -46
- package/.bkit/core/prompts/bkit-plan-update.md +70 -52
- package/.bkit/core/prompts/bkit-ship-conflict-resolve.md +82 -50
- package/.bkit/core/prompts/bkit-ship-deferred-sweep.md +80 -45
- package/.bkit/core/prompts/bkit-ship-update-docs.md +35 -29
- package/.bkit/core/prompts/bkit-utility-compress-markdown.md +55 -49
- package/.bkit/core/prompts/bkit-utility-update-decisions.md +76 -49
- package/.bkit/core/prompts/bkit-utility-update-deferrals.md +70 -41
- package/.bkit/core/prompts/bkit-utility-update-documentation.md +33 -30
- package/.bkit/core/prompts/bkit-utility-update-failures.md +73 -43
- package/.bkit/core/prompts/bkit-utility-update-knowledge.md +77 -50
- package/.bkit/core/prompts/bkit-utility-update-roadmap.md +77 -45
- package/.bkit/core/prompts/bkit-utility-update-tracker.md +144 -68
- package/.bkit/core/workflows/bkit-auto.md +53 -30
- package/.bkit/core/workflows/bkit-build.md +635 -304
- package/.bkit/core/workflows/bkit-debug.md +301 -148
- package/.bkit/core/workflows/bkit-design.md +167 -95
- package/.bkit/core/workflows/bkit-plan.md +172 -84
- package/.bkit/core/workflows/bkit-ship.md +299 -152
- package/.bkit/shared/.agents/plugins/bkit/hooks.json +10 -0
- package/.bkit/shared/.claude/bkit-cloud.md +12 -10
- package/.bkit/shared/.claude/settings.json +3 -0
- package/.bkit/shared/.codex/bkit-cloud.md +98 -0
- package/.bkit/shared/.codex/hooks.json +20 -0
- package/.bkit/shared/.cursor/bkit-cloud.md +3 -3
- package/.bkit/shared/.opencode/opencode.json +1 -1
- package/.bkit/shared/CLAUDE.md +5 -1
- package/.bkit/shared/GEMINI.md +4 -1
- package/.bkit/shared/docs/architecture.md +4 -7
- package/.bkit/shared/docs/data-schema.md +4 -7
- package/.bkit/shared/docs/deployments.md +239 -166
- package/.bkit/shared/docs/design.md +11 -12
- package/.bkit/shared/docs/noise.md +8 -7
- package/.bkit/shared/docs/observability.md +5 -8
- package/.bkit/shared/docs/security.md +35 -17
- package/.bkit/shared/docs/setup.md +29 -18
- package/.bkit/shared/docs/technology.md +3 -6
- package/.bkit/shared/docs/testing.md +282 -176
- package/.bkit/shared/gitignore +6 -2
- package/.bkit/templates/.claude/hooks/bkit-cloud-bootstrap.sh +15 -16
- package/.bkit/templates/.cursor/Dockerfile +12 -8
- package/.bkit/templates/.cursor/environment.json +1 -1
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-bug.yml +10 -8
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-change.yml +24 -12
- package/.bkit/templates/.github/ISSUE_TEMPLATE/bkit-idea.yml +3 -3
- package/.bkit/templates/.github/renovate.json5 +34 -6
- package/.bkit/templates/.github/workflows/bkit-ci.yml +53 -50
- package/.bkit/templates/.github/workflows/bkit-cloud.yml +13 -14
- package/.bkit/templates/.github/workflows/bkit-health.yml +97 -0
- package/.bkit/templates/.github/workflows/bkit-renovate.yml +5 -4
- package/.bkit/templates/.github/workflows/bkit-trivy.yml +5 -4
- package/.bkit/templates/.husky/pre-commit +2 -2
- package/.bkit/templates/.husky/pre-push +95 -35
- package/.bkit/templates/.prettierignore +6 -7
- package/.bkit/templates/.vale.ini +27 -27
- package/.bkit/templates/context/bkit-cloudrun.md +23 -15
- package/.bkit/templates/context/bkit-expo.md +70 -52
- package/.bkit/templates/context/bkit-github.md +93 -56
- package/.bkit/templates/context/bkit-inngest.md +21 -15
- package/.bkit/templates/context/bkit-maestro.md +22 -16
- package/.bkit/templates/context/bkit-playwright.md +23 -17
- package/.bkit/templates/context/bkit-resend.md +12 -10
- package/.bkit/templates/context/bkit-sentry.md +30 -20
- package/.bkit/templates/context/bkit-serena.md +8 -7
- package/.bkit/templates/context/bkit-stripe.md +14 -13
- package/.bkit/templates/context/bkit-supabase.md +16 -13
- package/.bkit/templates/context/bkit-tavily.md +14 -11
- package/.bkit/templates/context/bkit-vercel.md +27 -18
- package/.bkit/templates/docs/capabilities.md +15 -14
- package/.bkit/templates/scripts/ci/{check-accepted-divergences.mjs → bkit-check-accepted-divergences.mjs} +6 -3
- package/.bkit/templates/scripts/ci/{check-accepted-divergences.test.mjs → bkit-check-accepted-divergences.test.mjs} +3 -3
- package/.bkit/templates/scripts/ci/{check-capstone.mjs → bkit-check-capstone.mjs} +2 -2
- package/.bkit/templates/scripts/ci/{check-capstone.test.mjs → bkit-check-capstone.test.mjs} +4 -4
- package/.bkit/templates/scripts/ci/{check-dependency-audit.mjs → bkit-check-dependency-audit.mjs} +103 -18
- package/.bkit/templates/scripts/ci/{check-dependency-audit.test.mjs → bkit-check-dependency-audit.test.mjs} +31 -3
- package/.bkit/templates/scripts/ci/bkit-machine-lock.sh +387 -0
- package/.bkit/templates/scripts/ci/bkit-test-awake.mjs +75 -0
- package/.bkit/templates/scripts/ci/bkit-test-awake.test.mjs +160 -0
- package/.bkit/templates/scripts/ci/lanes/{resolve-push-base.mjs → bkit-resolve-push-base.mjs} +3 -3
- package/.bkit/templates/scripts/ci/lanes/{resolve-push-base.test.mjs → bkit-resolve-push-base.test.mjs} +4 -4
- package/.bkit/templates/scripts/cleanup/bkit-disk-prune.mjs +9 -1
- package/.bkit/templates/scripts/graphify/bkit-graph-drift.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graph-eager.py +3 -3
- package/.bkit/templates/scripts/graphify/bkit-graph-embed.py +63 -0
- package/.bkit/templates/scripts/graphify/bkit-graph-imports.py +2 -2
- package/.bkit/templates/scripts/graphify/bkit-graph-pre-push.sh +69 -18
- package/.bkit/templates/scripts/graphify/bkit-graph-repair.py +3 -3
- package/.bkit/templates/scripts/graphify/bkit-graph-surface.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graphify-graphml.py +1 -1
- package/.bkit/templates/scripts/graphify/bkit-graphify-rollup.py +197 -126
- package/.bkit/templates/scripts/graphify/bkit-graphify.sh +64 -41
- package/.bkit/templates/scripts/slop/bkit-slop-type-suppression.mjs +23 -7
- package/.bkit/templates/slop-scan.config.json +9 -2
- package/CHANGELOG.md +119 -0
- package/README.md +250 -76
- package/dist/checks/after/auth.js +36 -33
- package/dist/checks/after/ci-yml.js +52 -2
- package/dist/checks/after/index.js +12 -4
- package/dist/checks/after/tools.js +73 -33
- package/dist/checks/before/context-fetch.js +218 -33
- package/dist/checks/before/env.js +1 -1
- package/dist/checks/before/index.js +6 -2
- package/dist/checks/before/repo.js +35 -1
- package/dist/checks/status-holes.js +739 -114
- package/dist/checks/tips/catalogue.js +59 -17
- package/dist/checks/tips/detect.js +30 -0
- package/dist/checks/tips/index.js +48 -6
- package/dist/cli.js +222 -84
- package/dist/commands/analysis.js +77 -53
- package/dist/commands/ci/ci.js +302 -25
- package/dist/commands/ci/pins.js +142 -0
- package/dist/commands/ci/push-gate.js +194 -0
- package/dist/commands/install/uninstall.js +23 -27
- package/dist/commands/install/upgrade.js +21 -11
- package/dist/commands/land.js +126 -10
- package/dist/commands/lib.js +244 -5
- package/dist/commands/registry.js +6 -2
- package/dist/commands/setup/setup.js +1 -0
- package/dist/commands/stats.js +69 -30
- package/dist/commands/workflow/branches.js +1232 -111
- package/dist/commands/workflow/challenge.js +90 -37
- package/dist/commands/workflow/completeness.js +97 -0
- package/dist/commands/workflow/context.js +371 -51
- package/dist/commands/workflow/counters.js +206 -40
- package/dist/commands/workflow/decisions.js +60 -17
- package/dist/commands/workflow/disk.js +213 -55
- package/dist/commands/workflow/fids.js +18 -1
- package/dist/commands/workflow/issues.js +6 -0
- package/dist/commands/workflow/ledgers.js +372 -21
- package/dist/commands/workflow/locks.js +2 -0
- package/dist/commands/workflow/plan-blocks.js +78 -14
- package/dist/commands/workflow/plans.js +205 -0
- package/dist/commands/workflow/prs.js +12 -3
- package/dist/commands/workflow/repo.js +6 -0
- package/dist/commands/workflow/roadmap.js +50 -17
- package/dist/commands/workflow/run-facts.js +23 -28
- package/dist/commands/workflow/runs.js +530 -33
- package/dist/commands/workflow/runtime.js +3 -0
- package/dist/commands/workflow/skills.js +1 -0
- package/dist/commands/workflow/status.js +166 -19
- package/dist/commands/workflow/step-table.js +61 -29
- package/dist/commands/workflow/steps.js +542 -26
- package/dist/commands/workflow/summary-findings.js +117 -0
- package/dist/commands/workflow/summary.js +154 -41
- package/dist/commands/workflow/tasks.js +378 -0
- package/dist/commands/workflow/test-blocks.js +231 -0
- package/dist/commands/workflow/tests-changed.js +172 -0
- package/dist/commands/workflow/tests.js +1013 -321
- package/dist/commands/workflow/workflows.js +191 -38
- package/dist/commands/workflow/worktrees.js +310 -42
- package/dist/install/cloud-env.js +233 -99
- package/dist/install/context-ci-workflow.js +85 -0
- package/dist/install/manifest.js +57 -12
- package/dist/install/modules/antigravity.js +3 -2
- package/dist/install/modules/cloud.js +3 -3
- package/dist/install/modules/codex.js +12 -2
- package/dist/install/modules/core.js +851 -53
- package/dist/install/modules/cursor.js +6 -6
- package/dist/install/modules/opencode.js +11 -5
- package/dist/install/template-notes.js +116 -0
- package/dist/install/version-file.js +3 -2
- package/dist/ledgers/compact.js +87 -0
- package/dist/ledgers/journal.js +233 -0
- package/dist/ledgers/status.js +115 -5
- package/dist/ledgers/telemetry.js +121 -17
- package/dist/render/hosts.js +100 -14
- package/dist/shared/bkit-latest.js +26 -4
- package/dist/shared/dep-updater.js +49 -0
- package/dist/shared/egress.js +1 -1
- package/dist/shared/package-manager.js +6 -0
- package/dist/shared/settings.js +59 -10
- package/dist/shared/timeouts.js +2 -0
- package/dist/tools/cli-doc.js +97 -0
- package/dist/tools/grammar-density.js +1 -1
- package/dist/tools/instructions-sources.js +15 -16
- package/dist/tools/instructions.js +83 -39
- package/package.json +58 -42
- package/.bkit/core/.bkit/lite.md +0 -73
- package/.bkit/core/engine/commands/workflow/workstreams.ts +0 -172
- package/.bkit/core/prompts/bkit-build-plan-execute.md +0 -124
- package/.bkit/templates/scripts/ci/bkit-local-stack-lock.sh +0 -194
- package/dist/commands/workflow/workstreams.js +0 -149
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Filler.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Hedging.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/LLMSlop.yml +0 -0
- /package/.bkit/templates/.vale/styles/{House → Bkit}/Verbose.yml +0 -0
- /package/.bkit/templates/scripts/ci/{accepted-advisories.json → bkit-accepted-advisories.json} +0 -0
- /package/.bkit/templates/scripts/ci/{accepted-divergences.json → bkit-accepted-divergences.json} +0 -0
- /package/.bkit/templates/scripts/launchd/{launchd.env.example → bkit-launchd.env.example} +0 -0
- /package/.bkit/templates/scripts/launchd/{ai.bkit.launchd.plist → bkit-launchd.plist} +0 -0
|
@@ -4,7 +4,6 @@ import * as fs from "node:fs";
|
|
|
4
4
|
import * as path from "node:path";
|
|
5
5
|
import { spawnSync } from "node:child_process";
|
|
6
6
|
import { readJsonFile } from "../../shared/json.js";
|
|
7
|
-
import { readBkitConfig } from "../../shared/settings.js";
|
|
8
7
|
/**
|
|
9
8
|
* Detect whether BKIT_GH_TOKEN is set in the shell environment. Distinguishes
|
|
10
9
|
* empty from unset so action text can guide the user precisely. Never reads the
|
|
@@ -55,7 +54,7 @@ export function detectGhMcpToken(cwd) {
|
|
|
55
54
|
id: "gh-mcp-token-unset-shell",
|
|
56
55
|
severity: "advisory",
|
|
57
56
|
detect: "BKIT_GH_TOKEN is not set in the shell environment (undefined). The GitHub MCP server authenticates with `Authorization: Bearer ${BKIT_GH_TOKEN}` — without it, every tracker, PR, and board MCP call fails to connect.",
|
|
58
|
-
action: "Set BKIT_GH_TOKEN in .bkit/.env (canonical local-secrets file, gitignored), then `direnv allow` and restart your editor so MCP servers pick it up:\n\n cp .bkit/.env.example .bkit/.env # if not already done\n # edit .bkit/.env — set BKIT_GH_TOKEN=<PAT>\n direnv allow\n\nUse a fine-grained PAT when every target repo sits under one owner (Contents, Pull requests, Issues, and Actions read & write, plus organization-scoped Projects read & write if you use board sync); use a classic PAT when one token must span owners (scopes repo / workflow / read:org / project / security_events). Generate at: https://github.com/settings/personal-access-tokens (fine-grained) or https://github.com/settings/tokens (classic). In cloud sessions (Claude Code web / Cursor
|
|
57
|
+
action: "Set BKIT_GH_TOKEN in .bkit/.env (canonical local-secrets file, gitignored), then `direnv allow` and restart your editor so MCP servers pick it up:\n\n cp .bkit/.env.example .bkit/.env # if not already done\n # edit .bkit/.env — set BKIT_GH_TOKEN=<PAT>\n direnv allow\n\nUse a fine-grained PAT when every target repo sits under one owner (Contents, Pull requests, Issues, and Actions read & write, plus organization-scoped Projects read & write if you use board sync); use a classic PAT when one token must span owners (scopes repo / workflow / read:org / project / security_events). Generate at: https://github.com/settings/personal-access-tokens (fine-grained) or https://github.com/settings/tokens (classic). In cloud sessions (Claude Code web / Cursor Cloud Agents / Codex Cloud) set BKIT_GH_TOKEN in the dashboard env vars instead — repo files are not read for secrets there.",
|
|
59
58
|
};
|
|
60
59
|
}
|
|
61
60
|
if (status === "empty") {
|
|
@@ -97,48 +96,52 @@ export function detectGhSecret(secretName) {
|
|
|
97
96
|
return names.includes(secretName) ? "present" : "missing";
|
|
98
97
|
}
|
|
99
98
|
/**
|
|
100
|
-
* Build the consolidated
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
99
|
+
* Build the consolidated cloud-secrets checklist advisory. Fires when the consumer's
|
|
100
|
+
* repo has bkit-cloud.yml installed OR a `.claude/`, `.cursor/` or `.codex/` install
|
|
101
|
+
* present — each indicates cloud-side agent use. Lists one location per trigger present:
|
|
102
|
+
* GitHub Actions for the router, plus each installed host's cloud dashboard with its
|
|
103
|
+
* generated paste doc. Never depends on the issue tracker: every host's env block is the
|
|
104
|
+
* same tracker-independent set (install/cloud-env.ts).
|
|
105
105
|
*
|
|
106
|
-
* Returns null when none of the
|
|
106
|
+
* Returns null when none of the trigger paths exist.
|
|
107
107
|
*/
|
|
108
108
|
export function buildCloudDashboardsAdvisory(cwd) {
|
|
109
109
|
const hasRouter = fs.existsSync(path.join(cwd, ".github", "workflows", "bkit-cloud.yml"));
|
|
110
|
-
const
|
|
111
|
-
|
|
112
|
-
|
|
110
|
+
const hosts = [
|
|
111
|
+
[
|
|
112
|
+
".cursor",
|
|
113
|
+
"**Cursor Cloud Agents**: open `https://cursor.com/dashboard/cloud-agents` → your environment → **Secrets** tab. Add each secret as a **Runtime Secret** (loaded as an env var, redacted from the agent's transcript). Cursor reads `.cursor/Dockerfile` + `.cursor/environment.json` from the repo but secrets come from this dashboard only; the resolved paste-ready values are in `.cursor/bkit-cloud.md` (gitignored).",
|
|
114
|
+
],
|
|
115
|
+
[
|
|
116
|
+
".claude",
|
|
117
|
+
"**Claude Code (web)**: open `https://claude.ai/code` → environment selector → your environment → **Environment variables**. Paste the block from `.claude/bkit-cloud.md` (gitignored), which also carries the setup script and network list. Claude reads both from the dashboard, NOT from the repo, so changes here do not require a commit.",
|
|
118
|
+
],
|
|
119
|
+
[
|
|
120
|
+
".codex",
|
|
121
|
+
"**Codex Cloud**: open ChatGPT → **Settings > Codex Cloud > Environments** → your environment → **Environment variables**. Paste the block from `.codex/bkit-cloud.md` (gitignored), which also carries the install script and allowed domains.",
|
|
122
|
+
],
|
|
123
|
+
];
|
|
124
|
+
const present = hosts.filter(([dir]) => fs.existsSync(path.join(cwd, dir)));
|
|
125
|
+
if (!hasRouter && present.length === 0)
|
|
113
126
|
return null;
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
const isCursorCloud = config.cloudAgents === "cursor" ||
|
|
119
|
-
(!hasRouter && hasCursor && config.issueTracker === "linear");
|
|
120
|
-
const secretList = isCursorCloud ? "`BKIT_LINEAR_API_KEY`" : "`ANTHROPIC_API_KEY`";
|
|
121
|
-
const ghSetLines = isCursorCloud
|
|
122
|
-
? " gh secret set BKIT_LINEAR_API_KEY --body='<value>'\n\n" +
|
|
123
|
-
" Verify: `gh secret list | grep -E 'BKIT_LINEAR_API_KEY'`\n\n"
|
|
124
|
-
: " gh secret set ANTHROPIC_API_KEY --body='<value>'\n\n" +
|
|
127
|
+
const sections = [];
|
|
128
|
+
if (hasRouter) {
|
|
129
|
+
sections.push("**GitHub Actions** (used by bkit-cloud.yml and your own workflows):\n" +
|
|
130
|
+
" gh secret set ANTHROPIC_API_KEY --body='<value>'\n\n" +
|
|
125
131
|
" Verify: `gh secret list | grep -E 'ANTHROPIC_API_KEY'`\n\n" +
|
|
126
|
-
" Keyless alternative for bkit-cloud.yml (workload identity federation): leave the secret unset and set the `ANTHROPIC_FEDERATION_RULE_ID` + `ANTHROPIC_ORGANIZATION_ID` repo variables (`gh variable set`) from a Claude Console federation rule.\n\n"
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
132
|
+
" Keyless alternative for bkit-cloud.yml (workload identity federation): leave the secret unset and set the `ANTHROPIC_FEDERATION_RULE_ID` + `ANTHROPIC_ORGANIZATION_ID` repo variables (`gh variable set`) from a Claude Console federation rule.\n\n" +
|
|
133
|
+
" ANTHROPIC_API_KEY is read from the Anthropic dashboard (https://console.anthropic.com/settings/keys); `.bkit/.env` holds the same value as BKIT_ANTHROPIC_API_KEY. The Claude GitHub App (`/install-github-app`) is also required for `cloud=claude`.");
|
|
134
|
+
}
|
|
135
|
+
for (const [, text] of present)
|
|
136
|
+
sections.push(text);
|
|
130
137
|
return {
|
|
131
138
|
id: "cloud-secrets-three-locations",
|
|
132
139
|
severity: "advisory",
|
|
133
|
-
detect:
|
|
140
|
+
detect: "The secrets bkit's cloud integration uses must also be set in each cloud location you use. Bkit cannot verify dashboard state — surface the checklist so you don't ship a half-configured cloud setup.",
|
|
134
141
|
action: "Set each secret in the required locations:\n\n" +
|
|
135
|
-
|
|
136
|
-
ghSetLines +
|
|
137
|
-
"2. **Cursor Cloud Agents** (used by Cursor's cloud agent runner): open `https://cursor.com/dashboard/cloud-agents` → your environment → **Secrets** tab. Add each secret as a **Runtime Secret** (loaded as an env var, redacted from the agent's transcript). Cursor reads `.cursor/Dockerfile` + `.cursor/environment.json` from the repo but secrets come from this dashboard only; the resolved paste-ready values are in `.cursor/bkit-cloud.md` (gitignored).\n\n" +
|
|
138
|
-
"3. **Claude Code (web)** (used by Claude.ai's cloud agent runner): open `https://claude.ai/code` → Settings → Setup → Environment Variables. Add each secret. Claude reads its setup script from the dashboard, NOT from the repo, so changes here do not require a commit.\n\n" +
|
|
142
|
+
sections.map((s, i) => `${i + 1}. ${s}\n\n`).join("") +
|
|
139
143
|
"**Context-fetch (`/bkit-debug` in the cloud):** if you run the debug workflow in these cloud agents, the observability creds your `.agents/context.md` context-fetch blocks use (e.g. `VERCEL_TOKEN`, `SUPABASE_ACCESS_TOKEN`) must ALSO be set in the same dashboards above — non-interactively, since headless agents cannot `vercel login`. These are operator/observability READ creds, not app-runtime secrets. Commit the non-secret selectors (team scope / project ref / `--environment`) in your copied block so they need no dashboard entry. The CLIs those blocks call install automatically in the cloud from each block's `context-fetch:provision` sibling — no manual setup.\n\n" +
|
|
140
|
-
"Same VALUE in all places.
|
|
141
|
-
vendorNote,
|
|
144
|
+
"Same VALUE in all places.",
|
|
142
145
|
};
|
|
143
146
|
}
|
|
144
147
|
/** Repo variables that, both set, switch bkit-cloud.yml's claude job to workload identity federation. */
|
|
@@ -621,6 +621,57 @@ export function detectGhaFloatingTags(cwd) {
|
|
|
621
621
|
"Look up SHAs with `git ls-remote https://github.com/<org>/<repo>.git 'refs/tags/v*' | tail -3`. Apply to ALL workflow files that run with elevated permissions (`packages: write`, `id-token: write`). Copy `.github/renovate.json5` or `.github/dependabot.yml` from the bkit examples so SHA pins refresh on upstream releases. See docs/deployments.md § Dependency updaters.",
|
|
622
622
|
};
|
|
623
623
|
}
|
|
624
|
+
/**
|
|
625
|
+
* CI template copies named without the `bkit-` prefix: unprefixed path → template name, both
|
|
626
|
+
* relative to the repo root.
|
|
627
|
+
*/
|
|
628
|
+
const CI_SCRIPT_DIR = "scripts/ci";
|
|
629
|
+
const ciScriptUnit = (...files) => files.map((file) => {
|
|
630
|
+
const slash = file.lastIndexOf("/");
|
|
631
|
+
const dir = slash === -1 ? "" : file.slice(0, slash + 1);
|
|
632
|
+
return [`${CI_SCRIPT_DIR}/${file}`, `${CI_SCRIPT_DIR}/${dir}bkit-${file.slice(slash + 1)}`];
|
|
633
|
+
});
|
|
634
|
+
/**
|
|
635
|
+
* The renamed files grouped into units that move together: a script, its test and the
|
|
636
|
+
* data file it reads. `bkit upgrade` moves a unit only whole.
|
|
637
|
+
*/
|
|
638
|
+
export const CI_SCRIPT_UNITS = [
|
|
639
|
+
ciScriptUnit("check-capstone.mjs", "check-capstone.test.mjs"),
|
|
640
|
+
ciScriptUnit("check-dependency-audit.mjs", "check-dependency-audit.test.mjs", "accepted-advisories.json"),
|
|
641
|
+
ciScriptUnit("check-accepted-divergences.mjs", "check-accepted-divergences.test.mjs", "accepted-divergences.json"),
|
|
642
|
+
ciScriptUnit("lanes/resolve-push-base.mjs", "lanes/resolve-push-base.test.mjs"),
|
|
643
|
+
];
|
|
644
|
+
export const CI_SCRIPT_RENAMES = CI_SCRIPT_UNITS.flat();
|
|
645
|
+
/**
|
|
646
|
+
* Detect CI template copies named without the `bkit-` prefix. They keep working while every
|
|
647
|
+
* reference uses the same old name; the risk is renaming a file without its references — the
|
|
648
|
+
* CI dependency-audit step is guarded by `hashFiles(...)` and silently skips. The copies are the
|
|
649
|
+
* consumer's: `bkit upgrade` moves the unedited ones (`migrateBrandedTemplateFiles`), and this
|
|
650
|
+
* advisory names the ones it leaves (edited, or a `bkit-` target already present); the action
|
|
651
|
+
* inlines the rename and the reference edit.
|
|
652
|
+
*/
|
|
653
|
+
export function detectCiScriptsOldNames(cwd) {
|
|
654
|
+
const found = CI_SCRIPT_RENAMES.filter(([oldPath]) => fs.existsSync(path.join(cwd, oldPath)));
|
|
655
|
+
if (found.length === 0)
|
|
656
|
+
return null;
|
|
657
|
+
const moves = found
|
|
658
|
+
.filter(([, newPath]) => !fs.existsSync(path.join(cwd, newPath)))
|
|
659
|
+
.map(([oldPath, newPath]) => ` git mv ${oldPath} ${newPath}`);
|
|
660
|
+
const both = found
|
|
661
|
+
.filter(([, newPath]) => fs.existsSync(path.join(cwd, newPath)))
|
|
662
|
+
.map(([oldPath, newPath]) => ` ${oldPath} (also present: ${newPath})`);
|
|
663
|
+
const pairs = found.map(([oldPath, newPath]) => `${oldPath} → ${newPath}`).join(", ");
|
|
664
|
+
return {
|
|
665
|
+
id: "ci-scripts-old-names",
|
|
666
|
+
severity: "advisory",
|
|
667
|
+
detect: `${found.length} CI template ${found.length === 1 ? "copy uses its" : "copies use their"} old name without the \`bkit-\` prefix: ${found.map(([oldPath]) => `\`${oldPath}\``).join(", ")}. They work while every reference uses the old name too; renaming a file without its references makes the CI dependency-audit step skip silently.`,
|
|
668
|
+
action: (moves.length > 0 ? `Rename:\n\n${moves.join("\n")}\n\n` : "") +
|
|
669
|
+
(both.length > 0
|
|
670
|
+
? `Both names present — move any edits (accepted advisories, registry rows) into the new file, then \`git rm\` the old one:\n\n${both.join("\n")}\n\n`
|
|
671
|
+
: "") +
|
|
672
|
+
`In the same commit, replace each old path with its new one in \`.github/workflows/*.yml\`, \`.husky/pre-push\`, \`package.json\` and the files under \`scripts/ci/\` (the scripts name their JSON files): ${pairs}. Then \`grep -rn -E "(^|[^a-z-])(check-capstone|check-dependency-audit|check-accepted-divergences|accepted-advisories|accepted-divergences|resolve-push-base)(\\.test)?\\.(mjs|json)" .github .husky package.json scripts/ci\` prints nothing.`,
|
|
673
|
+
};
|
|
674
|
+
}
|
|
624
675
|
/**
|
|
625
676
|
* Detect whether the consumer composed a gate on bkit's `Detect Direct Push` step
|
|
626
677
|
* outputs (`should_force_build` / `should_run_full`). The bkit-ci.yml template ships these
|
|
@@ -681,8 +732,7 @@ export function detectRunLevelsNotComposed(cwd) {
|
|
|
681
732
|
detect: `${ciRel} ships bkit's \`Detect Direct Push\` step outputs (\`should_force_build\`, \`should_run_full\`, \`cache.outputs.skip\`) but no consumer-side workflow or step gates on them.`,
|
|
682
733
|
action: "`docs/deployments.md` documents bkit's none / partial / full run-level shape — the matrix is documentation-only until you compose at least one consumer-side gate. Examples:\n\n" +
|
|
683
734
|
" - A deploy job: `if: steps.detect.outputs.should_force_build == 'true' || github.ref == 'refs/heads/main'`\n" +
|
|
684
|
-
" - An E2E job: enable the `bkit-stub:e2e` block (which already gates on `should_run_full`).\n" +
|
|
685
|
-
" - A smoke workflow: copy the `bkit-stub:smoke` block to `.github/workflows/smoke.yml`.\n\n" +
|
|
735
|
+
" - An E2E job: enable the `bkit-stub:e2e` block (which already gates on `should_run_full`).\n\n" +
|
|
686
736
|
`If your consumer doesn't need run-level tiers (single-track CI, no preview deploys), dismiss by removing the \`Detect Direct Push\` step from ${ciRel}. Note this also disables \`[force cache]\` / \`[force build]\` / \`[force full]\` tag detection.`,
|
|
687
737
|
};
|
|
688
738
|
}
|
|
@@ -11,8 +11,8 @@ import { detectOpencodeYmlProviderDrift } from "../../install/modules/opencode.j
|
|
|
11
11
|
import { detectManagedDuplicate, detectManagedStale } from "./managed.js";
|
|
12
12
|
import { buildCloudDashboardsAdvisory, detectCiRouterSecrets, detectGhMcpToken } from "./auth.js";
|
|
13
13
|
import { buildCloudSetupAdvisory, buildGithubProjectAdvisory, buildGithubProjectTokenScopeAdvisory, buildTrackerSetupAdvisory, detectActionsWritePermissions, detectMainBranchProtection, } from "./github.js";
|
|
14
|
-
import { buildDepUpdaterSetupAdvisory, detectBkitStubs, detectValePackageNotSynced, detectWorkflowLintToolsMissing, } from "./tools.js";
|
|
15
|
-
import { detectBkitCloudYmlAlwaysTrueGate, detectCiYmlCapstoneContractDrift, detectCiYmlMissingActionlint, detectCiYmlRunInjection, detectGhaFloatingTags, detectRunLevelsNotComposed, detectTaggedTestsWithoutCiHome, detectTestIntegrationEnv, detectTurboIntegrationInputs, } from "./ci-yml.js";
|
|
14
|
+
import { buildDepUpdaterSetupAdvisory, detectBkitStubs, detectValeMissing, detectValePackageNotSynced, detectWorkflowLintToolsMissing, } from "./tools.js";
|
|
15
|
+
import { detectBkitCloudYmlAlwaysTrueGate, detectCiScriptsOldNames, detectCiYmlCapstoneContractDrift, detectCiYmlMissingActionlint, detectCiYmlRunInjection, detectGhaFloatingTags, detectRunLevelsNotComposed, detectTaggedTestsWithoutCiHome, detectTestIntegrationEnv, detectTurboIntegrationInputs, } from "./ci-yml.js";
|
|
16
16
|
import { dropTipSilencedAdvisories, setupTipsChecklistLines, setupTipsMarkdownLines, } from "../tips/index.js";
|
|
17
17
|
// ---------------------------------------------------------------------------
|
|
18
18
|
// formatChecklist — pure renderer
|
|
@@ -109,7 +109,7 @@ export function renderAdvisoriesMarkdown(findings, opts, suppressed = [], tips =
|
|
|
109
109
|
// This is a generated, gitignored artifact — not authored prose. Advisory
|
|
110
110
|
// strings (and reproduced config snippets like `.vale.ini`'s `write-good.So =
|
|
111
111
|
// NO`) legitimately contain sentence-initial "So" and slop tokens. The shipped
|
|
112
|
-
// `lint:prose` globs on-disk `.agents/*.md`, so without this whole-file Vale
|
|
112
|
+
// `bkit:lint:prose` globs on-disk `.agents/*.md`, so without this whole-file Vale
|
|
113
113
|
// skip the husky hooks fail on a file the consumer cannot edit.
|
|
114
114
|
lines.push("<!-- vale off -->");
|
|
115
115
|
lines.push("");
|
|
@@ -265,7 +265,7 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
265
265
|
const ghMcpToken = detectGhMcpToken(cwd);
|
|
266
266
|
if (ghMcpToken)
|
|
267
267
|
phase3.push(ghMcpToken);
|
|
268
|
-
// Main branch protection — bkit's PR-base gates (build Step
|
|
268
|
+
// Main branch protection — bkit's PR-base gates (build Step 16, ship Step 2)
|
|
269
269
|
// assert feat/* PRs target dev. Enforcing it at the GitHub layer needs branch
|
|
270
270
|
// protection on main restricting merges to PRs from dev.
|
|
271
271
|
const protectionStatus = detectMainBranchProtection();
|
|
@@ -337,6 +337,10 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
337
337
|
const cloudGate = detectBkitCloudYmlAlwaysTrueGate(cwd);
|
|
338
338
|
if (cloudGate)
|
|
339
339
|
phase3.push(cloudGate);
|
|
340
|
+
// CI template copies named without the `bkit-` prefix.
|
|
341
|
+
const ciScriptNames = detectCiScriptsOldNames(cwd);
|
|
342
|
+
if (ciScriptNames)
|
|
343
|
+
phase3.push(ciScriptNames);
|
|
340
344
|
// Self-installed opencode.yml (/oc handler) drifted from the installed opencode provider —
|
|
341
345
|
// it hardcodes a model + secret that `bkit install --opencode=` does not rewrite. Not for
|
|
342
346
|
// claude.yml (its @claude handler is provider-fixed). bkit-cloud.yml self-syncs, so exempt.
|
|
@@ -375,6 +379,10 @@ export function runPostInstallCheck(preflightAdvisories, cwd = process.cwd(), su
|
|
|
375
379
|
const runLevels = detectRunLevelsNotComposed(cwd);
|
|
376
380
|
if (runLevels)
|
|
377
381
|
phase3.push(runLevels);
|
|
382
|
+
// vale missing while bkit:lint:prose runs the prose gate
|
|
383
|
+
const valeMissing = detectValeMissing(cwd);
|
|
384
|
+
if (valeMissing)
|
|
385
|
+
phase3.push(valeMissing);
|
|
378
386
|
// vale not synced
|
|
379
387
|
const vale = detectValePackageNotSynced(cwd);
|
|
380
388
|
if (vale)
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
import * as fs from "node:fs";
|
|
4
4
|
import * as path from "node:path";
|
|
5
5
|
import { spawnSync } from "node:child_process";
|
|
6
|
+
import { readPackageJson } from "../../shared/package-json.js";
|
|
6
7
|
import { ciWorkflowPath, readBkitConfig } from "../../shared/settings.js";
|
|
8
|
+
import { DEP_UPDATER_NAMES, findDepUpdaterConfigs, } from "../../shared/dep-updater.js";
|
|
7
9
|
/** True when `cmd --version` runs (binary on PATH, exits 0). */
|
|
8
10
|
function toolVersionRuns(cmd) {
|
|
9
11
|
const res = spawnSync(cmd, ["--version"], {
|
|
@@ -12,13 +14,36 @@ function toolVersionRuns(cmd) {
|
|
|
12
14
|
});
|
|
13
15
|
return res.status === 0;
|
|
14
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* Detect a prose gate that cannot run here: package.json `bkit:lint:prose` calls `bkit ci prose`,
|
|
19
|
+
* which fails without vale, and vale is not on PATH. Null when the gate is not adopted.
|
|
20
|
+
*/
|
|
21
|
+
export function detectValeMissing(cwd) {
|
|
22
|
+
const read = readPackageJson(cwd);
|
|
23
|
+
if (!read.ok)
|
|
24
|
+
return null;
|
|
25
|
+
const scripts = read.pkg["scripts"];
|
|
26
|
+
const lintProse = typeof scripts === "object" && scripts !== null
|
|
27
|
+
? scripts["bkit:lint:prose"]
|
|
28
|
+
: undefined;
|
|
29
|
+
if (typeof lintProse !== "string" || !lintProse.includes("bkit ci prose"))
|
|
30
|
+
return null;
|
|
31
|
+
if (toolVersionRuns("vale"))
|
|
32
|
+
return null;
|
|
33
|
+
return {
|
|
34
|
+
id: "vale-not-installed",
|
|
35
|
+
severity: "advisory",
|
|
36
|
+
detect: "package.json `bkit:lint:prose` runs `bkit ci prose`, but vale is not on PATH — the prose gate fails, so every pre-push gate that runs `bkit:lint:prose` fails on this machine.",
|
|
37
|
+
action: "Install vale, then download its styles:\n\n brew install vale # macOS; other platforms: https://vale.sh/docs/install\n vale sync\n\nCI and the cloud templates install vale already; this is for local machines.",
|
|
38
|
+
};
|
|
39
|
+
}
|
|
15
40
|
/**
|
|
16
41
|
* Detect whether vale is installed but write-good styles are not synced.
|
|
17
|
-
* Returns null if vale is not on PATH (
|
|
42
|
+
* Returns null if vale is not on PATH (`detectValeMissing` covers that case).
|
|
18
43
|
*/
|
|
19
44
|
export function detectValePackageNotSynced(cwd) {
|
|
20
45
|
if (!toolVersionRuns("vale"))
|
|
21
|
-
return null; // vale not on PATH —
|
|
46
|
+
return null; // vale not on PATH — detectValeMissing
|
|
22
47
|
if (fs.existsSync(path.join(cwd, ".vale", "styles", "write-good")))
|
|
23
48
|
return null;
|
|
24
49
|
// `vale sync` reads `Packages` from .vale.ini; without one it has nothing to download.
|
|
@@ -27,14 +52,14 @@ export function detectValePackageNotSynced(cwd) {
|
|
|
27
52
|
id: "vale-package-not-synced",
|
|
28
53
|
severity: "advisory",
|
|
29
54
|
detect: "vale is on PATH but the repo has no .vale.ini and .vale/styles/write-good/ is absent — prose linting does not run.",
|
|
30
|
-
action: "Adopt bkit's Vale template first: copy .bkit/templates/.vale.ini to .vale.ini and .bkit/templates/.vale/styles/
|
|
55
|
+
action: "Adopt bkit's Vale template first: copy .bkit/templates/.vale.ini to .vale.ini and .bkit/templates/.vale/styles/Bkit/*.yml to .vale/styles/Bkit/. Then run `vale sync` (one-time per repo) to download the write-good package the copied .vale.ini names. `vale sync` reads its package list from .vale.ini, so it cannot fetch write-good before that file exists.",
|
|
31
56
|
};
|
|
32
57
|
}
|
|
33
58
|
return {
|
|
34
59
|
id: "vale-package-not-synced",
|
|
35
60
|
severity: "advisory",
|
|
36
61
|
detect: "vale is on PATH but .vale/styles/write-good/ is absent — vale packages not synced.",
|
|
37
|
-
action: "Run `vale sync` (one-time per repo) to download the write-good package. lint:prose tries to self-heal this (copy from the main worktree, then `vale sync`) and
|
|
62
|
+
action: "Run `vale sync` (one-time per repo) to download the write-good package. bkit:lint:prose tries to self-heal this (copy from the main worktree, then `vale sync`) and fails if it cannot.",
|
|
38
63
|
};
|
|
39
64
|
}
|
|
40
65
|
/**
|
|
@@ -91,10 +116,6 @@ const BKIT_STUBS = [
|
|
|
91
116
|
id: "e2e",
|
|
92
117
|
description: "Run `pnpm test:e2e` gated on `should_run_full` (the `[force full]` commit/PR tag) or `needs_e2e` (auto-force-e2e). Pairs with vercel-await for PR-time runs against the preview deployment.",
|
|
93
118
|
},
|
|
94
|
-
{
|
|
95
|
-
id: "smoke",
|
|
96
|
-
description: "Post-CI smoke test triggered by `workflow_run` after main-CI succeeds. Cannot share a file with push/pull_request triggers — copy the commented YAML to a new `.github/workflows/smoke.yml` file.",
|
|
97
|
-
},
|
|
98
119
|
{
|
|
99
120
|
id: "coverage",
|
|
100
121
|
description: "Report vitest coverage on PRs and in every run's job summary via davelosert/vitest-coverage-report-action (free, runs inside Actions with GITHUB_TOKEN — no third-party service, safe for private repos). PER-TIER: unit and integration are measured and commented SEPARATELY (a single merged number lets integration mask a hollow unit suite — coverage is a union). Report-only by default: nothing fails the build until a threshold is set. Enabling (documented in the stub header): (1) add `@vitest/coverage-v8` (pinned to your vitest major) plus a vitest.config coverage block with `reporter: ['text','json-summary','json']` and `reportOnFailure: true` — json-summary + json are load-bearing (the action reads coverage-summary.json and coverage-final.json); (2) run coverage TWICE into separate dirs — unit → coverage/unit (exclude integration files), integration → coverage/integration — so each tier gets its own honest number (avoids the last-writer-wins clobber a second same-dir run would cause); (3) add a JOB-LEVEL permissions block to bkit-tests-unit with `contents: read` + `pull-requests: write` — job-level REPLACES the workflow-level block (not additive), so omitting `contents: read` breaks the checkout; (4) two report steps with distinct `name:` (unit / integration) pointing at each dir's coverage-summary.json + coverage-final.json; the unit step runs on every event (`if: !cancelled()` plus a `hashFiles` guard on its summary), sets `vite-config-path: vitest.unit.config.ts` so the job summary and PR comment show the floor as the target, and comments only on same-repo PRs (`comment-on: pr`, else `none`). SEPARATE LANES (one job per tier): put the integration run + report + its OWN pull-requests: write block in bkit-tests-integration, not bkit-tests-unit — each lane posts its own comment. Thresholds are opt-in and PER TIER: UNIT is the gate — put `coverage.thresholds.branches` in a `vitest.unit.config.ts` (`mergeConfig` over vitest.config) that ONLY the unit run loads via `-c` (vitest coverage is per-RUN/root config, NOT per-project — `projects` does not scope it and a `thresholds` block in vitest.config reds BOTH runs; the report action reads the same file as raw text, so keep the floor on one unquoted `branches: <n>` line and no other metric name + colon + number in it; branches is the meaningful floor, set to current and ratchet up). INTEGRATION is REPORT-ONLY — gate it on EXECUTION (the capstone's integration_ran > 0), not a %: a whole-repo integration % is denominator-noise (it covers boundaries/flows, not pure logic). For a real integration %, add `--coverage.include=src/server/**` on the integration run (same CLI-flag idiom as --exclude) then set a floor, or ratchet from current — never a picked number. Fork PRs: GITHUB_TOKEN is read-only, so the unit step sets `comment-on: none` there (its job summary still lands) and the integration step keeps the `head.repo == repo` guard (or use the action's workflow_run two-workflow pattern). Guard the integration report on `hashFiles('coverage/integration/coverage-summary.json') != ''` so a repo with no integration tier skips it cleanly.",
|
|
@@ -168,7 +189,7 @@ const BKIT_STUBS = [
|
|
|
168
189
|
},
|
|
169
190
|
{
|
|
170
191
|
id: "health",
|
|
171
|
-
description: "Copy
|
|
192
|
+
description: "Copy .bkit/templates/.github/workflows/bkit-health.yml to .github/workflows/bkit-health.yml, then replace {{DEFAULT_BRANCH}} and {{PRODUCTION_URL}} and swap the Vercel lookup for your host's API. It runs after every finished CI run on the default branch, green or red, probes production only when production serves that run's commit, and fails when it cannot tell. Not a required check. DROP if you have no deployed health URL.",
|
|
172
193
|
},
|
|
173
194
|
];
|
|
174
195
|
export function detectBkitStubs(cwd) {
|
|
@@ -244,32 +265,23 @@ const UPDATER_EXAMPLE_PATHS = [
|
|
|
244
265
|
".bkit/templates/.github/workflows/bkit-renovate.yml",
|
|
245
266
|
".bkit/templates/.github/dependabot.yml",
|
|
246
267
|
].join("\n ");
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
const dependabotYaml = path.join(cwd, ".github", "dependabot.yaml");
|
|
252
|
-
const renovate = fs.existsSync(renovateJson5)
|
|
253
|
-
? renovateJson5
|
|
254
|
-
: fs.existsSync(renovateJson)
|
|
255
|
-
? renovateJson
|
|
256
|
-
: null;
|
|
257
|
-
const dependabot = fs.existsSync(dependabotYml)
|
|
258
|
-
? dependabotYml
|
|
259
|
-
: fs.existsSync(dependabotYaml)
|
|
260
|
-
? dependabotYaml
|
|
261
|
-
: null;
|
|
262
|
-
return { renovate, dependabot };
|
|
263
|
-
}
|
|
268
|
+
const UPDATER_EXAMPLE = {
|
|
269
|
+
renovate: ".bkit/templates/.github/renovate.json5",
|
|
270
|
+
dependabot: ".bkit/templates/.github/dependabot.yml",
|
|
271
|
+
};
|
|
264
272
|
/**
|
|
265
|
-
* Read-only dependency-updater check.
|
|
273
|
+
* Read-only dependency-updater check: `bkit.dependencies.updater` against the configs present.
|
|
266
274
|
*
|
|
267
275
|
* - Both Renovate and Dependabot configs → they open competing PRs.
|
|
268
|
-
* -
|
|
276
|
+
* - One config, and the setting does not name it → blocker.
|
|
277
|
+
* - The setting names an updater whose config is absent → blocker.
|
|
278
|
+
* - No updater config, workflows exist, and the setting is unset → point
|
|
269
279
|
* at the example templates.
|
|
270
280
|
*/
|
|
271
281
|
export function buildDepUpdaterSetupAdvisory(cwd) {
|
|
272
|
-
const
|
|
282
|
+
const configs = findDepUpdaterConfigs(cwd);
|
|
283
|
+
const { renovate, dependabot } = configs;
|
|
284
|
+
const setting = readBkitConfig(cwd).depUpdater;
|
|
273
285
|
if (renovate && dependabot) {
|
|
274
286
|
return {
|
|
275
287
|
id: "dep-updater-both",
|
|
@@ -278,9 +290,37 @@ export function buildDepUpdaterSetupAdvisory(cwd) {
|
|
|
278
290
|
action: "Keep one. Delete the config you are not using, and turn off that bot in the host UI.",
|
|
279
291
|
};
|
|
280
292
|
}
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
293
|
+
const found = renovate ? "renovate" : dependabot ? "dependabot" : null;
|
|
294
|
+
if (found) {
|
|
295
|
+
if (setting === found)
|
|
296
|
+
return null;
|
|
297
|
+
const name = DEP_UPDATER_NAMES[found];
|
|
298
|
+
const file = configs[found];
|
|
299
|
+
if (setting === null) {
|
|
300
|
+
return {
|
|
301
|
+
id: "dep-updater-unset",
|
|
302
|
+
severity: "blocker",
|
|
303
|
+
detect: `${name} config found (\`${file}\`), but \`bkit.dependencies.updater\` is not \`"${found}"\`.`,
|
|
304
|
+
action: `Set \`bkit.dependencies.updater\` to \`"${found}"\` in package.json. \`bkit upgrade\` sets it when the field is empty.`,
|
|
305
|
+
};
|
|
306
|
+
}
|
|
307
|
+
return {
|
|
308
|
+
id: "dep-updater-mismatch",
|
|
309
|
+
severity: "blocker",
|
|
310
|
+
detect: `\`bkit.dependencies.updater\` is \`"${setting}"\`, but the repo has a ${name} config (\`${file}\`).`,
|
|
311
|
+
action: `Set \`bkit.dependencies.updater\` to \`"${found}"\` in package.json, or delete \`${file}\` and turn ${name} off in the host UI.`,
|
|
312
|
+
};
|
|
313
|
+
}
|
|
314
|
+
if (setting === "renovate" || setting === "dependabot") {
|
|
315
|
+
const name = DEP_UPDATER_NAMES[setting];
|
|
316
|
+
return {
|
|
317
|
+
id: "dep-updater-mismatch",
|
|
318
|
+
severity: "blocker",
|
|
319
|
+
detect: `\`bkit.dependencies.updater\` is \`"${setting}"\`, but no ${name} config was found, so nothing bumps dependencies.`,
|
|
320
|
+
action: `Copy \`${UPDATER_EXAMPLE[setting]}\` into place and own it, or set \`bkit.dependencies.updater\` to the updater you run, or \`"none"\`. See .bkit/templates.md.`,
|
|
321
|
+
};
|
|
322
|
+
}
|
|
323
|
+
if (setting === "none")
|
|
284
324
|
return null;
|
|
285
325
|
if (!fs.existsSync(path.join(cwd, ".github", "workflows")))
|
|
286
326
|
return null;
|
|
@@ -290,6 +330,6 @@ export function buildDepUpdaterSetupAdvisory(cwd) {
|
|
|
290
330
|
detect: "No dependency updater config. SHA-pinned actions and package bumps will not refresh on their own.",
|
|
291
331
|
action: "Copy one example and own it:\n\n" +
|
|
292
332
|
` ${UPDATER_EXAMPLE_PATHS}\n\n` +
|
|
293
|
-
'Use one updater, not both
|
|
333
|
+
'Use one updater, not both, and set `bkit.dependencies.updater` to its name (`"renovate"` or `"dependabot"`) in package.json. To silence this advisory, set it to `"none"`. See .bkit/templates.md.',
|
|
294
334
|
};
|
|
295
335
|
}
|