@esbenwiberg/corpus-default 1.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/LICENSE +21 -0
- package/README.md +10 -0
- package/dist/dimensions/consistency.d.ts +3 -0
- package/dist/dimensions/consistency.d.ts.map +1 -0
- package/dist/dimensions/consistency.js +8 -0
- package/dist/dimensions/consistency.js.map +1 -0
- package/dist/dimensions/context.d.ts +3 -0
- package/dist/dimensions/context.d.ts.map +1 -0
- package/dist/dimensions/context.js +8 -0
- package/dist/dimensions/context.js.map +1 -0
- package/dist/dimensions/cost.d.ts +3 -0
- package/dist/dimensions/cost.d.ts.map +1 -0
- package/dist/dimensions/cost.js +8 -0
- package/dist/dimensions/cost.js.map +1 -0
- package/dist/dimensions/feedback.d.ts +3 -0
- package/dist/dimensions/feedback.d.ts.map +1 -0
- package/dist/dimensions/feedback.js +8 -0
- package/dist/dimensions/feedback.js.map +1 -0
- package/dist/dimensions/latency.d.ts +3 -0
- package/dist/dimensions/latency.d.ts.map +1 -0
- package/dist/dimensions/latency.js +8 -0
- package/dist/dimensions/latency.js.map +1 -0
- package/dist/dimensions/safety.d.ts +3 -0
- package/dist/dimensions/safety.d.ts.map +1 -0
- package/dist/dimensions/safety.js +8 -0
- package/dist/dimensions/safety.js.map +1 -0
- package/dist/fixers/agent-guidance-present-llm.d.ts +3 -0
- package/dist/fixers/agent-guidance-present-llm.d.ts.map +1 -0
- package/dist/fixers/agent-guidance-present-llm.js +109 -0
- package/dist/fixers/agent-guidance-present-llm.js.map +1 -0
- package/dist/fixers/agent-guidance-present.d.ts +3 -0
- package/dist/fixers/agent-guidance-present.d.ts.map +1 -0
- package/dist/fixers/agent-guidance-present.js +46 -0
- package/dist/fixers/agent-guidance-present.js.map +1 -0
- package/dist/fixers/docs-readme-present-llm.d.ts +3 -0
- package/dist/fixers/docs-readme-present-llm.d.ts.map +1 -0
- package/dist/fixers/docs-readme-present-llm.js +109 -0
- package/dist/fixers/docs-readme-present-llm.js.map +1 -0
- package/dist/fixers/docs-readme-present.d.ts +3 -0
- package/dist/fixers/docs-readme-present.d.ts.map +1 -0
- package/dist/fixers/docs-readme-present.js +41 -0
- package/dist/fixers/docs-readme-present.js.map +1 -0
- package/dist/fixers/editorconfig-present.d.ts +3 -0
- package/dist/fixers/editorconfig-present.d.ts.map +1 -0
- package/dist/fixers/editorconfig-present.js +30 -0
- package/dist/fixers/editorconfig-present.js.map +1 -0
- package/dist/fixers/gitignore-comprehensive.d.ts +3 -0
- package/dist/fixers/gitignore-comprehensive.d.ts.map +1 -0
- package/dist/fixers/gitignore-comprehensive.js +61 -0
- package/dist/fixers/gitignore-comprehensive.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +153 -0
- package/dist/index.js.map +1 -0
- package/dist/probes/_shared/latency-bands.d.ts +3 -0
- package/dist/probes/_shared/latency-bands.d.ts.map +1 -0
- package/dist/probes/_shared/latency-bands.js +8 -0
- package/dist/probes/_shared/latency-bands.js.map +1 -0
- package/dist/probes/agent-guidance-fresh.d.ts +3 -0
- package/dist/probes/agent-guidance-fresh.d.ts.map +1 -0
- package/dist/probes/agent-guidance-fresh.js +198 -0
- package/dist/probes/agent-guidance-fresh.js.map +1 -0
- package/dist/probes/agent-guidance-nested.d.ts +3 -0
- package/dist/probes/agent-guidance-nested.d.ts.map +1 -0
- package/dist/probes/agent-guidance-nested.js +177 -0
- package/dist/probes/agent-guidance-nested.js.map +1 -0
- package/dist/probes/agent-guidance-present.d.ts +3 -0
- package/dist/probes/agent-guidance-present.d.ts.map +1 -0
- package/dist/probes/agent-guidance-present.js +32 -0
- package/dist/probes/agent-guidance-present.js.map +1 -0
- package/dist/probes/agent-guidance-quality.d.ts +3 -0
- package/dist/probes/agent-guidance-quality.d.ts.map +1 -0
- package/dist/probes/agent-guidance-quality.js +134 -0
- package/dist/probes/agent-guidance-quality.js.map +1 -0
- package/dist/probes/agent-guidance-substance.d.ts +3 -0
- package/dist/probes/agent-guidance-substance.d.ts.map +1 -0
- package/dist/probes/agent-guidance-substance.js +64 -0
- package/dist/probes/agent-guidance-substance.js.map +1 -0
- package/dist/probes/arch-boundaries-clear.d.ts +3 -0
- package/dist/probes/arch-boundaries-clear.d.ts.map +1 -0
- package/dist/probes/arch-boundaries-clear.js +202 -0
- package/dist/probes/arch-boundaries-clear.js.map +1 -0
- package/dist/probes/arch-doc-present.d.ts +3 -0
- package/dist/probes/arch-doc-present.d.ts.map +1 -0
- package/dist/probes/arch-doc-present.js +46 -0
- package/dist/probes/arch-doc-present.js.map +1 -0
- package/dist/probes/arch-doc-quality.d.ts +3 -0
- package/dist/probes/arch-doc-quality.d.ts.map +1 -0
- package/dist/probes/arch-doc-quality.js +138 -0
- package/dist/probes/arch-doc-quality.js.map +1 -0
- package/dist/probes/arch-fitness-tests-configured.d.ts +3 -0
- package/dist/probes/arch-fitness-tests-configured.d.ts.map +1 -0
- package/dist/probes/arch-fitness-tests-configured.js +180 -0
- package/dist/probes/arch-fitness-tests-configured.js.map +1 -0
- package/dist/probes/build-clean.d.ts +3 -0
- package/dist/probes/build-clean.d.ts.map +1 -0
- package/dist/probes/build-clean.js +72 -0
- package/dist/probes/build-clean.js.map +1 -0
- package/dist/probes/build-configured.d.ts +3 -0
- package/dist/probes/build-configured.d.ts.map +1 -0
- package/dist/probes/build-configured.js +158 -0
- package/dist/probes/build-configured.js.map +1 -0
- package/dist/probes/changelog-strategy-declared.d.ts +3 -0
- package/dist/probes/changelog-strategy-declared.d.ts.map +1 -0
- package/dist/probes/changelog-strategy-declared.js +81 -0
- package/dist/probes/changelog-strategy-declared.js.map +1 -0
- package/dist/probes/ci-configured.d.ts +3 -0
- package/dist/probes/ci-configured.d.ts.map +1 -0
- package/dist/probes/ci-configured.js +164 -0
- package/dist/probes/ci-configured.js.map +1 -0
- package/dist/probes/ci-runs-build.d.ts +3 -0
- package/dist/probes/ci-runs-build.d.ts.map +1 -0
- package/dist/probes/ci-runs-build.js +92 -0
- package/dist/probes/ci-runs-build.js.map +1 -0
- package/dist/probes/ci-runs-lint.d.ts +3 -0
- package/dist/probes/ci-runs-lint.d.ts.map +1 -0
- package/dist/probes/ci-runs-lint.js +84 -0
- package/dist/probes/ci-runs-lint.js.map +1 -0
- package/dist/probes/ci-runs-tests.d.ts +3 -0
- package/dist/probes/ci-runs-tests.d.ts.map +1 -0
- package/dist/probes/ci-runs-tests.js +68 -0
- package/dist/probes/ci-runs-tests.js.map +1 -0
- package/dist/probes/ci-runs-typecheck.d.ts +3 -0
- package/dist/probes/ci-runs-typecheck.d.ts.map +1 -0
- package/dist/probes/ci-runs-typecheck.js +89 -0
- package/dist/probes/ci-runs-typecheck.js.map +1 -0
- package/dist/probes/commits-conventional-followed.d.ts +3 -0
- package/dist/probes/commits-conventional-followed.d.ts.map +1 -0
- package/dist/probes/commits-conventional-followed.js +80 -0
- package/dist/probes/commits-conventional-followed.js.map +1 -0
- package/dist/probes/dead-code-configured.d.ts +3 -0
- package/dist/probes/dead-code-configured.d.ts.map +1 -0
- package/dist/probes/dead-code-configured.js +218 -0
- package/dist/probes/dead-code-configured.js.map +1 -0
- package/dist/probes/deps-audit-configured.d.ts +3 -0
- package/dist/probes/deps-audit-configured.d.ts.map +1 -0
- package/dist/probes/deps-audit-configured.js +172 -0
- package/dist/probes/deps-audit-configured.js.map +1 -0
- package/dist/probes/deps-lockfile-present.d.ts +3 -0
- package/dist/probes/deps-lockfile-present.d.ts.map +1 -0
- package/dist/probes/deps-lockfile-present.js +190 -0
- package/dist/probes/deps-lockfile-present.js.map +1 -0
- package/dist/probes/docs-adr-presence.d.ts +3 -0
- package/dist/probes/docs-adr-presence.d.ts.map +1 -0
- package/dist/probes/docs-adr-presence.js +76 -0
- package/dist/probes/docs-adr-presence.js.map +1 -0
- package/dist/probes/docs-adr-quality.d.ts +3 -0
- package/dist/probes/docs-adr-quality.d.ts.map +1 -0
- package/dist/probes/docs-adr-quality.js +128 -0
- package/dist/probes/docs-adr-quality.js.map +1 -0
- package/dist/probes/docs-contributing-present.d.ts +3 -0
- package/dist/probes/docs-contributing-present.d.ts.map +1 -0
- package/dist/probes/docs-contributing-present.js +15 -0
- package/dist/probes/docs-contributing-present.js.map +1 -0
- package/dist/probes/docs-links-resolved.d.ts +3 -0
- package/dist/probes/docs-links-resolved.d.ts.map +1 -0
- package/dist/probes/docs-links-resolved.js +252 -0
- package/dist/probes/docs-links-resolved.js.map +1 -0
- package/dist/probes/docs-readme-clarity.d.ts +3 -0
- package/dist/probes/docs-readme-clarity.d.ts.map +1 -0
- package/dist/probes/docs-readme-clarity.js +118 -0
- package/dist/probes/docs-readme-clarity.js.map +1 -0
- package/dist/probes/docs-readme-present.d.ts +3 -0
- package/dist/probes/docs-readme-present.d.ts.map +1 -0
- package/dist/probes/docs-readme-present.js +15 -0
- package/dist/probes/docs-readme-present.js.map +1 -0
- package/dist/probes/docs-readme-substance.d.ts +3 -0
- package/dist/probes/docs-readme-substance.d.ts.map +1 -0
- package/dist/probes/docs-readme-substance.js +62 -0
- package/dist/probes/docs-readme-substance.js.map +1 -0
- package/dist/probes/editorconfig-present.d.ts +3 -0
- package/dist/probes/editorconfig-present.d.ts.map +1 -0
- package/dist/probes/editorconfig-present.js +15 -0
- package/dist/probes/editorconfig-present.js.map +1 -0
- package/dist/probes/errors-actionability.d.ts +3 -0
- package/dist/probes/errors-actionability.d.ts.map +1 -0
- package/dist/probes/errors-actionability.js +180 -0
- package/dist/probes/errors-actionability.js.map +1 -0
- package/dist/probes/format-clean.d.ts +3 -0
- package/dist/probes/format-clean.d.ts.map +1 -0
- package/dist/probes/format-clean.js +114 -0
- package/dist/probes/format-clean.js.map +1 -0
- package/dist/probes/format-configured.d.ts +3 -0
- package/dist/probes/format-configured.d.ts.map +1 -0
- package/dist/probes/format-configured.js +243 -0
- package/dist/probes/format-configured.js.map +1 -0
- package/dist/probes/git-branch-protection.d.ts +3 -0
- package/dist/probes/git-branch-protection.d.ts.map +1 -0
- package/dist/probes/git-branch-protection.js +47 -0
- package/dist/probes/git-branch-protection.js.map +1 -0
- package/dist/probes/gitignore-comprehensive.d.ts +3 -0
- package/dist/probes/gitignore-comprehensive.d.ts.map +1 -0
- package/dist/probes/gitignore-comprehensive.js +59 -0
- package/dist/probes/gitignore-comprehensive.js.map +1 -0
- package/dist/probes/hooks-gates-lint-test-build.d.ts +3 -0
- package/dist/probes/hooks-gates-lint-test-build.d.ts.map +1 -0
- package/dist/probes/hooks-gates-lint-test-build.js +231 -0
- package/dist/probes/hooks-gates-lint-test-build.js.map +1 -0
- package/dist/probes/hooks-precommit-present.d.ts +3 -0
- package/dist/probes/hooks-precommit-present.d.ts.map +1 -0
- package/dist/probes/hooks-precommit-present.js +43 -0
- package/dist/probes/hooks-precommit-present.js.map +1 -0
- package/dist/probes/latency-build.d.ts +3 -0
- package/dist/probes/latency-build.d.ts.map +1 -0
- package/dist/probes/latency-build.js +53 -0
- package/dist/probes/latency-build.js.map +1 -0
- package/dist/probes/latency-lint.d.ts +3 -0
- package/dist/probes/latency-lint.d.ts.map +1 -0
- package/dist/probes/latency-lint.js +50 -0
- package/dist/probes/latency-lint.js.map +1 -0
- package/dist/probes/latency-test-suite.d.ts +3 -0
- package/dist/probes/latency-test-suite.d.ts.map +1 -0
- package/dist/probes/latency-test-suite.js +75 -0
- package/dist/probes/latency-test-suite.js.map +1 -0
- package/dist/probes/latency-typecheck.d.ts +3 -0
- package/dist/probes/latency-typecheck.d.ts.map +1 -0
- package/dist/probes/latency-typecheck.js +67 -0
- package/dist/probes/latency-typecheck.js.map +1 -0
- package/dist/probes/lint-clean.d.ts +3 -0
- package/dist/probes/lint-clean.d.ts.map +1 -0
- package/dist/probes/lint-clean.js +109 -0
- package/dist/probes/lint-clean.js.map +1 -0
- package/dist/probes/lint-configured.d.ts +3 -0
- package/dist/probes/lint-configured.d.ts.map +1 -0
- package/dist/probes/lint-configured.js +268 -0
- package/dist/probes/lint-configured.js.map +1 -0
- package/dist/probes/readme-commands-runnable.d.ts +3 -0
- package/dist/probes/readme-commands-runnable.d.ts.map +1 -0
- package/dist/probes/readme-commands-runnable.js +307 -0
- package/dist/probes/readme-commands-runnable.js.map +1 -0
- package/dist/probes/runtime-dev-loop-bootable.d.ts +3 -0
- package/dist/probes/runtime-dev-loop-bootable.d.ts.map +1 -0
- package/dist/probes/runtime-dev-loop-bootable.js +239 -0
- package/dist/probes/runtime-dev-loop-bootable.js.map +1 -0
- package/dist/probes/safety-dangerous-script-flags.d.ts +3 -0
- package/dist/probes/safety-dangerous-script-flags.d.ts.map +1 -0
- package/dist/probes/safety-dangerous-script-flags.js +126 -0
- package/dist/probes/safety-dangerous-script-flags.js.map +1 -0
- package/dist/probes/secrets-dotenv-gitignored.d.ts +3 -0
- package/dist/probes/secrets-dotenv-gitignored.d.ts.map +1 -0
- package/dist/probes/secrets-dotenv-gitignored.js +45 -0
- package/dist/probes/secrets-dotenv-gitignored.js.map +1 -0
- package/dist/probes/secrets-precommit-scan-configured.d.ts +3 -0
- package/dist/probes/secrets-precommit-scan-configured.d.ts.map +1 -0
- package/dist/probes/secrets-precommit-scan-configured.js +130 -0
- package/dist/probes/secrets-precommit-scan-configured.js.map +1 -0
- package/dist/probes/secrets-scan-clean.d.ts +3 -0
- package/dist/probes/secrets-scan-clean.d.ts.map +1 -0
- package/dist/probes/secrets-scan-clean.js +80 -0
- package/dist/probes/secrets-scan-clean.js.map +1 -0
- package/dist/probes/size-directory-depth.d.ts +3 -0
- package/dist/probes/size-directory-depth.d.ts.map +1 -0
- package/dist/probes/size-directory-depth.js +80 -0
- package/dist/probes/size-directory-depth.js.map +1 -0
- package/dist/probes/size-large-files.d.ts +3 -0
- package/dist/probes/size-large-files.d.ts.map +1 -0
- package/dist/probes/size-large-files.js +117 -0
- package/dist/probes/size-large-files.js.map +1 -0
- package/dist/probes/size-repo-token-estimate.d.ts +3 -0
- package/dist/probes/size-repo-token-estimate.d.ts.map +1 -0
- package/dist/probes/size-repo-token-estimate.js +83 -0
- package/dist/probes/size-repo-token-estimate.js.map +1 -0
- package/dist/probes/specs-present.d.ts +3 -0
- package/dist/probes/specs-present.d.ts.map +1 -0
- package/dist/probes/specs-present.js +77 -0
- package/dist/probes/specs-present.js.map +1 -0
- package/dist/probes/specs-quality.d.ts +3 -0
- package/dist/probes/specs-quality.d.ts.map +1 -0
- package/dist/probes/specs-quality.js +153 -0
- package/dist/probes/specs-quality.js.map +1 -0
- package/dist/probes/tests-clean.d.ts +3 -0
- package/dist/probes/tests-clean.d.ts.map +1 -0
- package/dist/probes/tests-clean.js +69 -0
- package/dist/probes/tests-clean.js.map +1 -0
- package/dist/probes/tests-cover-public-surface.d.ts +3 -0
- package/dist/probes/tests-cover-public-surface.d.ts.map +1 -0
- package/dist/probes/tests-cover-public-surface.js +172 -0
- package/dist/probes/tests-cover-public-surface.js.map +1 -0
- package/dist/probes/tests-runner-configured.d.ts +3 -0
- package/dist/probes/tests-runner-configured.d.ts.map +1 -0
- package/dist/probes/tests-runner-configured.js +261 -0
- package/dist/probes/tests-runner-configured.js.map +1 -0
- package/dist/probes/types-clean.d.ts +3 -0
- package/dist/probes/types-clean.d.ts.map +1 -0
- package/dist/probes/types-clean.js +72 -0
- package/dist/probes/types-clean.js.map +1 -0
- package/dist/probes/types-configured.d.ts +3 -0
- package/dist/probes/types-configured.d.ts.map +1 -0
- package/dist/probes/types-configured.js +77 -0
- package/dist/probes/types-configured.js.map +1 -0
- package/package.json +30 -0
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const NODE_AUDIT_HINTS = [
|
|
3
|
+
/\bnpm\s+audit\b/,
|
|
4
|
+
/\bpnpm\s+audit\b/,
|
|
5
|
+
/\byarn\s+audit\b/,
|
|
6
|
+
/\baudit-ci\b/,
|
|
7
|
+
/\bbetter-npm-audit\b/,
|
|
8
|
+
/\bsnyk\s+test\b/i,
|
|
9
|
+
/\bsnyk\b/i,
|
|
10
|
+
];
|
|
11
|
+
const PY_AUDIT_HINTS = [/\bpip-audit\b/i, /\bsafety\s+(?:check|scan)\b/i];
|
|
12
|
+
const GO_AUDIT_HINTS = [/\bgovulncheck\b/i];
|
|
13
|
+
const RUST_AUDIT_HINTS = [/\bcargo[-\s]audit\b/i, /\bcargo[-\s]deny\b/i];
|
|
14
|
+
const JAVA_AUDIT_HINTS = [/\bdependency-check\b/i, /\borg\.owasp:dependency-check\b/i, /\bsnyk\b/i];
|
|
15
|
+
const DOTNET_AUDIT_HINTS = [/\bdotnet\s+list\s+package\s+--vulnerable\b/i, /\bdotnet-retire\b/i];
|
|
16
|
+
const RUBY_AUDIT_HINTS = [/\bbundle(?:r)?[-\s]audit\b/i];
|
|
17
|
+
const GENERIC_AUDIT_HINTS = [
|
|
18
|
+
/\btrivy\s+(?:fs|repo)\b/i,
|
|
19
|
+
/\bdependabot\b/i,
|
|
20
|
+
/uses:\s*github\/dependency-review-action/i,
|
|
21
|
+
];
|
|
22
|
+
const ALL_HINTS = [
|
|
23
|
+
...NODE_AUDIT_HINTS,
|
|
24
|
+
...PY_AUDIT_HINTS,
|
|
25
|
+
...GO_AUDIT_HINTS,
|
|
26
|
+
...RUST_AUDIT_HINTS,
|
|
27
|
+
...JAVA_AUDIT_HINTS,
|
|
28
|
+
...DOTNET_AUDIT_HINTS,
|
|
29
|
+
...RUBY_AUDIT_HINTS,
|
|
30
|
+
...GENERIC_AUDIT_HINTS,
|
|
31
|
+
];
|
|
32
|
+
const DEPENDABOT_PATHS = [".github/dependabot.yml", ".github/dependabot.yaml"];
|
|
33
|
+
export default defineProbe({
|
|
34
|
+
id: "deps.audit-configured",
|
|
35
|
+
version: "1.0.0",
|
|
36
|
+
dimensions: [{ id: "safety", weight: 1 }],
|
|
37
|
+
tier: "static",
|
|
38
|
+
evidence: ["node_package", "files", "ci_workflows"],
|
|
39
|
+
rationale: `
|
|
40
|
+
A vulnerability scanner is the only durable defence against a
|
|
41
|
+
transitive dependency landing a known CVE in your tree. Without one,
|
|
42
|
+
an agent (or human) won't notice until production. This probe looks
|
|
43
|
+
for a recognised audit step in package.json scripts or in a CI
|
|
44
|
+
workflow, across the major ecosystems (npm/yarn/pnpm audit,
|
|
45
|
+
pip-audit/safety, govulncheck, cargo audit / cargo deny, OWASP
|
|
46
|
+
dependency-check, \`dotnet list package --vulnerable\`,
|
|
47
|
+
bundler-audit), plus generic options (Snyk, Trivy, Dependabot).
|
|
48
|
+
`,
|
|
49
|
+
remediation: "Wire a vuln audit into CI. Node: `npx audit-ci --moderate` or `npm audit --audit-level=high`. Python: `pip-audit`. Go: `govulncheck ./...`. Rust: `cargo audit`. Java: OWASP `dependency-check`. .NET: `dotnet list package --vulnerable --include-transitive`. Ruby: `bundle audit`. Alternative: enable GitHub Dependabot (commit `.github/dependabot.yml`) or use Snyk/Trivy. Pick one — any audit is better than no audit.",
|
|
50
|
+
async detect(ev) {
|
|
51
|
+
const checkText = (raw) => raw ? ALL_HINTS.some((p) => p.test(raw)) : false;
|
|
52
|
+
if (ev.node_package.present) {
|
|
53
|
+
const scriptsBlob = Object.values(ev.node_package.scripts).join("\n");
|
|
54
|
+
if (checkText(scriptsBlob))
|
|
55
|
+
return { kind: "predicate", value: true };
|
|
56
|
+
if ("audit-ci" in ev.node_package.devDependencies ||
|
|
57
|
+
"better-npm-audit" in ev.node_package.devDependencies ||
|
|
58
|
+
"snyk" in ev.node_package.devDependencies) {
|
|
59
|
+
return { kind: "predicate", value: true };
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
for (const wf of ev.ci_workflows.workflows) {
|
|
63
|
+
if (ALL_HINTS.some((p) => p.test(wf.raw))) {
|
|
64
|
+
return { kind: "predicate", value: true };
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
for (const path of DEPENDABOT_PATHS) {
|
|
68
|
+
if (ev.files.has(path))
|
|
69
|
+
return { kind: "predicate", value: true };
|
|
70
|
+
}
|
|
71
|
+
return { kind: "predicate", value: false };
|
|
72
|
+
},
|
|
73
|
+
score: { kind: "predicate", direction: "positive" },
|
|
74
|
+
fixtures: [
|
|
75
|
+
{
|
|
76
|
+
name: "nothing-configured",
|
|
77
|
+
evidence: {
|
|
78
|
+
node_package: { present: true },
|
|
79
|
+
files: [],
|
|
80
|
+
ci_workflows: { present: false, workflows: [] },
|
|
81
|
+
},
|
|
82
|
+
expect: { reading: { kind: "predicate", value: false }, score: 0 },
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
name: "npm-audit-in-script",
|
|
86
|
+
evidence: {
|
|
87
|
+
node_package: {
|
|
88
|
+
present: true,
|
|
89
|
+
scripts: { audit: "npm audit --audit-level=high" },
|
|
90
|
+
},
|
|
91
|
+
files: [],
|
|
92
|
+
ci_workflows: { present: false, workflows: [] },
|
|
93
|
+
},
|
|
94
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
name: "audit-ci-devdep",
|
|
98
|
+
evidence: {
|
|
99
|
+
node_package: {
|
|
100
|
+
present: true,
|
|
101
|
+
devDependencies: { "audit-ci": "^7.0.0" },
|
|
102
|
+
},
|
|
103
|
+
files: [],
|
|
104
|
+
ci_workflows: { present: false, workflows: [] },
|
|
105
|
+
},
|
|
106
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
name: "govulncheck-in-ci",
|
|
110
|
+
evidence: {
|
|
111
|
+
node_package: { present: false },
|
|
112
|
+
files: [],
|
|
113
|
+
ci_workflows: {
|
|
114
|
+
present: true,
|
|
115
|
+
workflows: [{ path: ".github/workflows/sec.yml", raw: "run: govulncheck ./..." }],
|
|
116
|
+
},
|
|
117
|
+
},
|
|
118
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
name: "cargo-audit-in-ci",
|
|
122
|
+
evidence: {
|
|
123
|
+
node_package: { present: false },
|
|
124
|
+
files: [],
|
|
125
|
+
ci_workflows: {
|
|
126
|
+
present: true,
|
|
127
|
+
workflows: [{ path: ".github/workflows/audit.yml", raw: "run: cargo audit" }],
|
|
128
|
+
},
|
|
129
|
+
},
|
|
130
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
131
|
+
},
|
|
132
|
+
{
|
|
133
|
+
name: "dotnet-vulnerable-in-ci",
|
|
134
|
+
evidence: {
|
|
135
|
+
node_package: { present: false },
|
|
136
|
+
files: [],
|
|
137
|
+
ci_workflows: {
|
|
138
|
+
present: true,
|
|
139
|
+
workflows: [
|
|
140
|
+
{
|
|
141
|
+
path: ".github/workflows/ci.yml",
|
|
142
|
+
raw: "run: dotnet list package --vulnerable --include-transitive",
|
|
143
|
+
},
|
|
144
|
+
],
|
|
145
|
+
},
|
|
146
|
+
},
|
|
147
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
name: "dependabot-config",
|
|
151
|
+
evidence: {
|
|
152
|
+
node_package: { present: false },
|
|
153
|
+
files: [".github/dependabot.yml"],
|
|
154
|
+
ci_workflows: { present: false, workflows: [] },
|
|
155
|
+
},
|
|
156
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
name: "pip-audit-in-ci",
|
|
160
|
+
evidence: {
|
|
161
|
+
node_package: { present: false },
|
|
162
|
+
files: [],
|
|
163
|
+
ci_workflows: {
|
|
164
|
+
present: true,
|
|
165
|
+
workflows: [{ path: ".github/workflows/sec.yml", raw: "run: pip-audit" }],
|
|
166
|
+
},
|
|
167
|
+
},
|
|
168
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
169
|
+
},
|
|
170
|
+
],
|
|
171
|
+
});
|
|
172
|
+
//# sourceMappingURL=deps-audit-configured.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deps-audit-configured.js","sourceRoot":"","sources":["../../src/probes/deps-audit-configured.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,gBAAgB,GAAG;IACvB,iBAAiB;IACjB,kBAAkB;IAClB,kBAAkB;IAClB,cAAc;IACd,sBAAsB;IACtB,kBAAkB;IAClB,WAAW;CACZ,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,gBAAgB,EAAE,8BAA8B,CAAC,CAAC;AAC1E,MAAM,cAAc,GAAG,CAAC,kBAAkB,CAAC,CAAC;AAC5C,MAAM,gBAAgB,GAAG,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAAC;AACzE,MAAM,gBAAgB,GAAG,CAAC,uBAAuB,EAAE,kCAAkC,EAAE,WAAW,CAAC,CAAC;AACpG,MAAM,kBAAkB,GAAG,CAAC,6CAA6C,EAAE,oBAAoB,CAAC,CAAC;AACjG,MAAM,gBAAgB,GAAG,CAAC,6BAA6B,CAAC,CAAC;AACzD,MAAM,mBAAmB,GAAG;IAC1B,0BAA0B;IAC1B,iBAAiB;IACjB,2CAA2C;CAC5C,CAAC;AAEF,MAAM,SAAS,GAAG;IAChB,GAAG,gBAAgB;IACnB,GAAG,cAAc;IACjB,GAAG,cAAc;IACjB,GAAG,gBAAgB;IACnB,GAAG,gBAAgB;IACnB,GAAG,kBAAkB;IACrB,GAAG,gBAAgB;IACnB,GAAG,mBAAmB;CACvB,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,wBAAwB,EAAE,yBAAyB,CAAC,CAAC;AAE/E,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,uBAAuB;IAC3B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACzC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,CAAC;IAEnD,SAAS,EAAE;;;;;;;;;GASV;IAED,WAAW,EACT,gaAAga;IAEla,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,SAAS,GAAG,CAAC,GAAuB,EAAE,EAAE,CAC5C,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEnD,IAAI,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,IAAI,SAAS,CAAC,WAAW,CAAC;gBAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACtE,IACE,UAAU,IAAI,EAAE,CAAC,YAAY,CAAC,eAAe;gBAC7C,kBAAkB,IAAI,EAAE,CAAC,YAAY,CAAC,eAAe;gBACrD,MAAM,IAAI,EAAE,CAAC,YAAY,CAAC,eAAe,EACzC,CAAC;gBACD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,EAAE,IAAI,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;YAC3C,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC1C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;YACpC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACpE,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAED,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE;IAEnD,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,oBAAoB;YAC1B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;gBAC/B,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;aAChD;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACnE;QACD;YACE,IAAI,EAAE,qBAAqB;YAC3B,QAAQ,EAAE;gBACR,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,EAAE,KAAK,EAAE,8BAA8B,EAAE;iBACnD;gBACD,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;aAChD;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE;gBACR,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE;iBAC1C;gBACD,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;aAChD;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,2BAA2B,EAAE,GAAG,EAAE,wBAAwB,EAAE,CAAC;iBAClF;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,GAAG,EAAE,kBAAkB,EAAE,CAAC;iBAC9E;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,yBAAyB;YAC/B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE;wBACT;4BACE,IAAI,EAAE,0BAA0B;4BAChC,GAAG,EAAE,4DAA4D;yBAClE;qBACF;iBACF;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,CAAC,wBAAwB,CAAC;gBACjC,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;aAChD;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,YAAY,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,2BAA2B,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC;iBAC1E;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deps-lockfile-present.d.ts","sourceRoot":"","sources":["../../src/probes/deps-lockfile-present.ts"],"names":[],"mappings":";AA0BA,wBAwLG"}
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const NODE_LOCKFILES = [
|
|
3
|
+
"package-lock.json",
|
|
4
|
+
"npm-shrinkwrap.json",
|
|
5
|
+
"yarn.lock",
|
|
6
|
+
"pnpm-lock.yaml",
|
|
7
|
+
"bun.lockb",
|
|
8
|
+
"bun.lock",
|
|
9
|
+
];
|
|
10
|
+
const PY_MANIFEST = /(?:^|\/)(?:pyproject\.toml|setup\.cfg|setup\.py|Pipfile)$/i;
|
|
11
|
+
const PY_LOCKFILES = /(?:^|\/)(?:poetry\.lock|Pipfile\.lock|uv\.lock|pdm\.lock)$/i;
|
|
12
|
+
const GO_MOD = /(?:^|\/)go\.mod$/i;
|
|
13
|
+
const GO_SUM = /(?:^|\/)go\.sum$/i;
|
|
14
|
+
const RUST_MANIFEST = /(?:^|\/)Cargo\.toml$/i;
|
|
15
|
+
const RUST_LOCKFILE = /(?:^|\/)Cargo\.lock$/i;
|
|
16
|
+
const RUBY_GEMFILE = /(?:^|\/)Gemfile$/;
|
|
17
|
+
const RUBY_LOCKFILE = /(?:^|\/)Gemfile\.lock$/;
|
|
18
|
+
const DOTNET_PROJECT = /\.(?:cs|fs|vb)proj$/i;
|
|
19
|
+
const DOTNET_LOCKFILE = /(?:^|\/)packages\.lock\.json$/i;
|
|
20
|
+
export default defineProbe({
|
|
21
|
+
id: "deps.lockfile-present",
|
|
22
|
+
version: "1.0.0",
|
|
23
|
+
dimensions: [{ id: "safety", weight: 1 }],
|
|
24
|
+
tier: "static",
|
|
25
|
+
evidence: ["node_package", "files", "size_stats"],
|
|
26
|
+
rationale: `
|
|
27
|
+
A lockfile pins the exact dependency graph an agent (or anyone else)
|
|
28
|
+
will install. Without one, two installs minutes apart can produce
|
|
29
|
+
different trees, and the agent's "works on my machine" may not be
|
|
30
|
+
reproducible. This probe checks for a lockfile alongside a recognised
|
|
31
|
+
manifest across Node, Python (poetry/pipenv/uv/pdm), Go (\`go.sum\`),
|
|
32
|
+
Rust (\`Cargo.lock\`), Ruby (\`Gemfile.lock\`), and .NET
|
|
33
|
+
(\`packages.lock.json\`). Maven has no native lockfile concept and is
|
|
34
|
+
ignored.
|
|
35
|
+
`,
|
|
36
|
+
remediation: "Commit a lockfile. Node: run `npm install` / `yarn` / `pnpm install` / `bun install` and check in the resulting lockfile. Python: use Poetry, Pipenv, uv, or pdm and commit their lockfile. Go: `go mod tidy` then commit `go.sum`. Rust: commit `Cargo.lock` (binaries — for libraries it's optional but harmless). Ruby: commit `Gemfile.lock`. .NET: set `<RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>` in the project and commit `packages.lock.json`.",
|
|
37
|
+
async detect(ev) {
|
|
38
|
+
const allPaths = ev.size_stats.files.map((f) => f.path);
|
|
39
|
+
const hasFile = (re) => allPaths.some((p) => re.test(p));
|
|
40
|
+
const ecosystems = [];
|
|
41
|
+
if (ev.node_package.present) {
|
|
42
|
+
const hasNodeLock = NODE_LOCKFILES.some((name) => ev.files.has(name));
|
|
43
|
+
ecosystems.push({ name: "node", manifest: true, lockfile: hasNodeLock });
|
|
44
|
+
}
|
|
45
|
+
if (hasFile(PY_MANIFEST)) {
|
|
46
|
+
ecosystems.push({ name: "python", manifest: true, lockfile: hasFile(PY_LOCKFILES) });
|
|
47
|
+
}
|
|
48
|
+
if (hasFile(GO_MOD)) {
|
|
49
|
+
ecosystems.push({ name: "go", manifest: true, lockfile: hasFile(GO_SUM) });
|
|
50
|
+
}
|
|
51
|
+
if (hasFile(RUST_MANIFEST)) {
|
|
52
|
+
ecosystems.push({ name: "rust", manifest: true, lockfile: hasFile(RUST_LOCKFILE) });
|
|
53
|
+
}
|
|
54
|
+
if (hasFile(RUBY_GEMFILE)) {
|
|
55
|
+
ecosystems.push({ name: "ruby", manifest: true, lockfile: hasFile(RUBY_LOCKFILE) });
|
|
56
|
+
}
|
|
57
|
+
if (hasFile(DOTNET_PROJECT)) {
|
|
58
|
+
ecosystems.push({ name: "dotnet", manifest: true, lockfile: hasFile(DOTNET_LOCKFILE) });
|
|
59
|
+
}
|
|
60
|
+
if (ecosystems.length === 0) {
|
|
61
|
+
return { kind: "na", reason: "no recognised dependency manifest" };
|
|
62
|
+
}
|
|
63
|
+
const allLocked = ecosystems.every((e) => e.lockfile);
|
|
64
|
+
return { kind: "predicate", value: allLocked };
|
|
65
|
+
},
|
|
66
|
+
score: { kind: "predicate", direction: "positive" },
|
|
67
|
+
fixtures: [
|
|
68
|
+
{
|
|
69
|
+
name: "no-manifest",
|
|
70
|
+
evidence: {
|
|
71
|
+
node_package: { present: false },
|
|
72
|
+
size_stats: { files: [], totalBytes: 0, totalFiles: 0, source: "git-ls-files" },
|
|
73
|
+
files: [],
|
|
74
|
+
},
|
|
75
|
+
expect: { reading: { kind: "na", reason: "no recognised dependency manifest" }, score: null },
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
name: "node-with-lockfile",
|
|
79
|
+
evidence: {
|
|
80
|
+
node_package: { present: true },
|
|
81
|
+
files: ["package-lock.json"],
|
|
82
|
+
size_stats: { files: [], totalBytes: 0, totalFiles: 0, source: "git-ls-files" },
|
|
83
|
+
},
|
|
84
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
name: "node-no-lockfile",
|
|
88
|
+
evidence: {
|
|
89
|
+
node_package: { present: true },
|
|
90
|
+
files: [],
|
|
91
|
+
size_stats: { files: [], totalBytes: 0, totalFiles: 0, source: "git-ls-files" },
|
|
92
|
+
},
|
|
93
|
+
expect: { reading: { kind: "predicate", value: false }, score: 0 },
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
name: "go-with-sum",
|
|
97
|
+
evidence: {
|
|
98
|
+
node_package: { present: false },
|
|
99
|
+
files: [],
|
|
100
|
+
size_stats: {
|
|
101
|
+
source: "git-ls-files",
|
|
102
|
+
totalBytes: 200,
|
|
103
|
+
totalFiles: 2,
|
|
104
|
+
files: [
|
|
105
|
+
{ path: "go.mod", bytes: 100, lines: 5, depth: 0 },
|
|
106
|
+
{ path: "go.sum", bytes: 100, lines: 5, depth: 0 },
|
|
107
|
+
],
|
|
108
|
+
},
|
|
109
|
+
},
|
|
110
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
name: "rust-no-cargo-lock",
|
|
114
|
+
evidence: {
|
|
115
|
+
node_package: { present: false },
|
|
116
|
+
files: [],
|
|
117
|
+
size_stats: {
|
|
118
|
+
source: "git-ls-files",
|
|
119
|
+
totalBytes: 100,
|
|
120
|
+
totalFiles: 1,
|
|
121
|
+
files: [{ path: "Cargo.toml", bytes: 100, lines: 5, depth: 0 }],
|
|
122
|
+
},
|
|
123
|
+
},
|
|
124
|
+
expect: { reading: { kind: "predicate", value: false }, score: 0 },
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
name: "dotnet-with-packages-lock",
|
|
128
|
+
evidence: {
|
|
129
|
+
node_package: { present: false },
|
|
130
|
+
files: [],
|
|
131
|
+
size_stats: {
|
|
132
|
+
source: "git-ls-files",
|
|
133
|
+
totalBytes: 200,
|
|
134
|
+
totalFiles: 2,
|
|
135
|
+
files: [
|
|
136
|
+
{ path: "src/App.csproj", bytes: 100, lines: 5, depth: 1 },
|
|
137
|
+
{ path: "src/packages.lock.json", bytes: 100, lines: 5, depth: 1 },
|
|
138
|
+
],
|
|
139
|
+
},
|
|
140
|
+
},
|
|
141
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
name: "python-pipfile-no-lock",
|
|
145
|
+
evidence: {
|
|
146
|
+
node_package: { present: false },
|
|
147
|
+
files: [],
|
|
148
|
+
size_stats: {
|
|
149
|
+
source: "git-ls-files",
|
|
150
|
+
totalBytes: 100,
|
|
151
|
+
totalFiles: 1,
|
|
152
|
+
files: [{ path: "Pipfile", bytes: 100, lines: 5, depth: 0 }],
|
|
153
|
+
},
|
|
154
|
+
},
|
|
155
|
+
expect: { reading: { kind: "predicate", value: false }, score: 0 },
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
name: "ruby-with-gemfile-lock",
|
|
159
|
+
evidence: {
|
|
160
|
+
node_package: { present: false },
|
|
161
|
+
files: [],
|
|
162
|
+
size_stats: {
|
|
163
|
+
source: "git-ls-files",
|
|
164
|
+
totalBytes: 200,
|
|
165
|
+
totalFiles: 2,
|
|
166
|
+
files: [
|
|
167
|
+
{ path: "Gemfile", bytes: 100, lines: 5, depth: 0 },
|
|
168
|
+
{ path: "Gemfile.lock", bytes: 100, lines: 5, depth: 0 },
|
|
169
|
+
],
|
|
170
|
+
},
|
|
171
|
+
},
|
|
172
|
+
expect: { reading: { kind: "predicate", value: true }, score: 100 },
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
name: "node-locked-but-go-unlocked",
|
|
176
|
+
evidence: {
|
|
177
|
+
node_package: { present: true },
|
|
178
|
+
files: ["package-lock.json"],
|
|
179
|
+
size_stats: {
|
|
180
|
+
source: "git-ls-files",
|
|
181
|
+
totalBytes: 100,
|
|
182
|
+
totalFiles: 1,
|
|
183
|
+
files: [{ path: "go.mod", bytes: 100, lines: 5, depth: 0 }],
|
|
184
|
+
},
|
|
185
|
+
},
|
|
186
|
+
expect: { reading: { kind: "predicate", value: false }, score: 0 },
|
|
187
|
+
},
|
|
188
|
+
],
|
|
189
|
+
});
|
|
190
|
+
//# sourceMappingURL=deps-lockfile-present.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deps-lockfile-present.js","sourceRoot":"","sources":["../../src/probes/deps-lockfile-present.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,cAAc,GAAG;IACrB,mBAAmB;IACnB,qBAAqB;IACrB,WAAW;IACX,gBAAgB;IAChB,WAAW;IACX,UAAU;CACX,CAAC;AAEF,MAAM,WAAW,GAAG,4DAA4D,CAAC;AACjF,MAAM,YAAY,GAAG,6DAA6D,CAAC;AAEnF,MAAM,MAAM,GAAG,mBAAmB,CAAC;AACnC,MAAM,MAAM,GAAG,mBAAmB,CAAC;AAEnC,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAC9C,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAE9C,MAAM,YAAY,GAAG,kBAAkB,CAAC;AACxC,MAAM,aAAa,GAAG,wBAAwB,CAAC;AAE/C,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAC9C,MAAM,eAAe,GAAG,gCAAgC,CAAC;AAEzD,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,uBAAuB;IAC3B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACzC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,YAAY,CAAC;IAEjD,SAAS,EAAE;;;;;;;;;GASV;IAED,WAAW,EACT,+cAA+c;IAEjd,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjE,MAAM,UAAU,GAA6D,EAAE,CAAC;QAEhF,IAAI,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YACtE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3B,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1B,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5B,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACjD,CAAC;IAED,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE;IAEnD,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE;gBAC/E,KAAK,EAAE,EAAE;aACV;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mCAAmC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;SAC9F;QACD;YACE,IAAI,EAAE,oBAAoB;YAC1B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;gBAC/B,KAAK,EAAE,CAAC,mBAAmB,CAAC;gBAC5B,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE;aAChF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;gBAC/B,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE;aAChF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACnE;QACD;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBAClD,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;qBACnD;iBACF;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,oBAAoB;YAC1B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAChE;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACnE;QACD;YACE,IAAI,EAAE,2BAA2B;YACjC,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBAC1D,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;qBACnE;iBACF;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,wBAAwB;YAC9B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC7D;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACnE;QACD;YACE,IAAI,EAAE,wBAAwB;YAC9B,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;gBAChC,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACnD,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;qBACzD;iBACF;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACpE;QACD;YACE,IAAI,EAAE,6BAA6B;YACnC,QAAQ,EAAE;gBACR,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;gBAC/B,KAAK,EAAE,CAAC,mBAAmB,CAAC;gBAC5B,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC5D;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACnE;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-adr-presence.d.ts","sourceRoot":"","sources":["../../src/probes/docs-adr-presence.ts"],"names":[],"mappings":";AAMA,wBA6EG"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const ADR_DIRS = ["docs/adr/", "doc/adr/", "adr/", "decisions/", "docs/decisions/"];
|
|
3
|
+
const ADR_FILE_PATTERN = /\.(md|markdown)$/i;
|
|
4
|
+
export default defineProbe({
|
|
5
|
+
id: "docs.adr-presence",
|
|
6
|
+
version: "1.0.0",
|
|
7
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
8
|
+
tier: "derived",
|
|
9
|
+
evidence: ["size_stats"],
|
|
10
|
+
rationale: `
|
|
11
|
+
Architecture Decision Records explain *why* the codebase looks the way
|
|
12
|
+
it does — exactly the questions an agent would otherwise ask the team.
|
|
13
|
+
Counting ADRs is cheap and revealing: zero means decisions are tribal
|
|
14
|
+
knowledge.
|
|
15
|
+
`,
|
|
16
|
+
remediation: "Start writing ADRs (Architecture Decision Records) under `docs/adr/`. Each one captures one decision: the context, the options, what you chose, and why. Even short ADRs (50–200 words) prevent future debates from re-litigating settled choices. Templates: see adr.github.io or `Nygard`-style.",
|
|
17
|
+
async detect(ev) {
|
|
18
|
+
if (ev.size_stats.source === "none") {
|
|
19
|
+
return { kind: "na", reason: "no git working tree" };
|
|
20
|
+
}
|
|
21
|
+
const samples = [];
|
|
22
|
+
for (const f of ev.size_stats.files) {
|
|
23
|
+
if (ADR_DIRS.some((d) => f.path.startsWith(d)) && ADR_FILE_PATTERN.test(f.path)) {
|
|
24
|
+
samples.push({ path: f.path });
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return { kind: "count", value: samples.length, samples: samples.slice(0, 5) };
|
|
28
|
+
},
|
|
29
|
+
score: {
|
|
30
|
+
kind: "count",
|
|
31
|
+
direction: "positive",
|
|
32
|
+
bands: [{ upTo: 0, score: 0 }, { upTo: 2, score: 30 }, { upTo: 5, score: 70 }, { score: 100 }],
|
|
33
|
+
},
|
|
34
|
+
fixtures: [
|
|
35
|
+
{
|
|
36
|
+
name: "no-adrs",
|
|
37
|
+
evidence: {
|
|
38
|
+
size_stats: {
|
|
39
|
+
source: "git-ls-files",
|
|
40
|
+
totalBytes: 0,
|
|
41
|
+
totalFiles: 1,
|
|
42
|
+
files: [{ path: "src/x.ts", bytes: 1, lines: 1, depth: 2 }],
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
expect: { reading: { kind: "count", value: 0, samples: [] }, score: 0 },
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
name: "three-adrs",
|
|
49
|
+
evidence: {
|
|
50
|
+
size_stats: {
|
|
51
|
+
source: "git-ls-files",
|
|
52
|
+
totalBytes: 0,
|
|
53
|
+
totalFiles: 3,
|
|
54
|
+
files: [
|
|
55
|
+
{ path: "docs/adr/0001-intro.md", bytes: 1, lines: 1, depth: 3 },
|
|
56
|
+
{ path: "docs/adr/0002-stack.md", bytes: 1, lines: 1, depth: 3 },
|
|
57
|
+
{ path: "docs/adr/0003-license.md", bytes: 1, lines: 1, depth: 3 },
|
|
58
|
+
],
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
expect: {
|
|
62
|
+
reading: {
|
|
63
|
+
kind: "count",
|
|
64
|
+
value: 3,
|
|
65
|
+
samples: [
|
|
66
|
+
{ path: "docs/adr/0001-intro.md" },
|
|
67
|
+
{ path: "docs/adr/0002-stack.md" },
|
|
68
|
+
{ path: "docs/adr/0003-license.md" },
|
|
69
|
+
],
|
|
70
|
+
},
|
|
71
|
+
score: 70,
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
],
|
|
75
|
+
});
|
|
76
|
+
//# sourceMappingURL=docs-adr-presence.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-adr-presence.js","sourceRoot":"","sources":["../../src/probes/docs-adr-presence.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;AACpF,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAE7C,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,mBAAmB;IACvB,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,SAAS;IACf,QAAQ,EAAE,CAAC,YAAY,CAAC;IAExB,SAAS,EAAE;;;;;GAKV;IAED,WAAW,EACT,oSAAoS;IAEtS,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACpC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAC;QACvD,CAAC;QACD,MAAM,OAAO,GAAe,EAAE,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACpC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChF,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAChF,CAAC;IAED,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,UAAU;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;KAC/F;IAED,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE;gBACR,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,CAAC;oBACb,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC5D;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACxE;QACD;YACE,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE;gBACR,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,CAAC;oBACb,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBAChE,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBAChE,EAAE,IAAI,EAAE,0BAA0B,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;qBACnE;iBACF;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,CAAC;oBACR,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,wBAAwB,EAAE;wBAClC,EAAE,IAAI,EAAE,wBAAwB,EAAE;wBAClC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;gBACD,KAAK,EAAE,EAAE;aACV;SACF;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-adr-quality.d.ts","sourceRoot":"","sources":["../../src/probes/docs-adr-quality.ts"],"names":[],"mappings":";AA+BA,wBAgHG"}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const PROBE_VERSION = "1.0.0";
|
|
3
|
+
const MAX_ADRS = 5;
|
|
4
|
+
const MAX_CHARS_PER_ADR = 3_000;
|
|
5
|
+
const MAX_INPUT_CHARS = 18_000;
|
|
6
|
+
const ADR_DIRS = ["docs/adr/", "doc/adr/", "adr/", "decisions/", "docs/decisions/"];
|
|
7
|
+
const ADR_FILE = /\.(?:md|markdown)$/i;
|
|
8
|
+
const RUBRIC = {
|
|
9
|
+
task: "Judge the substance of these Architecture Decision Records. Are they recording real decisions in a form an agent could learn from, or are they templates with the slots empty?",
|
|
10
|
+
criteria: [
|
|
11
|
+
{
|
|
12
|
+
id: "decision-stated",
|
|
13
|
+
description: "Does each ADR actually state a decision? A good ADR names what was chosen, what the alternatives were, and which one won. A 'Status: Proposed — TBD' ADR doesn't count; nor does an ADR that lists alternatives without picking one.",
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
id: "rationale-clear",
|
|
17
|
+
description: "Does the ADR explain *why* — the constraint, the tradeoff, or the past incident that drove the call? Without rationale an agent can't tell whether a change is safe to revisit. Bullet lists of pros/cons with no synthesis count for less than a paragraph that names the binding constraint.",
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
id: "current-and-living",
|
|
21
|
+
description: "Do the ADRs feel maintained — statuses meaningful (Accepted / Superseded / Deprecated with a pointer), dates present, content matching how the code actually works today? A folder of accepted-but-untrue ADRs is a trap; the agent will follow them and be wrong.",
|
|
22
|
+
},
|
|
23
|
+
],
|
|
24
|
+
};
|
|
25
|
+
export default defineProbe({
|
|
26
|
+
id: "docs.adr-quality",
|
|
27
|
+
version: PROBE_VERSION,
|
|
28
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
29
|
+
tier: "reasoned",
|
|
30
|
+
evidence: ["files", "size_stats", "judge"],
|
|
31
|
+
rationale: `
|
|
32
|
+
docs.adr-presence counts files. An ADR folder can hit the count
|
|
33
|
+
without recording any real decisions — templates with empty slots,
|
|
34
|
+
"TBD" statuses, lists of alternatives with no choice. This probe
|
|
35
|
+
samples a few ADRs and asks an LLM whether they describe actual
|
|
36
|
+
decisions, with rationale, that are still current. Cached.
|
|
37
|
+
`,
|
|
38
|
+
remediation: "Make your ADRs actually decide something. Each should name: (1) the decision made, (2) the alternatives considered, (3) why this option won (the binding constraint or tradeoff), (4) status (Accepted / Superseded with pointer / Deprecated) and a date. Empty templates and 'Proposed — TBD' don't count.",
|
|
39
|
+
async detect(ev) {
|
|
40
|
+
const adrPaths = ev.size_stats.files
|
|
41
|
+
.map((f) => f.path)
|
|
42
|
+
.filter((p) => ADR_DIRS.some((d) => p.startsWith(d)) && ADR_FILE.test(p))
|
|
43
|
+
.sort();
|
|
44
|
+
if (adrPaths.length === 0) {
|
|
45
|
+
return { kind: "na", reason: "no ADRs found" };
|
|
46
|
+
}
|
|
47
|
+
const sampled = [];
|
|
48
|
+
let totalChars = 0;
|
|
49
|
+
for (const p of adrPaths) {
|
|
50
|
+
if (sampled.length >= MAX_ADRS)
|
|
51
|
+
break;
|
|
52
|
+
const text = await ev.files.readText(p);
|
|
53
|
+
if (!text)
|
|
54
|
+
continue;
|
|
55
|
+
const slice = text.slice(0, MAX_CHARS_PER_ADR);
|
|
56
|
+
sampled.push({ path: p, text: slice });
|
|
57
|
+
totalChars += slice.length;
|
|
58
|
+
if (totalChars >= MAX_INPUT_CHARS)
|
|
59
|
+
break;
|
|
60
|
+
}
|
|
61
|
+
if (sampled.length === 0) {
|
|
62
|
+
return { kind: "na", reason: "ADR files declared but unreadable" };
|
|
63
|
+
}
|
|
64
|
+
const input = sampled.map((s) => `# ${s.path}\n\n${s.text}`).join("\n\n---\n\n");
|
|
65
|
+
const result = await ev.judge.score({
|
|
66
|
+
probeId: "docs.adr-quality",
|
|
67
|
+
probeVersion: PROBE_VERSION,
|
|
68
|
+
input,
|
|
69
|
+
rubric: RUBRIC,
|
|
70
|
+
});
|
|
71
|
+
return {
|
|
72
|
+
kind: "judge",
|
|
73
|
+
score: result.score,
|
|
74
|
+
perCriterion: result.perCriterion,
|
|
75
|
+
rationale: result.rationale,
|
|
76
|
+
model: result.model,
|
|
77
|
+
};
|
|
78
|
+
},
|
|
79
|
+
score: { kind: "judge" },
|
|
80
|
+
fixtures: [
|
|
81
|
+
{
|
|
82
|
+
name: "no-adrs",
|
|
83
|
+
evidence: {
|
|
84
|
+
size_stats: { files: [], totalBytes: 0, totalFiles: 0, source: "git-ls-files" },
|
|
85
|
+
},
|
|
86
|
+
expect: { reading: { kind: "na", reason: "no ADRs found" }, score: null },
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
name: "substantive-adrs",
|
|
90
|
+
evidence: {
|
|
91
|
+
size_stats: {
|
|
92
|
+
source: "git-ls-files",
|
|
93
|
+
totalBytes: 200,
|
|
94
|
+
totalFiles: 1,
|
|
95
|
+
files: [{ path: "docs/adr/0001-stack.md", bytes: 200, lines: 20, depth: 2 }],
|
|
96
|
+
},
|
|
97
|
+
files: {
|
|
98
|
+
"docs/adr/0001-stack.md": "# Use TypeScript\nStatus: Accepted (2026-01)\nDecision: ts.\nWhy: types catch errors.\n",
|
|
99
|
+
},
|
|
100
|
+
judge: {
|
|
101
|
+
score: 80,
|
|
102
|
+
perCriterion: {
|
|
103
|
+
"decision-stated": 80,
|
|
104
|
+
"rationale-clear": 80,
|
|
105
|
+
"current-and-living": 80,
|
|
106
|
+
},
|
|
107
|
+
rationale: "Clear decision, dated, with rationale.",
|
|
108
|
+
model: "fixture",
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
expect: {
|
|
112
|
+
reading: {
|
|
113
|
+
kind: "judge",
|
|
114
|
+
score: 80,
|
|
115
|
+
perCriterion: {
|
|
116
|
+
"decision-stated": 80,
|
|
117
|
+
"rationale-clear": 80,
|
|
118
|
+
"current-and-living": 80,
|
|
119
|
+
},
|
|
120
|
+
rationale: "Clear decision, dated, with rationale.",
|
|
121
|
+
model: "fixture",
|
|
122
|
+
},
|
|
123
|
+
score: 80,
|
|
124
|
+
},
|
|
125
|
+
},
|
|
126
|
+
],
|
|
127
|
+
});
|
|
128
|
+
//# sourceMappingURL=docs-adr-quality.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-adr-quality.js","sourceRoot":"","sources":["../../src/probes/docs-adr-quality.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,aAAa,GAAG,OAAO,CAAC;AAC9B,MAAM,QAAQ,GAAG,CAAC,CAAC;AACnB,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAChC,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;AACpF,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AAEvC,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,gLAAgL;IACtL,QAAQ,EAAE;QACR;YACE,EAAE,EAAE,iBAAiB;YACrB,WAAW,EACT,sOAAsO;SACzO;QACD;YACE,EAAE,EAAE,iBAAiB;YACrB,WAAW,EACT,gSAAgS;SACnS;QACD;YACE,EAAE,EAAE,oBAAoB;YACxB,WAAW,EACT,oQAAoQ;SACvQ;KACF;CACO,CAAC;AAEX,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,kBAAkB;IACtB,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC;IAE1C,SAAS,EAAE;;;;;;GAMV;IAED,WAAW,EACT,8SAA8S;IAEhT,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK;aACjC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACxE,IAAI,EAAE,CAAC;QAEV,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;QACjD,CAAC;QAED,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,IAAI,OAAO,CAAC,MAAM,IAAI,QAAQ;gBAAE,MAAM;YACtC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAC/C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YACvC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC;YAC3B,IAAI,UAAU,IAAI,eAAe;gBAAE,MAAM;QAC3C,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAC;QACrE,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEjF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;YAClC,OAAO,EAAE,kBAAkB;YAC3B,YAAY,EAAE,aAAa;YAC3B,KAAK;YACL,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC;IACJ,CAAC;IAED,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;IAExB,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE;gBACR,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE;aAChF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;SAC1E;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,QAAQ,EAAE;gBACR,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC7E;gBACD,KAAK,EAAE;oBACL,wBAAwB,EACtB,yFAAyF;iBAC5F;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE;wBACZ,iBAAiB,EAAE,EAAE;wBACrB,iBAAiB,EAAE,EAAE;wBACrB,oBAAoB,EAAE,EAAE;qBACzB;oBACD,SAAS,EAAE,wCAAwC;oBACnD,KAAK,EAAE,SAAS;iBACjB;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE;wBACZ,iBAAiB,EAAE,EAAE;wBACrB,iBAAiB,EAAE,EAAE;wBACrB,oBAAoB,EAAE,EAAE;qBACzB;oBACD,SAAS,EAAE,wCAAwC;oBACnD,KAAK,EAAE,SAAS;iBACjB;gBACD,KAAK,EAAE,EAAE;aACV;SACF;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-contributing-present.d.ts","sourceRoot":"","sources":["../../src/probes/docs-contributing-present.ts"],"names":[],"mappings":";AAEA,wBAaG"}
|