docs(scripts): add scripts/README.md cataloguing every npm script - #230
Open
nastaso wants to merge 1 commit into
Open
docs(scripts): add scripts/README.md cataloguing every npm script#230nastaso wants to merge 1 commit into
nastaso wants to merge 1 commit into
Conversation
Groups all 24 scripts/*.mjs by purpose (question bank, SEO/asset generation, build guards, CSP/headers, indexing/monitoring, one-off maintenance), mapping each npm-script name -> file -> description. Descriptions checked against each script's actual body, not just its header comment or filename. Closes #196.
Deploying cloudcertprep with
|
| Latest commit: |
84975eb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e412f924.cloudcertprep.pages.dev |
| Branch Preview URL: | https://docs-scripts-readme.cloudcertprep.pages.dev |
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
1 participant
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.
What does this PR do?
Closes #196. Adds
scripts/README.md: everyscripts/*.mjsfile (24 total), grouped by purpose (question bank, SEO/asset generation, build guards, CSP/headers, indexing/monitoring, one-off maintenance), mapping npm-script name -> file -> one-line description, plus a short note on the two committed baseline JSON files those scripts read.Descriptions are checked against each script's actual body (not just its header comment or filename) - generated from reading all 24 files in full, cross-checked against
package.json's script list and the three GitHub workflow files that invoke a few scripts directly (no npm-script wrapper):monitor-sitemap.mjs/monitor-stats-rpc.mjsviamonitor-production.yml,ping-indexnow.mjsviaindexnow.yml. Two scripts (cleanup-orphaned-attempts.mjs,verify-delete-cascade.mjs) have no npm-script or CI wiring at all - confirmed by grep, documented as owner-run manual tools.A finding along the way, flagged not fixed
Codex's audit (spot-checking 3 random table rows against the real source, lens: does the description match the code, not just the filename/comment) turned up a real gap in
verify-delete-cascade.mjsitself, independent of this documentation: its "other user's rows are UNCHANGED" check only fails on a count decrease, not an increase, and per-table seed failures are non-fatal by design - so a table whose seed insert silently failed would report0before and after and pass as "unchanged" without ever actually being exercised. I verified this myself by reading the exact lines. This is a gap in the verification script's own rigor, not something this PR should fix (out of scope for a docs-only change, and it's a security/data-integrity-adjacent script I have no mandate to touch here) - left aNEEDS-ALEXnote directly on that table row with the exact line numbers so it doesn't get lost.Testing
npm run build: stays green (this file is documentation only, not wired into any build step).scripts/viatest -f, both directions (every real file covered, every named file real).package.jsonvia grep.Checklist
npm run buildstays greenscripts/, mechanically verifiedpackage.json, mechanically verified