mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-15 01:30:40 +00:00
99 lines
2.8 KiB
Python
99 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 set a maximal number of allowed consecutive blank lines.
|
||
|
|
|
||
|
|
.. rubric:: Options
|
||
|
|
|
||
|
|
* ``max`` defines the maximal number of empty lines allowed in the document.
|
||
|
|
* ``max-start`` defines the maximal number of empty lines allowed at the
|
||
|
|
beginning of the file. This option takes precedence over ``max``.
|
||
|
|
* ``max-end`` defines the maximal number of empty lines allowed at the end of
|
||
|
|
the file. This option takes precedence over ``max``.
|
||
|
|
|
||
|
|
.. rubric:: Examples
|
||
|
|
|
||
|
|
#. With ``empty-lines: {max: 1}``
|
||
|
|
|
||
|
|
the following code snippet would **PASS**:
|
||
|
|
::
|
||
|
|
|
||
|
|
- foo:
|
||
|
|
- 1
|
||
|
|
- 2
|
||
|
|
|
||
|
|
- bar: [3, 4]
|
||
|
|
|
||
|
|
the following code snippet would **FAIL**:
|
||
|
|
::
|
||
|
|
|
||
|
|
- foo:
|
||
|
|
- 1
|
||
|
|
- 2
|
||
|
|
|
||
|
|
|
||
|
|
- bar: [3, 4]
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
from yamllint.linter import LintProblem
|
||
|
|
|
||
|
|
|
||
|
|
ID = 'empty-lines'
|
||
|
|
TYPE = 'line'
|
||
|
|
CONF = {'max': int,
|
||
|
|
'max-start': int,
|
||
|
|
'max-end': int}
|
||
|
|
DEFAULT = {'max': 2,
|
||
|
|
'max-start': 0,
|
||
|
|
'max-end': 0}
|
||
|
|
|
||
|
|
|
||
|
|
def check(conf, line):
|
||
|
|
if line.start == line.end and line.end < len(line.buffer):
|
||
|
|
# Only alert on the last blank line of a series
|
||
|
|
if (line.end < len(line.buffer) - 1 and
|
||
|
|
line.buffer[line.end + 1] == '\n'):
|
||
|
|
return
|
||
|
|
|
||
|
|
blank_lines = 0
|
||
|
|
|
||
|
|
while (line.start > blank_lines and
|
||
|
|
line.buffer[line.start - blank_lines - 1] == '\n'):
|
||
|
|
blank_lines += 1
|
||
|
|
|
||
|
|
max = conf['max']
|
||
|
|
|
||
|
|
# Special case: start of document
|
||
|
|
if line.start - blank_lines == 0:
|
||
|
|
blank_lines += 1 # first line doesn't have a preceding \n
|
||
|
|
max = conf['max-start']
|
||
|
|
|
||
|
|
# Special case: end of document
|
||
|
|
# NOTE: The last line of a file is always supposed to end with a new
|
||
|
|
# line. See POSIX definition of a line at:
|
||
|
|
if line.end == len(line.buffer) - 1 and line.buffer[line.end] == '\n':
|
||
|
|
# Allow the exception of the one-byte file containing '\n'
|
||
|
|
if line.end == 0:
|
||
|
|
return
|
||
|
|
|
||
|
|
max = conf['max-end']
|
||
|
|
|
||
|
|
if blank_lines > max:
|
||
|
|
yield LintProblem(line.line_no, 1, 'too many blank lines (%d > %d)'
|
||
|
|
% (blank_lines, max))
|