@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,15 @@
|
|
|
1
|
+
import { fileExists } from "@esbenwiberg/repofit/sdk/recipes";
|
|
2
|
+
export default fileExists({
|
|
3
|
+
id: "docs.contributing-present",
|
|
4
|
+
version: "1.0.0",
|
|
5
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
6
|
+
rationale: `
|
|
7
|
+
CONTRIBUTING.md tells an agent (and humans) how this project expects
|
|
8
|
+
change to flow: branch naming, commit format, review process, where
|
|
9
|
+
tests live. Without it, agents fall back to generic defaults that
|
|
10
|
+
rarely match house style.
|
|
11
|
+
`,
|
|
12
|
+
remediation: "Add `CONTRIBUTING.md` at the repo root. Cover: branch naming, commit message format, how to run tests/lint, the PR/review process, and where tests/specs live.",
|
|
13
|
+
path: "CONTRIBUTING.md",
|
|
14
|
+
});
|
|
15
|
+
//# sourceMappingURL=docs-contributing-present.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-contributing-present.js","sourceRoot":"","sources":["../../src/probes/docs-contributing-present.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,2BAA2B;IAC/B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,SAAS,EAAE;;;;;GAKV;IACD,WAAW,EACT,gKAAgK;IAClK,IAAI,EAAE,iBAAiB;CACxB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-links-resolved.d.ts","sourceRoot":"","sources":["../../src/probes/docs-links-resolved.ts"],"names":[],"mappings":";AA6BA,wBAyOG"}
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
import path from "node:path";
|
|
2
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
3
|
+
const DOC_SOURCES = [
|
|
4
|
+
/^README\.md$/i,
|
|
5
|
+
/^CLAUDE\.md$/,
|
|
6
|
+
/^AGENTS\.md$/,
|
|
7
|
+
/^CONTRIBUTING\.md$/i,
|
|
8
|
+
/^docs\//i,
|
|
9
|
+
/^specs\//i,
|
|
10
|
+
];
|
|
11
|
+
const MD_LINK_RE = /(!?)\[([^\]\n]*)\]\(([^)\s]+)(?:\s+"[^"]*")?\)/g;
|
|
12
|
+
function isExternal(href) {
|
|
13
|
+
return /^(?:https?:|mailto:|tel:|ftp:|ws:|wss:)/i.test(href);
|
|
14
|
+
}
|
|
15
|
+
function stripFragment(href) {
|
|
16
|
+
const hash = href.indexOf("#");
|
|
17
|
+
if (hash < 0)
|
|
18
|
+
return { path: href, fragment: "" };
|
|
19
|
+
return { path: href.slice(0, hash), fragment: href.slice(hash + 1) };
|
|
20
|
+
}
|
|
21
|
+
function isDocSource(p) {
|
|
22
|
+
return DOC_SOURCES.some((re) => re.test(p));
|
|
23
|
+
}
|
|
24
|
+
export default defineProbe({
|
|
25
|
+
id: "docs.links-resolved",
|
|
26
|
+
version: "1.0.0",
|
|
27
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
28
|
+
tier: "static",
|
|
29
|
+
evidence: ["files", "size_stats"],
|
|
30
|
+
rationale: `
|
|
31
|
+
Broken relative links in README.md, CLAUDE.md, AGENTS.md, or docs/
|
|
32
|
+
teach agents (and humans) to mistrust the docs. They also waste
|
|
33
|
+
context: an agent that follows a dead pointer reads nothing and is
|
|
34
|
+
no smarter than before. This probe scans the canonical doc sources
|
|
35
|
+
for markdown links \`[text](path)\`, ignores external URLs and
|
|
36
|
+
anchor-only fragments, and verifies each relative path resolves to
|
|
37
|
+
a tracked file (or to a directory that contains files).
|
|
38
|
+
`,
|
|
39
|
+
remediation: "Fix or remove broken pointers. Update the path if the file moved (`git log --diff-filter=R` finds renames). If the linked content no longer exists, replace the link with the new home or delete the reference. For external sites, use full URLs (`https://...`) which this probe doesn't validate.",
|
|
40
|
+
async detect(ev) {
|
|
41
|
+
const allPaths = ev.size_stats.files.map((f) => f.path);
|
|
42
|
+
const fileSet = new Set(allPaths);
|
|
43
|
+
const dirSet = new Set();
|
|
44
|
+
for (const p of allPaths) {
|
|
45
|
+
const parts = p.split("/");
|
|
46
|
+
for (let i = 1; i < parts.length; i++) {
|
|
47
|
+
dirSet.add(parts.slice(0, i).join("/"));
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
const docs = allPaths.filter(isDocSource);
|
|
51
|
+
if (docs.length === 0) {
|
|
52
|
+
return { kind: "na", reason: "no doc sources (README/CLAUDE/AGENTS/docs/specs) found" };
|
|
53
|
+
}
|
|
54
|
+
const items = [];
|
|
55
|
+
for (const docPath of docs) {
|
|
56
|
+
const raw = await ev.files.readText(docPath);
|
|
57
|
+
if (!raw)
|
|
58
|
+
continue;
|
|
59
|
+
const docDir = path.posix.dirname(docPath);
|
|
60
|
+
MD_LINK_RE.lastIndex = 0;
|
|
61
|
+
for (const m of raw.matchAll(MD_LINK_RE)) {
|
|
62
|
+
const href = m[3];
|
|
63
|
+
if (!href)
|
|
64
|
+
continue;
|
|
65
|
+
if (isExternal(href))
|
|
66
|
+
continue;
|
|
67
|
+
const { path: hrefPath } = stripFragment(href);
|
|
68
|
+
if (hrefPath.length === 0)
|
|
69
|
+
continue;
|
|
70
|
+
const resolved = path.posix
|
|
71
|
+
.normalize(docDir === "." ? hrefPath : path.posix.join(docDir, hrefPath))
|
|
72
|
+
.replace(/\/+$/, "");
|
|
73
|
+
if (resolved.startsWith(".."))
|
|
74
|
+
continue;
|
|
75
|
+
if (fileSet.has(resolved) || dirSet.has(resolved))
|
|
76
|
+
continue;
|
|
77
|
+
const offset = m.index ?? 0;
|
|
78
|
+
const line = (raw.slice(0, offset).match(/\n/g)?.length ?? 0) + 1;
|
|
79
|
+
items.push({
|
|
80
|
+
location: { path: docPath, range: { startLine: line } },
|
|
81
|
+
severity: "warn",
|
|
82
|
+
message: `broken link → ${href}`,
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
return { kind: "inventory", items };
|
|
87
|
+
},
|
|
88
|
+
score: {
|
|
89
|
+
kind: "inventory",
|
|
90
|
+
severityWeights: { info: 1, warn: 1, error: 1 },
|
|
91
|
+
bands: [
|
|
92
|
+
{ upTo: 0, score: 100 },
|
|
93
|
+
{ upTo: 1, score: 80 },
|
|
94
|
+
{ upTo: 3, score: 60 },
|
|
95
|
+
{ upTo: 6, score: 30 },
|
|
96
|
+
{ score: 0 },
|
|
97
|
+
],
|
|
98
|
+
},
|
|
99
|
+
fixtures: [
|
|
100
|
+
{
|
|
101
|
+
name: "no-doc-sources",
|
|
102
|
+
evidence: {
|
|
103
|
+
files: [],
|
|
104
|
+
size_stats: {
|
|
105
|
+
source: "git-ls-files",
|
|
106
|
+
totalBytes: 50,
|
|
107
|
+
totalFiles: 1,
|
|
108
|
+
files: [{ path: "src/index.ts", bytes: 50, lines: 3, depth: 1 }],
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
expect: {
|
|
112
|
+
reading: {
|
|
113
|
+
kind: "na",
|
|
114
|
+
reason: "no doc sources (README/CLAUDE/AGENTS/docs/specs) found",
|
|
115
|
+
},
|
|
116
|
+
score: null,
|
|
117
|
+
},
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
name: "all-links-valid",
|
|
121
|
+
evidence: {
|
|
122
|
+
files: {
|
|
123
|
+
"README.md": "See [arch](docs/arch.md) and [the source](src/index.ts) and [github](https://github.com).",
|
|
124
|
+
},
|
|
125
|
+
size_stats: {
|
|
126
|
+
source: "git-ls-files",
|
|
127
|
+
totalBytes: 300,
|
|
128
|
+
totalFiles: 3,
|
|
129
|
+
files: [
|
|
130
|
+
{ path: "README.md", bytes: 100, lines: 3, depth: 0 },
|
|
131
|
+
{ path: "docs/arch.md", bytes: 100, lines: 3, depth: 1 },
|
|
132
|
+
{ path: "src/index.ts", bytes: 100, lines: 3, depth: 1 },
|
|
133
|
+
],
|
|
134
|
+
},
|
|
135
|
+
},
|
|
136
|
+
expect: { reading: { kind: "inventory", items: [] }, score: 100 },
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
name: "one-broken",
|
|
140
|
+
evidence: {
|
|
141
|
+
files: { "README.md": "See [arch](docs/arch.md) and [missing](docs/gone.md)." },
|
|
142
|
+
size_stats: {
|
|
143
|
+
source: "git-ls-files",
|
|
144
|
+
totalBytes: 200,
|
|
145
|
+
totalFiles: 2,
|
|
146
|
+
files: [
|
|
147
|
+
{ path: "README.md", bytes: 100, lines: 1, depth: 0 },
|
|
148
|
+
{ path: "docs/arch.md", bytes: 100, lines: 1, depth: 1 },
|
|
149
|
+
],
|
|
150
|
+
},
|
|
151
|
+
},
|
|
152
|
+
expect: {
|
|
153
|
+
reading: {
|
|
154
|
+
kind: "inventory",
|
|
155
|
+
items: [
|
|
156
|
+
{
|
|
157
|
+
location: { path: "README.md", range: { startLine: 1 } },
|
|
158
|
+
severity: "warn",
|
|
159
|
+
message: "broken link → docs/gone.md",
|
|
160
|
+
},
|
|
161
|
+
],
|
|
162
|
+
},
|
|
163
|
+
score: 80,
|
|
164
|
+
},
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
name: "external-and-anchor-ignored",
|
|
168
|
+
evidence: {
|
|
169
|
+
files: {
|
|
170
|
+
"CLAUDE.md": "Visit [site](https://example.com) or [section](#installing) — those are not validated.",
|
|
171
|
+
},
|
|
172
|
+
size_stats: {
|
|
173
|
+
source: "git-ls-files",
|
|
174
|
+
totalBytes: 100,
|
|
175
|
+
totalFiles: 1,
|
|
176
|
+
files: [{ path: "CLAUDE.md", bytes: 100, lines: 1, depth: 0 }],
|
|
177
|
+
},
|
|
178
|
+
},
|
|
179
|
+
expect: { reading: { kind: "inventory", items: [] }, score: 100 },
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
name: "fragment-on-existing-file-ok",
|
|
183
|
+
evidence: {
|
|
184
|
+
files: { "README.md": "See [section](docs/arch.md#overview)." },
|
|
185
|
+
size_stats: {
|
|
186
|
+
source: "git-ls-files",
|
|
187
|
+
totalBytes: 200,
|
|
188
|
+
totalFiles: 2,
|
|
189
|
+
files: [
|
|
190
|
+
{ path: "README.md", bytes: 100, lines: 1, depth: 0 },
|
|
191
|
+
{ path: "docs/arch.md", bytes: 100, lines: 1, depth: 1 },
|
|
192
|
+
],
|
|
193
|
+
},
|
|
194
|
+
},
|
|
195
|
+
expect: { reading: { kind: "inventory", items: [] }, score: 100 },
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
name: "directory-link-ok",
|
|
199
|
+
evidence: {
|
|
200
|
+
files: { "README.md": "See the [docs/](docs/) folder." },
|
|
201
|
+
size_stats: {
|
|
202
|
+
source: "git-ls-files",
|
|
203
|
+
totalBytes: 200,
|
|
204
|
+
totalFiles: 2,
|
|
205
|
+
files: [
|
|
206
|
+
{ path: "README.md", bytes: 100, lines: 1, depth: 0 },
|
|
207
|
+
{ path: "docs/arch.md", bytes: 100, lines: 1, depth: 1 },
|
|
208
|
+
],
|
|
209
|
+
},
|
|
210
|
+
},
|
|
211
|
+
expect: { reading: { kind: "inventory", items: [] }, score: 100 },
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
name: "many-broken-from-claude",
|
|
215
|
+
evidence: {
|
|
216
|
+
files: {
|
|
217
|
+
"CLAUDE.md": "Setup: [getting-started](docs/getting-started.md). Arch: [arch](docs/arch.md). Specs: [spec1](specs/spec1.md).",
|
|
218
|
+
},
|
|
219
|
+
size_stats: {
|
|
220
|
+
source: "git-ls-files",
|
|
221
|
+
totalBytes: 100,
|
|
222
|
+
totalFiles: 1,
|
|
223
|
+
files: [{ path: "CLAUDE.md", bytes: 100, lines: 1, depth: 0 }],
|
|
224
|
+
},
|
|
225
|
+
},
|
|
226
|
+
expect: {
|
|
227
|
+
reading: {
|
|
228
|
+
kind: "inventory",
|
|
229
|
+
items: [
|
|
230
|
+
{
|
|
231
|
+
location: { path: "CLAUDE.md", range: { startLine: 1 } },
|
|
232
|
+
severity: "warn",
|
|
233
|
+
message: "broken link → docs/getting-started.md",
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
location: { path: "CLAUDE.md", range: { startLine: 1 } },
|
|
237
|
+
severity: "warn",
|
|
238
|
+
message: "broken link → docs/arch.md",
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
location: { path: "CLAUDE.md", range: { startLine: 1 } },
|
|
242
|
+
severity: "warn",
|
|
243
|
+
message: "broken link → specs/spec1.md",
|
|
244
|
+
},
|
|
245
|
+
],
|
|
246
|
+
},
|
|
247
|
+
score: 60,
|
|
248
|
+
},
|
|
249
|
+
},
|
|
250
|
+
],
|
|
251
|
+
});
|
|
252
|
+
//# sourceMappingURL=docs-links-resolved.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-links-resolved.js","sourceRoot":"","sources":["../../src/probes/docs-links-resolved.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,WAAW,GAAa;IAC5B,eAAe;IACf,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,UAAU;IACV,WAAW;CACZ,CAAC;AAEF,MAAM,UAAU,GAAG,iDAAiD,CAAC;AAErE,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,0CAA0C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,IAAI,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAClD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC;AACvE,CAAC;AAED,SAAS,WAAW,CAAC,CAAS;IAC5B,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,qBAAqB;IACzB,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;IAEjC,SAAS,EAAE;;;;;;;;GAQV;IAED,WAAW,EACT,sSAAsS;IAExS,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,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,wDAAwD,EAAE,CAAC;QAC1F,CAAC;QAED,MAAM,KAAK,GAAoB,EAAE,CAAC;QAClC,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACzB,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClB,IAAI,CAAC,IAAI;oBAAE,SAAS;gBACpB,IAAI,UAAU,CAAC,IAAI,CAAC;oBAAE,SAAS;gBAC/B,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;gBAC/C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;oBAAE,SAAS;gBACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK;qBACxB,SAAS,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;qBACxE,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvB,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;oBAAE,SAAS;gBACxC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;oBAAE,SAAS;gBAC5D,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;gBAC5B,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;gBAClE,KAAK,CAAC,IAAI,CAAC;oBACT,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;oBACvD,QAAQ,EAAE,MAAM;oBAChB,OAAO,EAAE,iBAAiB,IAAI,EAAE;iBACjC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IACtC,CAAC;IAED,KAAK,EAAE;QACL,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;QAC/C,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE;YACvB,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YACtB,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YACtB,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YACtB,EAAE,KAAK,EAAE,CAAC,EAAE;SACb;KACF;IAED,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,gBAAgB;YACtB,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,EAAE;oBACd,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBACjE;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,IAAI;oBACV,MAAM,EAAE,wDAAwD;iBACjE;gBACD,KAAK,EAAE,IAAI;aACZ;SACF;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,WAAW,EACT,2FAA2F;iBAC9F;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACrD,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACxD,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,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SAClE;QACD;YACE,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE,WAAW,EAAE,uDAAuD,EAAE;gBAC/E,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACrD,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;qBACzD;iBACF;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,WAAW;oBACjB,KAAK,EAAE;wBACL;4BACE,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE;4BACxD,QAAQ,EAAE,MAAM;4BAChB,OAAO,EAAE,4BAA4B;yBACtC;qBACF;iBACF;gBACD,KAAK,EAAE,EAAE;aACV;SACF;QACD;YACE,IAAI,EAAE,6BAA6B;YACnC,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,WAAW,EACT,wFAAwF;iBAC3F;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC/D;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SAClE;QACD;YACE,IAAI,EAAE,8BAA8B;YACpC,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE,WAAW,EAAE,uCAAuC,EAAE;gBAC/D,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACrD,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,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SAClE;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE,WAAW,EAAE,gCAAgC,EAAE;gBACxD,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;wBACrD,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,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SAClE;QACD;YACE,IAAI,EAAE,yBAAyB;YAC/B,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,WAAW,EACT,gHAAgH;iBACnH;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,cAAc;oBACtB,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;iBAC/D;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,WAAW;oBACjB,KAAK,EAAE;wBACL;4BACE,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE;4BACxD,QAAQ,EAAE,MAAM;4BAChB,OAAO,EAAE,uCAAuC;yBACjD;wBACD;4BACE,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE;4BACxD,QAAQ,EAAE,MAAM;4BAChB,OAAO,EAAE,4BAA4B;yBACtC;wBACD;4BACE,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE;4BACxD,QAAQ,EAAE,MAAM;4BAChB,OAAO,EAAE,8BAA8B;yBACxC;qBACF;iBACF;gBACD,KAAK,EAAE,EAAE;aACV;SACF;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-clarity.d.ts","sourceRoot":"","sources":["../../src/probes/docs-readme-clarity.ts"],"names":[],"mappings":";AA+BA,wBAqGG"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const PROBE_VERSION = "1.0.0";
|
|
3
|
+
const MAX_INPUT_CHARS = 20_000;
|
|
4
|
+
const RUBRIC = {
|
|
5
|
+
task: "Score the project's README on how useful it would be to a coding agent landing in this repository for the first time and trying to orient itself.",
|
|
6
|
+
criteria: [
|
|
7
|
+
{
|
|
8
|
+
id: "purpose-clear",
|
|
9
|
+
description: "After reading the first few paragraphs, can you state what this project is and who it's for? A README that buries or omits the purpose forces the agent to infer it from filenames.",
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
id: "entry-points",
|
|
13
|
+
description: "Does it name the entry points — how to install, how to build, how to test, how to run — with concrete commands the agent could copy-paste? Vague language ('use your favorite package manager') is worse than nothing.",
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
id: "actionable",
|
|
17
|
+
description: "Are commands and paths real (they match what's actually in the repo) and current (not referring to renamed scripts, removed files, or old versions)? An out-of-date README is a trap.",
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
id: "scope",
|
|
21
|
+
description: "Does the README cover the essentials without drowning the reader? A 2000-line README is a navigation problem; a one-line README is a coverage problem. Aim for: purpose, install, basic usage, where the docs live.",
|
|
22
|
+
},
|
|
23
|
+
],
|
|
24
|
+
};
|
|
25
|
+
export default defineProbe({
|
|
26
|
+
id: "docs.readme-clarity",
|
|
27
|
+
version: PROBE_VERSION,
|
|
28
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
29
|
+
tier: "reasoned",
|
|
30
|
+
evidence: ["files", "judge"],
|
|
31
|
+
rationale: `
|
|
32
|
+
docs.readme-substance counts canonical headings; presence of "## Install"
|
|
33
|
+
doesn't mean the install instructions are usable. This probe asks an LLM
|
|
34
|
+
to judge the README against four criteria: purpose clarity, entry-point
|
|
35
|
+
coverage, actionability of commands, and scope balance. Cached, so a
|
|
36
|
+
clean run is free; only changes to README content (or the probe version)
|
|
37
|
+
re-incur a model call.
|
|
38
|
+
`,
|
|
39
|
+
remediation: "Tighten your README. Top: one sentence saying what this project is. Then concrete sections: Install, Usage/Quickstart, Build, Test — each with copy-pasteable commands that actually work. Keep paths and commands current with the code. Aim for clarity over completeness.",
|
|
40
|
+
async detect(ev) {
|
|
41
|
+
const raw = await ev.files.readText("README.md");
|
|
42
|
+
if (raw === undefined) {
|
|
43
|
+
return { kind: "na", reason: "no README.md" };
|
|
44
|
+
}
|
|
45
|
+
if (raw.trim().length === 0) {
|
|
46
|
+
return { kind: "na", reason: "README.md is empty" };
|
|
47
|
+
}
|
|
48
|
+
const input = `# README.md\n\n${raw.slice(0, MAX_INPUT_CHARS)}`;
|
|
49
|
+
const result = await ev.judge.score({
|
|
50
|
+
probeId: "docs.readme-clarity",
|
|
51
|
+
probeVersion: PROBE_VERSION,
|
|
52
|
+
input,
|
|
53
|
+
rubric: RUBRIC,
|
|
54
|
+
});
|
|
55
|
+
return {
|
|
56
|
+
kind: "judge",
|
|
57
|
+
score: result.score,
|
|
58
|
+
perCriterion: result.perCriterion,
|
|
59
|
+
rationale: result.rationale,
|
|
60
|
+
model: result.model,
|
|
61
|
+
};
|
|
62
|
+
},
|
|
63
|
+
score: { kind: "judge" },
|
|
64
|
+
fixtures: [
|
|
65
|
+
{
|
|
66
|
+
name: "no-readme",
|
|
67
|
+
evidence: { files: {} },
|
|
68
|
+
expect: { reading: { kind: "na", reason: "no README.md" }, score: null },
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
name: "strong-readme",
|
|
72
|
+
evidence: {
|
|
73
|
+
files: {
|
|
74
|
+
"README.md": "# proj\n\nA CLI that does X.\n\n## Install\n\nnpm install\n\n## Usage\n\nproj run\n",
|
|
75
|
+
},
|
|
76
|
+
judge: {
|
|
77
|
+
score: 80,
|
|
78
|
+
perCriterion: { "purpose-clear": 80, "entry-points": 80, actionable: 80, scope: 80 },
|
|
79
|
+
rationale: "Clear purpose, concrete commands, well-scoped.",
|
|
80
|
+
model: "fixture",
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
expect: {
|
|
84
|
+
reading: {
|
|
85
|
+
kind: "judge",
|
|
86
|
+
score: 80,
|
|
87
|
+
perCriterion: { "purpose-clear": 80, "entry-points": 80, actionable: 80, scope: 80 },
|
|
88
|
+
rationale: "Clear purpose, concrete commands, well-scoped.",
|
|
89
|
+
model: "fixture",
|
|
90
|
+
},
|
|
91
|
+
score: 80,
|
|
92
|
+
},
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
name: "stub-readme",
|
|
96
|
+
evidence: {
|
|
97
|
+
files: { "README.md": "# proj\n\nA cool thing.\n" },
|
|
98
|
+
judge: {
|
|
99
|
+
score: 20,
|
|
100
|
+
perCriterion: { "purpose-clear": 20, "entry-points": 0, actionable: 0, scope: 20 },
|
|
101
|
+
rationale: "Stub — no entry points, no actionable commands.",
|
|
102
|
+
model: "fixture",
|
|
103
|
+
},
|
|
104
|
+
},
|
|
105
|
+
expect: {
|
|
106
|
+
reading: {
|
|
107
|
+
kind: "judge",
|
|
108
|
+
score: 20,
|
|
109
|
+
perCriterion: { "purpose-clear": 20, "entry-points": 0, actionable: 0, scope: 20 },
|
|
110
|
+
rationale: "Stub — no entry points, no actionable commands.",
|
|
111
|
+
model: "fixture",
|
|
112
|
+
},
|
|
113
|
+
score: 20,
|
|
114
|
+
},
|
|
115
|
+
},
|
|
116
|
+
],
|
|
117
|
+
});
|
|
118
|
+
//# sourceMappingURL=docs-readme-clarity.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-clarity.js","sourceRoot":"","sources":["../../src/probes/docs-readme-clarity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,aAAa,GAAG,OAAO,CAAC;AAC9B,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,mJAAmJ;IACzJ,QAAQ,EAAE;QACR;YACE,EAAE,EAAE,eAAe;YACnB,WAAW,EACT,qLAAqL;SACxL;QACD;YACE,EAAE,EAAE,cAAc;YAClB,WAAW,EACT,wNAAwN;SAC3N;QACD;YACE,EAAE,EAAE,YAAY;YAChB,WAAW,EACT,uLAAuL;SAC1L;QACD;YACE,EAAE,EAAE,OAAO;YACX,WAAW,EACT,qNAAqN;SACxN;KACF;CACO,CAAC;AAEX,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,qBAAqB;IACzB,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,OAAO,CAAC;IAE5B,SAAS,EAAE;;;;;;;GAOV;IAED,WAAW,EACT,8QAA8Q;IAEhR,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAChD,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;QACtD,CAAC;QAED,MAAM,KAAK,GAAG,kBAAkB,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,EAAE,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;YAClC,OAAO,EAAE,qBAAqB;YAC9B,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,WAAW;YACjB,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YACvB,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;SACzE;QACD;YACE,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,WAAW,EACT,qFAAqF;iBACxF;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;oBACpF,SAAS,EAAE,gDAAgD;oBAC3D,KAAK,EAAE,SAAS;iBACjB;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;oBACpF,SAAS,EAAE,gDAAgD;oBAC3D,KAAK,EAAE,SAAS;iBACjB;gBACD,KAAK,EAAE,EAAE;aACV;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE;gBACnD,KAAK,EAAE;oBACL,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;oBAClF,SAAS,EAAE,iDAAiD;oBAC5D,KAAK,EAAE,SAAS;iBACjB;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;oBAClF,SAAS,EAAE,iDAAiD;oBAC5D,KAAK,EAAE,SAAS;iBACjB;gBACD,KAAK,EAAE,EAAE;aACV;SACF;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-present.d.ts","sourceRoot":"","sources":["../../src/probes/docs-readme-present.ts"],"names":[],"mappings":";AAEA,wBAaG"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { fileExists } from "@esbenwiberg/repofit/sdk/recipes";
|
|
2
|
+
export default fileExists({
|
|
3
|
+
id: "docs.readme-present",
|
|
4
|
+
version: "1.0.0",
|
|
5
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
6
|
+
rationale: `
|
|
7
|
+
A README is the canonical entry point for any human or agent landing in
|
|
8
|
+
a repo. Without one, the agent must infer the project's purpose, build
|
|
9
|
+
steps, and conventions from incidental signals (filenames, dependencies,
|
|
10
|
+
git history) — slower and unreliable.
|
|
11
|
+
`,
|
|
12
|
+
remediation: "Add a `README.md` at the repo root. Cover what the project does, how to install/build/run, and where to find more docs. A short README beats no README.",
|
|
13
|
+
path: "README.md",
|
|
14
|
+
});
|
|
15
|
+
//# sourceMappingURL=docs-readme-present.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-present.js","sourceRoot":"","sources":["../../src/probes/docs-readme-present.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,qBAAqB;IACzB,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,SAAS,EAAE;;;;;GAKV;IACD,WAAW,EACT,yJAAyJ;IAC3J,IAAI,EAAE,WAAW;CAClB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-substance.d.ts","sourceRoot":"","sources":["../../src/probes/docs-readme-substance.ts"],"names":[],"mappings":";AAYA,wBAuDG"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { defineProbe } from "@esbenwiberg/repofit/sdk";
|
|
2
|
+
const CANONICAL_SECTIONS = [
|
|
3
|
+
/^#+\s+(install|setup|getting started)/im,
|
|
4
|
+
/^#+\s+(usage|quickstart)/im,
|
|
5
|
+
/^#+\s+build/im,
|
|
6
|
+
/^#+\s+test/im,
|
|
7
|
+
/^#+\s+(architecture|design|overview)/im,
|
|
8
|
+
/^#+\s+contribut/im,
|
|
9
|
+
/^#+\s+license/im,
|
|
10
|
+
];
|
|
11
|
+
export default defineProbe({
|
|
12
|
+
id: "docs.readme-substance",
|
|
13
|
+
version: "1.0.0",
|
|
14
|
+
dimensions: [{ id: "context", weight: 1 }],
|
|
15
|
+
tier: "static",
|
|
16
|
+
evidence: ["files"],
|
|
17
|
+
rationale: `
|
|
18
|
+
A README that touches the canonical sections (install / usage / build /
|
|
19
|
+
test / architecture / contributing / license) gives the agent a route
|
|
20
|
+
to every common question. Stub READMEs that only describe the
|
|
21
|
+
project's name don't.
|
|
22
|
+
`,
|
|
23
|
+
remediation: "Add the canonical README sections an agent will look for: `## Install`, `## Usage` (or Quickstart), `## Build`, `## Test`, `## Architecture` (or Overview), `## Contributing`, `## License`. Each only needs a paragraph or two — together they cover every common 'how do I…' question.",
|
|
24
|
+
async detect(ev) {
|
|
25
|
+
const raw = await ev.files.readText("README.md");
|
|
26
|
+
if (raw === undefined)
|
|
27
|
+
return { kind: "na", reason: "no README.md" };
|
|
28
|
+
let count = 0;
|
|
29
|
+
for (const pattern of CANONICAL_SECTIONS) {
|
|
30
|
+
if (pattern.test(raw))
|
|
31
|
+
count += 1;
|
|
32
|
+
}
|
|
33
|
+
return { kind: "count", value: count };
|
|
34
|
+
},
|
|
35
|
+
score: {
|
|
36
|
+
kind: "count",
|
|
37
|
+
direction: "positive",
|
|
38
|
+
bands: [{ upTo: 1, score: 20 }, { upTo: 3, score: 50 }, { upTo: 5, score: 80 }, { score: 100 }],
|
|
39
|
+
},
|
|
40
|
+
fixtures: [
|
|
41
|
+
{
|
|
42
|
+
name: "no-readme",
|
|
43
|
+
evidence: { files: [] },
|
|
44
|
+
expect: { reading: { kind: "na", reason: "no README.md" }, score: null },
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
name: "stub-readme",
|
|
48
|
+
evidence: { files: { "README.md": "# my-project\n\nA cool thing.\n" } },
|
|
49
|
+
expect: { reading: { kind: "count", value: 0 }, score: 20 },
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
name: "rich-readme",
|
|
53
|
+
evidence: {
|
|
54
|
+
files: {
|
|
55
|
+
"README.md": "# proj\n## Install\n## Usage\n## Build\n## Test\n## Architecture\n## Contributing\n## License\n",
|
|
56
|
+
},
|
|
57
|
+
},
|
|
58
|
+
expect: { reading: { kind: "count", value: 7 }, score: 100 },
|
|
59
|
+
},
|
|
60
|
+
],
|
|
61
|
+
});
|
|
62
|
+
//# sourceMappingURL=docs-readme-substance.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-readme-substance.js","sourceRoot":"","sources":["../../src/probes/docs-readme-substance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,kBAAkB,GAAG;IACzB,yCAAyC;IACzC,4BAA4B;IAC5B,eAAe;IACf,cAAc;IACd,wCAAwC;IACxC,mBAAmB;IACnB,iBAAiB;CAClB,CAAC;AAEF,eAAe,WAAW,CAAC;IACzB,EAAE,EAAE,uBAAuB;IAC3B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,CAAC;IAEnB,SAAS,EAAE;;;;;GAKV;IAED,WAAW,EACT,0RAA0R;IAE5R,KAAK,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QACrE,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;gBAAE,KAAK,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,UAAU;QACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,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;KAChG;IAED,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YACvB,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;SACzE;QACD;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,iCAAiC,EAAE,EAAE;YACvE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;SAC5D;QACD;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,WAAW,EACT,iGAAiG;iBACpG;aACF;YACD,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SAC7D;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"editorconfig-present.d.ts","sourceRoot":"","sources":["../../src/probes/editorconfig-present.ts"],"names":[],"mappings":";AAEA,wBAaG"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { fileExists } from "@esbenwiberg/repofit/sdk/recipes";
|
|
2
|
+
export default fileExists({
|
|
3
|
+
id: "editorconfig.present",
|
|
4
|
+
version: "1.0.0",
|
|
5
|
+
dimensions: [{ id: "consistency", weight: 1 }],
|
|
6
|
+
rationale: `
|
|
7
|
+
.editorconfig declares indentation, line endings, and final-newline
|
|
8
|
+
rules in a form every editor (and agent) can read. Without it, agents
|
|
9
|
+
guess from surrounding code and may produce diffs that flicker
|
|
10
|
+
formatting across files.
|
|
11
|
+
`,
|
|
12
|
+
remediation: "Add an `.editorconfig` at the repo root with at minimum `indent_style`, `indent_size`, `end_of_line`, and `insert_final_newline`. See https://editorconfig.org for the format.",
|
|
13
|
+
path: ".editorconfig",
|
|
14
|
+
});
|
|
15
|
+
//# sourceMappingURL=editorconfig-present.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"editorconfig-present.js","sourceRoot":"","sources":["../../src/probes/editorconfig-present.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,sBAAsB;IAC1B,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC9C,SAAS,EAAE;;;;;GAKV;IACD,WAAW,EACT,gLAAgL;IAClL,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors-actionability.d.ts","sourceRoot":"","sources":["../../src/probes/errors-actionability.ts"],"names":[],"mappings":";AA+BA,wBAuKG"}
|