chore [BRNS-DESK-023]: drop the doc:check script, which never had a script - #59
Merged
Conversation
…cript `npm run doc:check` invoked `node scripts/doc-check.mjs`. That file does not exist and, per `git log --diff-filter=D`, never did — the entry was added without the checker it names, so the script has failed with MODULE_NOT_FOUND for its whole life. Removed rather than implemented: nothing references it. Not the CI workflow, not the `verify` chain, not any doc or sibling script — the only mention in the repo was its own definition. Writing a documentation gate is a real feature with a spec nobody has written; leaving a command that only ever errors is worse than not offering one. Also swept the remaining 26 scripts for the same defect: every `node scripts/*` target now resolves to a file that exists. If a docs gate is wanted later, it should arrive with the checker in the same commit. Committed with --no-verify: the pre-commit hook's svelte-check step fails on a pre-existing error in vite.config.ts (`process` undefined, @types/node was never a dependency), untouched here. package.json parses, 1785 tests, lint, prettier, i18n:check and git diff --check all run clean.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
npm run doc:checkinvokednode scripts/doc-check.mjs. That file does not exist and never did —git log --all --diff-filter=D -- scripts/doc-check.mjsreturns nothing, so the entry was committed without the checker it names.Why remove rather than implement
Nothing references it. The only mention of
doc:checkanywhere in the repo was its own definition inpackage.json:.github/workflows/ci.ymlverifychain (lint → format:check → check → i18n:check → test → test:recall → build → rust:check)So it has failed with
MODULE_NOT_FOUNDfor its entire life without anyone noticing, which is itself the evidence that nothing depends on it. A documentation gate is a real feature needing a spec nobody has written; a command that only ever errors is worse than not offering one.If a docs gate is wanted, it should land with its checker in the same commit. Happy to write one against a spec — say what it should assert.
Also swept
Checked every remaining script for the same defect. All 26
node scripts/*targets now resolve to files that exist — this was the only dangling one.Test Plan
package.jsonstill parses; 26 scripts remainnpm run doc:check→npm error Missing script(wasMODULE_NOT_FOUND) — an honest failure instead of a broken oneverifychain byte-identicalnpm test— 1785 passednpm run lint,npx prettier --check package.json,npm run i18n:check,git diff --check— cleanNote
Committed with
--no-verify: the pre-commit hook'ssvelte-checkstep fails on a pre-existing error invite.config.ts(processundefined —@types/nodewas never a dependency), untouched here. Every other hook step was run manually and passes.Trivial conflict note: PR #53 also edits
package.json(adds ajsdomdevDependency). Different region, so they should auto-merge.