@svp-labs/talos 0.0.0 → 0.1.1
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/ENGINEERING.md +408 -0
- package/README.md +49 -0
- package/assets/claude/kit-block.md +58 -0
- package/assets/codeowners +2 -0
- package/assets/dependabot/update.yml +7 -0
- package/assets/hooks/pre-push +76 -0
- package/assets/issue-forms/bug.yml +44 -0
- package/assets/issue-forms/chore.yml +32 -0
- package/assets/issue-forms/config.yml +2 -0
- package/assets/issue-forms/dead-code.yml +32 -0
- package/assets/issue-forms/debt.yml +32 -0
- package/assets/issue-forms/epic.yml +34 -0
- package/assets/issue-forms/feature.yml +40 -0
- package/assets/issue-forms/refactor.yml +32 -0
- package/assets/issue-forms/spike.yml +32 -0
- package/assets/labels.yml +101 -0
- package/assets/patches/@stryker-mutator__vitest-runner@10.0.0.patch +14 -0
- package/assets/prompts/review.md +66 -0
- package/assets/pull_request_template.md +14 -0
- package/assets/rulesets/channel.json +28 -0
- package/assets/rulesets/channels-branch.json +8 -0
- package/assets/rulesets/merge-queue.json +34 -0
- package/assets/rulesets/owner-review.json +21 -0
- package/assets/rulesets/release-tags.json +8 -0
- package/assets/rulesets/self-test.json +21 -0
- package/assets/workflows/talos.yml +423 -0
- package/bootstrap/find-pin.sh +76 -0
- package/bootstrap/launch.ts +347 -0
- package/bootstrap/php.sh +55 -0
- package/dist/adopt/assets.js +40 -0
- package/dist/adopt/assets.js.map +1 -0
- package/dist/adopt/config.js +68 -0
- package/dist/adopt/config.js.map +1 -0
- package/dist/adopt/dependabot.js +176 -0
- package/dist/adopt/dependabot.js.map +1 -0
- package/dist/adopt/detect.js +148 -0
- package/dist/adopt/detect.js.map +1 -0
- package/dist/adopt/dev-deps.js +179 -0
- package/dist/adopt/dev-deps.js.map +1 -0
- package/dist/adopt/draft.js +43 -0
- package/dist/adopt/draft.js.map +1 -0
- package/dist/adopt/hooks.js +101 -0
- package/dist/adopt/hooks.js.map +1 -0
- package/dist/adopt/json-text.js +45 -0
- package/dist/adopt/json-text.js.map +1 -0
- package/dist/adopt/kit.js +68 -0
- package/dist/adopt/kit.js.map +1 -0
- package/dist/adopt/languages.js +127 -0
- package/dist/adopt/languages.js.map +1 -0
- package/dist/adopt/local.js +100 -0
- package/dist/adopt/local.js.map +1 -0
- package/dist/adopt/php.js +67 -0
- package/dist/adopt/php.js.map +1 -0
- package/dist/adopt/plan.js +114 -0
- package/dist/adopt/plan.js.map +1 -0
- package/dist/adopt/python.js +200 -0
- package/dist/adopt/python.js.map +1 -0
- package/dist/adopt/remote.js +110 -0
- package/dist/adopt/remote.js.map +1 -0
- package/dist/adopt/rust.js +250 -0
- package/dist/adopt/rust.js.map +1 -0
- package/dist/adopt/scaffold.js +76 -0
- package/dist/adopt/scaffold.js.map +1 -0
- package/dist/adopt/security.js +153 -0
- package/dist/adopt/security.js.map +1 -0
- package/dist/adopt/supply.js +153 -0
- package/dist/adopt/supply.js.map +1 -0
- package/dist/adopt/talos-yml.js +95 -0
- package/dist/adopt/talos-yml.js.map +1 -0
- package/dist/adopt/texts.js +121 -0
- package/dist/adopt/texts.js.map +1 -0
- package/dist/adopt/toml-text.js +180 -0
- package/dist/adopt/toml-text.js.map +1 -0
- package/dist/adopt/tool-pins.js +133 -0
- package/dist/adopt/tool-pins.js.map +1 -0
- package/dist/adopt/tsconfig.js +80 -0
- package/dist/adopt/tsconfig.js.map +1 -0
- package/dist/bin/talos.js +7 -0
- package/dist/bin/talos.js.map +1 -0
- package/dist/central/channels-file.js +82 -0
- package/dist/central/channels-file.js.map +1 -0
- package/dist/central/channels-job.js +112 -0
- package/dist/central/channels-job.js.map +1 -0
- package/dist/central/channels.js +204 -0
- package/dist/central/channels.js.map +1 -0
- package/dist/central/drift-job.js +132 -0
- package/dist/central/drift-job.js.map +1 -0
- package/dist/central/drift.js +195 -0
- package/dist/central/drift.js.map +1 -0
- package/dist/central/gate-runs.js +48 -0
- package/dist/central/gate-runs.js.map +1 -0
- package/dist/central/org-rulesets.js +129 -0
- package/dist/central/org-rulesets.js.map +1 -0
- package/dist/central/pick.js +67 -0
- package/dist/central/pick.js.map +1 -0
- package/dist/central/privacy.js +158 -0
- package/dist/central/privacy.js.map +1 -0
- package/dist/central/releases.js +130 -0
- package/dist/central/releases.js.map +1 -0
- package/dist/central/repos.js +36 -0
- package/dist/central/repos.js.map +1 -0
- package/dist/central/runtime-port.js +49 -0
- package/dist/central/runtime-port.js.map +1 -0
- package/dist/central/sweep-job.js +62 -0
- package/dist/central/sweep-job.js.map +1 -0
- package/dist/central/sweep.js +182 -0
- package/dist/central/sweep.js.map +1 -0
- package/dist/checks/common/code-files.js +59 -0
- package/dist/checks/common/code-files.js.map +1 -0
- package/dist/checks/common/custom.js +123 -0
- package/dist/checks/common/custom.js.map +1 -0
- package/dist/checks/common/duplication.js +96 -0
- package/dist/checks/common/duplication.js.map +1 -0
- package/dist/checks/common/index.js +14 -0
- package/dist/checks/common/index.js.map +1 -0
- package/dist/checks/common/jscpd-config.js +50 -0
- package/dist/checks/common/jscpd-config.js.map +1 -0
- package/dist/checks/common/jscpd-report.js +62 -0
- package/dist/checks/common/jscpd-report.js.map +1 -0
- package/dist/checks/common/suppression-rules.js +271 -0
- package/dist/checks/common/suppression-rules.js.map +1 -0
- package/dist/checks/common/suppression-scan.js +103 -0
- package/dist/checks/common/suppression-scan.js.map +1 -0
- package/dist/checks/common/suppressions.js +26 -0
- package/dist/checks/common/suppressions.js.map +1 -0
- package/dist/checks/common/texts.js +34 -0
- package/dist/checks/common/texts.js.map +1 -0
- package/dist/checks/docs/claude-md.js +71 -0
- package/dist/checks/docs/claude-md.js.map +1 -0
- package/dist/checks/docs/comments.js +31 -0
- package/dist/checks/docs/comments.js.map +1 -0
- package/dist/checks/docs/cspell.js +138 -0
- package/dist/checks/docs/cspell.js.map +1 -0
- package/dist/checks/docs/decisions.js +30 -0
- package/dist/checks/docs/decisions.js.map +1 -0
- package/dist/checks/docs/files.js +64 -0
- package/dist/checks/docs/files.js.map +1 -0
- package/dist/checks/docs/glossary.js +99 -0
- package/dist/checks/docs/glossary.js.map +1 -0
- package/dist/checks/docs/index.js +25 -0
- package/dist/checks/docs/index.js.map +1 -0
- package/dist/checks/docs/markdown.js +39 -0
- package/dist/checks/docs/markdown.js.map +1 -0
- package/dist/checks/docs/markdownlint.js +86 -0
- package/dist/checks/docs/markdownlint.js.map +1 -0
- package/dist/checks/docs/references.js +82 -0
- package/dist/checks/docs/references.js.map +1 -0
- package/dist/checks/docs/spelling.js +83 -0
- package/dist/checks/docs/spelling.js.map +1 -0
- package/dist/checks/infra/actionlint.js +95 -0
- package/dist/checks/infra/actionlint.js.map +1 -0
- package/dist/checks/infra/configs.js +52 -0
- package/dist/checks/infra/configs.js.map +1 -0
- package/dist/checks/infra/dockerfile.js +69 -0
- package/dist/checks/infra/dockerfile.js.map +1 -0
- package/dist/checks/infra/files.js +123 -0
- package/dist/checks/infra/files.js.map +1 -0
- package/dist/checks/infra/index.js +59 -0
- package/dist/checks/infra/index.js.map +1 -0
- package/dist/checks/infra/powershell.js +128 -0
- package/dist/checks/infra/powershell.js.map +1 -0
- package/dist/checks/infra/report.js +46 -0
- package/dist/checks/infra/report.js.map +1 -0
- package/dist/checks/infra/shell.js +64 -0
- package/dist/checks/infra/shell.js.map +1 -0
- package/dist/checks/infra/zizmor.js +93 -0
- package/dist/checks/infra/zizmor.js.map +1 -0
- package/dist/checks/process/commits.js +74 -0
- package/dist/checks/process/commits.js.map +1 -0
- package/dist/checks/runtime/assess.js +140 -0
- package/dist/checks/runtime/assess.js.map +1 -0
- package/dist/checks/runtime/check.js +67 -0
- package/dist/checks/runtime/check.js.map +1 -0
- package/dist/checks/runtime/declaration.js +33 -0
- package/dist/checks/runtime/declaration.js.map +1 -0
- package/dist/checks/runtime/declarations.js +38 -0
- package/dist/checks/runtime/declarations.js.map +1 -0
- package/dist/checks/runtime/dockerfile.js +228 -0
- package/dist/checks/runtime/dockerfile.js.map +1 -0
- package/dist/checks/runtime/feeds.js +120 -0
- package/dist/checks/runtime/feeds.js.map +1 -0
- package/dist/checks/runtime/fetchers.js +72 -0
- package/dist/checks/runtime/fetchers.js.map +1 -0
- package/dist/checks/runtime/index.js +7 -0
- package/dist/checks/runtime/index.js.map +1 -0
- package/dist/checks/runtime/runtimes.js +30 -0
- package/dist/checks/runtime/runtimes.js.map +1 -0
- package/dist/checks/runtime/tools-lock.js +40 -0
- package/dist/checks/runtime/tools-lock.js.map +1 -0
- package/dist/checks/runtime/version-files.js +95 -0
- package/dist/checks/runtime/version-files.js.map +1 -0
- package/dist/checks/runtime/versions.js +51 -0
- package/dist/checks/runtime/versions.js.map +1 -0
- package/dist/checks/security/dependencies.js +70 -0
- package/dist/checks/security/dependencies.js.map +1 -0
- package/dist/checks/security/gitleaks-config.js +114 -0
- package/dist/checks/security/gitleaks-config.js.map +1 -0
- package/dist/checks/security/gitleaks.js +93 -0
- package/dist/checks/security/gitleaks.js.map +1 -0
- package/dist/checks/security/index.js +12 -0
- package/dist/checks/security/index.js.map +1 -0
- package/dist/checks/security/licences.js +50 -0
- package/dist/checks/security/licences.js.map +1 -0
- package/dist/checks/security/osv-config.js +56 -0
- package/dist/checks/security/osv-config.js.map +1 -0
- package/dist/checks/security/osv.js +146 -0
- package/dist/checks/security/osv.js.map +1 -0
- package/dist/checks/security/secrets.js +35 -0
- package/dist/checks/security/secrets.js.map +1 -0
- package/dist/checks/security/semgrep.js +184 -0
- package/dist/checks/security/semgrep.js.map +1 -0
- package/dist/checks/security/strength.js +80 -0
- package/dist/checks/security/strength.js.map +1 -0
- package/dist/checks/supply/advisories.js +66 -0
- package/dist/checks/supply/advisories.js.map +1 -0
- package/dist/checks/supply/base.js +37 -0
- package/dist/checks/supply/base.js.map +1 -0
- package/dist/checks/supply/dates.js +26 -0
- package/dist/checks/supply/dates.js.map +1 -0
- package/dist/checks/supply/dependabot.js +87 -0
- package/dist/checks/supply/dependabot.js.map +1 -0
- package/dist/checks/supply/deps.js +8 -0
- package/dist/checks/supply/deps.js.map +1 -0
- package/dist/checks/supply/exotic.js +36 -0
- package/dist/checks/supply/exotic.js.map +1 -0
- package/dist/checks/supply/expired.js +72 -0
- package/dist/checks/supply/expired.js.map +1 -0
- package/dist/checks/supply/fetcher.js +52 -0
- package/dist/checks/supply/fetcher.js.map +1 -0
- package/dist/checks/supply/index.js +21 -0
- package/dist/checks/supply/index.js.map +1 -0
- package/dist/checks/supply/judged.js +55 -0
- package/dist/checks/supply/judged.js.map +1 -0
- package/dist/checks/supply/lockfiles/cargo.js +34 -0
- package/dist/checks/supply/lockfiles/cargo.js.map +1 -0
- package/dist/checks/supply/lockfiles/composer.js +41 -0
- package/dist/checks/supply/lockfiles/composer.js.map +1 -0
- package/dist/checks/supply/lockfiles/index.js +51 -0
- package/dist/checks/supply/lockfiles/index.js.map +1 -0
- package/dist/checks/supply/lockfiles/locked.js +69 -0
- package/dist/checks/supply/lockfiles/locked.js.map +1 -0
- package/dist/checks/supply/lockfiles/npm.js +68 -0
- package/dist/checks/supply/lockfiles/npm.js.map +1 -0
- package/dist/checks/supply/lockfiles/pnpm.js +47 -0
- package/dist/checks/supply/lockfiles/pnpm.js.map +1 -0
- package/dist/checks/supply/lockfiles/python.js +77 -0
- package/dist/checks/supply/lockfiles/python.js.map +1 -0
- package/dist/checks/supply/lockfiles/yarn.js +77 -0
- package/dist/checks/supply/lockfiles/yarn.js.map +1 -0
- package/dist/checks/supply/pnpm-settings.js +95 -0
- package/dist/checks/supply/pnpm-settings.js.map +1 -0
- package/dist/checks/supply/provenance.js +82 -0
- package/dist/checks/supply/provenance.js.map +1 -0
- package/dist/checks/supply/registries.js +109 -0
- package/dist/checks/supply/registries.js.map +1 -0
- package/dist/checks/supply/release-age.js +63 -0
- package/dist/checks/supply/release-age.js.map +1 -0
- package/dist/checks/supply/settings.js +129 -0
- package/dist/checks/supply/settings.js.map +1 -0
- package/dist/cli/adopt.js +269 -0
- package/dist/cli/adopt.js.map +1 -0
- package/dist/cli/central.js +201 -0
- package/dist/cli/central.js.map +1 -0
- package/dist/cli/check.js +121 -0
- package/dist/cli/check.js.map +1 -0
- package/dist/cli/configs.js +65 -0
- package/dist/cli/configs.js.map +1 -0
- package/dist/cli/debt.js +75 -0
- package/dist/cli/debt.js.map +1 -0
- package/dist/cli/doctor.js +38 -0
- package/dist/cli/doctor.js.map +1 -0
- package/dist/cli/findings.js +32 -0
- package/dist/cli/findings.js.map +1 -0
- package/dist/cli/govern.js +98 -0
- package/dist/cli/govern.js.map +1 -0
- package/dist/cli/io.js +29 -0
- package/dist/cli/io.js.map +1 -0
- package/dist/cli/job.js +173 -0
- package/dist/cli/job.js.map +1 -0
- package/dist/cli/main.js +109 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/cli/new.js +73 -0
- package/dist/cli/new.js.map +1 -0
- package/dist/cli/org.js +88 -0
- package/dist/cli/org.js.map +1 -0
- package/dist/cli/plan.js +49 -0
- package/dist/cli/plan.js.map +1 -0
- package/dist/cli/run.js +78 -0
- package/dist/cli/run.js.map +1 -0
- package/dist/cli/self-test.js +127 -0
- package/dist/cli/self-test.js.map +1 -0
- package/dist/cli/shrinkwrap.js +20 -0
- package/dist/cli/shrinkwrap.js.map +1 -0
- package/dist/cli/status.js +39 -0
- package/dist/cli/status.js.map +1 -0
- package/dist/cli/ticket.js +180 -0
- package/dist/cli/ticket.js.map +1 -0
- package/dist/cli/verdict.js +57 -0
- package/dist/cli/verdict.js.map +1 -0
- package/dist/cli/version.js +29 -0
- package/dist/cli/version.js.map +1 -0
- package/dist/cli/why.js +96 -0
- package/dist/cli/why.js.map +1 -0
- package/dist/config/load.js +41 -0
- package/dist/config/load.js.map +1 -0
- package/dist/config/schema.js +75 -0
- package/dist/config/schema.js.map +1 -0
- package/dist/configs/drift.js +112 -0
- package/dist/configs/drift.js.map +1 -0
- package/dist/configs/files.js +35 -0
- package/dist/configs/files.js.map +1 -0
- package/dist/configs/header.js +31 -0
- package/dist/configs/header.js.map +1 -0
- package/dist/configs/index.js +8 -0
- package/dist/configs/index.js.map +1 -0
- package/dist/configs/json.js +26 -0
- package/dist/configs/json.js.map +1 -0
- package/dist/configs/packs.js +30 -0
- package/dist/configs/packs.js.map +1 -0
- package/dist/core/check.js +9 -0
- package/dist/core/check.js.map +1 -0
- package/dist/core/compare.js +46 -0
- package/dist/core/compare.js.map +1 -0
- package/dist/core/component.js +57 -0
- package/dist/core/component.js.map +1 -0
- package/dist/core/finding.js +2 -0
- package/dist/core/finding.js.map +1 -0
- package/dist/core/fingerprint.js +29 -0
- package/dist/core/fingerprint.js.map +1 -0
- package/dist/core/literal.js +85 -0
- package/dist/core/literal.js.map +1 -0
- package/dist/core/log.js +20 -0
- package/dist/core/log.js.map +1 -0
- package/dist/core/pack.js +2 -0
- package/dist/core/pack.js.map +1 -0
- package/dist/core/pool.js +16 -0
- package/dist/core/pool.js.map +1 -0
- package/dist/core/registry.js +28 -0
- package/dist/core/registry.js.map +1 -0
- package/dist/core/result.js +45 -0
- package/dist/core/result.js.map +1 -0
- package/dist/core/xml.js +63 -0
- package/dist/core/xml.js.map +1 -0
- package/dist/docs/claude.js +79 -0
- package/dist/docs/claude.js.map +1 -0
- package/dist/docs/comments/c-family.js +180 -0
- package/dist/docs/comments/c-family.js.map +1 -0
- package/dist/docs/comments/index.js +41 -0
- package/dist/docs/comments/index.js.map +1 -0
- package/dist/docs/comments/rules.js +174 -0
- package/dist/docs/comments/rules.js.map +1 -0
- package/dist/docs/comments/scan.js +138 -0
- package/dist/docs/comments/scan.js.map +1 -0
- package/dist/docs/comments/script.js +135 -0
- package/dist/docs/comments/script.js.map +1 -0
- package/dist/docs/decisions.js +168 -0
- package/dist/docs/decisions.js.map +1 -0
- package/dist/docs/glossary.js +81 -0
- package/dist/docs/glossary.js.map +1 -0
- package/dist/docs/links.js +119 -0
- package/dist/docs/links.js.map +1 -0
- package/dist/docs/markdown.js +176 -0
- package/dist/docs/markdown.js.map +1 -0
- package/dist/engine/gate.js +144 -0
- package/dist/engine/gate.js.map +1 -0
- package/dist/engine/local.js +90 -0
- package/dist/engine/local.js.map +1 -0
- package/dist/engine/plan.js +165 -0
- package/dist/engine/plan.js.map +1 -0
- package/dist/engine/prepare.js +140 -0
- package/dist/engine/prepare.js.map +1 -0
- package/dist/engine/report.js +71 -0
- package/dist/engine/report.js.map +1 -0
- package/dist/engine/run.js +142 -0
- package/dist/engine/run.js.map +1 -0
- package/dist/engine/session.js +10 -0
- package/dist/engine/session.js.map +1 -0
- package/dist/engine/verdict-caps.js +30 -0
- package/dist/engine/verdict-caps.js.map +1 -0
- package/dist/engine/verdict.js +49 -0
- package/dist/engine/verdict.js.map +1 -0
- package/dist/exec/exec.js +136 -0
- package/dist/exec/exec.js.map +1 -0
- package/dist/github/actions.js +62 -0
- package/dist/github/actions.js.map +1 -0
- package/dist/github/api.js +138 -0
- package/dist/github/api.js.map +1 -0
- package/dist/github/artifacts.js +203 -0
- package/dist/github/artifacts.js.map +1 -0
- package/dist/github/checks.js +86 -0
- package/dist/github/checks.js.map +1 -0
- package/dist/github/contents.js +38 -0
- package/dist/github/contents.js.map +1 -0
- package/dist/github/gate-runs.js +59 -0
- package/dist/github/gate-runs.js.map +1 -0
- package/dist/github/identities.js +29 -0
- package/dist/github/identities.js.map +1 -0
- package/dist/github/org-variables.js +41 -0
- package/dist/github/org-variables.js.map +1 -0
- package/dist/github/pulls.js +32 -0
- package/dist/github/pulls.js.map +1 -0
- package/dist/github/remote.js +26 -0
- package/dist/github/remote.js.map +1 -0
- package/dist/github/repos.js +64 -0
- package/dist/github/repos.js.map +1 -0
- package/dist/github/rulesets.js +44 -0
- package/dist/github/rulesets.js.map +1 -0
- package/dist/govern/commit.js +31 -0
- package/dist/govern/commit.js.map +1 -0
- package/dist/govern/compare.js +52 -0
- package/dist/govern/compare.js.map +1 -0
- package/dist/govern/create.js +97 -0
- package/dist/govern/create.js.map +1 -0
- package/dist/govern/govern.js +77 -0
- package/dist/govern/govern.js.map +1 -0
- package/dist/govern/installations.js +64 -0
- package/dist/govern/installations.js.map +1 -0
- package/dist/govern/org.js +170 -0
- package/dist/govern/org.js.map +1 -0
- package/dist/govern/output.js +32 -0
- package/dist/govern/output.js.map +1 -0
- package/dist/govern/plan.js +166 -0
- package/dist/govern/plan.js.map +1 -0
- package/dist/govern/rulesets-api.js +39 -0
- package/dist/govern/rulesets-api.js.map +1 -0
- package/dist/govern/state.js +108 -0
- package/dist/govern/state.js.map +1 -0
- package/dist/govern/steps.js +143 -0
- package/dist/govern/steps.js.map +1 -0
- package/dist/govern/templates.js +140 -0
- package/dist/govern/templates.js.map +1 -0
- package/dist/jobs/act.js +60 -0
- package/dist/jobs/act.js.map +1 -0
- package/dist/jobs/analyze.js +68 -0
- package/dist/jobs/analyze.js.map +1 -0
- package/dist/jobs/artifacts.js +35 -0
- package/dist/jobs/artifacts.js.map +1 -0
- package/dist/jobs/context.js +2 -0
- package/dist/jobs/context.js.map +1 -0
- package/dist/jobs/debt-issues.js +129 -0
- package/dist/jobs/debt-issues.js.map +1 -0
- package/dist/jobs/debt-report.js +125 -0
- package/dist/jobs/debt-report.js.map +1 -0
- package/dist/jobs/dispatch.js +103 -0
- package/dist/jobs/dispatch.js.map +1 -0
- package/dist/jobs/flaky.js +151 -0
- package/dist/jobs/flaky.js.map +1 -0
- package/dist/jobs/label-sync.js +67 -0
- package/dist/jobs/label-sync.js.map +1 -0
- package/dist/jobs/payloads.js +62 -0
- package/dist/jobs/payloads.js.map +1 -0
- package/dist/jobs/readiness-job.js +91 -0
- package/dist/jobs/readiness-job.js.map +1 -0
- package/dist/jobs/readiness.js +154 -0
- package/dist/jobs/readiness.js.map +1 -0
- package/dist/jobs/schedule.js +19 -0
- package/dist/jobs/schedule.js.map +1 -0
- package/dist/jobs/sync-chore.js +77 -0
- package/dist/jobs/sync-chore.js.map +1 -0
- package/dist/jobs/talos-issues.js +79 -0
- package/dist/jobs/talos-issues.js.map +1 -0
- package/dist/langs/lua/busted.js +124 -0
- package/dist/langs/lua/busted.js.map +1 -0
- package/dist/langs/lua/configs.js +173 -0
- package/dist/langs/lua/configs.js.map +1 -0
- package/dist/langs/lua/deadcode.js +11 -0
- package/dist/langs/lua/deadcode.js.map +1 -0
- package/dist/langs/lua/devtools.js +64 -0
- package/dist/langs/lua/devtools.js.map +1 -0
- package/dist/langs/lua/format.js +41 -0
- package/dist/langs/lua/format.js.map +1 -0
- package/dist/langs/lua/index.js +86 -0
- package/dist/langs/lua/index.js.map +1 -0
- package/dist/langs/lua/install.js +80 -0
- package/dist/langs/lua/install.js.map +1 -0
- package/dist/langs/lua/lint.js +46 -0
- package/dist/langs/lua/lint.js.map +1 -0
- package/dist/langs/lua/luacheck-config.js +151 -0
- package/dist/langs/lua/luacheck-config.js.map +1 -0
- package/dist/langs/lua/luacheck.js +102 -0
- package/dist/langs/lua/luacheck.js.map +1 -0
- package/dist/langs/lua/luals.js +66 -0
- package/dist/langs/lua/luals.js.map +1 -0
- package/dist/langs/lua/paths.js +94 -0
- package/dist/langs/lua/paths.js.map +1 -0
- package/dist/langs/lua/run.js +63 -0
- package/dist/langs/lua/run.js.map +1 -0
- package/dist/langs/lua/scripts/json.js +39 -0
- package/dist/langs/lua/scripts/json.js.map +1 -0
- package/dist/langs/lua/scripts/lcov.js +77 -0
- package/dist/langs/lua/scripts/lcov.js.map +1 -0
- package/dist/langs/lua/scripts/luacheck.js +97 -0
- package/dist/langs/lua/scripts/luacheck.js.map +1 -0
- package/dist/langs/lua/scripts/shape.js +197 -0
- package/dist/langs/lua/scripts/shape.js.map +1 -0
- package/dist/langs/lua/shape.js +142 -0
- package/dist/langs/lua/shape.js.map +1 -0
- package/dist/langs/lua/strength.js +38 -0
- package/dist/langs/lua/strength.js.map +1 -0
- package/dist/langs/lua/stylua.js +43 -0
- package/dist/langs/lua/stylua.js.map +1 -0
- package/dist/langs/lua/toolchain.js +49 -0
- package/dist/langs/lua/toolchain.js.map +1 -0
- package/dist/langs/lua/types.js +41 -0
- package/dist/langs/lua/types.js.map +1 -0
- package/dist/langs/php/analysis.js +22 -0
- package/dist/langs/php/analysis.js.map +1 -0
- package/dist/langs/php/composer.js +88 -0
- package/dist/langs/php/composer.js.map +1 -0
- package/dist/langs/php/configs.js +54 -0
- package/dist/langs/php/configs.js.map +1 -0
- package/dist/langs/php/deptrac-config.js +118 -0
- package/dist/langs/php/deptrac-config.js.map +1 -0
- package/dist/langs/php/deptrac.js +117 -0
- package/dist/langs/php/deptrac.js.map +1 -0
- package/dist/langs/php/format.js +94 -0
- package/dist/langs/php/format.js.map +1 -0
- package/dist/langs/php/index.js +81 -0
- package/dist/langs/php/index.js.map +1 -0
- package/dist/langs/php/infection.js +151 -0
- package/dist/langs/php/infection.js.map +1 -0
- package/dist/langs/php/install.js +52 -0
- package/dist/langs/php/install.js.map +1 -0
- package/dist/langs/php/neon.js +41 -0
- package/dist/langs/php/neon.js.map +1 -0
- package/dist/langs/php/paths.js +78 -0
- package/dist/langs/php/paths.js.map +1 -0
- package/dist/langs/php/pest.js +91 -0
- package/dist/langs/php/pest.js.map +1 -0
- package/dist/langs/php/phpmd-config.js +58 -0
- package/dist/langs/php/phpmd-config.js.map +1 -0
- package/dist/langs/php/phpmd.js +80 -0
- package/dist/langs/php/phpmd.js.map +1 -0
- package/dist/langs/php/phpstan-config.js +100 -0
- package/dist/langs/php/phpstan-config.js.map +1 -0
- package/dist/langs/php/phpstan.js +128 -0
- package/dist/langs/php/phpstan.js.map +1 -0
- package/dist/langs/php/pint-config.js +22 -0
- package/dist/langs/php/pint-config.js.map +1 -0
- package/dist/langs/php/run.js +88 -0
- package/dist/langs/php/run.js.map +1 -0
- package/dist/langs/php/runtime.js +60 -0
- package/dist/langs/php/runtime.js.map +1 -0
- package/dist/langs/php/scope.js +50 -0
- package/dist/langs/php/scope.js.map +1 -0
- package/dist/langs/php/shape.js +212 -0
- package/dist/langs/php/shape.js.map +1 -0
- package/dist/langs/php/strength-rules.js +114 -0
- package/dist/langs/php/strength-rules.js.map +1 -0
- package/dist/langs/php/strength.js +98 -0
- package/dist/langs/php/strength.js.map +1 -0
- package/dist/langs/php/toolchain.js +73 -0
- package/dist/langs/php/toolchain.js.map +1 -0
- package/dist/langs/php/typecov.js +84 -0
- package/dist/langs/php/typecov.js.map +1 -0
- package/dist/langs/py/arch.js +97 -0
- package/dist/langs/py/arch.js.map +1 -0
- package/dist/langs/py/complexipy.js +42 -0
- package/dist/langs/py/complexipy.js.map +1 -0
- package/dist/langs/py/configs.js +144 -0
- package/dist/langs/py/configs.js.map +1 -0
- package/dist/langs/py/deadcode.js +77 -0
- package/dist/langs/py/deadcode.js.map +1 -0
- package/dist/langs/py/environment.js +35 -0
- package/dist/langs/py/environment.js.map +1 -0
- package/dist/langs/py/format.js +32 -0
- package/dist/langs/py/format.js.map +1 -0
- package/dist/langs/py/importlinter.js +147 -0
- package/dist/langs/py/importlinter.js.map +1 -0
- package/dist/langs/py/index.js +73 -0
- package/dist/langs/py/index.js.map +1 -0
- package/dist/langs/py/install.js +49 -0
- package/dist/langs/py/install.js.map +1 -0
- package/dist/langs/py/lint.js +98 -0
- package/dist/langs/py/lint.js.map +1 -0
- package/dist/langs/py/lock.js +66 -0
- package/dist/langs/py/lock.js.map +1 -0
- package/dist/langs/py/mutation.js +164 -0
- package/dist/langs/py/mutation.js.map +1 -0
- package/dist/langs/py/mutmut-report.js +81 -0
- package/dist/langs/py/mutmut-report.js.map +1 -0
- package/dist/langs/py/mutmut-settings.js +168 -0
- package/dist/langs/py/mutmut-settings.js.map +1 -0
- package/dist/langs/py/paths.js +57 -0
- package/dist/langs/py/paths.js.map +1 -0
- package/dist/langs/py/pyright-config.js +123 -0
- package/dist/langs/py/pyright-config.js.map +1 -0
- package/dist/langs/py/pytest.js +96 -0
- package/dist/langs/py/pytest.js.map +1 -0
- package/dist/langs/py/ruff-settings.js +166 -0
- package/dist/langs/py/ruff-settings.js.map +1 -0
- package/dist/langs/py/ruff.js +44 -0
- package/dist/langs/py/ruff.js.map +1 -0
- package/dist/langs/py/run.js +44 -0
- package/dist/langs/py/run.js.map +1 -0
- package/dist/langs/py/sizes.js +65 -0
- package/dist/langs/py/sizes.js.map +1 -0
- package/dist/langs/py/spans.js +76 -0
- package/dist/langs/py/spans.js.map +1 -0
- package/dist/langs/py/strength.js +101 -0
- package/dist/langs/py/strength.js.map +1 -0
- package/dist/langs/py/toolchain.js +34 -0
- package/dist/langs/py/toolchain.js.map +1 -0
- package/dist/langs/py/types.js +66 -0
- package/dist/langs/py/types.js.map +1 -0
- package/dist/langs/rust/cargo-config.js +91 -0
- package/dist/langs/rust/cargo-config.js.map +1 -0
- package/dist/langs/rust/cargo-test.js +50 -0
- package/dist/langs/rust/cargo-test.js.map +1 -0
- package/dist/langs/rust/compile.js +99 -0
- package/dist/langs/rust/compile.js.map +1 -0
- package/dist/langs/rust/configs.js +60 -0
- package/dist/langs/rust/configs.js.map +1 -0
- package/dist/langs/rust/deadcode.js +47 -0
- package/dist/langs/rust/deadcode.js.map +1 -0
- package/dist/langs/rust/diagnostics.js +103 -0
- package/dist/langs/rust/diagnostics.js.map +1 -0
- package/dist/langs/rust/doctests.js +49 -0
- package/dist/langs/rust/doctests.js.map +1 -0
- package/dist/langs/rust/format.js +97 -0
- package/dist/langs/rust/format.js.map +1 -0
- package/dist/langs/rust/index.js +49 -0
- package/dist/langs/rust/index.js.map +1 -0
- package/dist/langs/rust/install.js +56 -0
- package/dist/langs/rust/install.js.map +1 -0
- package/dist/langs/rust/junit.js +49 -0
- package/dist/langs/rust/junit.js.map +1 -0
- package/dist/langs/rust/lcov.js +53 -0
- package/dist/langs/rust/lcov.js.map +1 -0
- package/dist/langs/rust/lint.js +47 -0
- package/dist/langs/rust/lint.js.map +1 -0
- package/dist/langs/rust/lints.js +61 -0
- package/dist/langs/rust/lints.js.map +1 -0
- package/dist/langs/rust/machete.js +53 -0
- package/dist/langs/rust/machete.js.map +1 -0
- package/dist/langs/rust/metadata.js +78 -0
- package/dist/langs/rust/metadata.js.map +1 -0
- package/dist/langs/rust/mutants.js +73 -0
- package/dist/langs/rust/mutants.js.map +1 -0
- package/dist/langs/rust/nextest.js +164 -0
- package/dist/langs/rust/nextest.js.map +1 -0
- package/dist/langs/rust/paths.js +60 -0
- package/dist/langs/rust/paths.js.map +1 -0
- package/dist/langs/rust/run.js +37 -0
- package/dist/langs/rust/run.js.map +1 -0
- package/dist/langs/rust/scan.js +173 -0
- package/dist/langs/rust/scan.js.map +1 -0
- package/dist/langs/rust/shapes.js +80 -0
- package/dist/langs/rust/shapes.js.map +1 -0
- package/dist/langs/rust/strength-rules.js +109 -0
- package/dist/langs/rust/strength-rules.js.map +1 -0
- package/dist/langs/rust/strength.js +114 -0
- package/dist/langs/rust/strength.js.map +1 -0
- package/dist/langs/rust/structure.js +222 -0
- package/dist/langs/rust/structure.js.map +1 -0
- package/dist/langs/rust/testfiles.js +62 -0
- package/dist/langs/rust/testfiles.js.map +1 -0
- package/dist/langs/rust/toolchain.js +91 -0
- package/dist/langs/rust/toolchain.js.map +1 -0
- package/dist/langs/rust/types.js +9 -0
- package/dist/langs/rust/types.js.map +1 -0
- package/dist/langs/ts/checks/arch.js +129 -0
- package/dist/langs/ts/checks/arch.js.map +1 -0
- package/dist/langs/ts/checks/deadcode.js +125 -0
- package/dist/langs/ts/checks/deadcode.js.map +1 -0
- package/dist/langs/ts/checks/e2e.js +174 -0
- package/dist/langs/ts/checks/e2e.js.map +1 -0
- package/dist/langs/ts/checks/format.js +107 -0
- package/dist/langs/ts/checks/format.js.map +1 -0
- package/dist/langs/ts/checks/javascript.js +30 -0
- package/dist/langs/ts/checks/javascript.js.map +1 -0
- package/dist/langs/ts/checks/lint.js +133 -0
- package/dist/langs/ts/checks/lint.js.map +1 -0
- package/dist/langs/ts/checks/size.js +79 -0
- package/dist/langs/ts/checks/size.js.map +1 -0
- package/dist/langs/ts/checks/strength.js +168 -0
- package/dist/langs/ts/checks/strength.js.map +1 -0
- package/dist/langs/ts/checks/toolchain.js +54 -0
- package/dist/langs/ts/checks/toolchain.js.map +1 -0
- package/dist/langs/ts/checks/typecov.js +121 -0
- package/dist/langs/ts/checks/typecov.js.map +1 -0
- package/dist/langs/ts/checks/types.js +71 -0
- package/dist/langs/ts/checks/types.js.map +1 -0
- package/dist/langs/ts/compare.js +110 -0
- package/dist/langs/ts/compare.js.map +1 -0
- package/dist/langs/ts/configs/depcruise.js +97 -0
- package/dist/langs/ts/configs/depcruise.js.map +1 -0
- package/dist/langs/ts/configs/eslint.js +209 -0
- package/dist/langs/ts/configs/eslint.js.map +1 -0
- package/dist/langs/ts/configs/index.js +59 -0
- package/dist/langs/ts/configs/index.js.map +1 -0
- package/dist/langs/ts/configs/knip.js +43 -0
- package/dist/langs/ts/configs/knip.js.map +1 -0
- package/dist/langs/ts/configs/prettier.js +37 -0
- package/dist/langs/ts/configs/prettier.js.map +1 -0
- package/dist/langs/ts/configs/shared.js +19 -0
- package/dist/langs/ts/configs/shared.js.map +1 -0
- package/dist/langs/ts/configs/stryker.js +117 -0
- package/dist/langs/ts/configs/stryker.js.map +1 -0
- package/dist/langs/ts/configs/tsconfig.js +64 -0
- package/dist/langs/ts/configs/tsconfig.js.map +1 -0
- package/dist/langs/ts/configs/vitest.js +62 -0
- package/dist/langs/ts/configs/vitest.js.map +1 -0
- package/dist/langs/ts/devtools.js +29 -0
- package/dist/langs/ts/devtools.js.map +1 -0
- package/dist/langs/ts/files.js +73 -0
- package/dist/langs/ts/files.js.map +1 -0
- package/dist/langs/ts/generated.js +29 -0
- package/dist/langs/ts/generated.js.map +1 -0
- package/dist/langs/ts/index.js +45 -0
- package/dist/langs/ts/index.js.map +1 -0
- package/dist/langs/ts/install.js +48 -0
- package/dist/langs/ts/install.js.map +1 -0
- package/dist/langs/ts/node.js +139 -0
- package/dist/langs/ts/node.js.map +1 -0
- package/dist/langs/ts/runners/stryker.js +56 -0
- package/dist/langs/ts/runners/stryker.js.map +1 -0
- package/dist/langs/ts/runners/vitest.js +79 -0
- package/dist/langs/ts/runners/vitest.js.map +1 -0
- package/dist/langs/ts/shadows.js +90 -0
- package/dist/langs/ts/shadows.js.map +1 -0
- package/dist/langs/ts/spans.js +57 -0
- package/dist/langs/ts/spans.js.map +1 -0
- package/dist/quality/coverage.js +162 -0
- package/dist/quality/coverage.js.map +1 -0
- package/dist/quality/index.js +4 -0
- package/dist/quality/index.js.map +1 -0
- package/dist/quality/junit.js +166 -0
- package/dist/quality/junit.js.map +1 -0
- package/dist/quality/lines.js +58 -0
- package/dist/quality/lines.js.map +1 -0
- package/dist/quality/luacov.js +345 -0
- package/dist/quality/luacov.js.map +1 -0
- package/dist/quality/mutants.js +202 -0
- package/dist/quality/mutants.js.map +1 -0
- package/dist/quality/mutation.js +121 -0
- package/dist/quality/mutation.js.map +1 -0
- package/dist/quality/paths.js +36 -0
- package/dist/quality/paths.js.map +1 -0
- package/dist/quality/protocol.js +2 -0
- package/dist/quality/protocol.js.map +1 -0
- package/dist/quality/reports.js +79 -0
- package/dist/quality/reports.js.map +1 -0
- package/dist/quality/suite.js +64 -0
- package/dist/quality/suite.js.map +1 -0
- package/dist/quality/tests.js +63 -0
- package/dist/quality/tests.js.map +1 -0
- package/dist/quality/text.js +32 -0
- package/dist/quality/text.js.map +1 -0
- package/dist/quality/typecov.js +16 -0
- package/dist/quality/typecov.js.map +1 -0
- package/dist/quality/verdicts.js +96 -0
- package/dist/quality/verdicts.js.map +1 -0
- package/dist/quality/xml.js +42 -0
- package/dist/quality/xml.js.map +1 -0
- package/dist/repo/changes.js +108 -0
- package/dist/repo/changes.js.map +1 -0
- package/dist/repo/facts.js +38 -0
- package/dist/repo/facts.js.map +1 -0
- package/dist/repo/git.js +79 -0
- package/dist/repo/git.js.map +1 -0
- package/dist/repo/talos-dir.js +36 -0
- package/dist/repo/talos-dir.js.map +1 -0
- package/dist/review/approval.js +73 -0
- package/dist/review/approval.js.map +1 -0
- package/dist/review/assemble.js +80 -0
- package/dist/review/assemble.js.map +1 -0
- package/dist/review/codeowners.js +28 -0
- package/dist/review/codeowners.js.map +1 -0
- package/dist/review/conditions.js +114 -0
- package/dist/review/conditions.js.map +1 -0
- package/dist/review/github.js +206 -0
- package/dist/review/github.js.map +1 -0
- package/dist/review/guard.js +119 -0
- package/dist/review/guard.js.map +1 -0
- package/dist/review/header.js +61 -0
- package/dist/review/header.js.map +1 -0
- package/dist/review/integrity.js +148 -0
- package/dist/review/integrity.js.map +1 -0
- package/dist/review/job.js +213 -0
- package/dist/review/job.js.map +1 -0
- package/dist/review/model.js +178 -0
- package/dist/review/model.js.map +1 -0
- package/dist/review/prompt.js +125 -0
- package/dist/review/prompt.js.map +1 -0
- package/dist/review/report.js +73 -0
- package/dist/review/report.js.map +1 -0
- package/dist/review/reviewer.js +205 -0
- package/dist/review/reviewer.js.map +1 -0
- package/dist/review/rules.js +54 -0
- package/dist/review/rules.js.map +1 -0
- package/dist/review/scope.js +39 -0
- package/dist/review/scope.js.map +1 -0
- package/dist/review/testfiles.js +53 -0
- package/dist/review/testfiles.js.map +1 -0
- package/dist/review/types.js +6 -0
- package/dist/review/types.js.map +1 -0
- package/dist/sarif/sarif.js +63 -0
- package/dist/sarif/sarif.js.map +1 -0
- package/dist/status/build.js +154 -0
- package/dist/status/build.js.map +1 -0
- package/dist/status/collect.js +132 -0
- package/dist/status/collect.js.map +1 -0
- package/dist/status/doctor.js +191 -0
- package/dist/status/doctor.js.map +1 -0
- package/dist/status/findings.js +161 -0
- package/dist/status/findings.js.map +1 -0
- package/dist/status/history.js +113 -0
- package/dist/status/history.js.map +1 -0
- package/dist/status/markers.js +65 -0
- package/dist/status/markers.js.map +1 -0
- package/dist/status/query.js +148 -0
- package/dist/status/query.js.map +1 -0
- package/dist/status/resolve.js +92 -0
- package/dist/status/resolve.js.map +1 -0
- package/dist/status/schema.js +110 -0
- package/dist/status/schema.js.map +1 -0
- package/dist/status/text.js +57 -0
- package/dist/status/text.js.map +1 -0
- package/dist/ticket/claim.js +147 -0
- package/dist/ticket/claim.js.map +1 -0
- package/dist/ticket/github.js +94 -0
- package/dist/ticket/github.js.map +1 -0
- package/dist/ticket/labels.js +64 -0
- package/dist/ticket/labels.js.map +1 -0
- package/dist/ticket/payload.js +37 -0
- package/dist/ticket/payload.js.map +1 -0
- package/dist/ticket/queue.js +51 -0
- package/dist/ticket/queue.js.map +1 -0
- package/dist/ticket/schemas.js +106 -0
- package/dist/ticket/schemas.js.map +1 -0
- package/dist/ticket/sections.js +66 -0
- package/dist/ticket/sections.js.map +1 -0
- package/dist/ticket/stale.js +108 -0
- package/dist/ticket/stale.js.map +1 -0
- package/dist/ticket/status.js +96 -0
- package/dist/ticket/status.js.map +1 -0
- package/dist/ticket/trust.js +29 -0
- package/dist/ticket/trust.js.map +1 -0
- package/dist/tools/fetch.js +117 -0
- package/dist/tools/fetch.js.map +1 -0
- package/dist/tools/lock.js +100 -0
- package/dist/tools/lock.js.map +1 -0
- package/dist/tools/lockfile.js +81 -0
- package/dist/tools/lockfile.js.map +1 -0
- package/dist/tools/pypi.js +44 -0
- package/dist/tools/pypi.js.map +1 -0
- package/dist/tools/store.js +62 -0
- package/dist/tools/store.js.map +1 -0
- package/dist/tools/tools.js +2 -0
- package/dist/tools/tools.js.map +1 -0
- package/dist/version/cache.js +18 -0
- package/dist/version/cache.js.map +1 -0
- package/dist/version/enforced.js +54 -0
- package/dist/version/enforced.js.map +1 -0
- package/dist/version/errors.js +8 -0
- package/dist/version/errors.js.map +1 -0
- package/dist/version/install.js +149 -0
- package/dist/version/install.js.map +1 -0
- package/dist/version/launch.js +104 -0
- package/dist/version/launch.js.map +1 -0
- package/dist/version/pin.js +121 -0
- package/dist/version/pin.js.map +1 -0
- package/dist/version/provenance.js +118 -0
- package/dist/version/provenance.js.map +1 -0
- package/dist/version/release.js +44 -0
- package/dist/version/release.js.map +1 -0
- package/dist/version/self.js +55 -0
- package/dist/version/self.js.map +1 -0
- package/dist/version/shrinkwrap.js +207 -0
- package/dist/version/shrinkwrap.js.map +1 -0
- package/npm-shrinkwrap.json +2140 -0
- package/package.json +81 -8
- package/tools/semgrep.in +1 -0
- package/tools/semgrep.txt +1150 -0
- package/tools.lock +429 -0
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { relative, sep } from 'node:path';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
import { excludeGlobs } from './markdownlint.js';
|
|
5
|
+
import { generatedHeader } from '../../configs/header.js';
|
|
6
|
+
import { EngineError } from '../../core/check.js';
|
|
7
|
+
import { KIT_BEGIN, KIT_END } from '../../docs/claude.js';
|
|
8
|
+
export const CSPELL_CONFIG = 'cspell.config.yaml';
|
|
9
|
+
/** The project's own words: the extension, which only adds what the dictionaries lack. */
|
|
10
|
+
export const WORDS_FILE = '.cspell/words.txt';
|
|
11
|
+
/** Docs, code, scripts and CI. */
|
|
12
|
+
const SPELLING_GLOBS = [
|
|
13
|
+
'**/*.{md,markdown}',
|
|
14
|
+
'**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}',
|
|
15
|
+
'**/*.{py,pyi,php,lua,rs}',
|
|
16
|
+
'**/*.{sh,bash,ps1,psm1,psd1}',
|
|
17
|
+
'**/*.{yml,yaml,toml,jsonc}',
|
|
18
|
+
'**/Dockerfile',
|
|
19
|
+
'**/*.Dockerfile',
|
|
20
|
+
'.githooks/*',
|
|
21
|
+
];
|
|
22
|
+
const NOT_SPELLED = ['**/pnpm-lock.yaml', '**/*.lock'];
|
|
23
|
+
/** Where Talos keeps its local reports and cache, in every repository. */
|
|
24
|
+
const TALOS_OUTPUT = '.talos';
|
|
25
|
+
/** What each language's tools write into a checkout: reports, sandboxes and installed packages. */
|
|
26
|
+
const TOOL_OUTPUT = [
|
|
27
|
+
['ts', ['coverage', 'reports', '.stryker-tmp']],
|
|
28
|
+
['py', ['.venv', 'htmlcov', 'mutants']],
|
|
29
|
+
['php', ['vendor']],
|
|
30
|
+
['lua', ['.lua']],
|
|
31
|
+
['rust', ['target', 'mutants.out']],
|
|
32
|
+
];
|
|
33
|
+
/** The directories Talos and the tools of these languages write output into, anywhere. */
|
|
34
|
+
export function outputGlobs(langs) {
|
|
35
|
+
const dirs = TOOL_OUTPUT.filter(([lang]) => langs.includes(lang)).flatMap(([, list]) => list);
|
|
36
|
+
return [TALOS_OUTPUT, ...dirs].map((dir) => `**/${dir}/**`);
|
|
37
|
+
}
|
|
38
|
+
/** Words of the text Talos writes into every repository and the project keeps. */
|
|
39
|
+
export const KIT_WORDS = ['talos'];
|
|
40
|
+
function escapeRegExp(text) {
|
|
41
|
+
return text.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw `\$&`);
|
|
42
|
+
}
|
|
43
|
+
/** What isn't prose: Talos's block in `CLAUDE.md`, advisory IDs, digests, commit SHAs. */
|
|
44
|
+
export const IGNORED_PATTERNS = [
|
|
45
|
+
`/${escapeRegExp(KIT_BEGIN)}[\\s\\S]*?${escapeRegExp(KIT_END)}/g`,
|
|
46
|
+
'/GHSA(-[0-9a-z]{4}){3}/g',
|
|
47
|
+
'/sha256:[0-9a-f]{64}/g',
|
|
48
|
+
String.raw `/\b[0-9a-f]{40}\b/g`,
|
|
49
|
+
String.raw `/\[[A-Za-z0-9#^-]{8,}\]/g`,
|
|
50
|
+
// mutmut names a mutant after its function, joined by `ǁ`: an identifier, not prose.
|
|
51
|
+
'/xǁ[\\wǁ]*/gu',
|
|
52
|
+
];
|
|
53
|
+
const LANGUAGE = 'en,en-GB';
|
|
54
|
+
function yamlList(items) {
|
|
55
|
+
return items.map((item) => ` - '${item.replaceAll("'", "''")}'`);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* The base for editors and `cspell`, written as Prettier writes it. It skips what Talos and the
|
|
59
|
+
* tools of the repository's languages write into a checkout, which `cspell` over every file
|
|
60
|
+
* would otherwise read.
|
|
61
|
+
*/
|
|
62
|
+
export function renderCspellBase(version, exclude, langs) {
|
|
63
|
+
const ignored = [
|
|
64
|
+
'**/node_modules/**',
|
|
65
|
+
...outputGlobs(langs),
|
|
66
|
+
'.cspell/**',
|
|
67
|
+
...NOT_SPELLED,
|
|
68
|
+
...excludeGlobs(exclude),
|
|
69
|
+
];
|
|
70
|
+
return [
|
|
71
|
+
generatedHeader('#', version).trimEnd(),
|
|
72
|
+
'# Spelling in docs, code, scripts and CI, in British or American English. Words the',
|
|
73
|
+
`# dictionaries don't know go in ${WORDS_FILE}, one per line.`,
|
|
74
|
+
"version: '0.2'",
|
|
75
|
+
`language: ${LANGUAGE}`,
|
|
76
|
+
'dictionaryDefinitions:',
|
|
77
|
+
' - name: project',
|
|
78
|
+
` path: ./${WORDS_FILE}`,
|
|
79
|
+
' addWords: true',
|
|
80
|
+
'dictionaries: [project]',
|
|
81
|
+
`words: [${KIT_WORDS.join(', ')}]`,
|
|
82
|
+
'ignoreRegExpList:',
|
|
83
|
+
...yamlList(IGNORED_PATTERNS),
|
|
84
|
+
'ignorePaths:',
|
|
85
|
+
...yamlList(ignored),
|
|
86
|
+
'',
|
|
87
|
+
].join('\n');
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* The settings the gate runs with: the base's, the project's word list and the glossary's
|
|
91
|
+
* terms, and no configuration file found anywhere else in the checkout.
|
|
92
|
+
*/
|
|
93
|
+
export function gateSettings(dictionaries) {
|
|
94
|
+
const definitions = [
|
|
95
|
+
...(dictionaries.words === undefined
|
|
96
|
+
? []
|
|
97
|
+
: [{ name: 'project', path: dictionaries.words, addWords: true }]),
|
|
98
|
+
{ name: 'glossary', path: dictionaries.glossary },
|
|
99
|
+
];
|
|
100
|
+
return {
|
|
101
|
+
version: '0.2',
|
|
102
|
+
language: LANGUAGE,
|
|
103
|
+
dictionaryDefinitions: definitions,
|
|
104
|
+
dictionaries: definitions.map((definition) => definition.name),
|
|
105
|
+
words: KIT_WORDS,
|
|
106
|
+
ignoreRegExpList: IGNORED_PATTERNS,
|
|
107
|
+
noConfigSearch: true,
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
/** The tracked files the spelling check reads. */
|
|
111
|
+
export function spellingFiles(facts) {
|
|
112
|
+
const skipped = new Set(facts.matching(...NOT_SPELLED));
|
|
113
|
+
return facts.matching(...SPELLING_GLOBS).filter((file) => !skipped.has(file));
|
|
114
|
+
}
|
|
115
|
+
const issueSchema = z.object({
|
|
116
|
+
text: z.string(),
|
|
117
|
+
row: z.number().int().positive(),
|
|
118
|
+
col: z.number().int().positive(),
|
|
119
|
+
uri: z.string(),
|
|
120
|
+
isFlagged: z.boolean().optional(),
|
|
121
|
+
});
|
|
122
|
+
/** A finding from one cspell issue; `root` is the checkout the paths are relative to. */
|
|
123
|
+
export function spellingFinding(root, issue) {
|
|
124
|
+
const parsed = issueSchema.safeParse(issue);
|
|
125
|
+
if (!parsed.success)
|
|
126
|
+
throw new EngineError('cspell reported an issue Talos cannot read');
|
|
127
|
+
const { text, row, col, uri } = parsed.data;
|
|
128
|
+
const file = relative(root, uri.startsWith('file:') ? fileURLToPath(uri) : uri)
|
|
129
|
+
.split(sep)
|
|
130
|
+
.join('/');
|
|
131
|
+
const what = parsed.data.isFlagged === true ? 'Forbidden word' : 'Unknown word';
|
|
132
|
+
return {
|
|
133
|
+
rule: 'cspell/unknown-word',
|
|
134
|
+
message: `${what} "${text}": correct it, or add it to ${WORDS_FILE}.`,
|
|
135
|
+
location: { file, line: row, column: col },
|
|
136
|
+
};
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=cspell.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cspell.js","sourceRoot":"","sources":["../../../src/checks/docs/cspell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAa,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG1D,MAAM,CAAC,MAAM,aAAa,GAAG,oBAAoB,CAAC;AAClD,0FAA0F;AAC1F,MAAM,CAAC,MAAM,UAAU,GAAG,mBAAmB,CAAC;AAE9C,kCAAkC;AAClC,MAAM,cAAc,GAAG;IACrB,oBAAoB;IACpB,sCAAsC;IACtC,0BAA0B;IAC1B,8BAA8B;IAC9B,4BAA4B;IAC5B,eAAe;IACf,iBAAiB;IACjB,aAAa;CACd,CAAC;AACF,MAAM,WAAW,GAAG,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;AAEvD,0EAA0E;AAC1E,MAAM,YAAY,GAAG,QAAQ,CAAC;AAE9B,mGAAmG;AACnG,MAAM,WAAW,GAAoD;IACnE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACvC,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnB,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;CACpC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,UAAU,WAAW,CAAC,KAAsB;IAChD,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC9F,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,CAAC;AAEnC,SAAS,YAAY,CAAC,IAAY;IAChC,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,CAAA,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,0FAA0F;AAC1F,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,IAAI,YAAY,CAAC,SAAS,CAAC,aAAa,YAAY,CAAC,OAAO,CAAC,IAAI;IACjE,0BAA0B;IAC1B,wBAAwB;IACxB,MAAM,CAAC,GAAG,CAAA,qBAAqB;IAC/B,MAAM,CAAC,GAAG,CAAA,2BAA2B;IACrC,qFAAqF;IACrF,eAAe;CAChB,CAAC;AAEF,MAAM,QAAQ,GAAG,UAAU,CAAC;AAE5B,SAAS,QAAQ,CAAC,KAAwB;IACxC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,OAA0B,EAC1B,KAAsB;IAEtB,MAAM,OAAO,GAAG;QACd,oBAAoB;QACpB,GAAG,WAAW,CAAC,KAAK,CAAC;QACrB,YAAY;QACZ,GAAG,WAAW;QACd,GAAG,YAAY,CAAC,OAAO,CAAC;KACzB,CAAC;IACF,OAAO;QACL,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE;QACvC,qFAAqF;QACrF,mCAAmC,UAAU,iBAAiB;QAC9D,gBAAgB;QAChB,aAAa,QAAQ,EAAE;QACvB,wBAAwB;QACxB,mBAAmB;QACnB,eAAe,UAAU,EAAE;QAC3B,oBAAoB;QACpB,yBAAyB;QACzB,WAAW,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QAClC,mBAAmB;QACnB,GAAG,QAAQ,CAAC,gBAAgB,CAAC;QAC7B,cAAc;QACd,GAAG,QAAQ,CAAC,OAAO,CAAC;QACpB,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AASD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,YAA8B;IACzD,MAAM,WAAW,GAAG;QAClB,GAAG,CAAC,YAAY,CAAC,KAAK,KAAK,SAAS;YAClC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,QAAQ,EAAE;KAClD,CAAC;IACF,OAAO;QACL,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,QAAQ;QAClB,qBAAqB,EAAE,WAAW;QAClC,YAAY,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QAC9D,KAAK,EAAE,SAAS;QAChB,gBAAgB,EAAE,gBAAgB;QAClC,cAAc,EAAE,IAAI;KACrB,CAAC;AACJ,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,aAAa,CAAC,KAAgB;IAC5C,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IACxD,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,yFAAyF;AACzF,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,KAAc;IAC1D,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,WAAW,CAAC,4CAA4C,CAAC,CAAC;IACzF,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;SAC5E,KAAK,CAAC,GAAG,CAAC;SACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc,CAAC;IAChF,OAAO;QACL,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,GAAG,IAAI,KAAK,IAAI,+BAA+B,UAAU,GAAG;QACrE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE;KAC3C,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { decisionFiles, decisionTexts, MARKDOWN_GLOBS, readOwnTexts } from './files.js';
|
|
2
|
+
import { APPLIES, skip } from '../../core/check.js';
|
|
3
|
+
import { judgeDecisions } from '../../docs/decisions.js';
|
|
4
|
+
/**
|
|
5
|
+
* Decision IDs are unique across `DECISIONS.md` and the briefs, every reference in the
|
|
6
|
+
* repository's Markdown resolves, and every reversal is linked both ways.
|
|
7
|
+
*/
|
|
8
|
+
export const decisionsCheck = {
|
|
9
|
+
id: 'docs/decisions',
|
|
10
|
+
tier: 'head',
|
|
11
|
+
scope: 'repo',
|
|
12
|
+
title: 'decision IDs, references and reversals',
|
|
13
|
+
applies: (ctx) => decisionFiles(ctx).length > 0
|
|
14
|
+
? APPLIES
|
|
15
|
+
: skip('the repository has no DECISIONS.md and no briefs'),
|
|
16
|
+
run: async (ctx) => {
|
|
17
|
+
const definitions = await decisionTexts(ctx);
|
|
18
|
+
const documents = await readOwnTexts(ctx, ctx.facts.matching(...MARKDOWN_GLOBS));
|
|
19
|
+
return judgeDecisions(definitions, documents).map((problem) => ({
|
|
20
|
+
rule: problem.rule,
|
|
21
|
+
message: problem.message,
|
|
22
|
+
location: {
|
|
23
|
+
file: problem.file,
|
|
24
|
+
line: problem.line,
|
|
25
|
+
...(problem.column === undefined ? {} : { column: problem.column }),
|
|
26
|
+
},
|
|
27
|
+
}));
|
|
28
|
+
},
|
|
29
|
+
};
|
|
30
|
+
//# sourceMappingURL=decisions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"decisions.js","sourceRoot":"","sources":["../../../src/checks/docs/decisions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,EAAE,OAAO,EAAc,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAU;IACnC,EAAE,EAAE,gBAAgB;IACpB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,wCAAwC;IAC/C,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CACf,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC;QAC3B,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAC,kDAAkD,CAAC;IAC9D,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACjB,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC;QACjF,OAAO,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAW,EAAE,CAAC,CAAC;YACvE,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE;gBACR,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;aACpE;SACF,CAAC,CAAC,CAAC;IACN,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { GENERATED_MARKER } from '../../configs/header.js';
|
|
4
|
+
import { KIT_BEGIN, KIT_END } from '../../docs/claude.js';
|
|
5
|
+
export const MARKDOWN_GLOBS = ['**/*.md', '**/*.markdown'];
|
|
6
|
+
const DECISIONS_FILE = 'DECISIONS.md';
|
|
7
|
+
/** A path without the slashes it ends with. */
|
|
8
|
+
export function withoutTrailingSlashes(path) {
|
|
9
|
+
let end = path.length;
|
|
10
|
+
while (end > 0 && path[end - 1] === '/')
|
|
11
|
+
end -= 1;
|
|
12
|
+
return path.slice(0, end);
|
|
13
|
+
}
|
|
14
|
+
/** Files read at once, so a large repository doesn't run out of file handles. */
|
|
15
|
+
const BATCH = 64;
|
|
16
|
+
/** A file of the checkout, or undefined when it isn't there (deleted in a working tree). */
|
|
17
|
+
export async function readText(ctx, file) {
|
|
18
|
+
try {
|
|
19
|
+
return await readFile(join(ctx.root, file), 'utf8');
|
|
20
|
+
}
|
|
21
|
+
catch {
|
|
22
|
+
return undefined;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
/** A tool config Talos rendered: its text is Talos's, not the project's. */
|
|
26
|
+
function isGenerated(text) {
|
|
27
|
+
const head = text.slice(0, 600).split('\n', 3);
|
|
28
|
+
return ((head[0] ?? '').includes(GENERATED_MARKER) ||
|
|
29
|
+
head.some((line) => line.trimStart().startsWith(`"//": "${GENERATED_MARKER}`)));
|
|
30
|
+
}
|
|
31
|
+
/** Blanks `CLAUDE.md`'s kit block, Talos's own text, keeping every line where it was. */
|
|
32
|
+
function withoutKitBlock(text) {
|
|
33
|
+
const begin = text.indexOf(KIT_BEGIN);
|
|
34
|
+
const end = begin === -1 ? -1 : text.indexOf(KIT_END, begin);
|
|
35
|
+
if (end === -1)
|
|
36
|
+
return text;
|
|
37
|
+
const stop = end + KIT_END.length;
|
|
38
|
+
return (text.slice(0, begin) + text.slice(begin, stop).replaceAll(/[^\n]/g, ' ') + text.slice(stop));
|
|
39
|
+
}
|
|
40
|
+
/** The project's own text in each file, skipping missing and generated files. */
|
|
41
|
+
export async function readOwnTexts(ctx, files) {
|
|
42
|
+
const docs = [];
|
|
43
|
+
for (let start = 0; start < files.length; start += BATCH) {
|
|
44
|
+
const batch = files.slice(start, start + BATCH);
|
|
45
|
+
const texts = await Promise.all(batch.map((file) => readText(ctx, file)));
|
|
46
|
+
for (const [index, text] of texts.entries()) {
|
|
47
|
+
const file = batch[index];
|
|
48
|
+
if (file === undefined || text === undefined || isGenerated(text))
|
|
49
|
+
continue;
|
|
50
|
+
docs.push({ file, text: withoutKitBlock(text) });
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
return docs;
|
|
54
|
+
}
|
|
55
|
+
/** `DECISIONS.md` and every brief: where decisions are defined. */
|
|
56
|
+
export function decisionFiles(ctx) {
|
|
57
|
+
const briefs = withoutTrailingSlashes(ctx.config.docs.briefs);
|
|
58
|
+
return ctx.facts.matching(DECISIONS_FILE, `${briefs}/**/*.md`);
|
|
59
|
+
}
|
|
60
|
+
/** The texts of `DECISIONS.md` and the briefs, read once per run. */
|
|
61
|
+
export async function decisionTexts(ctx) {
|
|
62
|
+
return ctx.memo('docs/decision-texts', () => readOwnTexts(ctx, decisionFiles(ctx)));
|
|
63
|
+
}
|
|
64
|
+
//# sourceMappingURL=files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/checks/docs/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG1D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AAC3D,MAAM,cAAc,GAAG,cAAc,CAAC;AAEtC,+CAA+C;AAC/C,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACtB,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG;QAAE,GAAG,IAAI,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,iFAAiF;AACjF,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAiB,EAAE,IAAY;IAC5D,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/C,OAAO,CACL,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,UAAU,gBAAgB,EAAE,CAAC,CAAC,CAC/E,CAAC;AACJ,CAAC;AAED,yFAAyF;AACzF,SAAS,eAAe,CAAC,IAAY;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7D,IAAI,GAAG,KAAK,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5B,MAAM,IAAI,GAAG,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAClC,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAC5F,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAiB,EACjB,KAAwB;IAExB,MAAM,IAAI,GAAc,EAAE,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1E,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC5E,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,aAAa,CAAC,GAAiB;IAC7C,MAAM,MAAM,GAAG,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,OAAO,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,MAAM,UAAU,CAAC,CAAC;AACjE,CAAC;AAED,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAiB;IACnD,OAAO,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACtF,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { decisionFiles, MARKDOWN_GLOBS, readOwnTexts, readText } from './files.js';
|
|
2
|
+
import { APPLIES, skip } from '../../core/check.js';
|
|
3
|
+
import { SOURCE_GLOBS } from '../../docs/comments/index.js';
|
|
4
|
+
import { avoidedInCode, avoidedWords, parseGlossary, } from '../../docs/glossary.js';
|
|
5
|
+
import { maskCode } from '../../docs/markdown.js';
|
|
6
|
+
const MARKDOWN = /\.(?:md|markdown)$/;
|
|
7
|
+
/** A line that lists the words a glossary entry avoids, as the glossary's parser reads it. */
|
|
8
|
+
const AVOID_LINE = /^\s*avoid:/i;
|
|
9
|
+
const HEADING = /^ {0,3}#{1,6}(?:[ \t]|$)/;
|
|
10
|
+
/** A bold label opening a paragraph of a decision: `**Decision:**`, `**Rejected:**`. */
|
|
11
|
+
const LABEL = /^\*\*([^*\n:]+)(?::\*\*|\*\*:)/;
|
|
12
|
+
const LIST_ITEM = /^\s*(?:[-*+]|\d+[.)])[ \t]/;
|
|
13
|
+
/** A word in double quotes, straight or curly, on one line: named, not used. */
|
|
14
|
+
const QUOTED = /"[^"\n]*"|“[^“”\n]*”/g;
|
|
15
|
+
function blank(text) {
|
|
16
|
+
return text.replaceAll(/[^\n]/g, ' ');
|
|
17
|
+
}
|
|
18
|
+
/** The glossary without its `Avoid:` lines, which list the words rather than use them. */
|
|
19
|
+
function withoutAvoidLines(text) {
|
|
20
|
+
return text
|
|
21
|
+
.split('\n')
|
|
22
|
+
.map((line) => (AVOID_LINE.test(line) ? blank(line) : line))
|
|
23
|
+
.join('\n');
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Whether a line still belongs to the `**Rejected:**` paragraph or list before it: a heading
|
|
27
|
+
* ends it, and so does a paragraph after a blank line that is neither a list item nor indented.
|
|
28
|
+
*/
|
|
29
|
+
function continuesRejection(line, previous) {
|
|
30
|
+
if (HEADING.test(line))
|
|
31
|
+
return false;
|
|
32
|
+
if (line.trim() === '' || previous.trim() !== '')
|
|
33
|
+
return true;
|
|
34
|
+
return LIST_ITEM.test(line) || /^\s/.test(line);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* A decision record without what it names but doesn't use: each `**Rejected:**` paragraph or
|
|
38
|
+
* list, where the alternatives that lost are named by design, and words in double quotes.
|
|
39
|
+
* Everything else a decision says still counts.
|
|
40
|
+
*/
|
|
41
|
+
function withoutRejections(text) {
|
|
42
|
+
const lines = text.split('\n');
|
|
43
|
+
let rejecting = false;
|
|
44
|
+
return lines
|
|
45
|
+
.map((line, index) => {
|
|
46
|
+
const label = LABEL.exec(line)?.[1];
|
|
47
|
+
if (label !== undefined)
|
|
48
|
+
rejecting = label.trim().toLowerCase() === 'rejected';
|
|
49
|
+
else if (rejecting)
|
|
50
|
+
rejecting = continuesRejection(line, lines[index - 1] ?? '');
|
|
51
|
+
return rejecting ? blank(line) : line.replaceAll(QUOTED, blank);
|
|
52
|
+
})
|
|
53
|
+
.join('\n');
|
|
54
|
+
}
|
|
55
|
+
/** The text of a file the avoided words are matched in, its line and column kept. */
|
|
56
|
+
function judged(file, text, files) {
|
|
57
|
+
if (!MARKDOWN.test(file))
|
|
58
|
+
return text;
|
|
59
|
+
const prose = maskCode(text);
|
|
60
|
+
if (file === files.glossary)
|
|
61
|
+
return withoutAvoidLines(prose);
|
|
62
|
+
return files.decisions.has(file) ? withoutRejections(prose) : prose;
|
|
63
|
+
}
|
|
64
|
+
function hitsIn(entries, file, text) {
|
|
65
|
+
const markdown = MARKDOWN.test(file);
|
|
66
|
+
return text.split('\n').flatMap((line, index) => {
|
|
67
|
+
const hits = markdown ? avoidedWords(entries, line) : avoidedInCode(entries, line);
|
|
68
|
+
return hits.map((hit) => ({
|
|
69
|
+
rule: 'glossary/avoid',
|
|
70
|
+
message: `"${hit.word}" is a word the glossary avoids: write "${hit.instead}" instead.`,
|
|
71
|
+
location: { file, line: index + 1, column: hit.index + 1 },
|
|
72
|
+
}));
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
async function avoided(ctx) {
|
|
76
|
+
const glossary = ctx.config.docs.glossary;
|
|
77
|
+
const text = await readText(ctx, glossary);
|
|
78
|
+
const entries = text === undefined ? [] : parseGlossary(text).filter((e) => e.avoid.length > 0);
|
|
79
|
+
if (entries.length === 0)
|
|
80
|
+
return [];
|
|
81
|
+
const files = { glossary, decisions: new Set(decisionFiles(ctx)) };
|
|
82
|
+
const docs = await readOwnTexts(ctx, ctx.facts.matching(...MARKDOWN_GLOBS, ...SOURCE_GLOBS));
|
|
83
|
+
return docs.flatMap((doc) => hitsIn(entries, doc.file, judged(doc.file, doc.text, files)));
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* The words the glossary lists under `Avoid:` fail in docs and in code, the glossary's own
|
|
87
|
+
* definitions included. A decision record may name one where it rejects it, or in quotes.
|
|
88
|
+
*/
|
|
89
|
+
export const glossaryCheck = {
|
|
90
|
+
id: 'docs/glossary',
|
|
91
|
+
tier: 'head',
|
|
92
|
+
scope: 'repo',
|
|
93
|
+
title: 'words the glossary avoids',
|
|
94
|
+
applies: (ctx) => ctx.facts.files.includes(ctx.config.docs.glossary)
|
|
95
|
+
? APPLIES
|
|
96
|
+
: skip(`the repository has no glossary at ${ctx.config.docs.glossary}`),
|
|
97
|
+
run: avoided,
|
|
98
|
+
};
|
|
99
|
+
//# sourceMappingURL=glossary.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"glossary.js","sourceRoot":"","sources":["../../../src/checks/docs/glossary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnF,OAAO,EAAE,OAAO,EAAiC,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAEnF,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,aAAa,EACb,YAAY,EAEZ,aAAa,GACd,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AACtC,8FAA8F;AAC9F,MAAM,UAAU,GAAG,aAAa,CAAC;AACjC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAC3C,wFAAwF;AACxF,MAAM,KAAK,GAAG,gCAAgC,CAAC;AAC/C,MAAM,SAAS,GAAG,4BAA4B,CAAC;AAC/C,gFAAgF;AAChF,MAAM,MAAM,GAAG,uBAAuB,CAAC;AAEvC,SAAS,KAAK,CAAC,IAAY;IACzB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC;AAED,0FAA0F;AAC1F,SAAS,iBAAiB,CAAC,IAAY;IACrC,OAAO,IAAI;SACR,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,IAAY,EAAE,QAAgB;IACxD,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC9D,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,IAAY;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACnB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC;aAC1E,IAAI,SAAS;YAAE,SAAS,GAAG,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACjF,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAID,qFAAqF;AACrF,SAAS,MAAM,CAAC,IAAY,EAAE,IAAY,EAAE,KAAY;IACtD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,IAAI,KAAK,KAAK,CAAC,QAAQ;QAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC7D,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACtE,CAAC;AAED,SAAS,MAAM,CAAC,OAAiC,EAAE,IAAY,EAAE,IAAY;IAC3E,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC9C,MAAM,IAAI,GAAe,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC/F,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,IAAI,GAAG,CAAC,IAAI,2CAA2C,GAAG,CAAC,OAAO,YAAY;YACvF,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE;SAC3D,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,GAAiB;IACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC1C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAChG,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;IACnE,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,cAAc,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;IAC7F,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAU;IAClC,EAAE,EAAE,eAAe;IACnB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,2BAA2B;IAClC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CACf,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChD,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAC,qCAAqC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3E,GAAG,EAAE,OAAO;CACb,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { claudeMdCheck } from './claude-md.js';
|
|
2
|
+
import { commentsCheck } from './comments.js';
|
|
3
|
+
import { decisionsCheck } from './decisions.js';
|
|
4
|
+
import { glossaryCheck } from './glossary.js';
|
|
5
|
+
import { markdownCheck, markdownlintBase } from './markdown.js';
|
|
6
|
+
import { referencesCheck } from './references.js';
|
|
7
|
+
import { cspellBase, spellingCheck } from './spelling.js';
|
|
8
|
+
/**
|
|
9
|
+
* The documentation rules: Markdown style, spelling, decision records, the glossary's avoided
|
|
10
|
+
* words, links, what code comments may say, and `CLAUDE.md`.
|
|
11
|
+
*/
|
|
12
|
+
export const docsPack = {
|
|
13
|
+
name: 'docs',
|
|
14
|
+
checks: [
|
|
15
|
+
commentsCheck,
|
|
16
|
+
markdownCheck,
|
|
17
|
+
spellingCheck,
|
|
18
|
+
decisionsCheck,
|
|
19
|
+
glossaryCheck,
|
|
20
|
+
referencesCheck,
|
|
21
|
+
claudeMdCheck,
|
|
22
|
+
],
|
|
23
|
+
generated: [markdownlintBase, cspellBase],
|
|
24
|
+
};
|
|
25
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAG1D;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAS;IAC5B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE;QACN,aAAa;QACb,aAAa;QACb,aAAa;QACb,cAAc;QACd,aAAa;QACb,eAAe;QACf,aAAa;KACd;IACD,SAAS,EAAE,CAAC,gBAAgB,EAAE,UAAU,CAAC;CAC1C,CAAC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { lint } from 'markdownlint-cli2/markdownlint/promise';
|
|
2
|
+
import { MARKDOWN_GLOBS, readText } from './files.js';
|
|
3
|
+
import { MARKDOWNLINT_CONFIG, MARKDOWNLINT_RULES, markdownlintFindings, NOT_LINTED, renderMarkdownlintBase, } from './markdownlint.js';
|
|
4
|
+
import { APPLIES, skip } from '../../core/check.js';
|
|
5
|
+
/** The tracked Markdown files markdownlint reads: those the base doesn't ignore. */
|
|
6
|
+
function lintedFiles(facts) {
|
|
7
|
+
const skipped = new Set(facts.matching(...NOT_LINTED));
|
|
8
|
+
return facts.matching(...MARKDOWN_GLOBS).filter((file) => !skipped.has(file));
|
|
9
|
+
}
|
|
10
|
+
/** The repository's Markdown through markdownlint, with the base's rules and nothing else. */
|
|
11
|
+
export const markdownCheck = {
|
|
12
|
+
id: 'docs/markdown',
|
|
13
|
+
tier: 'head',
|
|
14
|
+
scope: 'repo',
|
|
15
|
+
title: 'markdownlint',
|
|
16
|
+
applies: (ctx) => lintedFiles(ctx.facts).length > 0 ? APPLIES : skip('the repository has no Markdown to lint'),
|
|
17
|
+
run: async (ctx) => {
|
|
18
|
+
const strings = {};
|
|
19
|
+
for (const file of lintedFiles(ctx.facts)) {
|
|
20
|
+
const text = await readText(ctx, file);
|
|
21
|
+
if (text !== undefined)
|
|
22
|
+
strings[file] = text;
|
|
23
|
+
}
|
|
24
|
+
const results = await lint({
|
|
25
|
+
strings,
|
|
26
|
+
config: MARKDOWNLINT_RULES,
|
|
27
|
+
noInlineConfig: true,
|
|
28
|
+
handleRuleFailures: true,
|
|
29
|
+
});
|
|
30
|
+
return markdownlintFindings(results);
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
export const markdownlintBase = {
|
|
34
|
+
path: MARKDOWNLINT_CONFIG,
|
|
35
|
+
scope: 'repo',
|
|
36
|
+
applies: (ctx) => ctx.facts.has(...MARKDOWN_GLOBS),
|
|
37
|
+
render: (ctx) => renderMarkdownlintBase(ctx.version, ctx.config.exclude),
|
|
38
|
+
};
|
|
39
|
+
//# sourceMappingURL=markdown.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../../src/checks/docs/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wCAAwC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,UAAU,EACV,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAc,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAIhE,oFAAoF;AACpF,SAAS,WAAW,CAAC,KAAgB;IACnC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IACvD,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,8FAA8F;AAC9F,MAAM,CAAC,MAAM,aAAa,GAAU;IAClC,EAAE,EAAE,eAAe;IACnB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,cAAc;IACrB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CACf,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,wCAAwC,CAAC;IAC9F,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACjB,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC/C,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC;YACzB,OAAO;YACP,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,IAAI;YACpB,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAc;IACzC,IAAI,EAAE,mBAAmB;IACzB,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC;IAClD,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC;CACzE,CAAC"}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { withoutTrailingSlashes } from './files.js';
|
|
3
|
+
import { generatedHeader } from '../../configs/header.js';
|
|
4
|
+
import { EngineError } from '../../core/check.js';
|
|
5
|
+
export const MARKDOWNLINT_CONFIG = '.markdownlint-cli2.jsonc';
|
|
6
|
+
/** markdownlint's rules, every one on, with prose lines up to 100 outside tables and code. */
|
|
7
|
+
export const MARKDOWNLINT_RULES = {
|
|
8
|
+
default: true,
|
|
9
|
+
MD013: { line_length: 100, tables: false, code_blocks: false },
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* What markdownlint skips, in the gate and in the base alike: installed packages, and PR
|
|
13
|
+
* templates, which are forms of HTML comments to fill in rather than documents.
|
|
14
|
+
*/
|
|
15
|
+
export const NOT_LINTED = ['**/node_modules/**', '**/pull_request_template.md'];
|
|
16
|
+
/** Globs for what `talos.yml` excludes: each entry as a file and as a directory. */
|
|
17
|
+
export function excludeGlobs(exclude) {
|
|
18
|
+
return exclude.flatMap((entry) => {
|
|
19
|
+
const trimmed = withoutTrailingSlashes(entry);
|
|
20
|
+
return [trimmed, `${trimmed}/**`];
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/** A JSON array on one line when it fits in `width` after `prefix`, else one item a line. */
|
|
24
|
+
function jsonArray(prefix, items, width = 100) {
|
|
25
|
+
const inline = `${prefix}[${items.map((item) => JSON.stringify(item)).join(', ')}],`;
|
|
26
|
+
if (inline.length <= width)
|
|
27
|
+
return inline;
|
|
28
|
+
const indent = /^\s*/.exec(prefix)?.[0] ?? '';
|
|
29
|
+
const lines = items.map((item) => `${indent} ${JSON.stringify(item)},`);
|
|
30
|
+
return [`${prefix}[`, ...lines, `${indent}],`].join('\n');
|
|
31
|
+
}
|
|
32
|
+
function inlineObject(value) {
|
|
33
|
+
const entries = Object.entries(value).map(([key, item]) => `"${key}": ${JSON.stringify(item)}`);
|
|
34
|
+
return `{ ${entries.join(', ')} }`;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The base for editors and `markdownlint-cli2`, written as Prettier writes it. Inline
|
|
38
|
+
* `markdownlint-disable` comments do nothing. It has no extension file: every rule is already
|
|
39
|
+
* on, and the line length is the kit's.
|
|
40
|
+
*/
|
|
41
|
+
export function renderMarkdownlintBase(version, exclude) {
|
|
42
|
+
const ignores = [...NOT_LINTED, ...excludeGlobs(exclude)];
|
|
43
|
+
return [
|
|
44
|
+
generatedHeader('//', version).trimEnd(),
|
|
45
|
+
"// markdownlint's rules for every Markdown file, lines up to 100 outside tables and code.",
|
|
46
|
+
'{',
|
|
47
|
+
' "config": {',
|
|
48
|
+
' "default": true,',
|
|
49
|
+
` "MD013": ${inlineObject(MARKDOWNLINT_RULES.MD013)},`,
|
|
50
|
+
' },',
|
|
51
|
+
jsonArray(' "globs": ', ['**/*.md']),
|
|
52
|
+
jsonArray(' "ignores": ', ignores),
|
|
53
|
+
' "gitignore": true,',
|
|
54
|
+
' "noInlineConfig": true,',
|
|
55
|
+
'}',
|
|
56
|
+
'',
|
|
57
|
+
].join('\n');
|
|
58
|
+
}
|
|
59
|
+
const lintError = z.object({
|
|
60
|
+
lineNumber: z.number().int().positive(),
|
|
61
|
+
ruleNames: z.array(z.string()).min(1),
|
|
62
|
+
ruleDescription: z.string(),
|
|
63
|
+
errorDetail: z.string().nullable(),
|
|
64
|
+
errorRange: z.tuple([z.number(), z.number()]).nullable(),
|
|
65
|
+
});
|
|
66
|
+
const lintResults = z.record(z.string(), z.array(lintError));
|
|
67
|
+
function sentence(description, detail) {
|
|
68
|
+
const text = detail === null || detail === '' ? description : `${description} (${detail})`;
|
|
69
|
+
return /[.!?]$/.test(text) ? text : `${text}.`;
|
|
70
|
+
}
|
|
71
|
+
/** Findings from markdownlint's results, keyed by repository-relative file. */
|
|
72
|
+
export function markdownlintFindings(results) {
|
|
73
|
+
const parsed = lintResults.safeParse(results);
|
|
74
|
+
if (!parsed.success)
|
|
75
|
+
throw new EngineError('markdownlint returned results Talos cannot read');
|
|
76
|
+
return Object.entries(parsed.data).flatMap(([file, errors]) => errors.map((error) => ({
|
|
77
|
+
rule: `markdownlint/${error.ruleNames[0] ?? 'unknown'}`,
|
|
78
|
+
message: sentence(error.ruleDescription, error.errorDetail),
|
|
79
|
+
location: {
|
|
80
|
+
file,
|
|
81
|
+
line: error.lineNumber,
|
|
82
|
+
...(error.errorRange === null ? {} : { column: error.errorRange[0] }),
|
|
83
|
+
},
|
|
84
|
+
})));
|
|
85
|
+
}
|
|
86
|
+
//# sourceMappingURL=markdownlint.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownlint.js","sourceRoot":"","sources":["../../../src/checks/docs/markdownlint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,MAAM,CAAC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAE9D,8FAA8F;AAC9F,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE;CACtD,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,oBAAoB,EAAE,6BAA6B,CAAC,CAAC;AAEhF,oFAAoF;AACpF,MAAM,UAAU,YAAY,CAAC,OAA0B;IACrD,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,CAAC,OAAO,EAAE,GAAG,OAAO,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6FAA6F;AAC7F,SAAS,SAAS,CAAC,MAAc,EAAE,KAAwB,EAAE,KAAK,GAAG,GAAG;IACtE,MAAM,MAAM,GAAG,GAAG,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACrF,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK;QAAE,OAAO,MAAM,CAAC;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzE,OAAO,CAAC,GAAG,MAAM,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,YAAY,CAAC,KAAwC;IAC5D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChG,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAAe,EAAE,OAA0B;IAChF,MAAM,OAAO,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1D,OAAO;QACL,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE;QACxC,2FAA2F;QAC3F,GAAG;QACH,eAAe;QACf,sBAAsB;QACtB,gBAAgB,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG;QACzD,MAAM;QACN,SAAS,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,CAAC;QACrC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC;QACnC,sBAAsB;QACtB,2BAA2B;QAC3B,GAAG;QACH,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IACzB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AAE7D,SAAS,QAAQ,CAAC,WAAmB,EAAE,MAAqB;IAC1D,MAAM,IAAI,GAAG,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,KAAK,MAAM,GAAG,CAAC;IAC3F,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;AACjD,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACnD,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,WAAW,CAAC,iDAAiD,CAAC,CAAC;IAC9F,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAC5D,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrB,IAAI,EAAE,gBAAgB,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE;QACvD,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAC;QAC3D,QAAQ,EAAE;YACR,IAAI;YACJ,IAAI,EAAE,KAAK,CAAC,UAAU;YACtB,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;SACtE;KACF,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { stat } from 'node:fs/promises';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
import { MARKDOWN_GLOBS, readOwnTexts, readText } from './files.js';
|
|
4
|
+
import { APPLIES, skip } from '../../core/check.js';
|
|
5
|
+
import { markdownLinks, resolveLink } from '../../docs/links.js';
|
|
6
|
+
import { anchors } from '../../docs/markdown.js';
|
|
7
|
+
const MARKDOWN = /\.(?:md|markdown)$/;
|
|
8
|
+
/** GitHub's line anchors on a code file, `#L10` or `#L10-L20`. */
|
|
9
|
+
const LINE_ANCHOR = /^L\d+(?:-L\d+)?$/;
|
|
10
|
+
function lookup(ctx, docs) {
|
|
11
|
+
const own = new Map(docs.map((doc) => [doc.file, doc.text]));
|
|
12
|
+
const known = new Map();
|
|
13
|
+
const found = new Map();
|
|
14
|
+
return {
|
|
15
|
+
exists: (path) => {
|
|
16
|
+
let result = known.get(path);
|
|
17
|
+
if (result === undefined) {
|
|
18
|
+
result = stat(join(ctx.root, path)).then(() => true, () => false);
|
|
19
|
+
known.set(path, result);
|
|
20
|
+
}
|
|
21
|
+
return result;
|
|
22
|
+
},
|
|
23
|
+
anchorsOf: (path) => {
|
|
24
|
+
let result = found.get(path);
|
|
25
|
+
if (result === undefined) {
|
|
26
|
+
const text = own.get(path);
|
|
27
|
+
const read = text === undefined ? readText(ctx, path) : Promise.resolve(text);
|
|
28
|
+
result = read.then((value) => value === undefined
|
|
29
|
+
? undefined
|
|
30
|
+
: new Set([...anchors(value)].map((a) => a.toLowerCase())));
|
|
31
|
+
found.set(path, result);
|
|
32
|
+
}
|
|
33
|
+
return result;
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
function broken(file, link, message) {
|
|
38
|
+
return {
|
|
39
|
+
rule: 'docs/broken-link',
|
|
40
|
+
message,
|
|
41
|
+
location: { file, line: link.line, column: link.column },
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
async function judgeLink(doc, link, look) {
|
|
45
|
+
if (/\{\{|\$\{/.test(link.target))
|
|
46
|
+
return [];
|
|
47
|
+
const target = resolveLink(doc.file, link.target);
|
|
48
|
+
if (target.kind !== 'local')
|
|
49
|
+
return [];
|
|
50
|
+
const path = target.path === '' ? doc.file : target.path;
|
|
51
|
+
if (target.path !== '' && !(await look.exists(path))) {
|
|
52
|
+
return [broken(doc.file, link, `The link to ${link.target} names no file in the repository.`)];
|
|
53
|
+
}
|
|
54
|
+
const anchor = target.anchor;
|
|
55
|
+
if (anchor === undefined || !MARKDOWN.test(path) || LINE_ANCHOR.test(anchor))
|
|
56
|
+
return [];
|
|
57
|
+
const known = await look.anchorsOf(path);
|
|
58
|
+
if (known === undefined || known.has(anchor.toLowerCase()))
|
|
59
|
+
return [];
|
|
60
|
+
return [broken(doc.file, link, `The link to ${link.target} names no heading in ${path}.`)];
|
|
61
|
+
}
|
|
62
|
+
async function brokenLinks(ctx) {
|
|
63
|
+
const docs = await readOwnTexts(ctx, ctx.facts.matching(...MARKDOWN_GLOBS));
|
|
64
|
+
const look = lookup(ctx, docs);
|
|
65
|
+
const findings = [];
|
|
66
|
+
for (const doc of docs) {
|
|
67
|
+
for (const link of markdownLinks(doc.text)) {
|
|
68
|
+
findings.push(...(await judgeLink(doc, link, look)));
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return findings;
|
|
72
|
+
}
|
|
73
|
+
/** Markdown links to files and headings of the repository resolve. */
|
|
74
|
+
export const referencesCheck = {
|
|
75
|
+
id: 'docs/references',
|
|
76
|
+
tier: 'head',
|
|
77
|
+
scope: 'repo',
|
|
78
|
+
title: 'links to files and headings',
|
|
79
|
+
applies: (ctx) => ctx.facts.has(...MARKDOWN_GLOBS) ? APPLIES : skip('the repository has no Markdown'),
|
|
80
|
+
run: brokenLinks,
|
|
81
|
+
};
|
|
82
|
+
//# sourceMappingURL=references.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../src/checks/docs/references.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,OAAO,EAAiC,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAGnF,OAAO,EAAa,aAAa,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AACtC,kEAAkE;AAClE,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAOvC,SAAS,MAAM,CAAC,GAAiB,EAAE,IAAwB;IACzD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,GAAG,EAA4B,CAAC;IAClD,MAAM,KAAK,GAAG,IAAI,GAAG,EAA4C,CAAC;IAClE,OAAO;QACL,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACf,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CACtC,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ,CAAC;gBACF,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAClB,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC3B,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC9E,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,KAAK,KAAK,SAAS;oBACjB,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAC7D,CAAC;gBACF,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,IAAU,EAAE,OAAe;IACvD,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,OAAO;QACP,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;KACzD,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,GAAY,EAAE,IAAU,EAAE,IAAY;IAC7D,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7C,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,EAAE,CAAC;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACzD,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,IAAI,CAAC,MAAM,mCAAmC,CAAC,CAAC,CAAC;IACjG,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACxF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,EAAE,CAAC;IACtE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,IAAI,CAAC,MAAM,wBAAwB,IAAI,GAAG,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAiB;IAC1C,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC;IAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,sEAAsE;AACtE,MAAM,CAAC,MAAM,eAAe,GAAU;IACpC,EAAE,EAAE,iBAAiB;IACrB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,6BAA6B;IACpC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CACf,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC;IACrF,GAAG,EAAE,WAAW;CACjB,CAAC"}
|