linter: lint rule for using the legacy key/value format with whitespace #4923
+143
−78
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
jsternberg
force-pushed
the
lint-legacy-key-value-env
branch
4 times, most recently
from
18a8384
to
6be16d1
Compare
daghack
approved these changes
May 15, 2024
thaJeztah
reviewed
May 16, 2024
Comment on lines
+634
to
+636
| FROM scratch | ||
| ENV key value | ||
| LABEL key value |
There was a problem hiding this comment.
I know there were some concerns about warning about these being potentially too strict.
Wondering if we should have a "more permissive" and "more strict" rule. The most problematic ones are when multiple whitespaces are present;
ARG key one two
ENV key one twoThose look very much alike, but ARG means 3 args are defined, but the ENV one defines a single key env with value one two
thaJeztah
approved these changes
May 16, 2024
tonistiigi
reviewed
May 29, 2024
| @@ -105,4 +105,11 @@ var ( | |||
| return fmt.Sprintf("Multiple %s instructions should not be used in the same stage because only the last one will be used", instructionName) | |||
| }, | |||
| } | |||
| RuleLegacyKeyValueFormat = LinterRule[func(cmdName string) string]{ | |||
There was a problem hiding this comment.
We should provide some hint that key=value should be used instead in the message. Most users will not know what is "legacy format"
There was a problem hiding this comment.
Changed this message to read differently so now it explicitly mentions the solution in the detailed description.
jsternberg
force-pushed
the
lint-legacy-key-value-env
branch
from
6be16d1
to
d312e96
Compare
The `ENV` and `LABEL` commands both support using either a whitespace delimited token or one delimited with the equals token. The equals token is preferred because it is more explicit and less ambiguous than using whitespace. The linter rule emits a warning when it sees the whitespace separator used. To facilitate this, the parser was modified to include the separator as a node in the tree. The associated parsing code has also been changed for 3 arguments instead of only 2 per key/value pair. Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
jsternberg
force-pushed
the
lint-legacy-key-value-env
branch
from
d312e96
to
6cfa459
Compare
tonistiigi
approved these changes
May 30, 2024
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.
The
ENVandLABELcommands both support using either a whitespace delimited token or one delimited with the equals token. The equals token is preferred because it is more explicit and less ambiguous than using whitespace. The linter rule emits a warning when it sees the whitespace separator used.To facilitate this, the parser was modified to include the separator as a node in the tree. The associated parsing code has also been changed for 3 arguments instead of only 2 per key/value pair.