You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
2.8 KiB
Python
88 lines
2.8 KiB
Python
# -*- 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/>.
|
|
|
|
"""
|
|
Use this rule to control the position and formatting of comments.
|
|
|
|
.. rubric:: Options
|
|
|
|
* Use ``require-starting-space`` to require a space character right after the
|
|
``#``. Set to ``yes`` to enable, ``no`` to disable.
|
|
* ``min-spaces-from-content`` is used to visually separate inline comments from
|
|
content. It defines the minimal required number of spaces between a comment
|
|
and its preceding content.
|
|
|
|
.. rubric:: Examples
|
|
|
|
#. With ``comments: {require-starting-space: yes}``
|
|
|
|
the following code snippet would **PASS**:
|
|
::
|
|
|
|
# This sentence
|
|
# is a block comment
|
|
|
|
the following code snippet would **FAIL**:
|
|
::
|
|
|
|
#This sentence
|
|
#is a block comment
|
|
|
|
#. With ``comments: {min-spaces-from-content: 2}``
|
|
|
|
the following code snippet would **PASS**:
|
|
::
|
|
|
|
x = 2 ^ 127 - 1 # Mersenne prime number
|
|
|
|
the following code snippet would **FAIL**:
|
|
::
|
|
|
|
x = 2 ^ 127 - 1 # Mersenne prime number
|
|
"""
|
|
|
|
|
|
import yaml
|
|
|
|
from yamllint.linter import LintProblem
|
|
from yamllint.rules.common import get_comments_between_tokens
|
|
|
|
|
|
ID = 'comments'
|
|
TYPE = 'token'
|
|
CONF = {'require-starting-space': bool,
|
|
'min-spaces-from-content': int}
|
|
|
|
|
|
def check(conf, token, prev, next, nextnext, context):
|
|
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):
|
|
# Sometimes token end marks are on the next line
|
|
if token.end_mark.buffer[token.end_mark.pointer - 1] != '\n':
|
|
if (comment.pointer - token.end_mark.pointer <
|
|
conf['min-spaces-from-content']):
|
|
yield LintProblem(comment.line, comment.column,
|
|
'too few spaces before comment')
|
|
|
|
if (conf['require-starting-space'] and
|
|
comment.pointer + 1 < len(comment.buffer) and
|
|
comment.buffer[comment.pointer + 1] != ' ' and
|
|
comment.buffer[comment.pointer + 1] != '\n'):
|
|
yield LintProblem(comment.line, comment.column + 1,
|
|
'missing starting space in comment')
|