feat: predictible json/json5 handling #24612
Merged
Conversation
This file contains 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
rarkins
reviewed
Sep 23, 2023
viceice
reviewed
Sep 26, 2023
rarkins
changed the title
rarkins
requested changes
Sep 27, 2023
Co-authored-by: Rhys Arkins <rhys@arkins.net>
viceice
reviewed
Oct 16, 2023
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
This comment was marked as outdated.
This comment was marked as outdated.
viceice
previously approved these changes
Oct 24, 2023
rarkins
reviewed
Oct 24, 2023
viceice
approved these changes
Nov 4, 2023
rarkins
approved these changes
Nov 6, 2023
|
🎉 This PR is included in version 37.48.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
HonkingGoose
reviewed
Nov 6, 2023
| parsedJson = JSON5.parse(content); | ||
| logger.warn( | ||
| { context }, | ||
| 'File contents are invalid JSON but parse using JSON5. Support for this will be removed in a future release so please change to a support .json5 file name or ensure correct JSON syntax.' |
There was a problem hiding this comment.
This log message is a bit confusing. How about something like this:
File contents are invalid JSON but parse corectly as JSON5. In a future release, Renovate will strictly parse JSON as JSON, and JSON5 as JSON5. To prevent breaking your Renovate config in a upcoming major release: please make sure the file extension matches the content syntax.
In any case, we should be clear about:
- Current behavior (Renovate silently eats wrong file format)
- Upcoming behavior (Renovate will parse strictly according to file extension)
- What the user most do to prevent future breakage (make sure file extension matches file content syntax)
jon4hz
pushed a commit
to jon4hz/renovate
that referenced
this pull request
Nov 9, 2023
Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes
JSON5.parse, first try and parse the file withJSON.parseJSON.parsetry parsing withJSON5.parseand if parsed, log a warning message for the user to notify of the inconsistent behaviourContext
Closes: #24554
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: