dbbecb5875
Currently importing yamllint recursively imports its submodules, which finally requires having pyyaml installed. This is a problem when you just want to import APP_VERSION from yamllint. For instance, setup.py imports yamllint to know the version, but doesn't know yet that pyyaml is to be installed, because it is stated in setup.py itself. To solve this, yamllint/__init__.py will only contain constants. The linting functions will be in yamllint/linter.py.
93 lines
2.3 KiB
Python
93 lines
2.3 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 start marker (``---``).
|
|
|
|
.. rubric:: Options
|
|
|
|
* Set ``present`` to ``yes`` when the document start marker is required, or to
|
|
``no`` when it is forbidden.
|
|
|
|
.. rubric:: Examples
|
|
|
|
#. With ``document-start: {present: yes}``
|
|
|
|
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-start: {present: no}``
|
|
|
|
the following code snippet would **PASS**:
|
|
::
|
|
|
|
this:
|
|
is: [a, document]
|
|
...
|
|
|
|
the following code snippet would **FAIL**:
|
|
::
|
|
|
|
---
|
|
this:
|
|
is: [a, document]
|
|
...
|
|
"""
|
|
|
|
|
|
import yaml
|
|
|
|
from yamllint.linter import LintProblem
|
|
|
|
|
|
ID = 'document-start'
|
|
TYPE = 'token'
|
|
CONF = {'present': bool}
|
|
|
|
|
|
def check(conf, token, prev, next, context):
|
|
if conf['present']:
|
|
if (isinstance(prev, (yaml.StreamStartToken,
|
|
yaml.DocumentEndToken,
|
|
yaml.DirectiveToken)) and
|
|
not isinstance(token, (yaml.DocumentStartToken,
|
|
yaml.DirectiveToken,
|
|
yaml.StreamEndToken))):
|
|
yield LintProblem(token.start_mark.line + 1, 1,
|
|
'missing document start "---"')
|
|
|
|
else:
|
|
if isinstance(token, yaml.DocumentStartToken):
|
|
yield LintProblem(token.start_mark.line + 1,
|
|
token.start_mark.column + 1,
|
|
'found forbidden document start "---"')
|