Repository navigation
fix: enforce the guide lesson authoring contract - #1438
Open
fhammerschmidt wants to merge 1 commit into
Open
fhammerschmidt wants to merge 1 commit into
fhammerschmidt wants to merge 1 commit into
Conversation
Validate slug identifiers, 32-bit integer positions, and required exact output strings. Remove unused description and exercise title metadata and keep source paths only in build diagnostics. Run frontmatter and real lesson collection checks in Node as part of guide CI. Cover malformed fields, duplicate diagnostics, nested discovery, exact output, and path-free serialized lessons. Fixes rescript-lang#1404 Part of rescript-lang#1421.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This branch has not been deployed
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.
A typo or omission in
exercise.expectedOutputpreviously produced an unfinishable manual checkpoint. Lesson IDs were not checked against the documented slug format, and numeric positions were silently truncated. Loader data also included absolute build paths and unused metadata.Enforce the guide's authoring contract:
exercise.expectedOutputin the lesson model; preserve exact whitespace and empty strings, and remove the unsupported manual-check variant.descriptionandexercise.titlefields from the model, lessons, and authoring documentation.Run frontmatter and real filesystem collection tests in Node through the guide CI command. Coverage includes malformed fields, duplicate identifiers and positions with both filenames, nested MDX discovery, ordering, and serialized lessons without build paths. An empty expected output still needs a runtime log to complete its checkpoint.
Targets website
master(v12). No compiler repository changes.Validation:
build/clientandoutcontain lesson data without source paths or the build directory.Fixes #1404.
Part of #1421.