test(docs): cover catalog parsing helpers - #345
Open
ikenyal wants to merge 1 commit into
Open
Conversation
|
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
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.
Problem
Issue #, if available: #323
The catalog sync gate exercises
scripts/sync-catalog.mjsonly as a CLI command. Its parsing helpers have no direct tests, so a regression in blurb extraction or marker handling could silently corrupt the committed catalog or weaken the CI check.Changes
extractBlurb,extractBetweenMarkers, andinjectCatalog, including malformed marker order and missing-marker behavior.No published package behavior changes, so no changeset is needed.
This intentionally follows the narrow scope proposed in #323. If the maintainers would prefer a different test location, helper extraction, or scope, I am happy to adjust this PR or close it.
Validation
node --test scripts/*.test.mjs(45 passing)node scripts/sync-catalog.mjs --checknode scripts/sync-catalog.mjs --write(no README changes)git diff --checknpm run buildcould not run in this dedicated worktree because its workspace dependencies are not installed (tscis unavailable). The changed script and its CI workflow use Node built-ins only; the targeted checks above exercise the complete changed behavior.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.