Pragma: Allow comments following inline#1059
Merged
lorenzo merged 1 commit intohadolint:masterfrom Mar 5, 2025
Merged
Conversation
Allow comments and whitespace to follow inline with pragma comments, e.g.: ``` # hadolint ignore=DL3006 # comment on why to ignore this rule here # hadolint shell=powershell ``` Modify the parsers for pragma comments to ignore both: 1) just whitespaces following the inline comment. 2) whitespaces followed by `#`, and anything after until end of line. This improves robustness of the parser and allows users to add helpful comments to their pragmas. Note that not separating comment from pragma with an additional `#` will result in a silent failure to parse and the pragma will have no effect. fixes: hadolint#997 fixes: hadolint#1028 Signed-off-by: Moritz Röhrich <moritz@ildefons.de>
|
👀 @lorenzo Any way to push this forward? |
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
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.
Allow comments and whitespace to follow inline with pragma comments, e.g.:
Modify the parsers for pragma comments to ignore both:
#, and anything after until end of line.This improves robustness of the parser and allows users to add helpful comments to their pragmas.
Note that not separating comment from pragma with an additional
#will result in a silent failure to parse and the pragma will have no effect.fixes: #997
fixes: #1028
How to verify it
These two lines should be two working pragmas, instructing Hadolint to ignore DL3006 on the next Docker instruction and hinting that the shell used in the base image is Powershell (i.e. don't apply rules that are specific to POSIX-like shells).
Test cases are also included in this PR