JSON report is invalid when messages contain newlines or tabs #716
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
pfrenssen force-pushed the invalidjson branch from f40c55f to 317e34c Compare 
pfrenssen force-pushed the invalidjson branch from 317e34c to 44fe2fa Compare 
There was a problem hiding this comment.
Maybe also add \r to the list for Windows users.
…age return character.
| @aik099 great suggestion, thanks! I have added a line that converts carriage returns to the harmless '\r' character sequence. |
gsherwood changed the title 
| Thanks a lot for the fix. |
jrfnl added a commit to jrfnl/PHP_CodeSniffer that referenced this pull request Nov 23, 2024
…rs-add-tests-documentation-titles Generators: add tests for handling documentation titles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 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.
When any of the error or warning messages contain tabs or newlines and a JSON report is generated then the resulting JSON will be invalid.
A good solution for this would be to use
json_encode()to generate the JSON, but since we need to support old PHP versions this is not possible until PHP CodeSniffer 3 (see #449 for more information).For the moment we can work around the issue by replacing the offending characters before outputting the JSON report.