Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1f1757ced4 | ||
|
|
59d5bffbec | ||
|
|
53da21934d | ||
|
|
0c36d0175c | ||
|
|
20545febe5 | ||
|
|
88ebcbbb93 | ||
|
|
08615ec4f8 | ||
|
|
29aceb430a | ||
|
|
159e29ea6a | ||
|
|
f9198b7a9b | ||
|
|
44236077dd | ||
|
|
76f47e91ca | ||
|
|
f98bed1085 | ||
|
|
a483524b63 | ||
|
|
3a017a5a22 | ||
|
|
bab8137e2b | ||
|
|
41733fc7a5 | ||
|
|
688858e639 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
__pycache__
|
||||
*.py[cod]
|
||||
/docs/_build
|
||||
/dist
|
||||
/yamllint.egg-info
|
||||
|
||||
@@ -11,7 +11,7 @@ install:
|
||||
- pip install .
|
||||
script:
|
||||
- flake8 .
|
||||
- yamllint $(git ls-files '*.yml')
|
||||
- yamllint $(git ls-files '*.yaml' '*.yml')
|
||||
- coverage run --source=yamllint setup.py test
|
||||
after_success:
|
||||
coveralls
|
||||
|
||||
25
README.rst
25
README.rst
@@ -38,6 +38,27 @@ Screenshot
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
On Fedora / CentOS:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo dnf install yamllint
|
||||
|
||||
On Debian 9+ / Ubuntu 16.04+:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo apt-get install yamllint
|
||||
|
||||
On older Debian / Ubuntu versions:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
|
||||
sudo apt-get install yamllint
|
||||
|
||||
Alternatively using pip, the Python package manager:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo pip install yamllint
|
||||
@@ -58,7 +79,7 @@ Usage
|
||||
.. code:: bash
|
||||
|
||||
# Use a pre-defined lint configuration
|
||||
yamllint -d relaxed file.yml
|
||||
yamllint -d relaxed file.yaml
|
||||
|
||||
# Use a custom lint configuration
|
||||
yamllint -c ~/myconfig file.yml
|
||||
@@ -66,7 +87,7 @@ Usage
|
||||
.. code:: bash
|
||||
|
||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||
yamllint -f parsable file.yml
|
||||
yamllint -f parsable file.yaml
|
||||
|
||||
Configuration example
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -10,14 +10,14 @@ directory, or use the ``-c`` option:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -c ~/myconfig file.yml
|
||||
yamllint -c ~/myconfig file.yaml
|
||||
|
||||
Default configuration
|
||||
---------------------
|
||||
|
||||
Unless told otherwise, yamllint uses its ``default`` configuration:
|
||||
|
||||
.. literalinclude:: ../yamllint/conf/default.yml
|
||||
.. literalinclude:: ../yamllint/conf/default.yaml
|
||||
:language: yaml
|
||||
|
||||
Details on rules can be found on :doc:`the rules page <rules>`.
|
||||
@@ -85,7 +85,7 @@ For instance:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
yamllint -d "{extends: relaxed, rules: {line-length: {max: 120}}}" file.yml
|
||||
yamllint -d "{extends: relaxed, rules: {line-length: {max: 120}}}" file.yaml
|
||||
|
||||
Errors and warnings
|
||||
-------------------
|
||||
|
||||
@@ -4,16 +4,34 @@ Quickstart
|
||||
Installing yamllint
|
||||
-------------------
|
||||
|
||||
First, install yamllint. The easiest way is to use pip, the Python package
|
||||
manager:
|
||||
On Fedora / CentOS:
|
||||
|
||||
::
|
||||
.. code:: bash
|
||||
|
||||
sudo dnf install yamllint
|
||||
|
||||
On Debian 9+ / Ubuntu 16.04+:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo apt-get install yamllint
|
||||
|
||||
On older Debian / Ubuntu versions:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
|
||||
sudo apt-get install yamllint
|
||||
|
||||
Alternatively using pip, the Python package manager:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo pip install yamllint
|
||||
|
||||
If you prefer installing from source, you can run, from the source directory:
|
||||
|
||||
::
|
||||
.. code:: bash
|
||||
|
||||
python setup.py sdist
|
||||
sudo pip install dist/yamllint-*.tar.gz
|
||||
@@ -23,13 +41,13 @@ Running yamllint
|
||||
|
||||
Basic usage:
|
||||
|
||||
::
|
||||
.. code:: bash
|
||||
|
||||
yamllint file.yml other-file.yaml
|
||||
|
||||
You can also lint all YAML files in a whole directory:
|
||||
|
||||
::
|
||||
.. code:: bash
|
||||
|
||||
yamllint .
|
||||
|
||||
@@ -65,9 +83,9 @@ If you have a custom linting configuration file (see :doc:`how to configure
|
||||
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
|
||||
option:
|
||||
|
||||
::
|
||||
.. code:: bash
|
||||
|
||||
yamllint -c ~/myconfig file.yml
|
||||
yamllint -c ~/myconfig file.yaml
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -20,16 +20,8 @@ Neovim
|
||||
------
|
||||
|
||||
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
||||
installed, add to your ``.config/nvim/init.vim``:
|
||||
|
||||
::
|
||||
|
||||
if executable('yamllint')
|
||||
let g:neomake_yaml_yamllint_maker = {
|
||||
\ 'args': ['-f', 'parsable'],
|
||||
\ 'errorformat': '%E%f:%l:%c: [error] %m,%W%f:%l:%c: [warning] %m' }
|
||||
let g:neomake_yaml_enabled_makers = ['yamllint']
|
||||
endif
|
||||
installed, yamllint is supported by default. It is automatically enabled when
|
||||
editing YAML files.
|
||||
|
||||
Other text editors
|
||||
------------------
|
||||
|
||||
2
setup.py
2
setup.py
@@ -44,7 +44,7 @@ setup(
|
||||
|
||||
packages=find_packages(),
|
||||
entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
|
||||
package_data={'yamllint': ['conf/*.yml'],
|
||||
package_data={'yamllint': ['conf/*.yaml'],
|
||||
'tests': ['yaml-1.2-spec-examples/*']},
|
||||
install_requires=['pyyaml'],
|
||||
tests_require=['nose'],
|
||||
|
||||
@@ -381,6 +381,141 @@ class IndentationStackTestCase(RuleTestCase):
|
||||
# missing BEnd here
|
||||
' BEnd \n')
|
||||
|
||||
def test_flows_imbrication(self):
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('[[val]]\n'),
|
||||
'FSeqStart F_SEQ:1\n'
|
||||
'FSeqStart F_SEQ:1 F_SEQ:2\n'
|
||||
' Scalar F_SEQ:1 F_SEQ:2\n'
|
||||
' FSeqEnd F_SEQ:1\n'
|
||||
' FSeqEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('[[val], [val2]]\n'),
|
||||
'FSeqStart F_SEQ:1\n'
|
||||
'FSeqStart F_SEQ:1 F_SEQ:2\n'
|
||||
' Scalar F_SEQ:1 F_SEQ:2\n'
|
||||
' FSeqEnd F_SEQ:1\n'
|
||||
' FEntry F_SEQ:1\n'
|
||||
'FSeqStart F_SEQ:1 F_SEQ:9\n'
|
||||
' Scalar F_SEQ:1 F_SEQ:9\n'
|
||||
' FSeqEnd F_SEQ:1\n'
|
||||
' FSeqEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{{key}}\n'),
|
||||
'FMapStart F_MAP:1\n'
|
||||
'FMapStart F_MAP:1 F_MAP:2\n'
|
||||
' Scalar F_MAP:1 F_MAP:2\n'
|
||||
' FMapEnd F_MAP:1\n'
|
||||
' FMapEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('[key]: value\n'),
|
||||
'BMapStart B_MAP:0\n'
|
||||
' Key B_MAP:0 KEY:0\n'
|
||||
'FSeqStart B_MAP:0 KEY:0 F_SEQ:1\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_SEQ:1\n'
|
||||
' FSeqEnd B_MAP:0 KEY:0\n'
|
||||
' Value B_MAP:0 KEY:0 VAL:7\n'
|
||||
' Scalar B_MAP:0\n'
|
||||
' BEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('[[key]]: value\n'),
|
||||
'BMapStart B_MAP:0\n'
|
||||
' Key B_MAP:0 KEY:0\n'
|
||||
'FSeqStart B_MAP:0 KEY:0 F_SEQ:1\n'
|
||||
'FSeqStart B_MAP:0 KEY:0 F_SEQ:1 F_SEQ:2\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_SEQ:1 F_SEQ:2\n'
|
||||
' FSeqEnd B_MAP:0 KEY:0 F_SEQ:1\n'
|
||||
' FSeqEnd B_MAP:0 KEY:0\n'
|
||||
' Value B_MAP:0 KEY:0 VAL:9\n'
|
||||
' Scalar B_MAP:0\n'
|
||||
' BEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{key}: value\n'),
|
||||
'BMapStart B_MAP:0\n'
|
||||
' Key B_MAP:0 KEY:0\n'
|
||||
'FMapStart B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
' FMapEnd B_MAP:0 KEY:0\n'
|
||||
' Value B_MAP:0 KEY:0 VAL:7\n'
|
||||
' Scalar B_MAP:0\n'
|
||||
' BEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{key: value}: value\n'),
|
||||
'BMapStart B_MAP:0\n'
|
||||
' Key B_MAP:0 KEY:0\n'
|
||||
'FMapStart B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
' Key B_MAP:0 KEY:0 F_MAP:1 KEY:1\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_MAP:1 KEY:1\n'
|
||||
' Value B_MAP:0 KEY:0 F_MAP:1 KEY:1 VAL:6\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
' FMapEnd B_MAP:0 KEY:0\n'
|
||||
' Value B_MAP:0 KEY:0 VAL:14\n'
|
||||
' Scalar B_MAP:0\n'
|
||||
' BEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{{key}}: value\n'),
|
||||
'BMapStart B_MAP:0\n'
|
||||
' Key B_MAP:0 KEY:0\n'
|
||||
'FMapStart B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
'FMapStart B_MAP:0 KEY:0 F_MAP:1 F_MAP:2\n'
|
||||
' Scalar B_MAP:0 KEY:0 F_MAP:1 F_MAP:2\n'
|
||||
' FMapEnd B_MAP:0 KEY:0 F_MAP:1\n'
|
||||
' FMapEnd B_MAP:0 KEY:0\n'
|
||||
' Value B_MAP:0 KEY:0 VAL:9\n'
|
||||
' Scalar B_MAP:0\n'
|
||||
' BEnd \n')
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{{key}: val, {key2}: {val2}}\n'),
|
||||
'FMapStart F_MAP:1\n'
|
||||
' Key F_MAP:1 KEY:1\n'
|
||||
'FMapStart F_MAP:1 KEY:1 F_MAP:2\n'
|
||||
' Scalar F_MAP:1 KEY:1 F_MAP:2\n'
|
||||
' FMapEnd F_MAP:1 KEY:1\n'
|
||||
' Value F_MAP:1 KEY:1 VAL:8\n'
|
||||
' Scalar F_MAP:1\n'
|
||||
' FEntry F_MAP:1\n'
|
||||
' Key F_MAP:1 KEY:1\n'
|
||||
'FMapStart F_MAP:1 KEY:1 F_MAP:14\n'
|
||||
' Scalar F_MAP:1 KEY:1 F_MAP:14\n'
|
||||
' FMapEnd F_MAP:1 KEY:1\n'
|
||||
' Value F_MAP:1 KEY:1 VAL:21\n'
|
||||
'FMapStart F_MAP:1 KEY:1 VAL:21 F_MAP:22\n'
|
||||
' Scalar F_MAP:1 KEY:1 VAL:21 F_MAP:22\n'
|
||||
' FMapEnd F_MAP:1\n'
|
||||
' FMapEnd \n')
|
||||
|
||||
self.assertMultiLineEqual(
|
||||
self.full_stack('{[{{[val]}}, [{[key]: val2}]]}\n'),
|
||||
'FMapStart F_MAP:1\n'
|
||||
'FSeqStart F_MAP:1 F_SEQ:2\n'
|
||||
'FMapStart F_MAP:1 F_SEQ:2 F_MAP:3\n'
|
||||
'FMapStart F_MAP:1 F_SEQ:2 F_MAP:3 F_MAP:4\n'
|
||||
'FSeqStart F_MAP:1 F_SEQ:2 F_MAP:3 F_MAP:4 F_SEQ:5\n'
|
||||
' Scalar F_MAP:1 F_SEQ:2 F_MAP:3 F_MAP:4 F_SEQ:5\n'
|
||||
' FSeqEnd F_MAP:1 F_SEQ:2 F_MAP:3 F_MAP:4\n'
|
||||
' FMapEnd F_MAP:1 F_SEQ:2 F_MAP:3\n'
|
||||
' FMapEnd F_MAP:1 F_SEQ:2\n'
|
||||
' FEntry F_MAP:1 F_SEQ:2\n'
|
||||
'FSeqStart F_MAP:1 F_SEQ:2 F_SEQ:14\n'
|
||||
'FMapStart F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15\n'
|
||||
' Key F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15 KEY:15\n'
|
||||
'FSeqStart F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15 KEY:15 F_SEQ:16\n'
|
||||
' Scalar F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15 KEY:15 F_SEQ:16\n'
|
||||
' FSeqEnd F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15 KEY:15\n'
|
||||
' Value F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15 KEY:15 VAL:22\n'
|
||||
' Scalar F_MAP:1 F_SEQ:2 F_SEQ:14 F_MAP:15\n'
|
||||
' FMapEnd F_MAP:1 F_SEQ:2 F_SEQ:14\n'
|
||||
' FSeqEnd F_MAP:1 F_SEQ:2\n'
|
||||
' FSeqEnd F_MAP:1\n'
|
||||
' FMapEnd \n')
|
||||
|
||||
|
||||
class IndentationTestCase(RuleTestCase):
|
||||
rule_id = 'indentation'
|
||||
@@ -1098,12 +1233,46 @@ class IndentationTestCase(RuleTestCase):
|
||||
|
||||
def test_explicit_block_mappings(self):
|
||||
conf = 'indentation: {spaces: consistent}'
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ? key\n'
|
||||
' : value\n', conf)
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ? key\n'
|
||||
' :\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ?\n'
|
||||
' key\n'
|
||||
' : value\n', conf)
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ?\n'
|
||||
' key\n'
|
||||
' :\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'- ? key\n'
|
||||
' : value\n', conf)
|
||||
self.check('---\n'
|
||||
'- ? key\n'
|
||||
' :\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'- ?\n'
|
||||
' key\n'
|
||||
' : value\n', conf)
|
||||
self.check('---\n'
|
||||
'- ?\n'
|
||||
' key\n'
|
||||
' :\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ? key\n'
|
||||
@@ -1111,12 +1280,11 @@ class IndentationTestCase(RuleTestCase):
|
||||
' value\n'
|
||||
'...\n', conf, problem=(5, 8))
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ?\n'
|
||||
' key\n'
|
||||
'- - ?\n'
|
||||
' key\n'
|
||||
' :\n'
|
||||
' value\n'
|
||||
'...\n', conf)
|
||||
' value\n'
|
||||
'...\n', conf, problem=(5, 7))
|
||||
self.check('---\n'
|
||||
'object:\n'
|
||||
' ?\n'
|
||||
@@ -1288,6 +1456,48 @@ class IndentationTestCase(RuleTestCase):
|
||||
'- Clark Evans\n'
|
||||
'- Ingy döt Net\n', conf)
|
||||
|
||||
def test_flows_imbrication(self):
|
||||
conf = 'indentation: {spaces: consistent}'
|
||||
self.check('---\n'
|
||||
'[val]: value\n', conf)
|
||||
self.check('---\n'
|
||||
'{key}: value\n', conf)
|
||||
self.check('---\n'
|
||||
'{key: val}: value\n', conf)
|
||||
self.check('---\n'
|
||||
'[[val]]: value\n', conf)
|
||||
self.check('---\n'
|
||||
'{{key}}: value\n', conf)
|
||||
self.check('---\n'
|
||||
'{{key: val1}: val2}: value\n', conf)
|
||||
self.check('---\n'
|
||||
'- [val, {{key: val}: val}]: value\n'
|
||||
'- {[val,\n'
|
||||
' {{key: val}: val}]}\n'
|
||||
'- {[val,\n'
|
||||
' {{key: val,\n'
|
||||
' key2}}]}\n'
|
||||
'- {{{{{moustaches}}}}}\n'
|
||||
'- {{{{{moustache,\n'
|
||||
' moustache},\n'
|
||||
' moustache}},\n'
|
||||
' moustache}}\n', conf)
|
||||
self.check('---\n'
|
||||
'- {[val,\n'
|
||||
' {{key: val}: val}]}\n',
|
||||
conf, problem=(3, 6))
|
||||
self.check('---\n'
|
||||
'- {[val,\n'
|
||||
' {{key: val,\n'
|
||||
' key2}}]}\n',
|
||||
conf, problem=(4, 6))
|
||||
self.check('---\n'
|
||||
'- {{{{{moustache,\n'
|
||||
' moustache},\n'
|
||||
' moustache}},\n'
|
||||
' moustache}}\n',
|
||||
conf, problem1=(4, 8), problem2=(5, 4))
|
||||
|
||||
|
||||
class ScalarIndentationTestCase(RuleTestCase):
|
||||
rule_id = 'indentation'
|
||||
|
||||
256
tests/test_cli.py
Normal file
256
tests/test_cli.py
Normal file
@@ -0,0 +1,256 @@
|
||||
# -*- 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/>.
|
||||
|
||||
try:
|
||||
from cStringIO import StringIO
|
||||
except ImportError:
|
||||
from io import StringIO
|
||||
import os
|
||||
import shutil
|
||||
import tempfile
|
||||
import unittest
|
||||
import sys
|
||||
|
||||
from yamllint import cli
|
||||
|
||||
|
||||
class CommandLineTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.wd = tempfile.mkdtemp(prefix='yamllint-tests-')
|
||||
|
||||
# .yaml file at root
|
||||
with open(os.path.join(self.wd, 'a.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'- 1 \n'
|
||||
'- 2')
|
||||
|
||||
# .yml file at root
|
||||
open(os.path.join(self.wd, 'empty.yml'), 'w').close()
|
||||
|
||||
# file in dir
|
||||
os.mkdir(os.path.join(self.wd, 'sub'))
|
||||
with open(os.path.join(self.wd, 'sub', 'ok.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n')
|
||||
|
||||
# file in very nested dir
|
||||
dir = self.wd
|
||||
for i in range(15):
|
||||
dir = os.path.join(dir, 's')
|
||||
os.mkdir(dir)
|
||||
with open(os.path.join(dir, 'file.yaml'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n'
|
||||
'key: other value\n')
|
||||
|
||||
# empty dir
|
||||
os.mkdir(os.path.join(self.wd, 'empty-dir'))
|
||||
|
||||
# non-YAML file
|
||||
with open(os.path.join(self.wd, 'no-yaml.json'), 'w') as f:
|
||||
f.write('---\n'
|
||||
'key: value\n')
|
||||
|
||||
def tearDown(self):
|
||||
shutil.rmtree(self.wd)
|
||||
|
||||
def test_find_files_recursively(self):
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively([self.wd])),
|
||||
[os.path.join(self.wd, 'a.yaml'),
|
||||
os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'),
|
||||
os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'sub/ok.yaml'),
|
||||
os.path.join(self.wd, 'empty-dir')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml')],
|
||||
)
|
||||
|
||||
items = [os.path.join(self.wd, 'sub'),
|
||||
os.path.join(self.wd, '/etc/another/file')]
|
||||
self.assertEqual(
|
||||
sorted(cli.find_files_recursively(items)),
|
||||
[os.path.join(self.wd, '/etc/another/file'),
|
||||
os.path.join(self.wd, 'sub/ok.yaml')],
|
||||
)
|
||||
|
||||
def test_run_with_bad_arguments(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(())
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^usage')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('--unknown-arg', ))
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^usage')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-c', './conf.yaml', '-d', 'relaxed', 'file'))
|
||||
|
||||
self.assertNotEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^Options --config-file and '
|
||||
r'--config-data cannot be used')
|
||||
|
||||
def test_run_with_bad_config(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-d', 'rules: {a: b}', 'file'))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^invalid config: no such rule')
|
||||
|
||||
def test_run_with_empty_config(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-d', '', 'file'))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'^invalid config: not a dict')
|
||||
|
||||
def test_run_version(self):
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('--version', ))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertRegexpMatches(out + err, r'yamllint \d+\.\d+')
|
||||
|
||||
def test_run_non_existing_file(self):
|
||||
file = os.path.join(self.wd, 'i-do-not-exist.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, -1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertRegexpMatches(err, r'No such file or directory')
|
||||
|
||||
def test_run_one_problem_file(self):
|
||||
file = os.path.join(self.wd, 'a.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'%s:2:4: [error] trailing spaces (trailing-spaces)\n'
|
||||
'%s:3:4: [error] no new line character at the end of file '
|
||||
'(new-line-at-end-of-file)\n') % (file, file))
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_one_ok_file(self):
|
||||
file = os.path.join(self.wd, 'sub', 'ok.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_empty_file(self):
|
||||
file = os.path.join(self.wd, 'empty.yml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(('-f', 'parsable', file))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 0)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, '')
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_multiple_files(self):
|
||||
items = [os.path.join(self.wd, 'empty.yml'),
|
||||
os.path.join(self.wd, 's')]
|
||||
file = items[1] + '/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run(['-f', 'parsable'] + items)
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'%s:3:1: [error] duplication of key "key" in mapping '
|
||||
'(key-duplicates)\n') % file)
|
||||
self.assertEqual(err, '')
|
||||
|
||||
def test_run_colored_output(self):
|
||||
file = os.path.join(self.wd, 'a.yaml')
|
||||
|
||||
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||
with self.assertRaises(SystemExit) as ctx:
|
||||
cli.run((file, ))
|
||||
|
||||
self.assertEqual(ctx.exception.code, 1)
|
||||
|
||||
out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
|
||||
self.assertEqual(out, (
|
||||
'\033[4m%s\033[0m\n'
|
||||
' \033[2m2:4\033[0m \033[31merror\033[0m '
|
||||
'trailing spaces \033[2m(trailing-spaces)\033[0m\n'
|
||||
' \033[2m3:4\033[0m \033[31merror\033[0m '
|
||||
'no new line character at the end of file '
|
||||
'\033[2m(new-line-at-end-of-file)\033[0m\n'
|
||||
'\n' % file))
|
||||
self.assertEqual(err, '')
|
||||
@@ -32,6 +32,10 @@ class SimpleConfigTestCase(unittest.TestCase):
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 1)
|
||||
|
||||
def test_invalid_conf(self):
|
||||
with self.assertRaises(config.YamlLintConfigError):
|
||||
config.YamlLintConfig('not: valid: yaml')
|
||||
|
||||
def test_unknown_rule(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
|
||||
@@ -22,7 +22,7 @@ indentation, etc."""
|
||||
|
||||
|
||||
APP_NAME = 'yamllint'
|
||||
APP_VERSION = '1.2.0'
|
||||
APP_VERSION = '1.2.1'
|
||||
APP_DESCRIPTION = __doc__
|
||||
|
||||
__author__ = u'Adrien Vergé'
|
||||
|
||||
@@ -88,7 +88,7 @@ def run(argv=None):
|
||||
|
||||
try:
|
||||
if args.config_data is not None:
|
||||
if ':' not in args.config_data:
|
||||
if args.config_data != '' and ':' not in args.config_data:
|
||||
args.config_data = 'extends: ' + args.config_data
|
||||
conf = YamlLintConfig(content=args.config_data)
|
||||
elif args.config_file is not None:
|
||||
@@ -123,7 +123,7 @@ def run(argv=None):
|
||||
if not first and args.format != 'parsable':
|
||||
print('')
|
||||
except EnvironmentError as e:
|
||||
print(e)
|
||||
print(e, file=sys.stderr)
|
||||
return_code = -1
|
||||
|
||||
sys.exit(return_code)
|
||||
|
||||
@@ -59,6 +59,9 @@ class YamlLintConfig(object):
|
||||
except Exception as e:
|
||||
raise YamlLintConfigError('invalid config: %s' % e)
|
||||
|
||||
if type(conf) != dict:
|
||||
raise YamlLintConfigError('invalid config: not a dict')
|
||||
|
||||
self.rules = conf.get('rules', {})
|
||||
|
||||
# Does this conf override another conf that we need to load?
|
||||
@@ -129,7 +132,7 @@ def get_extended_config_file(name):
|
||||
# Is it a standard conf shipped with yamllint...
|
||||
if '/' not in name:
|
||||
std_conf = os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
||||
'conf', name + '.yml')
|
||||
'conf', name + '.yaml')
|
||||
|
||||
if os.path.isfile(std_conf):
|
||||
return std_conf
|
||||
|
||||
@@ -233,7 +233,7 @@ def check_scalar_indentation(conf, token, context):
|
||||
elif token.style in ('"', "'"):
|
||||
return token.start_mark.column + 1
|
||||
elif token.style in ('>', '|'):
|
||||
if context['stack'][-1].type == B_SEQ:
|
||||
if context['stack'][-1].type == B_ENT:
|
||||
# - >
|
||||
# multi
|
||||
# line
|
||||
@@ -295,7 +295,7 @@ def check_scalar_indentation(conf, token, context):
|
||||
(expected_indent, indent))
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
def _check(conf, token, prev, next, nextnext, context):
|
||||
if 'stack' not in context:
|
||||
context['stack'] = [Parent(ROOT, 0)]
|
||||
context['cur_line'] = -1
|
||||
@@ -348,19 +348,18 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
# Step 2.b: Update state
|
||||
|
||||
if isinstance(token, yaml.BlockMappingStartToken):
|
||||
# - a: 1
|
||||
# or
|
||||
# - ? a
|
||||
# : 1
|
||||
# or
|
||||
# - ?
|
||||
# a
|
||||
# : 1
|
||||
assert isinstance(next, yaml.KeyToken)
|
||||
if next.start_mark.line == token.start_mark.line:
|
||||
# - a: 1
|
||||
# b: 2
|
||||
# or
|
||||
# - ? a
|
||||
# : 1
|
||||
indent = token.start_mark.column
|
||||
else:
|
||||
# - ?
|
||||
# a
|
||||
# : 1
|
||||
indent = detect_indent(token.start_mark.column, next)
|
||||
assert next.start_mark.line == token.start_mark.line
|
||||
|
||||
indent = token.start_mark.column
|
||||
|
||||
context['stack'].append(Parent(B_MAP, indent))
|
||||
|
||||
@@ -380,8 +379,8 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
elif isinstance(token, yaml.BlockSequenceStartToken):
|
||||
# - - a
|
||||
# - b
|
||||
assert next.start_mark.line == token.start_mark.line
|
||||
assert isinstance(next, yaml.BlockEntryToken)
|
||||
assert next.start_mark.line == token.start_mark.line
|
||||
|
||||
indent = token.start_mark.column
|
||||
|
||||
@@ -497,12 +496,16 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
consumed_current_token = False
|
||||
while True:
|
||||
if (context['stack'][-1].type == F_SEQ and
|
||||
isinstance(token, yaml.FlowSequenceEndToken)):
|
||||
isinstance(token, yaml.FlowSequenceEndToken) and
|
||||
not consumed_current_token):
|
||||
context['stack'].pop()
|
||||
consumed_current_token = True
|
||||
|
||||
elif (context['stack'][-1].type == F_MAP and
|
||||
isinstance(token, yaml.FlowMappingEndToken)):
|
||||
isinstance(token, yaml.FlowMappingEndToken) and
|
||||
not consumed_current_token):
|
||||
context['stack'].pop()
|
||||
consumed_current_token = True
|
||||
|
||||
elif (context['stack'][-1].type in (B_MAP, B_SEQ) and
|
||||
isinstance(token, yaml.BlockEndToken) and
|
||||
@@ -541,3 +544,13 @@ def check(conf, token, prev, next, nextnext, context):
|
||||
|
||||
else:
|
||||
break
|
||||
|
||||
|
||||
def check(conf, token, prev, next, nextnext, context):
|
||||
try:
|
||||
for problem in _check(conf, token, prev, next, nextnext, context):
|
||||
yield problem
|
||||
except AssertionError:
|
||||
yield LintProblem(token.start_mark.line + 1,
|
||||
token.start_mark.column + 1,
|
||||
'cannot infer indentation: unexpected token')
|
||||
|
||||
Reference in New Issue
Block a user