Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c037d3e586 | ||
|
|
228c47ab77 | ||
|
|
413d7a8e4e | ||
|
|
c332c8e3d4 | ||
|
|
ea67ba3394 | ||
|
|
a7dbfb08b3 | ||
|
|
42eda54014 | ||
|
|
e909692f88 | ||
|
|
3bc72d4c40 | ||
|
|
21e81b6435 | ||
|
|
b97b6ad19b | ||
|
|
2b7f5c5e72 | ||
|
|
64369db9a2 | ||
|
|
2428f6eeaf | ||
|
|
bf386b3c90 | ||
|
|
03e0f5aa6b | ||
|
|
3b2a73d224 | ||
|
|
3c525ab743 |
@@ -11,7 +11,7 @@ install:
|
|||||||
- pip install .
|
- pip install .
|
||||||
script:
|
script:
|
||||||
- flake8 .
|
- flake8 .
|
||||||
- yamllint $(git ls-files '*.yaml' '*.yml')
|
- yamllint --strict $(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
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ On Fedora / CentOS:
|
|||||||
|
|
||||||
sudo dnf install yamllint
|
sudo dnf install yamllint
|
||||||
|
|
||||||
On Debian 9+ / Ubuntu 16.04+:
|
On Debian 8+ / Ubuntu 16.04+:
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
|
|||||||
@@ -102,8 +102,15 @@ Errors and warnings
|
|||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
Problems detected by yamllint can be raised either as errors or as warnings.
|
Problems detected by yamllint can be raised either as errors or as warnings.
|
||||||
|
The CLI will output them (with different colors when using the ``standard``
|
||||||
|
output format).
|
||||||
|
|
||||||
In both cases, the script will output them (with different colors when using the
|
By default the script will exit with a return code ``1`` *only when* there is one or
|
||||||
``standard`` output format), but the exit code can be different. More precisely,
|
more error(s).
|
||||||
the script will exit will a failure code *only when* there is one or more
|
|
||||||
error(s).
|
However if strict mode is enabled with the ``-s`` (or ``--strict``) option, the
|
||||||
|
return code will be:
|
||||||
|
|
||||||
|
* ``0`` if no errors or warnings occur
|
||||||
|
* ``1`` if one or more errors occur
|
||||||
|
* ``2`` if no errors occur, but one or more warnings occur
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ On Fedora / CentOS:
|
|||||||
|
|
||||||
sudo dnf install yamllint
|
sudo dnf install yamllint
|
||||||
|
|
||||||
On Debian 9+ / Ubuntu 16.04+:
|
On Debian 8+ / Ubuntu 16.04+:
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
|
|||||||
11
hooks.yaml
Normal file
11
hooks.yaml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
# For use with pre-commit.
|
||||||
|
# See usage instructions at http://pre-commit.com
|
||||||
|
|
||||||
|
- id: yamllint
|
||||||
|
name: yamllint
|
||||||
|
description: This hook runs yamllint.
|
||||||
|
entry: yamllint
|
||||||
|
language: python
|
||||||
|
files: \.(yaml|yml)$
|
||||||
@@ -43,7 +43,7 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_starting_space(self):
|
def test_starting_space(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: -1\n'
|
' min-spaces-from-content: -1\n'
|
||||||
'comments-indentation: disable\n')
|
'comments-indentation: disable\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
@@ -82,7 +82,7 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_spaces_from_content(self):
|
def test_spaces_from_content(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: no\n'
|
' require-starting-space: false\n'
|
||||||
' min-spaces-from-content: 2\n')
|
' min-spaces-from-content: 2\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'# comment\n'
|
'# comment\n'
|
||||||
@@ -104,7 +104,7 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_both(self):
|
def test_both(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: 2\n'
|
' min-spaces-from-content: 2\n'
|
||||||
'comments-indentation: disable\n')
|
'comments-indentation: disable\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
@@ -134,7 +134,7 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_empty_comment(self):
|
def test_empty_comment(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: 2\n')
|
' min-spaces-from-content: 2\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'# This is paragraph 1.\n'
|
'# This is paragraph 1.\n'
|
||||||
@@ -146,13 +146,13 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_first_line(self):
|
def test_first_line(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: 2\n')
|
' min-spaces-from-content: 2\n')
|
||||||
self.check('# comment\n', conf)
|
self.check('# comment\n', conf)
|
||||||
|
|
||||||
def test_last_line(self):
|
def test_last_line(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: 2\n'
|
' min-spaces-from-content: 2\n'
|
||||||
'new-line-at-end-of-file: disable\n')
|
'new-line-at-end-of-file: disable\n')
|
||||||
self.check('# comment with no newline char:\n'
|
self.check('# comment with no newline char:\n'
|
||||||
@@ -160,7 +160,7 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_multi_line_scalar(self):
|
def test_multi_line_scalar(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: yes\n'
|
' require-starting-space: true\n'
|
||||||
' min-spaces-from-content: 2\n'
|
' min-spaces-from-content: 2\n'
|
||||||
'trailing-spaces: disable\n')
|
'trailing-spaces: disable\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ class DocumentEndTestCase(RuleTestCase):
|
|||||||
' document: end\n', conf)
|
' document: end\n', conf)
|
||||||
|
|
||||||
def test_required(self):
|
def test_required(self):
|
||||||
conf = 'document-end: {present: yes}'
|
conf = 'document-end: {present: true}'
|
||||||
self.check('', conf)
|
self.check('', conf)
|
||||||
self.check('\n', conf)
|
self.check('\n', conf)
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
@@ -43,7 +43,7 @@ class DocumentEndTestCase(RuleTestCase):
|
|||||||
' document: end\n', conf, problem=(3, 1))
|
' document: end\n', conf, problem=(3, 1))
|
||||||
|
|
||||||
def test_forbidden(self):
|
def test_forbidden(self):
|
||||||
conf = 'document-end: {present: no}'
|
conf = 'document-end: {present: false}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'with:\n'
|
'with:\n'
|
||||||
' document: end\n'
|
' document: end\n'
|
||||||
@@ -53,7 +53,7 @@ class DocumentEndTestCase(RuleTestCase):
|
|||||||
' document: end\n', conf)
|
' document: end\n', conf)
|
||||||
|
|
||||||
def test_multiple_documents(self):
|
def test_multiple_documents(self):
|
||||||
conf = ('document-end: {present: yes}\n'
|
conf = ('document-end: {present: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'first: document\n'
|
'first: document\n'
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ class DocumentStartTestCase(RuleTestCase):
|
|||||||
'key: val\n', conf)
|
'key: val\n', conf)
|
||||||
|
|
||||||
def test_required(self):
|
def test_required(self):
|
||||||
conf = ('document-start: {present: yes}\n'
|
conf = ('document-start: {present: true}\n'
|
||||||
'empty-lines: disable\n')
|
'empty-lines: disable\n')
|
||||||
self.check('', conf)
|
self.check('', conf)
|
||||||
self.check('\n', conf)
|
self.check('\n', conf)
|
||||||
@@ -44,7 +44,7 @@ class DocumentStartTestCase(RuleTestCase):
|
|||||||
'key: val\n', conf)
|
'key: val\n', conf)
|
||||||
|
|
||||||
def test_forbidden(self):
|
def test_forbidden(self):
|
||||||
conf = ('document-start: {present: no}\n'
|
conf = ('document-start: {present: false}\n'
|
||||||
'empty-lines: disable\n')
|
'empty-lines: disable\n')
|
||||||
self.check('', conf)
|
self.check('', conf)
|
||||||
self.check('key: val\n', conf)
|
self.check('key: val\n', conf)
|
||||||
@@ -62,7 +62,7 @@ class DocumentStartTestCase(RuleTestCase):
|
|||||||
'key: val\n', conf, problem=(2, 1))
|
'key: val\n', conf, problem=(2, 1))
|
||||||
|
|
||||||
def test_multiple_documents(self):
|
def test_multiple_documents(self):
|
||||||
conf = 'document-start: {present: yes}'
|
conf = 'document-start: {present: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'first: document\n'
|
'first: document\n'
|
||||||
'...\n'
|
'...\n'
|
||||||
@@ -85,7 +85,7 @@ class DocumentStartTestCase(RuleTestCase):
|
|||||||
'third: document\n', conf, problem=(4, 1, 'syntax'))
|
'third: document\n', conf, problem=(4, 1, 'syntax'))
|
||||||
|
|
||||||
def test_directives(self):
|
def test_directives(self):
|
||||||
conf = 'document-start: {present: yes}'
|
conf = 'document-start: {present: true}'
|
||||||
self.check('%YAML 1.2\n'
|
self.check('%YAML 1.2\n'
|
||||||
'---\n'
|
'---\n'
|
||||||
'doc: ument\n'
|
'doc: ument\n'
|
||||||
|
|||||||
@@ -549,7 +549,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
|
|
||||||
def test_one_space(self):
|
def test_one_space(self):
|
||||||
conf = 'indentation: {spaces: 1, indent-sequences: no}'
|
conf = 'indentation: {spaces: 1, indent-sequences: false}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -562,7 +562,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
' - name: Linux\n'
|
' - name: Linux\n'
|
||||||
' date: 1991\n'
|
' date: 1991\n'
|
||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
conf = 'indentation: {spaces: 1, indent-sequences: yes}'
|
conf = 'indentation: {spaces: 1, indent-sequences: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -577,7 +577,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
|
|
||||||
def test_two_spaces(self):
|
def test_two_spaces(self):
|
||||||
conf = 'indentation: {spaces: 2, indent-sequences: no}'
|
conf = 'indentation: {spaces: 2, indent-sequences: false}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -590,7 +590,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
' - name: Linux\n'
|
' - name: Linux\n'
|
||||||
' date: 1991\n'
|
' date: 1991\n'
|
||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
conf = 'indentation: {spaces: 2, indent-sequences: yes}'
|
conf = 'indentation: {spaces: 2, indent-sequences: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -605,7 +605,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
|
|
||||||
def test_three_spaces(self):
|
def test_three_spaces(self):
|
||||||
conf = 'indentation: {spaces: 3, indent-sequences: no}'
|
conf = 'indentation: {spaces: 3, indent-sequences: false}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -618,7 +618,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
' - name: Linux\n'
|
' - name: Linux\n'
|
||||||
' date: 1991\n'
|
' date: 1991\n'
|
||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
conf = 'indentation: {spaces: 3, indent-sequences: yes}'
|
conf = 'indentation: {spaces: 3, indent-sequences: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'object:\n'
|
'object:\n'
|
||||||
' k1:\n'
|
' k1:\n'
|
||||||
@@ -632,7 +632,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
' date: 1991\n'
|
' date: 1991\n'
|
||||||
'...\n', conf)
|
'...\n', conf)
|
||||||
|
|
||||||
def test_consistent(self):
|
def test_consistent_spaces(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' indent-sequences: whatever}\n'
|
' indent-sequences: whatever}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
@@ -713,6 +713,142 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'- b\n'
|
'- b\n'
|
||||||
'- c\n', conf)
|
'- c\n', conf)
|
||||||
|
|
||||||
|
def test_consistent_spaces_and_indent_sequences(self):
|
||||||
|
conf = 'indentation: {spaces: consistent, indent-sequences: true}'
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(3, 1))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 5))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf, problem1=(7, 1))
|
||||||
|
|
||||||
|
conf = 'indentation: {spaces: consistent, indent-sequences: false}'
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 5))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 3))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf, problem1=(3, 3))
|
||||||
|
|
||||||
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
|
' indent-sequences: consistent}')
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 5))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf, problem1=(7, 1))
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf)
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 5))
|
||||||
|
|
||||||
|
conf = 'indentation: {spaces: consistent, indent-sequences: whatever}'
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf)
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf)
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
'- 1\n'
|
||||||
|
'- 2\n'
|
||||||
|
'- 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
'- a\n'
|
||||||
|
'- b\n'
|
||||||
|
'- c\n', conf)
|
||||||
|
self.check('---\n'
|
||||||
|
'list one:\n'
|
||||||
|
' - 1\n'
|
||||||
|
' - 2\n'
|
||||||
|
' - 3\n'
|
||||||
|
'list two:\n'
|
||||||
|
' - a\n'
|
||||||
|
' - b\n'
|
||||||
|
' - c\n', conf, problem1=(7, 5))
|
||||||
|
|
||||||
def test_indent_sequences_whatever(self):
|
def test_indent_sequences_whatever(self):
|
||||||
conf = 'indentation: {spaces: 4, indent-sequences: whatever}'
|
conf = 'indentation: {spaces: 4, indent-sequences: whatever}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
@@ -1130,7 +1266,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
problem=(2, 3))
|
problem=(2, 3))
|
||||||
|
|
||||||
def test_multi_lines(self):
|
def test_multi_lines(self):
|
||||||
conf = 'indentation: {spaces: consistent, indent-sequences: yes}'
|
conf = 'indentation: {spaces: consistent, indent-sequences: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'long_string: >\n'
|
'long_string: >\n'
|
||||||
' bla bla blah\n'
|
' bla bla blah\n'
|
||||||
@@ -1438,7 +1574,7 @@ class IndentationTestCase(RuleTestCase):
|
|||||||
'- !!map # Block collection\n'
|
'- !!map # Block collection\n'
|
||||||
' foo: bar\n', conf)
|
' foo: bar\n', conf)
|
||||||
|
|
||||||
conf = 'indentation: {spaces: consistent, indent-sequences: no}'
|
conf = 'indentation: {spaces: consistent, indent-sequences: false}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'sequence: !!seq\n'
|
'sequence: !!seq\n'
|
||||||
'- entry\n'
|
'- entry\n'
|
||||||
@@ -1505,7 +1641,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_basics_plain(self):
|
def test_basics_plain(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: no}\n'
|
' check-multi-line-strings: false}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('multi\n'
|
self.check('multi\n'
|
||||||
'line\n', conf)
|
'line\n', conf)
|
||||||
@@ -1534,7 +1670,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_check_multi_line_plain(self):
|
def test_check_multi_line_plain(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('multi\n'
|
self.check('multi\n'
|
||||||
' line\n', conf, problem=(2, 2))
|
' line\n', conf, problem=(2, 2))
|
||||||
@@ -1557,7 +1693,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_basics_quoted(self):
|
def test_basics_quoted(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: no}\n'
|
' check-multi-line-strings: false}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('"multi\n'
|
self.check('"multi\n'
|
||||||
' line"\n', conf)
|
' line"\n', conf)
|
||||||
@@ -1588,7 +1724,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_check_multi_line_quoted(self):
|
def test_check_multi_line_quoted(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('"multi\n'
|
self.check('"multi\n'
|
||||||
'line"\n', conf, problem=(2, 1))
|
'line"\n', conf, problem=(2, 1))
|
||||||
@@ -1644,7 +1780,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_basics_folded_style(self):
|
def test_basics_folded_style(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: no}\n'
|
' check-multi-line-strings: false}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('>\n'
|
self.check('>\n'
|
||||||
' multi\n'
|
' multi\n'
|
||||||
@@ -1682,7 +1818,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_check_multi_line_folded_style(self):
|
def test_check_multi_line_folded_style(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('>\n'
|
self.check('>\n'
|
||||||
' multi\n'
|
' multi\n'
|
||||||
@@ -1723,7 +1859,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_basics_literal_style(self):
|
def test_basics_literal_style(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: no}\n'
|
' check-multi-line-strings: false}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('|\n'
|
self.check('|\n'
|
||||||
' multi\n'
|
' multi\n'
|
||||||
@@ -1761,7 +1897,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_check_multi_line_literal_style(self):
|
def test_check_multi_line_literal_style(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('|\n'
|
self.check('|\n'
|
||||||
' multi\n'
|
' multi\n'
|
||||||
@@ -1805,7 +1941,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_paragraph_plain(self):
|
def test_paragraph_plain(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('- long text: very "long"\n'
|
self.check('- long text: very "long"\n'
|
||||||
' \'string\' with\n'
|
' \'string\' with\n'
|
||||||
@@ -1827,7 +1963,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_paragraph_double_quoted(self):
|
def test_paragraph_double_quoted(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('- long text: "very \\"long\\"\n'
|
self.check('- long text: "very \\"long\\"\n'
|
||||||
' \'string\' with\n'
|
' \'string\' with\n'
|
||||||
@@ -1855,7 +1991,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_paragraph_single_quoted(self):
|
def test_paragraph_single_quoted(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('- long text: \'very "long"\n'
|
self.check('- long text: \'very "long"\n'
|
||||||
' \'\'string\'\' with\n'
|
' \'\'string\'\' with\n'
|
||||||
@@ -1883,7 +2019,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_paragraph_folded(self):
|
def test_paragraph_folded(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('- long text: >\n'
|
self.check('- long text: >\n'
|
||||||
' very "long"\n'
|
' very "long"\n'
|
||||||
@@ -1901,7 +2037,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_paragraph_literal(self):
|
def test_paragraph_literal(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('- long text: |\n'
|
self.check('- long text: |\n'
|
||||||
' very "long"\n'
|
' very "long"\n'
|
||||||
@@ -1919,7 +2055,7 @@ class ScalarIndentationTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_consistent(self):
|
def test_consistent(self):
|
||||||
conf = ('indentation: {spaces: consistent,\n'
|
conf = ('indentation: {spaces: consistent,\n'
|
||||||
' check-multi-line-strings: yes}\n'
|
' check-multi-line-strings: true}\n'
|
||||||
'document-start: disable\n')
|
'document-start: disable\n')
|
||||||
self.check('multi\n'
|
self.check('multi\n'
|
||||||
'line\n', conf)
|
'line\n', conf)
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81))
|
self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81))
|
||||||
|
|
||||||
def test_non_breakable_word(self):
|
def test_non_breakable_word(self):
|
||||||
conf = 'line-length: {max: 20, allow-non-breakable-words: yes}'
|
conf = 'line-length: {max: 20, allow-non-breakable-words: true}'
|
||||||
self.check('---\n' + 30 * 'A' + '\n', conf)
|
self.check('---\n' + 30 * 'A' + '\n', conf)
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'this:\n'
|
'this:\n'
|
||||||
@@ -91,7 +91,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
'long_line: http://localhost/very/very/long/url\n', conf,
|
'long_line: http://localhost/very/very/long/url\n', conf,
|
||||||
problem=(2, 21))
|
problem=(2, 21))
|
||||||
|
|
||||||
conf = 'line-length: {max: 20, allow-non-breakable-words: no}'
|
conf = 'line-length: {max: 20, allow-non-breakable-words: false}'
|
||||||
self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
|
self.check('---\n' + 30 * 'A' + '\n', conf, problem=(2, 21))
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'this:\n'
|
'this:\n'
|
||||||
@@ -116,7 +116,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
'long_line: http://localhost/very/very/long/url\n'
|
'long_line: http://localhost/very/very/long/url\n'
|
||||||
'...\n', conf, problem=(2, 21))
|
'...\n', conf, problem=(2, 21))
|
||||||
|
|
||||||
conf = ('line-length: {max: 20, allow-non-breakable-words: yes}\n'
|
conf = ('line-length: {max: 20, allow-non-breakable-words: true}\n'
|
||||||
'trailing-spaces: disable')
|
'trailing-spaces: disable')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'loooooooooong+word+and+some+space+at+the+end \n',
|
'loooooooooong+word+and+some+space+at+the+end \n',
|
||||||
@@ -124,7 +124,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
|
|
||||||
def test_non_breakable_inline_mappings(self):
|
def test_non_breakable_inline_mappings(self):
|
||||||
conf = 'line-length: {max: 20, ' \
|
conf = 'line-length: {max: 20, ' \
|
||||||
'allow-non-breakable-inline-mappings: yes}'
|
'allow-non-breakable-inline-mappings: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'long_line: http://localhost/very/very/long/url\n'
|
'long_line: http://localhost/very/very/long/url\n'
|
||||||
'long line: http://localhost/very/very/long/url\n', conf)
|
'long line: http://localhost/very/very/long/url\n', conf)
|
||||||
@@ -137,7 +137,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
conf, problem1=(2, 21), problem2=(3, 21))
|
conf, problem1=(2, 21), problem2=(3, 21))
|
||||||
|
|
||||||
conf = ('line-length: {max: 20,'
|
conf = ('line-length: {max: 20,'
|
||||||
' allow-non-breakable-inline-mappings: yes}\n'
|
' allow-non-breakable-inline-mappings: true}\n'
|
||||||
'trailing-spaces: disable')
|
'trailing-spaces: disable')
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'long_line: and+some+space+at+the+end \n',
|
'long_line: and+some+space+at+the+end \n',
|
||||||
@@ -150,7 +150,7 @@ class LineLengthTestCase(RuleTestCase):
|
|||||||
conf, problem=(2, 21))
|
conf, problem=(2, 21))
|
||||||
|
|
||||||
# See https://github.com/adrienverge/yamllint/issues/21
|
# See https://github.com/adrienverge/yamllint/issues/21
|
||||||
conf = 'line-length: {allow-non-breakable-inline-mappings: yes}'
|
conf = 'line-length: {allow-non-breakable-inline-mappings: true}'
|
||||||
self.check('---\n'
|
self.check('---\n'
|
||||||
'content: |\n'
|
'content: |\n'
|
||||||
' {% this line is' + 99 * ' really' + ' long %}\n',
|
' {% this line is' + 99 * ' really' + ' long %}\n',
|
||||||
|
|||||||
@@ -40,6 +40,10 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
'- 1 \n'
|
'- 1 \n'
|
||||||
'- 2')
|
'- 2')
|
||||||
|
|
||||||
|
# file with only one warning
|
||||||
|
with open(os.path.join(self.wd, 'warn.yaml'), 'w') as f:
|
||||||
|
f.write('key: value\n')
|
||||||
|
|
||||||
# .yml file at root
|
# .yml file at root
|
||||||
open(os.path.join(self.wd, 'empty.yml'), 'w').close()
|
open(os.path.join(self.wd, 'empty.yml'), 'w').close()
|
||||||
|
|
||||||
@@ -85,7 +89,8 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
[os.path.join(self.wd, 'a.yaml'),
|
[os.path.join(self.wd, 'a.yaml'),
|
||||||
os.path.join(self.wd, 'empty.yml'),
|
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, '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')],
|
os.path.join(self.wd, 'sub/ok.yaml'),
|
||||||
|
os.path.join(self.wd, 'warn.yaml')],
|
||||||
)
|
)
|
||||||
|
|
||||||
items = [os.path.join(self.wd, 'sub/ok.yaml'),
|
items = [os.path.join(self.wd, 'sub/ok.yaml'),
|
||||||
@@ -247,6 +252,24 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
'(new-line-at-end-of-file)\n') % (file, file))
|
'(new-line-at-end-of-file)\n') % (file, file))
|
||||||
self.assertEqual(err, '')
|
self.assertEqual(err, '')
|
||||||
|
|
||||||
|
def test_run_one_warning(self):
|
||||||
|
file = os.path.join(self.wd, 'warn.yaml')
|
||||||
|
|
||||||
|
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run(('-f', 'parsable', file))
|
||||||
|
|
||||||
|
self.assertEqual(ctx.exception.code, 0)
|
||||||
|
|
||||||
|
def test_run_warning_in_strict_mode(self):
|
||||||
|
file = os.path.join(self.wd, 'warn.yaml')
|
||||||
|
|
||||||
|
sys.stdout, sys.stderr = StringIO(), StringIO()
|
||||||
|
with self.assertRaises(SystemExit) as ctx:
|
||||||
|
cli.run(('-f', 'parsable', '--strict', file))
|
||||||
|
|
||||||
|
self.assertEqual(ctx.exception.code, 2)
|
||||||
|
|
||||||
def test_run_one_ok_file(self):
|
def test_run_one_ok_file(self):
|
||||||
file = os.path.join(self.wd, 'sub', 'ok.yaml')
|
file = os.path.join(self.wd, 'sub', 'ok.yaml')
|
||||||
|
|
||||||
|
|||||||
@@ -62,6 +62,45 @@ class SimpleConfigTestCase(unittest.TestCase):
|
|||||||
' max-spaces-after: 1\n'
|
' max-spaces-after: 1\n'
|
||||||
' abcdef: yes\n')
|
' abcdef: yes\n')
|
||||||
|
|
||||||
|
def test_yes_no_for_booleans(self):
|
||||||
|
c = config.YamlLintConfig('rules:\n'
|
||||||
|
' indentation:\n'
|
||||||
|
' spaces: 2\n'
|
||||||
|
' indent-sequences: true\n'
|
||||||
|
' check-multi-line-strings: false\n')
|
||||||
|
self.assertEqual(c.rules['indentation']['indent-sequences'], True)
|
||||||
|
self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
|
||||||
|
False)
|
||||||
|
|
||||||
|
c = config.YamlLintConfig('rules:\n'
|
||||||
|
' indentation:\n'
|
||||||
|
' spaces: 2\n'
|
||||||
|
' indent-sequences: yes\n'
|
||||||
|
' check-multi-line-strings: false\n')
|
||||||
|
self.assertEqual(c.rules['indentation']['indent-sequences'], True)
|
||||||
|
self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
|
||||||
|
False)
|
||||||
|
|
||||||
|
c = config.YamlLintConfig('rules:\n'
|
||||||
|
' indentation:\n'
|
||||||
|
' spaces: 2\n'
|
||||||
|
' indent-sequences: whatever\n'
|
||||||
|
' check-multi-line-strings: false\n')
|
||||||
|
self.assertEqual(c.rules['indentation']['indent-sequences'],
|
||||||
|
'whatever')
|
||||||
|
self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
|
||||||
|
False)
|
||||||
|
|
||||||
|
with self.assertRaisesRegexp(
|
||||||
|
config.YamlLintConfigError,
|
||||||
|
'invalid config: option "indent-sequences" of "indentation" '
|
||||||
|
'should be in '):
|
||||||
|
c = config.YamlLintConfig('rules:\n'
|
||||||
|
' indentation:\n'
|
||||||
|
' spaces: 2\n'
|
||||||
|
' indent-sequences: YES!\n'
|
||||||
|
' check-multi-line-strings: false\n')
|
||||||
|
|
||||||
def test_validate_rule_conf(self):
|
def test_validate_rule_conf(self):
|
||||||
class Rule(object):
|
class Rule(object):
|
||||||
ID = 'fake'
|
ID = 'fake'
|
||||||
|
|||||||
@@ -48,6 +48,7 @@ from tests.common import RuleTestCase
|
|||||||
class SpecificationTestCase(RuleTestCase):
|
class SpecificationTestCase(RuleTestCase):
|
||||||
rule_id = None
|
rule_id = None
|
||||||
|
|
||||||
|
|
||||||
conf_general = ('document-start: disable\n'
|
conf_general = ('document-start: disable\n'
|
||||||
'comments: {min-spaces-from-content: 1}\n'
|
'comments: {min-spaces-from-content: 1}\n'
|
||||||
'braces: {min-spaces-inside: 1, max-spaces-inside: 1}\n'
|
'braces: {min-spaces-inside: 1, max-spaces-inside: 1}\n'
|
||||||
@@ -66,7 +67,7 @@ conf_overrides = {
|
|||||||
'example-2.18': ('empty-lines: {max-end: 1}\n'),
|
'example-2.18': ('empty-lines: {max-end: 1}\n'),
|
||||||
'example-2.19': ('empty-lines: {max-end: 1}\n'),
|
'example-2.19': ('empty-lines: {max-end: 1}\n'),
|
||||||
'example-2.28': ('empty-lines: {max-end: 3}\n'),
|
'example-2.28': ('empty-lines: {max-end: 3}\n'),
|
||||||
'example-5.3': ('indentation: {indent-sequences: no}\n'
|
'example-5.3': ('indentation: {indent-sequences: false}\n'
|
||||||
'colons: {max-spaces-before: 1}\n'),
|
'colons: {max-spaces-before: 1}\n'),
|
||||||
'example-6.4': ('trailing-spaces: disable\n'),
|
'example-6.4': ('trailing-spaces: disable\n'),
|
||||||
'example-6.5': ('trailing-spaces: disable\n'),
|
'example-6.5': ('trailing-spaces: disable\n'),
|
||||||
@@ -114,11 +115,11 @@ conf_overrides = {
|
|||||||
'example-8.14': ('colons: {max-spaces-before: 1}\n'),
|
'example-8.14': ('colons: {max-spaces-before: 1}\n'),
|
||||||
'example-8.16': ('indentation: {spaces: 1}\n'),
|
'example-8.16': ('indentation: {spaces: 1}\n'),
|
||||||
'example-8.17': ('indentation: disable\n'),
|
'example-8.17': ('indentation: disable\n'),
|
||||||
'example-8.20': ('indentation: {indent-sequences: no}\n'
|
'example-8.20': ('indentation: {indent-sequences: false}\n'
|
||||||
'colons: {max-spaces-before: 1}\n'),
|
'colons: {max-spaces-before: 1}\n'),
|
||||||
'example-8.22': ('indentation: disable\n'),
|
'example-8.22': ('indentation: disable\n'),
|
||||||
'example-10.1': ('colons: {max-spaces-before: 2}\n'),
|
'example-10.1': ('colons: {max-spaces-before: 2}\n'),
|
||||||
'example-10.2': ('indentation: {indent-sequences: no}\n'),
|
'example-10.2': ('indentation: {indent-sequences: false}\n'),
|
||||||
'example-10.8': ('truthy: disable\n'),
|
'example-10.8': ('truthy: disable\n'),
|
||||||
'example-10.9': ('truthy: disable\n'),
|
'example-10.9': ('truthy: disable\n'),
|
||||||
}
|
}
|
||||||
@@ -133,6 +134,7 @@ def _gen_test(buffer, conf):
|
|||||||
self.check(buffer, conf)
|
self.check(buffer, conf)
|
||||||
return test
|
return test
|
||||||
|
|
||||||
|
|
||||||
# The following tests are blacklisted (i.e. will not be checked against
|
# The following tests are blacklisted (i.e. will not be checked against
|
||||||
# yamllint), because pyyaml is currently not able to parse the contents
|
# yamllint), because pyyaml is currently not able to parse the contents
|
||||||
# (using yaml.parse()).
|
# (using yaml.parse()).
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ indentation, etc."""
|
|||||||
|
|
||||||
|
|
||||||
APP_NAME = 'yamllint'
|
APP_NAME = 'yamllint'
|
||||||
APP_VERSION = '1.5.0'
|
APP_VERSION = '1.6.1'
|
||||||
APP_DESCRIPTION = __doc__
|
APP_DESCRIPTION = __doc__
|
||||||
|
|
||||||
__author__ = u'Adrien Vergé'
|
__author__ = u'Adrien Vergé'
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ import argparse
|
|||||||
|
|
||||||
from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
|
from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
|
||||||
from yamllint.config import YamlLintConfig, YamlLintConfigError
|
from yamllint.config import YamlLintConfig, YamlLintConfigError
|
||||||
|
from yamllint.linter import PROBLEM_LEVELS
|
||||||
from yamllint import linter
|
from yamllint import linter
|
||||||
|
|
||||||
|
|
||||||
@@ -85,6 +86,10 @@ def run(argv=None):
|
|||||||
parser.add_argument('-f', '--format',
|
parser.add_argument('-f', '--format',
|
||||||
choices=('parsable', 'standard'), default='standard',
|
choices=('parsable', 'standard'), default='standard',
|
||||||
help='format for parsing output')
|
help='format for parsing output')
|
||||||
|
parser.add_argument('-s', '--strict',
|
||||||
|
action='store_true',
|
||||||
|
help='return non-zero exit code on warnings '
|
||||||
|
'as well as errors')
|
||||||
parser.add_argument('-v', '--version', action='version',
|
parser.add_argument('-v', '--version', action='version',
|
||||||
version='%s %s' % (APP_NAME, APP_VERSION))
|
version='%s %s' % (APP_NAME, APP_VERSION))
|
||||||
|
|
||||||
@@ -121,7 +126,7 @@ def run(argv=None):
|
|||||||
print(e, file=sys.stderr)
|
print(e, file=sys.stderr)
|
||||||
sys.exit(-1)
|
sys.exit(-1)
|
||||||
|
|
||||||
return_code = 0
|
max_level = 0
|
||||||
|
|
||||||
for file in find_files_recursively(args.files):
|
for file in find_files_recursively(args.files):
|
||||||
try:
|
try:
|
||||||
@@ -143,13 +148,19 @@ def run(argv=None):
|
|||||||
|
|
||||||
print(Format.standard(problem, file))
|
print(Format.standard(problem, file))
|
||||||
|
|
||||||
if return_code == 0 and problem.level == 'error':
|
max_level = max(max_level, PROBLEM_LEVELS[problem.level])
|
||||||
return_code = 1
|
|
||||||
|
|
||||||
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, file=sys.stderr)
|
print(e, file=sys.stderr)
|
||||||
return_code = -1
|
sys.exit(-1)
|
||||||
|
|
||||||
|
if max_level == PROBLEM_LEVELS['error']:
|
||||||
|
return_code = 1
|
||||||
|
elif max_level == PROBLEM_LEVELS['warning']:
|
||||||
|
return_code = 2 if args.strict else 0
|
||||||
|
else:
|
||||||
|
return_code = 0
|
||||||
|
|
||||||
sys.exit(return_code)
|
sys.exit(return_code)
|
||||||
|
|||||||
@@ -16,14 +16,14 @@ rules:
|
|||||||
max-spaces-after: 1
|
max-spaces-after: 1
|
||||||
comments:
|
comments:
|
||||||
level: warning
|
level: warning
|
||||||
require-starting-space: yes
|
require-starting-space: true
|
||||||
min-spaces-from-content: 2
|
min-spaces-from-content: 2
|
||||||
comments-indentation:
|
comments-indentation:
|
||||||
level: warning
|
level: warning
|
||||||
document-end: disable
|
document-end: disable
|
||||||
document-start:
|
document-start:
|
||||||
level: warning
|
level: warning
|
||||||
present: yes
|
present: true
|
||||||
empty-lines:
|
empty-lines:
|
||||||
max: 2
|
max: 2
|
||||||
max-start: 0
|
max-start: 0
|
||||||
@@ -32,13 +32,13 @@ rules:
|
|||||||
max-spaces-after: 1
|
max-spaces-after: 1
|
||||||
indentation:
|
indentation:
|
||||||
spaces: consistent
|
spaces: consistent
|
||||||
indent-sequences: yes
|
indent-sequences: true
|
||||||
check-multi-line-strings: no
|
check-multi-line-strings: false
|
||||||
key-duplicates: enable
|
key-duplicates: enable
|
||||||
line-length:
|
line-length:
|
||||||
max: 80
|
max: 80
|
||||||
allow-non-breakable-words: yes
|
allow-non-breakable-words: true
|
||||||
allow-non-breakable-inline-mappings: no
|
allow-non-breakable-inline-mappings: false
|
||||||
new-line-at-end-of-file: enable
|
new-line-at-end-of-file: enable
|
||||||
new-lines:
|
new-lines:
|
||||||
type: unix
|
type: unix
|
||||||
|
|||||||
@@ -25,5 +25,5 @@ rules:
|
|||||||
indent-sequences: consistent
|
indent-sequences: consistent
|
||||||
line-length:
|
line-length:
|
||||||
level: warning
|
level: warning
|
||||||
allow-non-breakable-inline-mappings: yes
|
allow-non-breakable-inline-mappings: true
|
||||||
truthy: disable
|
truthy: disable
|
||||||
|
|||||||
@@ -21,6 +21,16 @@ import yaml
|
|||||||
from yamllint import parser
|
from yamllint import parser
|
||||||
|
|
||||||
|
|
||||||
|
PROBLEM_LEVELS = {
|
||||||
|
0: None,
|
||||||
|
1: 'warning',
|
||||||
|
2: 'error',
|
||||||
|
None: 0,
|
||||||
|
'warning': 1,
|
||||||
|
'error': 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
class LintProblem(object):
|
class LintProblem(object):
|
||||||
"""Represents a linting problem found by yamllint."""
|
"""Represents a linting problem found by yamllint."""
|
||||||
def __init__(self, line, column, desc='<no description>', rule=None):
|
def __init__(self, line, column, desc='<no description>', rule=None):
|
||||||
@@ -53,7 +63,7 @@ class LintProblem(object):
|
|||||||
return '%d:%d: %s' % (self.line, self.column, self.message)
|
return '%d:%d: %s' % (self.line, self.column, self.message)
|
||||||
|
|
||||||
|
|
||||||
def get_costemic_problems(buffer, conf):
|
def get_cosmetic_problems(buffer, conf):
|
||||||
rules = conf.enabled_rules()
|
rules = conf.enabled_rules()
|
||||||
|
|
||||||
# Split token rules from line rules
|
# Split token rules from line rules
|
||||||
@@ -183,7 +193,7 @@ def _run(buffer, conf):
|
|||||||
# right line
|
# right line
|
||||||
syntax_error = get_syntax_error(buffer)
|
syntax_error = get_syntax_error(buffer)
|
||||||
|
|
||||||
for problem in get_costemic_problems(buffer, conf):
|
for problem in get_cosmetic_problems(buffer, conf):
|
||||||
# Insert the syntax error (if any) at the right place...
|
# Insert the syntax error (if any) at the right place...
|
||||||
if (syntax_error and syntax_error.line <= problem.line and
|
if (syntax_error and syntax_error.line <= problem.line and
|
||||||
syntax_error.column <= problem.column):
|
syntax_error.column <= problem.column):
|
||||||
|
|||||||
@@ -20,14 +20,14 @@ Use this rule to control the position and formatting of comments.
|
|||||||
.. rubric:: Options
|
.. rubric:: Options
|
||||||
|
|
||||||
* Use ``require-starting-space`` to require a space character right after the
|
* Use ``require-starting-space`` to require a space character right after the
|
||||||
``#``. Set to ``yes`` to enable, ``no`` to disable.
|
``#``. Set to ``true`` to enable, ``false`` to disable.
|
||||||
* ``min-spaces-from-content`` is used to visually separate inline comments from
|
* ``min-spaces-from-content`` is used to visually separate inline comments from
|
||||||
content. It defines the minimal required number of spaces between a comment
|
content. It defines the minimal required number of spaces between a comment
|
||||||
and its preceding content.
|
and its preceding content.
|
||||||
|
|
||||||
.. rubric:: Examples
|
.. rubric:: Examples
|
||||||
|
|
||||||
#. With ``comments: {require-starting-space: yes}``
|
#. With ``comments: {require-starting-space: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document end marker (``...``).
|
|||||||
|
|
||||||
.. rubric:: Options
|
.. rubric:: Options
|
||||||
|
|
||||||
* Set ``present`` to ``yes`` when the document end marker is required, or to
|
* Set ``present`` to ``true`` when the document end marker is required, or to
|
||||||
``no`` when it is forbidden.
|
``false`` when it is forbidden.
|
||||||
|
|
||||||
.. rubric:: Examples
|
.. rubric:: Examples
|
||||||
|
|
||||||
#. With ``document-end: {present: yes}``
|
#. With ``document-end: {present: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
@@ -49,7 +49,7 @@ Use this rule to require or forbid the use of document end marker (``...``).
|
|||||||
- is: another one
|
- is: another one
|
||||||
...
|
...
|
||||||
|
|
||||||
#. With ``document-end: {present: no}``
|
#. With ``document-end: {present: false}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document start marker (``---``).
|
|||||||
|
|
||||||
.. rubric:: Options
|
.. rubric:: Options
|
||||||
|
|
||||||
* Set ``present`` to ``yes`` when the document start marker is required, or to
|
* Set ``present`` to ``true`` when the document start marker is required, or to
|
||||||
``no`` when it is forbidden.
|
``false`` when it is forbidden.
|
||||||
|
|
||||||
.. rubric:: Examples
|
.. rubric:: Examples
|
||||||
|
|
||||||
#. With ``document-start: {present: yes}``
|
#. With ``document-start: {present: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
@@ -45,7 +45,7 @@ Use this rule to require or forbid the use of document start marker (``---``).
|
|||||||
- this
|
- this
|
||||||
- is: another one
|
- is: another one
|
||||||
|
|
||||||
#. With ``document-start: {present: no}``
|
#. With ``document-start: {present: false}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -25,12 +25,12 @@ Use this rule to control the indentation.
|
|||||||
same within the file.
|
same within the file.
|
||||||
* ``indent-sequences`` defines whether block sequences should be indented or
|
* ``indent-sequences`` defines whether block sequences should be indented or
|
||||||
not (when in a mapping, this indentation is not mandatory -- some people
|
not (when in a mapping, this indentation is not mandatory -- some people
|
||||||
perceive the ``-`` as part of the indentation). Possible values: ``yes``,
|
perceive the ``-`` as part of the indentation). Possible values: ``true``,
|
||||||
``no``, ``whatever`` and ``consistent``. ``consistent`` requires either all
|
``false``, ``whatever`` and ``consistent``. ``consistent`` requires either
|
||||||
block sequences to be indented, or none to be. ``whatever`` means either
|
all block sequences to be indented, or none to be. ``whatever`` means either
|
||||||
indenting or not indenting individual block sequences is OK.
|
indenting or not indenting individual block sequences is OK.
|
||||||
* ``check-multi-line-strings`` defines whether to lint indentation in
|
* ``check-multi-line-strings`` defines whether to lint indentation in
|
||||||
multi-line strings. Set to ``yes`` to enable, ``no`` to disable.
|
multi-line strings. Set to ``true`` to enable, ``false`` to disable.
|
||||||
|
|
||||||
.. rubric:: Examples
|
.. rubric:: Examples
|
||||||
|
|
||||||
@@ -99,7 +99,7 @@ Use this rule to control the indentation.
|
|||||||
Russian:
|
Russian:
|
||||||
dolls
|
dolls
|
||||||
|
|
||||||
#. With ``indentation: {spaces: 2, indent-sequences: no}``
|
#. With ``indentation: {spaces: 2, indent-sequences: false}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
@@ -152,7 +152,7 @@ Use this rule to control the indentation.
|
|||||||
- spaghetti
|
- spaghetti
|
||||||
- sauce
|
- sauce
|
||||||
|
|
||||||
#. With ``indentation: {spaces: 4, check-multi-line-strings: yes}``
|
#. With ``indentation: {spaces: 4, check-multi-line-strings: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
@@ -469,7 +469,19 @@ def _check(conf, token, prev, next, nextnext, context):
|
|||||||
if context['indent-sequences'] is False:
|
if context['indent-sequences'] is False:
|
||||||
indent = context['stack'][-1].indent
|
indent = context['stack'][-1].indent
|
||||||
elif context['indent-sequences'] is True:
|
elif context['indent-sequences'] is True:
|
||||||
indent = detect_indent(context['stack'][-1].indent, next)
|
if (context['spaces'] == 'consistent' and
|
||||||
|
next.start_mark.column -
|
||||||
|
context['stack'][-1].indent == 0):
|
||||||
|
# In this case, the block sequence item is not indented
|
||||||
|
# (while it should be), but we don't know yet the
|
||||||
|
# indentation it should have (because `spaces` is
|
||||||
|
# `consistent` and its value has not been computed yet
|
||||||
|
# -- this is probably the beginning of the document).
|
||||||
|
# So we choose an arbitrary value (2).
|
||||||
|
indent = 2
|
||||||
|
else:
|
||||||
|
indent = detect_indent(context['stack'][-1].indent,
|
||||||
|
next)
|
||||||
else: # 'whatever' or 'consistent'
|
else: # 'whatever' or 'consistent'
|
||||||
if next.start_mark.column == context['stack'][-1].indent:
|
if next.start_mark.column == context['stack'][-1].indent:
|
||||||
# key:
|
# key:
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Use this rule to set a limit to lines length.
|
|||||||
* ``max`` defines the maximal (inclusive) length of lines.
|
* ``max`` defines the maximal (inclusive) length of lines.
|
||||||
* ``allow-non-breakable-words`` is used to allow non breakable words (without
|
* ``allow-non-breakable-words`` is used to allow non breakable words (without
|
||||||
spaces inside) to overflow the limit. This is useful for long URLs, for
|
spaces inside) to overflow the limit. This is useful for long URLs, for
|
||||||
instance. Use ``yes`` to allow, ``no`` to forbid.
|
instance. Use ``true`` to allow, ``false`` to forbid.
|
||||||
* ``allow-non-breakable-inline-mappings`` implies ``allow-non-breakable-words``
|
* ``allow-non-breakable-inline-mappings`` implies ``allow-non-breakable-words``
|
||||||
and extends it to also allow non-breakable words in inline mappings.
|
and extends it to also allow non-breakable words in inline mappings.
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Use this rule to set a limit to lines length.
|
|||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
|
||||||
tempor incididunt ut labore et dolore magna aliqua.
|
tempor incididunt ut labore et dolore magna aliqua.
|
||||||
|
|
||||||
#. With ``line-length: {max: 60, allow-non-breakable-words: yes}``
|
#. With ``line-length: {max: 60, allow-non-breakable-words: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
@@ -68,15 +68,15 @@ Use this rule to set a limit to lines length.
|
|||||||
|
|
||||||
- foobar: http://localhost/very/very/very/very/very/very/very/very/long/url
|
- foobar: http://localhost/very/very/very/very/very/very/very/very/long/url
|
||||||
|
|
||||||
#. With ``line-length: {max: 60, allow-non-breakable-words: yes,
|
#. With ``line-length: {max: 60, allow-non-breakable-words: true,
|
||||||
allow-non-breakable-inline-mappings: yes}``
|
allow-non-breakable-inline-mappings: true}``
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
the following code snippet would **PASS**:
|
||||||
::
|
::
|
||||||
|
|
||||||
- foobar: http://localhost/very/very/very/very/very/very/very/very/long/url
|
- foobar: http://localhost/very/very/very/very/very/very/very/very/long/url
|
||||||
|
|
||||||
#. With ``line-length: {max: 60, allow-non-breakable-words: no}``
|
#. With ``line-length: {max: 60, allow-non-breakable-words: false}``
|
||||||
|
|
||||||
the following code snippet would **FAIL**:
|
the following code snippet would **FAIL**:
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -17,9 +17,9 @@
|
|||||||
"""
|
"""
|
||||||
Use this rule to forbid truthy values that are not quoted nor explicitly typed.
|
Use this rule to forbid truthy values that are not quoted nor explicitly typed.
|
||||||
|
|
||||||
This would prevent YAML parsers to tranform ``[yes, FALSE, Off]`` into ``[true,
|
This would prevent YAML parsers from transforming ``[yes, FALSE, Off]`` into
|
||||||
false, false]`` or ``{y: 1, yes: 2, on: 3, true: 4, True: 5}`` into ``{y: 1,
|
``[true, false, false]`` or ``{y: 1, yes: 2, on: 3, true: 4, True: 5}`` into
|
||||||
true: 5}``.
|
``{y: 1, true: 5}``.
|
||||||
|
|
||||||
.. rubric:: Examples
|
.. rubric:: Examples
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user