json-formatter: fix error message #594
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
Fix `message` field in output by json formatter in case of errors preventing rule application (e.g. parsing errors). Previously, a pretty printing method from `Text.Megaparsec.Error` was used, but this decorated the message with junk characters. The new `errorMessage` function converts a `ParseErrorBundle` into a printable `String` without additional junk, stripping newlines from the end as well. fixes: hadolint#593
|
Great job! |
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.
Fix
messagefield in output by json formatter in case of errorspreventing rule application (e.g. parsing errors).
Previously, a pretty printing method from
Text.Megaparsec.Errorwasused, but this decorated the message with junk characters. The new
errorMessagefunction converts aParseErrorBundleinto a printableStringwithout additional junk, stripping newlines from the end aswell.
fixes: #593
How to verify it
Executing
hadolint -f json Dockerfilefor the following Dockerfile should yield[{"line":1,"code":"DL1000","message":"missing whitespace","column":4,"file":"/home/moritz/tmp/Dockerfile","level":"error"}]: