snap: detect layouts vs layout in snap.yaml (#5869) #5911
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
* snap: detect layouts vs layout in snap.yaml This patch adds a check for a typo that people can easily make when experimenting with snap layouts. The yaml is defined to use the singular form but there used to be no notification when the plural form was used. Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: fix typo in a typo Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: simplify typo type Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: tweak error wording Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: tweak type documentation Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: tweak error handling Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com> * snap: generalize the typo detector Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
mvo5
approved these changes
Oct 4, 2018
| @@ -116,6 +127,8 @@ type socketsYaml struct { | |||
| // InfoFromSnapYaml creates a new info based on the given snap.yaml data | |||
| func InfoFromSnapYaml(yamlData []byte) (*Info, error) { | |||
| var y snapYaml | |||
| // Customize hints for the typo detector. | |||
| y.TypoLayouts.Hint = `use singular "layout" instead of plural "layouts"` | |||
There was a problem hiding this comment.
I know I'm late to the party and this is just a backport. But it would be great if this hint could be encocded into the struct tag like: TypoLayouts typoDetectoryaml:"layouts,omitempty typo-hints:"..."`. This would mean things are all in the same place. The downside of course is that its no longer i18n able. But at least right now the hint is also not i18n so…
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.
This patch adds a check for a typo that people can easily make when
experimenting with snap layouts. The yaml is defined to use the singular
form but there used to be no notification when the plural form was used.
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com
Signed-off-by: Zygmunt Krynicki zygmunt.krynicki@canonical.com