fix: improve robustness of README section replacement#5
Open
MatrixNeoKozak 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
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.
Summary of changes:
Refactor
replaceApiListSectioninscripts/update-readme-api-list.mjsto reliably replace the entire API list section, including its header, by using the H2 header as the starting point and<!-- API_LIST_END -->as the ending point. Added atry...catchblock to handle file writing errors.Rationale behind the implementation:
The previous implementation was brittle because it relied on searching for the next H2 header to determine the end of the section, which could lead to incorrectly including subsequent documentation sections. By using the
<!-- API_LIST_END -->marker as the definitive end point, the replacement is now deterministic and safe from structural variations in the README.Technical impact analysis:
This change increases the reliability of automated documentation updates, prevents corruption of the README structure, and improves error reporting during file system operations.