fix: handle non-JSON files and invalid JSON - #977
Open
Devansh-567 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.
Summary
This PR improves the robustness of the repository's annotation validation scripts by handling two cases that currently result in uncaught exceptions.
bin/annotate-specification-linksnow usesversion_urls.get(kind)instead of direct dictionary indexing, allowing the existing error-handling path for unknown specification kinds to execute.bin/annotation-tests.tsnow only processes.jsonfiles and reports invalid JSON with a readable per-file error instead of aborting with an uncaught exception.Changes
bin/annotate-specification-linksversion_urls[kind]withversion_urls.get(kind).This ensures that unknown specification kinds are handled by the existing
Nonecheck rather than raising aKeyError.bin/annotation-tests.ts.json.JSON.parsein atry/catch.This prevents unrelated files (such as
README.mdor editor temporary files) or malformed JSON from terminating the validation script with an uncaught exception.Why
Both changes make the validation scripts more resilient while preserving their behavior for valid inputs.
KeyError.