Fix TOML path targeting and formatting loss with toml-patch - #53
Merged
webpro merged 4 commits intoMay 23, 2026
Merged
Conversation
Introduces `@decimalturn/toml-patch` to update TOML versions without destroying original formatting or stripping inline comments. While this package has a smaller community footprint than alternative options (like `@shopify/toml-patch`), it offers a stable semver release.
Contributor
|
🚀 This pull request is included in v7.0.6. See Release 7.0.6 for release notes. |
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
2 participants
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.
This MR replaces the use of regex, which was introduced to maintain the original file format, with a TOML patching engine via “@decimalturn/toml-patch”. This ensures that only values under the path(s) are modified whilst preserving file comments and format.
Additionally, the tests for TOML files were aligned to match the tests for JSON files with some refactoring to reduce the boierplate in each test.
Note, “@decimalturn/toml-patch” has a reasonably small community footprint but appears to be actively maintained. Another option could be “@shopify/toml-patch” but I felt like it might be too immature.