Rules: Add the 'comments-indentation' rule

yamllint/conf/default.yml

@@ -1,8 +1,6 @@
 ---
 
 rules:
-  # block-sequence-indentation:
-  #   present: yes
   braces:
     min-spaces-inside: 0
     max-spaces-inside: 0
@@ -19,6 +17,8 @@ rules:
     level: warning
     require-starting-space: yes
     min-spaces-from-content: 2
+  comments-indentation:
+    level: warning
   document-end: disable
   document-start:
     level: warning
@@ -31,11 +31,12 @@ rules:
     max-spaces-after: 1
   indentation:
     spaces: 2
-    # indent-lists: yes
-    # check-comments: yes
   line-length:
     max: 80
   new-line-at-end-of-file: {level: error}
   new-lines:
     type: unix
+  #sequences-indentation:
+  #  level: warning
+  #  present: yes
   trailing-spaces: {}

yamllint/rules/__init__.py

@@ -20,6 +20,7 @@ from yamllint.rules import (
     colons,
     commas,
     comments,
+    comments_indentation,
     document_end,
     document_start,
     empty_lines,
@@ -37,6 +38,7 @@ _RULES = {
     colons.ID: colons,
     commas.ID: commas,
     comments.ID: comments,
+    comments_indentation.ID: comments_indentation,
     document_end.ID: document_end,
     document_start.ID: document_start,
     empty_lines.ID: empty_lines,

yamllint/rules/comments.py

@@ -14,7 +14,10 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import yaml
+
 from yamllint.errors import LintProblem
+from yamllint.rules.common import get_comments_between_tokens
 
 
 ID = 'comments'
@@ -23,54 +26,10 @@ CONF = {'require-starting-space': bool,
         'min-spaces-from-content': int}
 
 
-class Comment(object):
-    def __init__(self, line, column, buffer, pointer):
-        self.line = line
-        self.column = column
-        self.buffer = buffer
-        self.pointer = pointer
-
-    def __repr__(self):
-        end = self.buffer.find('\n', self.pointer)
-        if end == -1:
-            end = self.buffer.find('\0', self.pointer)
-        if end != -1:
-            return self.buffer[self.pointer:end]
-        return self.buffer[self.pointer:]
-
-    def __eq__(self, other):
-        return (self.line == other.line and
-                self.column == other.column and
-                str(self) == str(other))
-
-
-def get_comments_until_next_token(token, next):
-    if next is None:
-        buf = token.end_mark.buffer[token.end_mark.pointer:]
-    elif token.end_mark.line == next.start_mark.line:
-        return
-    else:
-        buf = token.end_mark.buffer[token.end_mark.pointer:
-                                    next.start_mark.pointer]
-
-    line_no = token.end_mark.line + 1
-    column_no = token.end_mark.column + 1
-    pointer = token.end_mark.pointer
-
-    for line in buf.split('\n'):
-        pos = line.find('#')
-        if pos != -1:
-            yield Comment(line_no, column_no + pos,
-                          token.end_mark.buffer, pointer + pos)
-
-        pointer += len(line) + 1
-        line_no += 1
-        column_no = 1
-
-
 def check(conf, token, prev, next):
-    for comment in get_comments_until_next_token(token, next):
+    for comment in get_comments_between_tokens(token, next):
         if (conf['min-spaces-from-content'] != -1 and
+                not isinstance(token, yaml.StreamStartToken) and
                 comment.line == token.end_mark.line + 1 and
                 comment.pointer - token.end_mark.pointer <
                 conf['min-spaces-from-content']):

yamllint/rules/comments_indentation.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2016 Adrien Vergé
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import yaml
+
+from yamllint.errors import LintProblem
+from yamllint.rules.common import get_comments_between_tokens
+
+
+ID = 'comments-indentation'
+TYPE = 'token'
+
+
+def check(conf, token, prev, next):
+    if prev is None:
+        return
+
+    token_indent = token.start_mark.column
+    if isinstance(token, yaml.StreamEndToken):
+        token_indent = 0
+
+    skip_first = True
+    if isinstance(prev, yaml.StreamStartToken):
+        skip_first = False
+
+    for comment in get_comments_between_tokens(prev, token,
+                                               skip_first_line=skip_first):
+        if comment.column != token_indent + 1:
+            yield LintProblem(comment.line, comment.column,
+                              'comment not intended like content')

yamllint/rules/common.py

@@ -14,6 +14,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import yaml
+
 from yamllint.errors import LintProblem
 
 
@@ -39,3 +41,53 @@ def spaces_before(token, prev, next, min=-1, max=-1,
         elif min != - 1 and spaces < min:
             return LintProblem(token.start_mark.line + 1,
                                token.start_mark.column + 1, min_desc)
+
+
+class Comment(object):
+    def __init__(self, line, column, buffer, pointer):
+        self.line = line
+        self.column = column
+        self.buffer = buffer
+        self.pointer = pointer
+
+    def __repr__(self):
+        end = self.buffer.find('\n', self.pointer)
+        if end == -1:
+            end = self.buffer.find('\0', self.pointer)
+        if end != -1:
+            return self.buffer[self.pointer:end]
+        return self.buffer[self.pointer:]
+
+    def __eq__(self, other):
+        return (self.line == other.line and
+                self.column == other.column and
+                str(self) == str(other))
+
+
+def get_comments_between_tokens(token1, token2, skip_first_line=False):
+    if token2 is None:
+        buf = token1.end_mark.buffer[token1.end_mark.pointer:]
+    elif (token1.end_mark.line == token2.start_mark.line and
+          not isinstance(token1, yaml.StreamStartToken) and
+          not isinstance(token2, yaml.StreamEndToken)):
+        return
+    else:
+        buf = token1.end_mark.buffer[token1.end_mark.pointer:
+                                     token2.start_mark.pointer]
+
+    line_no = token1.end_mark.line + 1
+    column_no = token1.end_mark.column + 1
+    pointer = token1.end_mark.pointer
+
+    for line in buf.split('\n'):
+        if skip_first_line:
+            skip_first_line = False
+        else:
+            pos = line.find('#')
+            if pos != -1:
+                yield Comment(line_no, column_no + pos,
+                              token1.end_mark.buffer, pointer + pos)
+
+        pointer += len(line) + 1
+        line_no += 1
+        column_no = 1