You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As we know, yamllint is integrated with ansible-lint and we run it on all yaml files. Still, we failed to document the fact that users can make use of official yamllint magic noqa comments for disabling these rules.
In order to avoid confusions and eventually conflicts from other tools/editors/IDEs that might also run yamllint themselves, it would make sense only support yamllint official comments for YAML rule, as they are originating from yamllint only.
Proposed yamllint only comment for yaml rule
# yamllint disable-line rule:line-lengthfoo: this is a very long line
YAMLLINT own comments are more powerful than our own # noqa comments, which are already known to not work well for some of rule violations reported by yamllint itself. If we stop supporting our own # noqa yaml[.*] and recommend use of yamllint ones, we might provide a much consistent user experience.
What do you think?
Should we only advertise use of yamllint noqa comments for yaml violations?
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
As we know,
yamllint
is integrated with ansible-lint and we run it on all yaml files. Still, we failed to document the fact that users can make use of official yamllint magic noqa comments for disabling these rules.https://ansible-lint.readthedocs.io/rules/yaml/ does not mention yamllint comments.
In order to avoid confusions and eventually conflicts from other tools/editors/IDEs that might also run yamllint themselves, it would make sense only support yamllint official comments for YAML rule, as they are originating from yamllint only.
Proposed yamllint only comment for yaml rule
YAMLLINT own comments are more powerful than our own
# noqa
comments, which are already known to not work well for some of rule violations reported by yamllint itself. If we stop supporting our own# noqa yaml[.*]
and recommend use of yamllint ones, we might provide a much consistent user experience.What do you think?
21 votes ·
Beta Was this translation helpful? Give feedback.
All reactions