Apply directives to comment lines.#817
Open
skhal wants to merge 1 commit into
Open
Conversation
Google keep-sorted (https://github.com/google/keep-sorted) helps to keep YAML lines sorted between two marker comments, which is helpful in Ansible playbooks, pre-commit configs, etc.: $ cat -n /tmp/example.yml 1 --- 2 example: 3 # keep-sorted start 4 - name: a 5 - name: c 6 b: bar 7 # keep-sorted end Yamllint reports "rule:comments-indentation" violation on line 7: $ yamllint -v yamllint 1.38.0 $ yamllint /tmp/example.yml /tmp/example.yml 7:3 warning comment not indented like content (comments-indentation) A directive to skip the next line does not work either: $ cat -n /tmp/example_nolint.yml 1 --- 2 example: 3 # keep-sorted start 4 - name: one 5 - name: two 6 b: bar 7 # yamllint disable-line rule:comments-indentation 8 # keep-sorted end $ yamllint /tmp/example_nolint.yml /tmp/example_nolint.yml 7:3 warning comment not indented like content (comments-indentation) Note that the violation is for the directive itself because Yamllint does not apply directives to comments. This change makes Yamllint apply the "next line directive" to comments.
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
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.
Google keep-sorted (https://github.com/google/keep-sorted) helps to keep YAML lines sorted between two marker comments, which is helpful in Ansible playbooks, pre-commit configs, etc.:
Yamllint reports "rule:comments-indentation" violation on line 7:
A directive to skip the next line does not work either:
Note that the violation is for the directive itself because Yamllint does not apply directives to comments.
This change makes Yamllint apply the "next line directive" to comments.