Extend yamllint hook
#398
Merged
Extend yamllint hook
#398
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
totoroot
force-pushed
the
extend-yamllint-hook
branch
from
eb418b0 to
206bc45
Compare
|
Sorry for the mess, we revamed module structure in #397, could you port these changes over? |
totoroot
force-pushed
the
extend-yamllint-hook
branch
3 times, most recently
from
d4a9d76 to
20fbe2c
Compare
domenkozar
reviewed
Mar 19, 2024
|
error: evaluation aborted with the following error message: 'cannot find attribute `hooks.yamllint.settings.relaxed'' |
|
@domenkozar I believe I fixed all warnings and rebased onto master again. Ready for review/merge. |
totoroot
force-pushed
the
extend-yamllint-hook
branch
from
2602c35 to
bf4ca5f
Compare
totoroot
force-pushed
the
extend-yamllint-hook
branch
from
bf4ca5f to
34fdf24
Compare
|
Ci is failing |
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.
I added a couple of options to the
yamllinthook, as so far it was only possible to pass a path to the configuration file.In some comments, I also reasoned why some options weren't added as they do not make sense for a pre-commit hook.
Similar to how I did it for the
typoshook, there is now also an option to pass a multiline string as configuration toyamllint. Additionallyyamllintallows for a serialized configuration, but the multiline string configuration option is the preferred way. Of course just providing a path to a configuration file remains possible.The behaviour of the hook itself mostly stayed the same, although the
relaxedoption was removed in favour of a more generalizedpresetoption, that allows us to easily add presets, should more ever be added toyamllint.A pre-commit hook only makes sense, if it prevents you from committing if errors were found, so
--strictshould definitely be the default.Breaking changes:
settings.yamllint.relaxed = true;is nowsettings.yamllint.preset = "relaxed";settings.yamllint.strictwas added and defaults totrue➡️ strict error checking for hookAdditional changes:
For some hooks I recently worked on, I noticed that I was shadowing the top-level attribute
config, which is never a good idea, so I changed the multiline configuration options toconfiguration.Affected hooks are
typosandvale. The options were only added recently.