0f073f7a09
Before, it was required to specify all the options when customizing a
rule. For instance, one could use `empty-lines: enable` or `empty-lines:
{max: 1, max-start: 2, max-end: 2}`, but not just `empty-lines: {max:
1}` (it would fail with *invalid config: missing option "max-start" for
rule "empty-lines"*).
This was a minor problem for users, but it prevented the addition of new
options to existing rules, see [1] for an example. If a new option was
added, updating yamllint for all users that customize the rule would
produce a crash (*invalid config: missing option ...*).
To avoid that, let's embed default values inside the rules themselves,
instead of keeping them in `conf/default.yaml`.
This refactor should not have any impact on existing projects. I've
manually checked that it did not change the output of tests, on
different projects:
- ansible/ansible: `test/runner/ansible-test sanity --python 3.7 --test yamllint`
- ansible/molecule: `yamllint -s test/ molecule/`
- Neo23x0/sigma: `make test-yaml`
- markstory/lint-review: `yamllint .`
[1]: https://github.com/adrienverge/yamllint/pull/151
108 lines
2.6 KiB
Python
108 lines
2.6 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 require or forbid the use of document end marker (``...``).
|
|
|
|
.. rubric:: Options
|
|
|
|
* Set ``present`` to ``true`` when the document end marker is required, or to
|
|
``false`` when it is forbidden.
|
|
|
|
.. rubric:: Examples
|
|
|
|
#. With ``document-end: {present: true}``
|
|
|
|
the following code snippet would **PASS**:
|
|
::
|
|
|
|
---
|
|
this:
|
|
is: [a, document]
|
|
...
|
|
---
|
|
- this
|
|
- is: another one
|
|
...
|
|
|
|
the following code snippet would **FAIL**:
|
|
::
|
|
|
|
---
|
|
this:
|
|
is: [a, document]
|
|
---
|
|
- this
|
|
- is: another one
|
|
...
|
|
|
|
#. With ``document-end: {present: false}``
|
|
|
|
the following code snippet would **PASS**:
|
|
::
|
|
|
|
---
|
|
this:
|
|
is: [a, document]
|
|
---
|
|
- this
|
|
- is: another one
|
|
|
|
the following code snippet would **FAIL**:
|
|
::
|
|
|
|
---
|
|
this:
|
|
is: [a, document]
|
|
...
|
|
---
|
|
- this
|
|
- is: another one
|
|
"""
|
|
|
|
|
|
import yaml
|
|
|
|
from yamllint.linter import LintProblem
|
|
|
|
|
|
ID = 'document-end'
|
|
TYPE = 'token'
|
|
CONF = {'present': bool}
|
|
DEFAULT = {'present': True}
|
|
|
|
|
|
def check(conf, token, prev, next, nextnext, context):
|
|
if conf['present']:
|
|
is_stream_end = isinstance(token, yaml.StreamEndToken)
|
|
is_start = isinstance(token, yaml.DocumentStartToken)
|
|
prev_is_end_or_stream_start = isinstance(
|
|
prev, (yaml.DocumentEndToken, yaml.StreamStartToken)
|
|
)
|
|
|
|
if is_stream_end and not prev_is_end_or_stream_start:
|
|
yield LintProblem(token.start_mark.line, 1,
|
|
'missing document end "..."')
|
|
elif is_start and not prev_is_end_or_stream_start:
|
|
yield LintProblem(token.start_mark.line + 1, 1,
|
|
'missing document end "..."')
|
|
|
|
else:
|
|
if isinstance(token, yaml.DocumentEndToken):
|
|
yield LintProblem(token.start_mark.line + 1,
|
|
token.start_mark.column + 1,
|
|
'found forbidden document end "..."')
|