Compare commits
26 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8e6e851c5b | ||
|
|
edd4cca02f | ||
|
|
867970258e | ||
|
|
d0cb5998c4 | ||
|
|
a5c97220e7 | ||
|
|
598e5e4370 | ||
|
|
03076ee214 | ||
|
|
eabd349902 | ||
|
|
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__
|
__pycache__
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
/docs/_build
|
/docs/_build
|
||||||
|
/dist
|
||||||
|
/yamllint.egg-info
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ install:
|
|||||||
- pip install .
|
- pip install .
|
||||||
script:
|
script:
|
||||||
- flake8 .
|
- flake8 .
|
||||||
- yamllint $(git ls-files '*.yml')
|
- yamllint $(git ls-files '*.yaml' '*.yml')
|
||||||
- coverage run --source=yamllint setup.py test
|
- coverage run --source=yamllint setup.py test
|
||||||
after_success:
|
after_success:
|
||||||
coveralls
|
coveralls
|
||||||
|
|||||||
27
README.rst
27
README.rst
@@ -38,6 +38,27 @@ Screenshot
|
|||||||
Installation
|
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
|
.. code:: bash
|
||||||
|
|
||||||
sudo pip install yamllint
|
sudo pip install yamllint
|
||||||
@@ -58,15 +79,15 @@ Usage
|
|||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
# Use a pre-defined lint configuration
|
# Use a pre-defined lint configuration
|
||||||
yamllint -d relaxed file.yml
|
yamllint -d relaxed file.yaml
|
||||||
|
|
||||||
# Use a custom lint configuration
|
# Use a custom lint configuration
|
||||||
yamllint -c ~/myconfig file.yml
|
yamllint -c /path/to/myconfig file-to-lint.yaml
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||||
yamllint -f parsable file.yml
|
yamllint -f parsable file.yaml
|
||||||
|
|
||||||
Configuration example
|
Configuration example
|
||||||
^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -1,23 +1,31 @@
|
|||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
|
|
||||||
yamllint uses a set of *rules* to check sources files for problems. Each rule is
|
yamllint uses a set of :doc:`rules <rules>` to check source files for problems.
|
||||||
independent from the others, and can be enabled, disabled or tweaked. All these
|
Each rule is independent from the others, and can be enabled, disabled or
|
||||||
settings can be gathered in a configuration file.
|
tweaked. All these settings can be gathered in a configuration file.
|
||||||
|
|
||||||
To use a custom configuration file, either name it ``.yamllint`` in your working
|
To use a custom configuration file, use the ``-c`` option:
|
||||||
directory, or use the ``-c`` option:
|
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
yamllint -c ~/myconfig file.yml
|
yamllint -c /path/to/myconfig file-to-lint.yaml
|
||||||
|
|
||||||
|
If ``-c`` is not provided, yamllint will look for a configuration file in the
|
||||||
|
following locations (by order of preference):
|
||||||
|
|
||||||
|
- ``.yamllint`` in the current working directory
|
||||||
|
- ``$XDG_CONFIG_HOME/yamllint/config``
|
||||||
|
- ``$HOME/.config/yamllint/config``
|
||||||
|
|
||||||
|
Finally if no config file is found, the default configuration is applied.
|
||||||
|
|
||||||
Default configuration
|
Default configuration
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
Unless told otherwise, yamllint uses its ``default`` configuration:
|
Unless told otherwise, yamllint uses its ``default`` configuration:
|
||||||
|
|
||||||
.. literalinclude:: ../yamllint/conf/default.yml
|
.. literalinclude:: ../yamllint/conf/default.yaml
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
||||||
Details on rules can be found on :doc:`the rules page <rules>`.
|
Details on rules can be found on :doc:`the rules page <rules>`.
|
||||||
@@ -85,7 +93,7 @@ For instance:
|
|||||||
|
|
||||||
.. code:: bash
|
.. 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
|
Errors and warnings
|
||||||
-------------------
|
-------------------
|
||||||
|
|||||||
@@ -4,16 +4,34 @@ Quickstart
|
|||||||
Installing yamllint
|
Installing yamllint
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
First, install yamllint. The easiest way is to use pip, the Python package
|
On Fedora / CentOS:
|
||||||
manager:
|
|
||||||
|
|
||||||
::
|
.. 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
|
sudo pip install yamllint
|
||||||
|
|
||||||
If you prefer installing from source, you can run, from the source directory:
|
If you prefer installing from source, you can run, from the source directory:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
python setup.py sdist
|
python setup.py sdist
|
||||||
sudo pip install dist/yamllint-*.tar.gz
|
sudo pip install dist/yamllint-*.tar.gz
|
||||||
@@ -23,13 +41,13 @@ Running yamllint
|
|||||||
|
|
||||||
Basic usage:
|
Basic usage:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint file.yml other-file.yaml
|
yamllint file.yml other-file.yaml
|
||||||
|
|
||||||
You can also lint all YAML files in a whole directory:
|
You can also lint all YAML files in a whole directory:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint .
|
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``
|
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
|
||||||
option:
|
option:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint -c ~/myconfig file.yml
|
yamllint -c ~/myconfig file.yaml
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
|||||||
@@ -20,16 +20,8 @@ Neovim
|
|||||||
------
|
------
|
||||||
|
|
||||||
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
||||||
installed, add to your ``.config/nvim/init.vim``:
|
installed, yamllint is supported by default. It is automatically enabled when
|
||||||
|
editing YAML files.
|
||||||
::
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Other text editors
|
Other text editors
|
||||||
------------------
|
------------------
|
||||||
|
|||||||
2
setup.py
2
setup.py
@@ -44,7 +44,7 @@ setup(
|
|||||||
|
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
|
entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
|
||||||
package_data={'yamllint': ['conf/*.yml'],
|
package_data={'yamllint': ['conf/*.yaml'],
|
||||||
'tests': ['yaml-1.2-spec-examples/*']},
|
'tests': ['yaml-1.2-spec-examples/*']},
|
||||||
install_requires=['pyyaml'],
|
install_requires=['pyyaml'],
|
||||||
tests_require=['nose'],
|
tests_require=['nose'],
|
||||||
|
|||||||
@@ -381,6 +381,141 @@ class IndentationStackTestCase(RuleTestCase):
|
|||||||
# missing BEnd here
|
# missing BEnd here
|
||||||
' BEnd \n')
|
' 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):
|
class IndentationTestCase(RuleTestCase):
|
||||||
rule_id = 'indentation'
|
rule_id = 'indentation'
|
||||||
@@ -1098,12 +1233,46 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_explicit_block_mappings(self):
|
def test_explicit_block_mappings(self):
|
||||||
conf = 'indentation: {spaces: consistent}'
|
conf = 'indentation: {spaces: consistent}'
|
||||||
|
self.check('---\n'
|
||||||
|
'object:\n'
|
||||||
|
' ? key\n'
|
||||||
|
' : value\n', conf)
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' ? key\n'
|
' ? key\n'
|
||||||
' :\n'
|
' :\n'
|
||||||
' value\n'
|
' value\n'
|
||||||
'...\n', conf)
|
'...\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'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' ? key\n'
|
' ? key\n'
|
||||||
@@ -1111,12 +1280,11 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
' value\n'
|
' value\n'
|
||||||
'...\n', conf, problem=(5, 8))
|
'...\n', conf, problem=(5, 8))
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'- - ?\n'
|
||||||
' ?\n'
|
' key\n'
|
||||||
' key\n'
|
|
||||||
' :\n'
|
' :\n'
|
||||||
' value\n'
|
' value\n'
|
||||||
'...\n', conf)
|
'...\n', conf, problem=(5, 7))
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' ?\n'
|
' ?\n'
|
||||||
@@ -1288,6 +1456,48 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'- Clark Evans\n'
|
'- Clark Evans\n'
|
||||||
'- Ingy döt Net\n', conf)
|
'- 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):
|
class ScalarIndentationTestCase(RuleTestCase):
|
||||||
rule_id = 'indentation'
|
rule_id = 'indentation'
|
||||||
|
|||||||
@@ -78,6 +78,12 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
' # http://localhost/very/long/url\n'
|
' # http://localhost/very/long/url\n'
|
||||||
' comment\n'
|
' comment\n'
|
||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
|
self.check('---\n'
|
||||||
|
'this:\n'
|
||||||
|
'is:\n'
|
||||||
|
'another:\n'
|
||||||
|
' - https://localhost/very/very/long/url\n'
|
||||||
|
'...\n', conf)
|
||||||
|
|
||||||
conf = 'line-length: {max: 20, allow-non-breakable-words: no}'
|
conf = 'line-length: {max: 20, allow-non-breakable-words: no}'
|
||||||
self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
|
self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
|
||||||
@@ -94,3 +100,9 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
' # http://localhost/very/long/url\n'
|
' # http://localhost/very/long/url\n'
|
||||||
' comment\n'
|
' comment\n'
|
||||||
'...\n', conf, problem=(5, 21))
|
'...\n', conf, problem=(5, 21))
|
||||||
|
self.check('---\n'
|
||||||
|
'this:\n'
|
||||||
|
'is:\n'
|
||||||
|
'another:\n'
|
||||||
|
' - https://localhost/very/very/long/url\n'
|
||||||
|
'...\n', conf, problem=(5, 21))
|
||||||
|
|||||||
299
tests/test_cli.py
Normal file
299
tests/test_cli.py
Normal file
@@ -0,0 +1,299 @@
|
|||||||
|
# -*- 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_with_config_file(self):
|
||||||
|
with open(os.path.join(self.wd, 'config'), 'w') as f:
|
||||||
|
f.write('rules: {trailing-spaces: disable}')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
|
||||||
|
self.assertEqual(ctx.exception.code, 0)
|
||||||
|
|
||||||
|
with open(os.path.join(self.wd, 'config'), 'w') as f:
|
||||||
|
f.write('rules: {trailing-spaces: enable}')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
|
||||||
|
self.assertEqual(ctx.exception.code, 1)
|
||||||
|
|
||||||
|
def test_run_with_user_global_config_file(self):
|
||||||
|
home = os.path.join(self.wd, 'fake-home')
|
||||||
|
os.mkdir(home)
|
||||||
|
dir = os.path.join(home, '.config')
|
||||||
|
os.mkdir(dir)
|
||||||
|
dir = os.path.join(dir, 'yamllint')
|
||||||
|
os.mkdir(dir)
|
||||||
|
config = os.path.join(dir, 'config')
|
||||||
|
|
||||||
|
temp = os.environ['HOME']
|
||||||
|
os.environ['HOME'] = home
|
||||||
|
|
||||||
|
with open(config, 'w') as f:
|
||||||
|
f.write('rules: {trailing-spaces: disable}')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||||
|
self.assertEqual(ctx.exception.code, 0)
|
||||||
|
|
||||||
|
with open(config, 'w') as f:
|
||||||
|
f.write('rules: {trailing-spaces: enable}')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||||
|
self.assertEqual(ctx.exception.code, 1)
|
||||||
|
|
||||||
|
os.environ['HOME'] = temp
|
||||||
|
|
||||||
|
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)
|
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):
|
def test_unknown_rule(self):
|
||||||
with self.assertRaisesRegexp(
|
with self.assertRaisesRegexp(
|
||||||
config.YamlLintConfigError,
|
config.YamlLintConfigError,
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ indentation, etc."""
|
|||||||
|
|
||||||
|
|
||||||
APP_NAME = 'yamllint'
|
APP_NAME = 'yamllint'
|
||||||
APP_VERSION = '1.2.0'
|
APP_VERSION = '1.2.2'
|
||||||
APP_DESCRIPTION = __doc__
|
APP_DESCRIPTION = __doc__
|
||||||
|
|
||||||
__author__ = u'Adrien Vergé'
|
__author__ = u'Adrien Vergé'
|
||||||
|
|||||||
@@ -86,15 +86,26 @@ def run(argv=None):
|
|||||||
'simultaneously.', file=sys.stderr)
|
'simultaneously.', file=sys.stderr)
|
||||||
sys.exit(-1)
|
sys.exit(-1)
|
||||||
|
|
||||||
|
# User-global config is supposed to be in ~/.config/yamllint/config
|
||||||
|
user_global_config = None
|
||||||
|
if 'XDG_CONFIG_HOME' in os.environ:
|
||||||
|
user_global_config = os.path.join(
|
||||||
|
os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
|
||||||
|
elif 'HOME' in os.environ:
|
||||||
|
user_global_config = os.path.join(
|
||||||
|
os.environ['HOME'], '.config', 'yamllint', 'config')
|
||||||
|
|
||||||
try:
|
try:
|
||||||
if args.config_data is not None:
|
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
|
args.config_data = 'extends: ' + args.config_data
|
||||||
conf = YamlLintConfig(content=args.config_data)
|
conf = YamlLintConfig(content=args.config_data)
|
||||||
elif args.config_file is not None:
|
elif args.config_file is not None:
|
||||||
conf = YamlLintConfig(file=args.config_file)
|
conf = YamlLintConfig(file=args.config_file)
|
||||||
elif os.path.isfile('.yamllint'):
|
elif os.path.isfile('.yamllint'):
|
||||||
conf = YamlLintConfig(file='.yamllint')
|
conf = YamlLintConfig(file='.yamllint')
|
||||||
|
elif user_global_config and os.path.isfile(user_global_config):
|
||||||
|
conf = YamlLintConfig(file=user_global_config)
|
||||||
else:
|
else:
|
||||||
conf = YamlLintConfig('extends: default')
|
conf = YamlLintConfig('extends: default')
|
||||||
except YamlLintConfigError as e:
|
except YamlLintConfigError as e:
|
||||||
@@ -123,7 +134,7 @@ def run(argv=None):
|
|||||||
if not first and args.format != 'parsable':
|
if not first and args.format != 'parsable':
|
||||||
print('')
|
print('')
|
||||||
except EnvironmentError as e:
|
except EnvironmentError as e:
|
||||||
print(e)
|
print(e, file=sys.stderr)
|
||||||
return_code = -1
|
return_code = -1
|
||||||
|
|
||||||
sys.exit(return_code)
|
sys.exit(return_code)
|
||||||
|
|||||||
@@ -59,6 +59,9 @@ class YamlLintConfig(object):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
raise YamlLintConfigError('invalid config: %s' % e)
|
raise YamlLintConfigError('invalid config: %s' % e)
|
||||||
|
|
||||||
|
if type(conf) != dict:
|
||||||
|
raise YamlLintConfigError('invalid config: not a dict')
|
||||||
|
|
||||||
self.rules = conf.get('rules', {})
|
self.rules = conf.get('rules', {})
|
||||||
|
|
||||||
# Does this conf override another conf that we need to load?
|
# 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...
|
# Is it a standard conf shipped with yamllint...
|
||||||
if '/' not in name:
|
if '/' not in name:
|
||||||
std_conf = os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
std_conf = os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
||||||
'conf', name + '.yml')
|
'conf', name + '.yaml')
|
||||||
|
|
||||||
if os.path.isfile(std_conf):
|
if os.path.isfile(std_conf):
|
||||||
return std_conf
|
return std_conf
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ CONF = {'max': int,
|
|||||||
|
|
||||||
def check(conf, line):
|
def check(conf, line):
|
||||||
if line.start == line.end and line.end < len(line.buffer):
|
if line.start == line.end and line.end < len(line.buffer):
|
||||||
# Only alert on the last blank line of a serie
|
# Only alert on the last blank line of a series
|
||||||
if (line.end < len(line.buffer) - 1 and
|
if (line.end < len(line.buffer) - 1 and
|
||||||
line.buffer[line.end + 1] == '\n'):
|
line.buffer[line.end + 1] == '\n'):
|
||||||
return
|
return
|
||||||
|
|||||||
@@ -233,7 +233,7 @@ def check_scalar_indentation(conf, token, context):
|
|||||||
elif token.style in ('"', "'"):
|
elif token.style in ('"', "'"):
|
||||||
return token.start_mark.column + 1
|
return token.start_mark.column + 1
|
||||||
elif token.style in ('>', '|'):
|
elif token.style in ('>', '|'):
|
||||||
if context['stack'][-1].type == B_SEQ:
|
if context['stack'][-1].type == B_ENT:
|
||||||
# - >
|
# - >
|
||||||
# multi
|
# multi
|
||||||
# line
|
# line
|
||||||
@@ -295,7 +295,7 @@ def check_scalar_indentation(conf, token, context):
|
|||||||
(expected_indent, indent))
|
(expected_indent, indent))
|
||||||
|
|
||||||
|
|
||||||
def check(conf, token, prev, next, nextnext, context):
|
def _check(conf, token, prev, next, nextnext, context):
|
||||||
if 'stack' not in context:
|
if 'stack' not in context:
|
||||||
context['stack'] = [Parent(ROOT, 0)]
|
context['stack'] = [Parent(ROOT, 0)]
|
||||||
context['cur_line'] = -1
|
context['cur_line'] = -1
|
||||||
@@ -348,19 +348,18 @@ def check(conf, token, prev, next, nextnext, context):
|
|||||||
# Step 2.b: Update state
|
# Step 2.b: Update state
|
||||||
|
|
||||||
if isinstance(token, yaml.BlockMappingStartToken):
|
if isinstance(token, yaml.BlockMappingStartToken):
|
||||||
|
# - a: 1
|
||||||
|
# or
|
||||||
|
# - ? a
|
||||||
|
# : 1
|
||||||
|
# or
|
||||||
|
# - ?
|
||||||
|
# a
|
||||||
|
# : 1
|
||||||
assert isinstance(next, yaml.KeyToken)
|
assert isinstance(next, yaml.KeyToken)
|
||||||
if next.start_mark.line == token.start_mark.line:
|
assert next.start_mark.line == token.start_mark.line
|
||||||
# - a: 1
|
|
||||||
# b: 2
|
indent = token.start_mark.column
|
||||||
# or
|
|
||||||
# - ? a
|
|
||||||
# : 1
|
|
||||||
indent = token.start_mark.column
|
|
||||||
else:
|
|
||||||
# - ?
|
|
||||||
# a
|
|
||||||
# : 1
|
|
||||||
indent = detect_indent(token.start_mark.column, next)
|
|
||||||
|
|
||||||
context['stack'].append(Parent(B_MAP, indent))
|
context['stack'].append(Parent(B_MAP, indent))
|
||||||
|
|
||||||
@@ -380,8 +379,8 @@ def check(conf, token, prev, next, nextnext, context):
|
|||||||
elif isinstance(token, yaml.BlockSequenceStartToken):
|
elif isinstance(token, yaml.BlockSequenceStartToken):
|
||||||
# - - a
|
# - - a
|
||||||
# - b
|
# - b
|
||||||
assert next.start_mark.line == token.start_mark.line
|
|
||||||
assert isinstance(next, yaml.BlockEntryToken)
|
assert isinstance(next, yaml.BlockEntryToken)
|
||||||
|
assert next.start_mark.line == token.start_mark.line
|
||||||
|
|
||||||
indent = token.start_mark.column
|
indent = token.start_mark.column
|
||||||
|
|
||||||
@@ -497,12 +496,16 @@ def check(conf, token, prev, next, nextnext, context):
|
|||||||
consumed_current_token = False
|
consumed_current_token = False
|
||||||
while True:
|
while True:
|
||||||
if (context['stack'][-1].type == F_SEQ and
|
if (context['stack'][-1].type == F_SEQ and
|
||||||
isinstance(token, yaml.FlowSequenceEndToken)):
|
isinstance(token, yaml.FlowSequenceEndToken) and
|
||||||
|
not consumed_current_token):
|
||||||
context['stack'].pop()
|
context['stack'].pop()
|
||||||
|
consumed_current_token = True
|
||||||
|
|
||||||
elif (context['stack'][-1].type == F_MAP and
|
elif (context['stack'][-1].type == F_MAP and
|
||||||
isinstance(token, yaml.FlowMappingEndToken)):
|
isinstance(token, yaml.FlowMappingEndToken) and
|
||||||
|
not consumed_current_token):
|
||||||
context['stack'].pop()
|
context['stack'].pop()
|
||||||
|
consumed_current_token = True
|
||||||
|
|
||||||
elif (context['stack'][-1].type in (B_MAP, B_SEQ) and
|
elif (context['stack'][-1].type in (B_MAP, B_SEQ) and
|
||||||
isinstance(token, yaml.BlockEndToken) and
|
isinstance(token, yaml.BlockEndToken) and
|
||||||
@@ -541,3 +544,13 @@ def check(conf, token, prev, next, nextnext, context):
|
|||||||
|
|
||||||
else:
|
else:
|
||||||
break
|
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')
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ Use this rule to set a limit to lines length.
|
|||||||
the following code snippet would **FAIL**:
|
the following code snippet would **FAIL**:
|
||||||
::
|
::
|
||||||
|
|
||||||
- this line is waaaaaaaaaaaaaay too long but could be easily splitted...
|
- this line is waaaaaaaaaaaaaay too long but could be easily split...
|
||||||
|
|
||||||
#. With ``line-length: {max: 60, allow-non-breakable-words: no}``
|
#. With ``line-length: {max: 60, allow-non-breakable-words: no}``
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ def check(conf, line):
|
|||||||
start += 1
|
start += 1
|
||||||
|
|
||||||
if start != line.end:
|
if start != line.end:
|
||||||
if line.buffer[start] == '#':
|
if line.buffer[start] in ('#', '-'):
|
||||||
start += 2
|
start += 2
|
||||||
|
|
||||||
if line.buffer.find(' ', start, line.end) == -1:
|
if line.buffer.find(' ', start, line.end) == -1:
|
||||||
|
|||||||
Reference in New Issue
Block a user