@cbartens/bkit 5.5.1 → 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 +167 -154
- package/.bkit/core/.agents/context.md +95 -29
- package/.bkit/core/.agents/docs.md +18 -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 +112 -102
- package/.bkit/core/.agents/skills.md +63 -15
- package/.bkit/core/.bkit/README.md +167 -154
- package/.bkit/core/.bkit/authoring.md +747 -0
- package/.bkit/core/.bkit/cli.md +407 -0
- package/.bkit/core/.bkit/cloud.md +283 -195
- package/.bkit/core/.bkit/comparison.md +45 -43
- package/.bkit/core/.bkit/install.md +166 -95
- package/.bkit/core/.bkit/jsonl.md +339 -196
- package/.bkit/core/.bkit/pipeline.md +142 -145
- package/.bkit/core/.bkit/prompts.md +295 -264
- package/.bkit/core/.bkit/providers.md +460 -277
- package/.bkit/core/.bkit/router.md +69 -0
- package/.bkit/core/.bkit/templates.md +530 -256
- package/.bkit/core/.bkit/trackers.md +116 -65
- package/.bkit/core/.bkit/workflows.md +742 -618
- 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 +6 -80
- package/.bkit/core/docs/templates/bkit-audit-accessibility.md +128 -130
- package/.bkit/core/docs/templates/bkit-audit-adoption.md +104 -94
- package/.bkit/core/docs/templates/bkit-audit-agents.md +96 -98
- package/.bkit/core/docs/templates/bkit-audit-aio-seo.md +100 -103
- package/.bkit/core/docs/templates/bkit-audit-analytics.md +141 -107
- package/.bkit/core/docs/templates/bkit-audit-annotations.md +99 -97
- package/.bkit/core/docs/templates/bkit-audit-app-performance.md +122 -121
- package/.bkit/core/docs/templates/bkit-audit-app-store.md +158 -101
- package/.bkit/core/docs/templates/bkit-audit-architecture.md +114 -96
- package/.bkit/core/docs/templates/bkit-audit-ci-performance.md +76 -97
- package/.bkit/core/docs/templates/bkit-audit-config.md +123 -101
- package/.bkit/core/docs/templates/bkit-audit-cost.md +86 -99
- package/.bkit/core/docs/templates/bkit-audit-coverage.md +76 -93
- package/.bkit/core/docs/templates/bkit-audit-database.md +102 -95
- package/.bkit/core/docs/templates/bkit-audit-dead-code.md +165 -108
- package/.bkit/core/docs/templates/bkit-audit-deferrals.md +115 -109
- package/.bkit/core/docs/templates/bkit-audit-dependencies.md +265 -113
- package/.bkit/core/docs/templates/bkit-audit-documentation.md +119 -118
- package/.bkit/core/docs/templates/bkit-audit-duplication.md +140 -111
- package/.bkit/core/docs/templates/bkit-audit-failures.md +111 -106
- package/.bkit/core/docs/templates/bkit-audit-flakes.md +100 -99
- package/.bkit/core/docs/templates/bkit-audit-gates.md +107 -103
- package/.bkit/core/docs/templates/bkit-audit-issues.md +105 -105
- package/.bkit/core/docs/templates/bkit-audit-llm.md +134 -85
- package/.bkit/core/docs/templates/bkit-audit-logs.md +124 -125
- package/.bkit/core/docs/templates/bkit-audit-models.md +99 -78
- package/.bkit/core/docs/templates/bkit-audit-privacy.md +56 -76
- package/.bkit/core/docs/templates/bkit-audit-prompts.md +63 -78
- package/.bkit/core/docs/templates/bkit-audit-red-team.md +125 -93
- package/.bkit/core/docs/templates/bkit-audit-reliability.md +97 -96
- package/.bkit/core/docs/templates/bkit-audit-repo.md +170 -98
- package/.bkit/core/docs/templates/bkit-audit-security.md +207 -121
- package/.bkit/core/docs/templates/bkit-audit-slop.md +78 -95
- package/.bkit/core/docs/templates/bkit-audit-testing.md +163 -139
- package/.bkit/core/docs/templates/bkit-audit-usability.md +114 -96
- package/.bkit/core/docs/templates/bkit-plan.md +158 -281
- package/.bkit/core/engine/checks/after/auth.ts +40 -37
- package/.bkit/core/engine/checks/after/ci-yml.ts +104 -31
- package/.bkit/core/engine/checks/after/github.ts +95 -17
- package/.bkit/core/engine/checks/after/index.ts +21 -8
- package/.bkit/core/engine/checks/after/suppression.ts +8 -5
- package/.bkit/core/engine/checks/after/tools.ts +125 -123
- package/.bkit/core/engine/checks/before/context-fetch.ts +227 -33
- package/.bkit/core/engine/checks/before/env.ts +3 -3
- package/.bkit/core/engine/checks/before/files.ts +5 -4
- package/.bkit/core/engine/checks/before/index.ts +25 -1
- package/.bkit/core/engine/checks/before/repo.ts +208 -2
- package/.bkit/core/engine/checks/status-holes.ts +916 -123
- package/.bkit/core/engine/checks/tips/catalogue.ts +82 -20
- package/.bkit/core/engine/checks/tips/detect.ts +66 -0
- package/.bkit/core/engine/checks/tips/index.ts +52 -11
- package/.bkit/core/engine/cli.ts +251 -130
- package/.bkit/core/engine/commands/analysis.ts +282 -199
- 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/comply.ts +77 -103
- package/.bkit/core/engine/commands/install/doctor.ts +2 -2
- package/.bkit/core/engine/commands/install/install.ts +57 -18
- package/.bkit/core/engine/commands/install/uninstall.ts +86 -55
- package/.bkit/core/engine/commands/install/upgrade.ts +32 -15
- package/.bkit/core/engine/commands/land.ts +139 -18
- package/.bkit/core/engine/commands/lib.ts +381 -22
- package/.bkit/core/engine/commands/registry.ts +10 -2
- package/.bkit/core/engine/commands/setup/setup.ts +8 -7
- package/.bkit/core/engine/commands/stats.ts +260 -0
- package/.bkit/core/engine/commands/tips.ts +10 -5
- package/.bkit/core/engine/commands/workflow/branches.ts +2215 -176
- package/.bkit/core/engine/commands/workflow/challenge.ts +748 -0
- package/.bkit/core/engine/commands/workflow/completeness.ts +109 -0
- package/.bkit/core/engine/commands/workflow/context.ts +1249 -47
- package/.bkit/core/engine/commands/workflow/counters.ts +483 -95
- package/.bkit/core/engine/commands/workflow/decisions.ts +585 -0
- package/.bkit/core/engine/commands/workflow/disk.ts +238 -56
- package/.bkit/core/engine/commands/workflow/fids.ts +811 -33
- package/.bkit/core/engine/commands/workflow/issues.ts +413 -64
- package/.bkit/core/engine/commands/workflow/ledgers.ts +1333 -36
- package/.bkit/core/engine/commands/workflow/locks.ts +28 -2
- package/.bkit/core/engine/commands/workflow/plan-blocks.ts +691 -0
- package/.bkit/core/engine/commands/workflow/plan-versions.ts +21 -0
- package/.bkit/core/engine/commands/workflow/plans.ts +257 -0
- package/.bkit/core/engine/commands/workflow/prs.ts +178 -33
- package/.bkit/core/engine/commands/workflow/repo.ts +66 -8
- package/.bkit/core/engine/commands/workflow/roadmap.ts +72 -22
- package/.bkit/core/engine/commands/workflow/run-facts.ts +492 -0
- package/.bkit/core/engine/commands/workflow/runs.ts +827 -79
- package/.bkit/core/engine/commands/workflow/runtime.ts +25 -1
- package/.bkit/core/engine/commands/workflow/skills.ts +1 -0
- package/.bkit/core/engine/commands/workflow/status.ts +329 -33
- package/.bkit/core/engine/commands/workflow/step-table.ts +381 -0
- package/.bkit/core/engine/commands/workflow/steps.ts +841 -105
- package/.bkit/core/engine/commands/workflow/summary-findings.ts +177 -0
- package/.bkit/core/engine/commands/workflow/summary.ts +544 -0
- 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 +2124 -330
- package/.bkit/core/engine/commands/workflow/tracker.ts +1195 -0
- package/.bkit/core/engine/commands/workflow/workflows.ts +1197 -235
- package/.bkit/core/engine/commands/workflow/worktrees.ts +543 -24
- 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 +67 -17
- package/.bkit/core/engine/install/modules/antigravity.ts +3 -2
- package/.bkit/core/engine/install/modules/cloud.ts +24 -16
- package/.bkit/core/engine/install/modules/codex.ts +15 -2
- package/.bkit/core/engine/install/modules/core.ts +1196 -45
- package/.bkit/core/engine/install/modules/cursor.ts +6 -6
- package/.bkit/core/engine/install/modules/opencode.ts +18 -6
- package/.bkit/core/engine/install/template-notes.ts +130 -0
- package/.bkit/core/engine/install/version-file.ts +9 -4
- 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/migrate.ts +92 -0
- package/.bkit/core/engine/ledgers/status.ts +249 -21
- package/.bkit/core/engine/ledgers/telemetry.ts +1397 -253
- package/.bkit/core/engine/render/hosts.ts +118 -14
- package/.bkit/core/engine/render/models.ts +12 -0
- package/.bkit/core/engine/shared/bkit-latest.ts +26 -4
- package/.bkit/core/engine/shared/branches.ts +4 -1
- package/.bkit/core/engine/shared/dep-updater.ts +60 -0
- package/.bkit/core/engine/shared/egress.ts +8 -1
- package/.bkit/core/engine/shared/json.ts +25 -7
- package/.bkit/core/engine/shared/package-manager.ts +9 -0
- package/.bkit/core/engine/shared/settings.ts +243 -31
- package/.bkit/core/engine/shared/text.ts +361 -0
- 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 +215 -0
- package/.bkit/core/engine/tools/instructions-sources.ts +832 -0
- package/.bkit/core/engine/tools/instructions.ts +1802 -0
- package/.bkit/core/hooks/antigravity-hook.js +25 -10
- package/.bkit/core/hooks/gateguard-engine.js +54 -29
- package/.bkit/core/hooks/guardrails-shell.js +4 -5
- package/.bkit/core/hooks/guardrails-tiers.js +10 -4
- 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 +202 -94
- package/.bkit/core/prompts/bkit-build-challenge-1.md +76 -34
- package/.bkit/core/prompts/bkit-build-challenge-2.md +85 -38
- package/.bkit/core/prompts/bkit-build-install-skills.md +50 -28
- package/.bkit/core/prompts/bkit-build-plan-convert.md +85 -0
- package/.bkit/core/prompts/bkit-build-plan-current.md +59 -36
- package/.bkit/core/prompts/bkit-build-plan-gaps-remediate.md +101 -36
- 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 +104 -43
- package/.bkit/core/prompts/bkit-debug-abort-handover.md +47 -32
- package/.bkit/core/prompts/bkit-debug-failure-diagnose.md +109 -57
- package/.bkit/core/prompts/bkit-debug-failure-remediate.md +65 -39
- package/.bkit/core/prompts/bkit-debug-failure-reproduce.md +53 -31
- package/.bkit/core/prompts/bkit-debug-failure-soak.md +65 -34
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-1.md +46 -31
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-2.md +45 -31
- package/.bkit/core/prompts/bkit-design-brainstorm-ideate-3.md +43 -30
- package/.bkit/core/prompts/bkit-design-generate.md +80 -46
- package/.bkit/core/prompts/bkit-design-organise.md +83 -32
- package/.bkit/core/prompts/bkit-design-review-1.md +70 -50
- package/.bkit/core/prompts/bkit-design-review-2.md +65 -46
- package/.bkit/core/prompts/bkit-design-spike.md +64 -40
- package/.bkit/core/prompts/bkit-design-update.md +53 -28
- package/.bkit/core/prompts/bkit-plan-generate.md +101 -29
- package/.bkit/core/prompts/bkit-plan-review-1.md +78 -41
- package/.bkit/core/prompts/bkit-plan-review-2.md +78 -35
- package/.bkit/core/prompts/bkit-plan-scope-check.md +116 -0
- package/.bkit/core/prompts/bkit-plan-update.md +86 -31
- package/.bkit/core/prompts/bkit-ship-conflict-resolve.md +94 -50
- package/.bkit/core/prompts/bkit-ship-deferred-sweep.md +91 -41
- package/.bkit/core/prompts/bkit-ship-update-docs.md +45 -24
- package/.bkit/core/prompts/bkit-utility-compress-markdown.md +65 -49
- package/.bkit/core/prompts/bkit-utility-update-decisions.md +87 -42
- package/.bkit/core/prompts/bkit-utility-update-deferrals.md +81 -37
- package/.bkit/core/prompts/bkit-utility-update-documentation.md +43 -25
- package/.bkit/core/prompts/bkit-utility-update-failures.md +84 -37
- package/.bkit/core/prompts/bkit-utility-update-knowledge.md +88 -42
- package/.bkit/core/prompts/bkit-utility-update-roadmap.md +92 -39
- package/.bkit/core/prompts/bkit-utility-update-tracker.md +159 -60
- package/.bkit/core/workflows/bkit-auto.md +89 -58
- package/.bkit/core/workflows/bkit-build.md +967 -517
- package/.bkit/core/workflows/bkit-debug.md +555 -387
- package/.bkit/core/workflows/bkit-design.md +319 -283
- package/.bkit/core/workflows/bkit-plan.md +319 -342
- package/.bkit/core/workflows/bkit-ship.md +525 -328
- package/.bkit/shared/.agents/plugins/bkit/hooks.json +10 -0
- package/.bkit/shared/.bkit/.env.example +2 -2
- package/.bkit/shared/.claude/bkit-cloud.md +12 -10
- package/.bkit/shared/.claude/settings.json +14 -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/.cursor/mcp.json +1 -1
- package/.bkit/shared/.cursor/rules/bkit-rules.mdc +1 -1
- package/.bkit/shared/.gitattributes +1 -1
- package/.bkit/shared/.mcp.json +1 -1
- package/.bkit/shared/.opencode/opencode.json +12 -1
- package/.bkit/shared/CLAUDE.md +6 -2
- package/.bkit/shared/GEMINI.md +5 -2
- package/.bkit/shared/docs/architecture.md +4 -7
- package/.bkit/shared/docs/data-schema.md +4 -7
- package/.bkit/shared/docs/deployments.md +241 -168
- 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 +289 -174
- 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 +45 -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 +54 -51
- package/.bkit/templates/.github/workflows/bkit-cloud.yml +34 -33
- 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 +96 -36
- package/.bkit/templates/.prettierignore +6 -0
- 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 +10 -2
- 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 +231 -0
- package/README.md +278 -89
- package/dist/checks/after/auth.js +36 -33
- package/dist/checks/after/ci-yml.js +91 -30
- package/dist/checks/after/github.js +91 -17
- package/dist/checks/after/index.js +22 -11
- package/dist/checks/after/suppression.js +8 -5
- package/dist/checks/after/tools.js +111 -114
- package/dist/checks/before/context-fetch.js +218 -33
- package/dist/checks/before/env.js +3 -3
- package/dist/checks/before/files.js +5 -3
- package/dist/checks/before/index.js +20 -3
- package/dist/checks/before/repo.js +197 -2
- package/dist/checks/status-holes.js +739 -114
- package/dist/checks/tips/catalogue.js +70 -19
- package/dist/checks/tips/detect.js +62 -0
- package/dist/checks/tips/index.js +51 -9
- package/dist/cli.js +234 -124
- package/dist/commands/analysis.js +174 -141
- 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/comply.js +54 -91
- package/dist/commands/install/doctor.js +2 -2
- package/dist/commands/install/install.js +50 -19
- package/dist/commands/install/uninstall.js +82 -55
- package/dist/commands/install/upgrade.js +21 -11
- package/dist/commands/land.js +137 -17
- package/dist/commands/lib.js +295 -21
- package/dist/commands/registry.js +10 -2
- package/dist/commands/setup/setup.js +8 -7
- package/dist/commands/stats.js +175 -0
- package/dist/commands/tips.js +7 -3
- package/dist/commands/workflow/branches.js +1873 -152
- package/dist/commands/workflow/challenge.js +609 -0
- package/dist/commands/workflow/completeness.js +97 -0
- package/dist/commands/workflow/context.js +1045 -46
- package/dist/commands/workflow/counters.js +385 -86
- package/dist/commands/workflow/decisions.js +484 -0
- package/dist/commands/workflow/disk.js +214 -56
- package/dist/commands/workflow/fids.js +706 -33
- package/dist/commands/workflow/issues.js +349 -59
- package/dist/commands/workflow/ledgers.js +1123 -37
- package/dist/commands/workflow/locks.js +26 -2
- package/dist/commands/workflow/plan-blocks.js +501 -0
- package/dist/commands/workflow/plan-versions.js +22 -0
- package/dist/commands/workflow/plans.js +205 -0
- package/dist/commands/workflow/prs.js +154 -35
- package/dist/commands/workflow/repo.js +58 -8
- package/dist/commands/workflow/roadmap.js +58 -23
- package/dist/commands/workflow/run-facts.js +421 -0
- package/dist/commands/workflow/runs.js +670 -72
- package/dist/commands/workflow/runtime.js +15 -1
- package/dist/commands/workflow/skills.js +1 -0
- package/dist/commands/workflow/status.js +282 -34
- package/dist/commands/workflow/step-table.js +308 -0
- package/dist/commands/workflow/steps.js +703 -96
- package/dist/commands/workflow/summary-findings.js +117 -0
- package/dist/commands/workflow/summary.js +388 -0
- 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 +1695 -305
- package/dist/commands/workflow/tracker.js +983 -0
- package/dist/commands/workflow/workflows.js +1014 -222
- package/dist/commands/workflow/worktrees.js +432 -26
- package/dist/install/cloud-env.js +233 -99
- package/dist/install/context-ci-workflow.js +85 -0
- package/dist/install/manifest.js +64 -17
- package/dist/install/modules/antigravity.js +3 -2
- package/dist/install/modules/cloud.js +25 -16
- package/dist/install/modules/codex.js +12 -2
- package/dist/install/modules/core.js +1090 -48
- package/dist/install/modules/cursor.js +6 -6
- package/dist/install/modules/opencode.js +13 -7
- package/dist/install/template-notes.js +116 -0
- package/dist/install/version-file.js +9 -4
- package/dist/ledgers/compact.js +87 -0
- package/dist/ledgers/journal.js +233 -0
- package/dist/ledgers/migrate.js +81 -0
- package/dist/ledgers/status.js +176 -13
- package/dist/ledgers/telemetry.js +1010 -125
- package/dist/render/hosts.js +104 -14
- package/dist/render/models.js +12 -0
- package/dist/shared/bkit-latest.js +26 -4
- package/dist/shared/branches.js +3 -1
- package/dist/shared/dep-updater.js +49 -0
- package/dist/shared/egress.js +8 -1
- package/dist/shared/json.js +20 -7
- package/dist/shared/package-manager.js +6 -0
- package/dist/shared/settings.js +181 -24
- package/dist/shared/text.js +333 -0
- package/dist/shared/timeouts.js +2 -0
- package/dist/tools/cli-doc.js +97 -0
- package/dist/tools/grammar-density.js +183 -0
- package/dist/tools/instructions-sources.js +720 -0
- package/dist/tools/instructions.js +1623 -0
- package/package.json +156 -51
- package/.bkit/core/.bkit/lite.md +0 -73
- package/.bkit/core/engine/commands/harvest.ts +0 -459
- package/.bkit/core/engine/commands/workflow/workstreams.ts +0 -166
- package/.bkit/core/engine/tools/wording.ts +0 -748
- package/.bkit/core/prompts/bkit-build-challenge-reconcile.md +0 -69
- package/.bkit/core/prompts/bkit-build-challenge-remediate.md +0 -71
- package/.bkit/core/prompts/bkit-build-challenge-tests.md +0 -74
- package/.bkit/core/prompts/bkit-build-plan-execute.md +0 -76
- package/.bkit/core/prompts/bkit-build-summary.md +0 -94
- package/.bkit/core/prompts/bkit-debug-summary.md +0 -96
- package/.bkit/core/prompts/bkit-design-summary.md +0 -107
- package/.bkit/core/prompts/bkit-plan-complexity-check.md +0 -67
- package/.bkit/core/prompts/bkit-plan-complexity-split.md +0 -88
- package/.bkit/core/prompts/bkit-plan-review-3.md +0 -93
- package/.bkit/core/prompts/bkit-plan-scope-check-1.md +0 -85
- package/.bkit/core/prompts/bkit-plan-scope-check-2.md +0 -85
- package/.bkit/core/prompts/bkit-plan-summary.md +0 -107
- package/.bkit/core/prompts/bkit-ship-summary.md +0 -78
- package/.bkit/templates/scripts/ci/bkit-local-stack-lock.sh +0 -194
- package/dist/commands/harvest.js +0 -353
- package/dist/commands/workflow/workstreams.js +0 -143
- package/dist/tools/wording.js +0 -680
- /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,11 +4,12 @@
|
|
|
4
4
|
// `audit` / `utility` for the agents); `bkit tips` prints the top three;
|
|
5
5
|
// `.bkit/advisories.md` lists every firing tip under `Setup tips`.
|
|
6
6
|
//
|
|
7
|
-
// Array order is the priority:
|
|
8
|
-
//
|
|
9
|
-
//
|
|
10
|
-
//
|
|
11
|
-
//
|
|
7
|
+
// Array order is the priority: an outdated bkit first (every workflow runs its old text and
|
|
8
|
+
// misses its fixes), then comms (can workflows reach anything), change quality (design →
|
|
9
|
+
// build), delivery (debug → ship), running cost, nice-to-have, and setup-specific plumbing
|
|
10
|
+
// last. `workflows` names where a tip matters: a workflow shows its own tips first, in
|
|
11
|
+
// array order, then the rest. The upgrade and comms tips name every context, so they lead
|
|
12
|
+
// everywhere until fixed; the upgrade tip alone cannot be silenced.
|
|
12
13
|
//
|
|
13
14
|
// Text rules: `line`, `why`, `caution` and `ask` are for the person, in plain English, and
|
|
14
15
|
// never name an outside service — examples of specific services go in `steps`, which is
|
|
@@ -16,10 +17,12 @@
|
|
|
16
17
|
// section opener and in the README's "Templates ready to adopt" row; change all three in
|
|
17
18
|
// the same commit.
|
|
18
19
|
//
|
|
19
|
-
// Detection rules: every `fires` is local (files, settings, environment) — no network.
|
|
20
|
+
// Detection rules: every `fires` is local (files, settings, environment) — no network. The
|
|
21
|
+
// `cwd` it receives is the main checkout (checks/tips/index.ts `tipsBase`), never the
|
|
22
|
+
// calling worktree, so a tip reflects the repo the integration branch carries.
|
|
20
23
|
// Where an advisory already detects the gap, `fires` calls that detector and `advisories`
|
|
21
24
|
// names its ids, so the tip and the advisory can never disagree and one
|
|
22
|
-
// `bkit.
|
|
25
|
+
// `bkit.advisories.ignore` entry silences both.
|
|
23
26
|
import * as fs from "node:fs";
|
|
24
27
|
import * as path from "node:path";
|
|
25
28
|
import { machineStepsPath, REPO_STEPS } from "../../commands/workflow/disk.js";
|
|
@@ -30,13 +33,26 @@ import { buildTrackerSetupAdvisory } from "../after/github.js";
|
|
|
30
33
|
import { buildDepUpdaterSetupAdvisory } from "../after/tools.js";
|
|
31
34
|
import { detectInstalledHostModules } from "../../install/hosts.js";
|
|
32
35
|
import { readBkitConfig } from "../../shared/settings.js";
|
|
33
|
-
import { anyWorkflowMentions, claudeSettingsHas, codexTopLevelHas, exists, hasJsTestRunner, hasLintStagedConfig, hasMcpServer, hasTestLinter, unlockedMcpServers, } from "./detect.js";
|
|
36
|
+
import { anyWorkflowMentions, claudeSettingsHas, codexTopLevelHas, exists, hasJsTestRunner, hasLintStagedConfig, hasMcpServer, hasNewerBkit, hasTestLinter, hasUnsharedFriction, readsBkitText, unlockedMcpServers, } from "./detect.js";
|
|
34
37
|
const hosts = (cwd) => detectInstalledHostModules(cwd);
|
|
35
38
|
/** Every phase workflow. A value import of `COMPLY_PHASES` would cycle through cli.ts. */
|
|
36
39
|
export const ALL_WORKFLOWS = ["design", "plan", "build", "debug", "ship"];
|
|
37
40
|
/** Every `bkit tips --workflow=` context: the phase workflows, then the two agent closes. */
|
|
38
41
|
export const EVERY_CONTEXT = [...ALL_WORKFLOWS, "audit", "utility"];
|
|
39
42
|
export const SETUP_TIPS = [
|
|
43
|
+
// --- current: is bkit itself up to date ---------------------------------------------
|
|
44
|
+
{
|
|
45
|
+
id: "bkit-upgrade",
|
|
46
|
+
workflows: EVERY_CONTEXT,
|
|
47
|
+
title: "Upgrade bkit",
|
|
48
|
+
line: "A newer bkit is out, but this repo still runs an older one, so your workflows miss its fixes. Upgrade it.",
|
|
49
|
+
why: "Each release fixes problems found in earlier ones and improves the steps your workflows follow. Upgrading is one command, and it also refreshes the files bkit keeps in this repo so they match the new version.",
|
|
50
|
+
caution: "Upgrading rewrites the files bkit manages in this repo. Look over what changed and commit it as one change.",
|
|
51
|
+
ask: "Upgrade bkit in this repo to the latest version: follow the paste block in .bkit/install.md § Upgrade — already installed, then show me what changed before committing.",
|
|
52
|
+
steps: "`.bkit/install.md` § Upgrade — already installed.",
|
|
53
|
+
silenceable: false,
|
|
54
|
+
fires: hasNewerBkit,
|
|
55
|
+
},
|
|
40
56
|
// --- connect: can bkit talk to anything at all -------------------------------------
|
|
41
57
|
{
|
|
42
58
|
id: "tracker",
|
|
@@ -44,8 +60,8 @@ export const SETUP_TIPS = [
|
|
|
44
60
|
title: "Connect an issue tracker",
|
|
45
61
|
line: "bkit isn't connected to an issue tracker, so it can't read the task it's working on or record what it did. Connect GitHub, Linear or Jira, or switch this tip off if you don't want one.",
|
|
46
62
|
why: "Every workflow starts by reading the issue it's working on and reports progress back to it as it goes. Without a tracker, you have to paste in what the agent should look at each time, and nothing records what changed or why.",
|
|
47
|
-
ask: 'Connect bkit to GitHub Issues: re-run `bkit install` with the tool flags I use plus `--tracker=github` (it records `bkit.
|
|
48
|
-
steps: '`.bkit/install.md` § Optional post-install decisions. Opt out: `"bkit": { "
|
|
63
|
+
ask: 'Connect bkit to GitHub Issues: re-run `bkit install` with the tool flags I use plus `--tracker=github` (it records `bkit.tracker.default` in package.json and adds the tracker server to .mcp.json). If I don\'t want a tracker, set `"issueTracker": "none"` under `bkit` in package.json instead.',
|
|
64
|
+
steps: '`.bkit/install.md` § Optional post-install decisions. Opt out: `"bkit": { "tracker": { "default": "none" } }` in `package.json`.',
|
|
49
65
|
advisories: ["tracker-setup-none"],
|
|
50
66
|
fires: (cwd) => buildTrackerSetupAdvisory(cwd)?.id === "tracker-setup-none",
|
|
51
67
|
},
|
|
@@ -112,7 +128,7 @@ export const SETUP_TIPS = [
|
|
|
112
128
|
title: "Automatic checks on every change",
|
|
113
129
|
line: "Nothing checks your changes automatically before they're merged, so broken code can land unnoticed. Add bkit's check workflow.",
|
|
114
130
|
why: 'This runs your tests and checks on GitHub every time something changes, and bkit\'s ship step waits for it to pass before merging. Without it, "shipped" only means "merged", not "checked".',
|
|
115
|
-
ask: "Copy .bkit/templates/.github/workflows/bkit-ci.yml to .github/workflows
|
|
131
|
+
ask: "Copy .bkit/templates/.github/workflows/bkit-ci.yml to .github/workflows/<the file package.json `bkit.testing.ciWorkflow` names; default bkit-ci.yml>, replace `main` and `{{NODE_VERSION}}` in it with my default branch and Node major version, and add the `typecheck`, `lint`, `format:check`, `bkit:lint:prose`, `bkit:slop:delta` and `test` scripts to package.json as listed in .bkit/templates.md § Gate tool scripts.",
|
|
116
132
|
steps: "`.bkit/templates.md` § CI workflow and § Gate tool scripts.",
|
|
117
133
|
fires: (cwd) => !exists(cwd, `.github/workflows/${readBkitConfig(cwd).ciWorkflow}`),
|
|
118
134
|
},
|
|
@@ -142,7 +158,7 @@ export const SETUP_TIPS = [
|
|
|
142
158
|
title: "Catch junk code",
|
|
143
159
|
line: "Nothing catches the junk code AI tends to write. Add slop-scan so new junk gets flagged before it's merged.",
|
|
144
160
|
why: "Filler and dead code look fine when you skim a change, so they pile up unnoticed until the codebase is hard to trust. slop-scan flags only new problems, so it won't bury you in old ones.",
|
|
145
|
-
ask: 'Run `pnpm add -D slop-scan`, copy .bkit/templates/slop-scan.config.json to slop-scan.config.json and .bkit/templates/scripts/slop/ to scripts/slop/, and add `"lint:slop": "slop-scan scan ."` and `"slop:delta": "bkit ci slop"` to the package.json scripts.',
|
|
161
|
+
ask: 'Run `pnpm add -D slop-scan`, copy .bkit/templates/slop-scan.config.json to slop-scan.config.json and .bkit/templates/scripts/slop/ to scripts/slop/, and add `"lint:slop": "slop-scan scan ."` and `"bkit:slop:delta": "bkit ci slop"` to the package.json scripts.',
|
|
146
162
|
steps: "`.bkit/templates.md` § slop-scan.",
|
|
147
163
|
fires: (cwd) => !exists(cwd, "slop-scan.config.json"),
|
|
148
164
|
},
|
|
@@ -162,7 +178,7 @@ export const SETUP_TIPS = [
|
|
|
162
178
|
title: "Keep written docs tight",
|
|
163
179
|
line: "Nothing checks the project's written docs, so they slowly fill with vague, padded wording that agents then have to read. Add Vale.",
|
|
164
180
|
why: "Agents read your docs and instructions on every run. Padded writing costs time and money every time it's read, and vague rules get followed vaguely. Vale (a writing checker) flags it.",
|
|
165
|
-
ask: "Run `brew install vale`, copy .bkit/templates/.vale.ini to .vale.ini and .bkit/templates/.vale/styles/
|
|
181
|
+
ask: "Run `brew install vale`, copy .bkit/templates/.vale.ini to .vale.ini and .bkit/templates/.vale/styles/Bkit/ to .vale/styles/Bkit/, then run `vale sync`.",
|
|
166
182
|
steps: "`.bkit/templates.md` § Vale.",
|
|
167
183
|
fires: (cwd) => !exists(cwd, ".vale.ini"),
|
|
168
184
|
},
|
|
@@ -281,7 +297,7 @@ export const SETUP_TIPS = [
|
|
|
281
297
|
title: "Automatic updates",
|
|
282
298
|
line: "Nothing keeps the project's libraries up to date. Add an updater so you get small, safe updates instead of one big risky one later.",
|
|
283
299
|
why: "An updater opens a small pull request whenever a library you use has a new version. Skip it and updates pile up into one large upgrade that's far more likely to break something.",
|
|
284
|
-
ask:
|
|
300
|
+
ask: 'Copy .bkit/templates/.github/dependabot.yml to .github/dependabot.yml (or .bkit/templates/.github/renovate.json5 to .github/renovate.json5 for Renovate instead), set `bkit.dependencies.updater` in package.json to `"dependabot"` (or `"renovate"`), and commit both to the default branch.',
|
|
285
301
|
steps: "`.bkit/templates.md` § Dependabot and Renovate.",
|
|
286
302
|
advisories: ["dep-updater-absent"],
|
|
287
303
|
fires: (cwd) => buildDepUpdaterSetupAdvisory(cwd)?.id === "dep-updater-absent",
|
|
@@ -296,6 +312,18 @@ export const SETUP_TIPS = [
|
|
|
296
312
|
steps: "`.bkit/templates.md` § Trivy. Accept a finding in `.trivyignore.yaml` with `statement` + `expired_at`; never drop `--include-dev-deps`.",
|
|
297
313
|
fires: (cwd) => exists(cwd, ".github/workflows") && !anyWorkflowMentions(cwd, "aquasecurity/trivy"),
|
|
298
314
|
},
|
|
315
|
+
{
|
|
316
|
+
id: "dependency-audit",
|
|
317
|
+
workflows: ["ship", "audit"],
|
|
318
|
+
title: "Fail on a known-vulnerable dependency",
|
|
319
|
+
line: "A library with a published security advisory can sit in the lockfile for months: the updater only offers a fix, and nothing fails the check when one is missing. Add the gate that stops a known problem before it reaches CI.",
|
|
320
|
+
why: "An updater never blocks anything, so a risk with no fix yet, or one nobody merged, stays invisible. The gate names each exception with a reason and an expiry, fails on a new one, and fails even when it cannot get an answer — so a known problem is never a silent pass.",
|
|
321
|
+
ask: "Copy .bkit/templates/scripts/ci/bkit-check-dependency-audit.mjs and .bkit/templates/scripts/ci/bkit-accepted-advisories.json to scripts/ci/, then paste the `Dependency audit` block from .bkit/templates/.husky/pre-push into .husky/pre-push above the gates.",
|
|
322
|
+
steps: "`.bkit/templates.md` § Dependency audit. Each acceptance needs a `reason` and a `YYYY-MM-DD` `expires`.",
|
|
323
|
+
fires: (cwd) => exists(cwd, ".husky/pre-push") &&
|
|
324
|
+
!exists(cwd, "scripts/ci/bkit-check-dependency-audit.mjs") &&
|
|
325
|
+
!exists(cwd, "scripts/ci/check-dependency-audit.mjs"),
|
|
326
|
+
},
|
|
299
327
|
{
|
|
300
328
|
id: "prettier-tables",
|
|
301
329
|
workflows: ["design", "plan"],
|
|
@@ -320,11 +348,15 @@ export const SETUP_TIPS = [
|
|
|
320
348
|
workflows: ["plan", "ship"],
|
|
321
349
|
title: "Quick pushes for logs and records",
|
|
322
350
|
line: "Pushing only plan logs and records still runs every test. Add the quick path for those pushes.",
|
|
323
|
-
why: "A workflow's last push is often just its logs and records.
|
|
324
|
-
ask: 'Copy the min-push parts of .bkit/templates/.husky/pre-push into .husky/pre-push:
|
|
351
|
+
why: "A workflow's last push is often just its logs and records. A successful full gate can cover the earlier code while the quick path checks the remaining bookkeeping. Any unverified code still runs the full gate.",
|
|
352
|
+
ask: 'Copy the min-push parts of .bkit/templates/.husky/pre-push into .husky/pre-push: PUSH_UPDATES / PUSH_SHARED_SHAS in the stdin loop, the `Min push` and `CI-suppressor guard on dev / main` blocks, and every `bkit ci push-gate` gate call. Wrap slow checks below the gates in `if [ "$MIN_PUSH" != "1" ]`.',
|
|
325
353
|
steps: "`.bkit/templates.md` § Git hooks.",
|
|
326
|
-
fires: (cwd) =>
|
|
327
|
-
!
|
|
354
|
+
fires: (cwd) => {
|
|
355
|
+
if (!exists(cwd, ".husky/pre-push"))
|
|
356
|
+
return false;
|
|
357
|
+
const hook = fs.readFileSync(path.join(cwd, ".husky/pre-push"), "utf-8");
|
|
358
|
+
return ["bkit ci min-push", "--update=", "bkit ci push-gate"].some((part) => !hook.includes(part));
|
|
359
|
+
},
|
|
328
360
|
},
|
|
329
361
|
{
|
|
330
362
|
id: "disk-prune",
|
|
@@ -338,7 +370,26 @@ export const SETUP_TIPS = [
|
|
|
338
370
|
!exists(cwd, REPO_STEPS) &&
|
|
339
371
|
!fs.existsSync(machineStepsPath()),
|
|
340
372
|
},
|
|
373
|
+
{
|
|
374
|
+
id: "share-friction",
|
|
375
|
+
title: "Tell bkit what slowed you down",
|
|
376
|
+
line: "Your workflows have noted problems with bkit itself that its makers never see. Send them, with your stats, as one issue on bkit's issue page.",
|
|
377
|
+
why: "Workflows note every place bkit got in the way: a command that failed, rework, a manual step. Those notes stay in this repo, so the people who fix bkit never learn about them. One report from you is how they reach the fix list.",
|
|
378
|
+
caution: "bkit's issue page is public. Your agent removes project names, paths and links first, and shows you the exact text before anything is posted.",
|
|
379
|
+
ask: "Share this repo's bkit friction and stats with bkit's makers as one new issue: follow the paste block in .bkit/README.md § Share friction with bkit, show me the exact title and text, and post only after I say yes.",
|
|
380
|
+
steps: "`.bkit/README.md` § Share friction with bkit.",
|
|
381
|
+
fires: hasUnsharedFriction,
|
|
382
|
+
},
|
|
341
383
|
// --- setup: only some setups -----------------------------------------------------------
|
|
384
|
+
{
|
|
385
|
+
id: "bkit-output-json",
|
|
386
|
+
title: "Scripts that read bkit's replies",
|
|
387
|
+
line: "A hook, script or CI step reads bkit's replies as JSON, but bkit replies in plain text unless the call passes `--json`. Add `--json` to those bkit calls.",
|
|
388
|
+
why: "bkit answers in short text lines by default because agents read them. A script expecting JSON gets nothing it can parse, so its step quietly does nothing.",
|
|
389
|
+
ask: "Add --json to every bkit call whose output a hook, script or CI workflow parses (piped to jq, or read with JSON.parse), then rerun `bkit tips` until this tip is gone.",
|
|
390
|
+
steps: "`.bkit/cli.md` § Contract. Files: `.claude/hooks/`, `.husky/`, `.github/workflows/`, `scripts/`.",
|
|
391
|
+
fires: (cwd) => readsBkitText(cwd).length > 0,
|
|
392
|
+
},
|
|
342
393
|
{
|
|
343
394
|
id: "cursor-files",
|
|
344
395
|
title: "Cursor editor settings",
|
|
@@ -353,7 +404,7 @@ export const SETUP_TIPS = [
|
|
|
353
404
|
title: "Tokens for apps opened from the Dock",
|
|
354
405
|
line: "On a Mac, apps opened from the Dock don't see your sign-in tokens, so they start signed out even though the same thing works in the terminal. Add bkit's loader.",
|
|
355
406
|
why: "The terminal loads your tokens, but apps started from the Dock or Finder skip that step. This one-time setup gives those apps the tokens too.",
|
|
356
|
-
ask: "Copy .bkit/templates/scripts/launchd/bkit-launchd-env.sh to scripts/launchd/, .bkit/templates/scripts/launchd/launchd.env.example to ~/.config/bkit/launchd.env and .bkit/templates/scripts/launchd/
|
|
407
|
+
ask: "Copy .bkit/templates/scripts/launchd/bkit-launchd-env.sh to scripts/launchd/, .bkit/templates/scripts/launchd/bkit-launchd.env.example to ~/.config/bkit/launchd.env and .bkit/templates/scripts/launchd/bkit-launchd.plist to ~/Library/LaunchAgents/ai.bkit.launchd.plist (fill in its paths), then run `launchctl bootstrap gui/$UID ~/Library/LaunchAgents/ai.bkit.launchd.plist`.",
|
|
357
408
|
steps: "`.bkit/templates.md` § Launchd GUI environment.",
|
|
358
409
|
fires: (cwd) => {
|
|
359
410
|
if (process.platform !== "darwin" || isCloudOrCi())
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
// configs, host settings files, lint-staged and test-linter config forms. No network.
|
|
3
3
|
import * as fs from "node:fs";
|
|
4
4
|
import * as path from "node:path";
|
|
5
|
+
import { git } from "../../commands/lib.js";
|
|
6
|
+
import { fold, parse } from "../../ledgers/telemetry.js";
|
|
7
|
+
import { BKIT_PACKAGE, cachedBkitOutdated } from "../../shared/bkit-latest.js";
|
|
5
8
|
import { parseJson } from "../../shared/json.js";
|
|
6
9
|
import { readDependencyNames, readPackageJson } from "../../shared/package-json.js";
|
|
7
10
|
/** True when `rel` exists under `cwd`. */
|
|
@@ -167,3 +170,62 @@ export function hasTestLinter(cwd) {
|
|
|
167
170
|
}
|
|
168
171
|
return eslintConfigs.some((text) => TEST_LINT_PLUGIN.test(text));
|
|
169
172
|
}
|
|
173
|
+
/** Consumer-owned folders whose files may run bkit and read what it prints. */
|
|
174
|
+
const OUTPUT_READER_DIRS = [".claude/hooks", ".husky", ".github/workflows", "scripts"];
|
|
175
|
+
/**
|
|
176
|
+
* A line that reads bkit's stdout as JSON without asking for it: a bkit call piped to `jq`,
|
|
177
|
+
* or a bkit argument list (`"bkit", "<noun>", "<verb>", …]`) passed to a spawn.
|
|
178
|
+
*/
|
|
179
|
+
const READS_BKIT_TEXT = [
|
|
180
|
+
/\bbkit\b(?:(?!--json)[^\n|])*\|\s*jq\b/i,
|
|
181
|
+
/"bkit",\s*"[a-z-]+",\s*"[a-z-]+"(?:(?!"--json")[^\n\]])*\]/,
|
|
182
|
+
];
|
|
183
|
+
/** Files under `dir` (relative to `cwd`), `node_modules` left out, at most 4 levels down. */
|
|
184
|
+
function filesUnder(cwd, dir, depth = 4) {
|
|
185
|
+
const abs = path.join(cwd, dir);
|
|
186
|
+
if (depth === 0 || !fs.existsSync(abs) || !fs.statSync(abs).isDirectory())
|
|
187
|
+
return [];
|
|
188
|
+
return fs.readdirSync(abs, { withFileTypes: true }).flatMap((e) => {
|
|
189
|
+
const rel = path.posix.join(dir, e.name);
|
|
190
|
+
if (e.isDirectory())
|
|
191
|
+
return e.name === "node_modules" ? [] : filesUnder(cwd, rel, depth - 1);
|
|
192
|
+
return e.isFile() ? [rel] : [];
|
|
193
|
+
});
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Hooks, CI workflows and scripts that parse bkit's output as JSON without `--json`;
|
|
197
|
+
* bkit prints text by default, so each one reads nothing.
|
|
198
|
+
*/
|
|
199
|
+
export function readsBkitText(cwd) {
|
|
200
|
+
return OUTPUT_READER_DIRS.flatMap((dir) => filesUnder(cwd, dir)).filter((rel) => {
|
|
201
|
+
const text = readText(cwd, rel);
|
|
202
|
+
return text.split("\n").some((line) => READS_BKIT_TEXT.some((re) => re.test(line)));
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* True when `.bkit/friction.jsonl` holds an entry worth sending to bkit: its fold winner
|
|
207
|
+
* is `OPEN` (or has no status) and its `scope` is not `consumer`. A shared entry gets a
|
|
208
|
+
* same-`key` `TRIAGED` row, so it stops counting. Never in bkit's own repo.
|
|
209
|
+
*/
|
|
210
|
+
export function hasUnsharedFriction(cwd) {
|
|
211
|
+
const pkg = readPackageJson(cwd);
|
|
212
|
+
if (pkg.ok && pkg.pkg["name"] === BKIT_PACKAGE)
|
|
213
|
+
return false;
|
|
214
|
+
const p = path.join(cwd, ".bkit", "friction.jsonl");
|
|
215
|
+
if (!fs.existsSync(p))
|
|
216
|
+
return false;
|
|
217
|
+
return [...fold(parse(fs.readFileSync(p, "utf-8")).events).values()].some((row) => {
|
|
218
|
+
const r = row;
|
|
219
|
+
return (r["kind"] === "friction" &&
|
|
220
|
+
(r["status"] === undefined || r["status"] === "OPEN") &&
|
|
221
|
+
r["scope"] !== "consumer");
|
|
222
|
+
});
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* True when a newer bkit release is out than the one this repo runs, per the answer
|
|
226
|
+
* `bkit repo info` cached in git's common dir. Never asks the registry itself.
|
|
227
|
+
*/
|
|
228
|
+
export function hasNewerBkit(cwd) {
|
|
229
|
+
const common = git(cwd, ["rev-parse", "--path-format=absolute", "--git-common-dir"]);
|
|
230
|
+
return common !== null && cachedBkitOutdated(cwd, common);
|
|
231
|
+
}
|
|
@@ -1,7 +1,41 @@
|
|
|
1
1
|
// checks/tips/index.ts — collect the firing setup tips and render them for `bkit tips`, the
|
|
2
2
|
// console checklist and `.bkit/advisories.md`. Catalogue + priority: ./catalogue.ts.
|
|
3
|
+
//
|
|
4
|
+
// Every `fires` reads the directory `tipsBase` returns — the main checkout, the tree the
|
|
5
|
+
// integration branch is checked out in — never the calling directory. A workflow runs in a
|
|
6
|
+
// worktree, but a worktree is an ephemeral branch: an empty or half-created one would fire
|
|
7
|
+
// every "file is missing" tip as a false gap. When no checkout is found at all, nothing fires.
|
|
8
|
+
import * as fs from "node:fs";
|
|
9
|
+
import * as path from "node:path";
|
|
10
|
+
import { git, mainCheckoutRoot } from "../../commands/lib.js";
|
|
3
11
|
import { ignoredAdvisoryIds, } from "../after/suppression.js";
|
|
4
12
|
import { ALL_WORKFLOWS, SETUP_TIPS } from "./catalogue.js";
|
|
13
|
+
/**
|
|
14
|
+
* The directory the tips are checked against: the main checkout's root — the tree the
|
|
15
|
+
* integration branch is checked out in — resolved from any worktree by
|
|
16
|
+
* `mainCheckoutRoot` (git's common dir), else `cwd` when git cannot say. A bare main
|
|
17
|
+
* repo has no checkout: the common dir's parent then belongs to no repo or to another
|
|
18
|
+
* one, so the caller's own top level is used. `null` when the base is not a checkout
|
|
19
|
+
* (holds neither `.git` nor `package.json`): a directory with nothing to check fires no
|
|
20
|
+
* tip rather than every "missing" tip as a false gap.
|
|
21
|
+
*/
|
|
22
|
+
export function tipsBase(cwd) {
|
|
23
|
+
const base = mainCheckoutOf(cwd) ?? git(cwd, ["rev-parse", "--show-toplevel"]) ?? cwd;
|
|
24
|
+
if (!fs.existsSync(base))
|
|
25
|
+
return null;
|
|
26
|
+
return fs.existsSync(path.join(base, ".git")) || fs.existsSync(path.join(base, "package.json"))
|
|
27
|
+
? base
|
|
28
|
+
: null;
|
|
29
|
+
}
|
|
30
|
+
/** `mainCheckoutRoot(cwd)` when git there resolves to the same common dir, else null. */
|
|
31
|
+
function mainCheckoutOf(cwd) {
|
|
32
|
+
const commonDir = (dir) => git(dir, ["rev-parse", "--path-format=absolute", "--git-common-dir"]);
|
|
33
|
+
const root = mainCheckoutRoot(cwd);
|
|
34
|
+
if (root === null || !fs.existsSync(root))
|
|
35
|
+
return null;
|
|
36
|
+
const own = commonDir(cwd);
|
|
37
|
+
return own !== null && commonDir(root) === own ? root : null;
|
|
38
|
+
}
|
|
5
39
|
/** Tips `bkit tips` prints without `--all` or `--workflow`. */
|
|
6
40
|
export const TIPS_CAP = 3;
|
|
7
41
|
/** Tips a workflow prints at its close (`bkit tips --workflow=<name>`). */
|
|
@@ -17,9 +51,9 @@ export function silenceLine(ids) {
|
|
|
17
51
|
const names = ids.map((id) => `\`${id}\``);
|
|
18
52
|
const list = names.length > 1 ? `${names.slice(0, -1).join(", ")} and ${names.at(-1)}` : names[0];
|
|
19
53
|
const what = ids.length > 1 ? "these tips" : "this tip";
|
|
20
|
-
return `**Want to silence ${what}?** Ask your agent to "add ${list} to \`bkit.
|
|
54
|
+
return `**Want to silence ${what}?** Ask your agent to "add ${list} to \`bkit.advisories.ignore\` in package.json".`;
|
|
21
55
|
}
|
|
22
|
-
/** `bkit.
|
|
56
|
+
/** `bkit.advisories.ignore` key that silences `STAR_TIP`. */
|
|
23
57
|
export const STAR_TIP_ID = "bkit-star";
|
|
24
58
|
/** Older key that also silences `STAR_TIP`, so repos that set it keep the line off. */
|
|
25
59
|
export const STAR_TIP_OLD_ID = "star";
|
|
@@ -32,13 +66,15 @@ export const STAR_TIP = "Do you like bkit? Then give it a star at [https://githu
|
|
|
32
66
|
/** `STAR_TIP` for a workflow's `## bkit Tips`, its question bold like each tip's title. */
|
|
33
67
|
export const STAR_TIP_PARAGRAPH = STAR_TIP.replace("Do you like bkit?", "**Do you like bkit?**");
|
|
34
68
|
/** Intro of the Setup tips section: who reads which field, and how to silence a tip. */
|
|
35
|
-
export const TIPS_SECTION_INTRO = "Things not set up yet, most useful first. For the person: each tip says what goes wrong today and a sentence to ask your agent. For an AI agent: follow each tip's Agent steps unless the person declines it. Silence a tip by adding its id to `bkit.
|
|
69
|
+
export const TIPS_SECTION_INTRO = "Things not set up yet, most useful first. For the person: each tip says what goes wrong today and a sentence to ask your agent. For an AI agent: follow each tip's Agent steps unless the person declines it. Silence a tip by adding its id to `bkit.advisories.ignore` in package.json; `bkit-upgrade` cannot be silenced. Full template catalogue: .bkit/templates.md.";
|
|
36
70
|
/** True when advisory `id` matches catalogue pattern `pattern` (trailing `*` = prefix). */
|
|
37
71
|
export function matchesAdvisory(pattern, id) {
|
|
38
72
|
return pattern.endsWith("*") ? id.startsWith(pattern.slice(0, -1)) : id === pattern;
|
|
39
73
|
}
|
|
40
|
-
/** True when `ignored` names the tip's id or any advisory id it reuses. */
|
|
74
|
+
/** True when `ignored` names the tip's id or any advisory id it reuses; never for an unsilenceable tip. */
|
|
41
75
|
export function isTipSilenced(tip, ignored) {
|
|
76
|
+
if (tip.silenceable === false)
|
|
77
|
+
return false;
|
|
42
78
|
if (ignored.has(tip.id))
|
|
43
79
|
return true;
|
|
44
80
|
const patterns = tip.advisories ?? [];
|
|
@@ -46,11 +82,14 @@ export function isTipSilenced(tip, ignored) {
|
|
|
46
82
|
}
|
|
47
83
|
/** Every firing tip in priority order, minus the ones the root package.json silences. */
|
|
48
84
|
export function collectTips(cwd, catalogue = SETUP_TIPS) {
|
|
49
|
-
const
|
|
85
|
+
const base = tipsBase(cwd);
|
|
86
|
+
if (base === null)
|
|
87
|
+
return { tips: [], suppressed: [], star: false };
|
|
88
|
+
const ignored = ignoredAdvisoryIds(base);
|
|
50
89
|
const tips = [];
|
|
51
90
|
const suppressed = [];
|
|
52
91
|
for (const tip of catalogue) {
|
|
53
|
-
if (!tip.fires(
|
|
92
|
+
if (!tip.fires(base))
|
|
54
93
|
continue;
|
|
55
94
|
if (isTipSilenced(tip, ignored))
|
|
56
95
|
suppressed.push({ id: tip.id, scope: "." });
|
|
@@ -62,11 +101,14 @@ export function collectTips(cwd, catalogue = SETUP_TIPS) {
|
|
|
62
101
|
}
|
|
63
102
|
/**
|
|
64
103
|
* Drop advisory findings whose tip the root package.json silenced, so one
|
|
65
|
-
* `bkit.
|
|
104
|
+
* `bkit.advisories.ignore` entry silences a tip and the advisories it reuses. Blockers are
|
|
66
105
|
* never dropped.
|
|
67
106
|
*/
|
|
68
107
|
export function dropTipSilencedAdvisories(findings, cwd, onSuppressed, catalogue = SETUP_TIPS) {
|
|
69
|
-
const
|
|
108
|
+
const base = tipsBase(cwd);
|
|
109
|
+
if (base === null)
|
|
110
|
+
return findings;
|
|
111
|
+
const ignored = ignoredAdvisoryIds(base);
|
|
70
112
|
if (ignored.size === 0)
|
|
71
113
|
return findings;
|
|
72
114
|
const patterns = catalogue
|
|
@@ -125,7 +167,7 @@ export function formatTips(tips, opts = {}) {
|
|
|
125
167
|
/** `formatTips` for a workflow's `## bkit Tips`: tips, star line, how to silence both. */
|
|
126
168
|
function formatWorkflowTips(tips, workflow, star) {
|
|
127
169
|
const shown = orderForWorkflow(tips, workflow).slice(0, WORKFLOW_TIPS_CAP);
|
|
128
|
-
const ids = shown.map((t) => t.id);
|
|
170
|
+
const ids = shown.filter((t) => t.silenceable !== false).map((t) => t.id);
|
|
129
171
|
const parts = shown.map(tipParagraph);
|
|
130
172
|
if (star) {
|
|
131
173
|
parts.push(STAR_TIP_PARAGRAPH);
|