yamllint version 1.6.0

Use the `--strict` flag to check all rules on local YAML files, to
prevent all problems (including warnings). This includes the newly added
`truthy` rule.

.travis.yml

@@ -11,7 +11,7 @@ install:
   - pip install .
 script:
   - flake8 .
-  - yamllint $(git ls-files '*.yaml' '*.yml')
+  - yamllint --strict $(git ls-files '*.yaml' '*.yml')
   - coverage run --source=yamllint setup.py test
 after_success:
   coveralls

README.rst

@@ -44,7 +44,7 @@ On Fedora / CentOS:
 
  sudo dnf install yamllint
 
-On Debian 9+ / Ubuntu 16.04+:
+On Debian 8+ / Ubuntu 16.04+:
 
 .. code:: bash
 

docs/configuration.rst

@@ -102,8 +102,15 @@ Errors and 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
-``standard`` output format), but the exit code can be different. More precisely,
-the script will exit will a failure code *only when* there is one or more
-error(s).
+By default the script will exit with a return code ``1`` *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

docs/quickstart.rst

@@ -10,7 +10,7 @@ On Fedora / CentOS:
 
  sudo dnf install yamllint
 
-On Debian 9+ / Ubuntu 16.04+:
+On Debian 8+ / Ubuntu 16.04+:
 
 .. code:: bash
 

docs/rules.rst

@@ -93,3 +93,8 @@ trailing-spaces
 ---------------
 
 .. automodule:: yamllint.rules.trailing_spaces
+
+truthy
+---------------
+
+.. automodule:: yamllint.rules.truthy

setup.cfg

@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal = 1

setup.py

@@ -42,7 +42,7 @@ setup(
         'Topic :: Software Development :: Testing',
     ],
 
-    packages=find_packages(),
+    packages=find_packages(exclude=['tests', 'tests.*']),
     entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
     package_data={'yamllint': ['conf/*.yaml'],
                   'tests': ['yaml-1.2-spec-examples/*']},

tests/rules/test_comments.py

@@ -43,7 +43,7 @@ class CommentsTestCase(RuleTestCase):
 
     def test_starting_space(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: -1\n'
                 'comments-indentation: disable\n')
         self.check('---\n'
@@ -82,7 +82,7 @@ class CommentsTestCase(RuleTestCase):
 
     def test_spaces_from_content(self):
         conf = ('comments:\n'
-                '  require-starting-space: no\n'
+                '  require-starting-space: false\n'
                 '  min-spaces-from-content: 2\n')
         self.check('---\n'
                    '# comment\n'
@@ -104,7 +104,7 @@ class CommentsTestCase(RuleTestCase):
 
     def test_both(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: 2\n'
                 'comments-indentation: disable\n')
         self.check('---\n'
@@ -134,7 +134,7 @@ class CommentsTestCase(RuleTestCase):
 
     def test_empty_comment(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: 2\n')
         self.check('---\n'
                    '# This is paragraph 1.\n'
@@ -146,13 +146,13 @@ class CommentsTestCase(RuleTestCase):
 
     def test_first_line(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: 2\n')
         self.check('# comment\n', conf)
 
     def test_last_line(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: 2\n'
                 'new-line-at-end-of-file: disable\n')
         self.check('# comment with no newline char:\n'
@@ -160,7 +160,7 @@ class CommentsTestCase(RuleTestCase):
 
     def test_multi_line_scalar(self):
         conf = ('comments:\n'
-                '  require-starting-space: yes\n'
+                '  require-starting-space: true\n'
                 '  min-spaces-from-content: 2\n'
                 'trailing-spaces: disable\n')
         self.check('---\n'

tests/rules/test_comments_indentation.py

@@ -102,13 +102,13 @@ class CommentsIndentationTestCase(RuleTestCase):
                    '  a: 1\n'
                    '  # b: 2\n'
                    '# this object is useless\n'
-                   'obj2: no\n', conf)
+                   'obj2: "no"\n', conf)
         self.check('---\n'
                    'obj1:\n'
                    '  a: 1\n'
                    '# this object is useless\n'
                    '  # b: 2\n'
-                   'obj2: no\n', conf, problem=(5, 3))
+                   'obj2: "no"\n', conf, problem=(5, 3))
         self.check('---\n'
                    'obj1:\n'
                    '  a: 1\n'

tests/rules/test_document_end.py

@@ -31,7 +31,7 @@ class DocumentEndTestCase(RuleTestCase):
                    '  document: end\n', conf)
 
     def test_required(self):
-        conf = 'document-end: {present: yes}'
+        conf = 'document-end: {present: true}'
         self.check('', conf)
         self.check('\n', conf)
         self.check('---\n'
@@ -43,7 +43,7 @@ class DocumentEndTestCase(RuleTestCase):
                    '  document: end\n', conf, problem=(3, 1))
 
     def test_forbidden(self):
-        conf = 'document-end: {present: no}'
+        conf = 'document-end: {present: false}'
         self.check('---\n'
                    'with:\n'
                    '  document: end\n'
@@ -53,7 +53,7 @@ class DocumentEndTestCase(RuleTestCase):
                    '  document: end\n', conf)
 
     def test_multiple_documents(self):
-        conf = ('document-end: {present: yes}\n'
+        conf = ('document-end: {present: true}\n'
                 'document-start: disable\n')
         self.check('---\n'
                    'first: document\n'

tests/rules/test_document_start.py

@@ -28,7 +28,7 @@ class DocumentStartTestCase(RuleTestCase):
                    'key: val\n', conf)
 
     def test_required(self):
-        conf = ('document-start: {present: yes}\n'
+        conf = ('document-start: {present: true}\n'
                 'empty-lines: disable\n')
         self.check('', conf)
         self.check('\n', conf)
@@ -44,7 +44,7 @@ class DocumentStartTestCase(RuleTestCase):
                    'key: val\n', conf)
 
     def test_forbidden(self):
-        conf = ('document-start: {present: no}\n'
+        conf = ('document-start: {present: false}\n'
                 'empty-lines: disable\n')
         self.check('', conf)
         self.check('key: val\n', conf)
@@ -62,7 +62,7 @@ class DocumentStartTestCase(RuleTestCase):
                    'key: val\n', conf, problem=(2, 1))
 
     def test_multiple_documents(self):
-        conf = 'document-start: {present: yes}'
+        conf = 'document-start: {present: true}'
         self.check('---\n'
                    'first: document\n'
                    '...\n'
@@ -85,7 +85,7 @@ class DocumentStartTestCase(RuleTestCase):
                    'third: document\n', conf, problem=(4, 1, 'syntax'))
 
     def test_directives(self):
-        conf = 'document-start: {present: yes}'
+        conf = 'document-start: {present: true}'
         self.check('%YAML 1.2\n'
                    '---\n'
                    'doc: ument\n'

tests/rules/test_indentation.py

@@ -549,7 +549,7 @@ class IndentationTestCase(RuleTestCase):
                    '...\n', conf)
 
     def test_one_space(self):
-        conf = 'indentation: {spaces: 1, indent-sequences: no}'
+        conf = 'indentation: {spaces: 1, indent-sequences: false}'
         self.check('---\n'
                    'object:\n'
                    ' k1:\n'
@@ -562,7 +562,7 @@ class IndentationTestCase(RuleTestCase):
                    ' - name: Linux\n'
                    '   date: 1991\n'
                    '...\n', conf)
-        conf = 'indentation: {spaces: 1, indent-sequences: yes}'
+        conf = 'indentation: {spaces: 1, indent-sequences: true}'
         self.check('---\n'
                    'object:\n'
                    ' k1:\n'
@@ -577,7 +577,7 @@ class IndentationTestCase(RuleTestCase):
                    '...\n', conf)
 
     def test_two_spaces(self):
-        conf = 'indentation: {spaces: 2, indent-sequences: no}'
+        conf = 'indentation: {spaces: 2, indent-sequences: false}'
         self.check('---\n'
                    'object:\n'
                    '  k1:\n'
@@ -590,7 +590,7 @@ class IndentationTestCase(RuleTestCase):
                    '  - name: Linux\n'
                    '    date: 1991\n'
                    '...\n', conf)
-        conf = 'indentation: {spaces: 2, indent-sequences: yes}'
+        conf = 'indentation: {spaces: 2, indent-sequences: true}'
         self.check('---\n'
                    'object:\n'
                    '  k1:\n'
@@ -605,7 +605,7 @@ class IndentationTestCase(RuleTestCase):
                    '...\n', conf)
 
     def test_three_spaces(self):
-        conf = 'indentation: {spaces: 3, indent-sequences: no}'
+        conf = 'indentation: {spaces: 3, indent-sequences: false}'
         self.check('---\n'
                    'object:\n'
                    '   k1:\n'
@@ -618,7 +618,7 @@ class IndentationTestCase(RuleTestCase):
                    '   - name: Linux\n'
                    '     date: 1991\n'
                    '...\n', conf)
-        conf = 'indentation: {spaces: 3, indent-sequences: yes}'
+        conf = 'indentation: {spaces: 3, indent-sequences: true}'
         self.check('---\n'
                    'object:\n'
                    '   k1:\n'
@@ -1130,7 +1130,7 @@ class IndentationTestCase(RuleTestCase):
                    problem=(2, 3))
 
     def test_multi_lines(self):
-        conf = 'indentation: {spaces: consistent, indent-sequences: yes}'
+        conf = 'indentation: {spaces: consistent, indent-sequences: true}'
         self.check('---\n'
                    'long_string: >\n'
                    '  bla bla blah\n'
@@ -1438,7 +1438,7 @@ class IndentationTestCase(RuleTestCase):
                    '- !!map  # Block collection\n'
                    '  foo: bar\n', conf)
 
-        conf = 'indentation: {spaces: consistent, indent-sequences: no}'
+        conf = 'indentation: {spaces: consistent, indent-sequences: false}'
         self.check('---\n'
                    'sequence: !!seq\n'
                    '- entry\n'
@@ -1505,7 +1505,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_basics_plain(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: no}\n'
+                '              check-multi-line-strings: false}\n'
                 'document-start: disable\n')
         self.check('multi\n'
                    'line\n', conf)
@@ -1534,7 +1534,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_check_multi_line_plain(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('multi\n'
                    ' line\n', conf, problem=(2, 2))
@@ -1557,7 +1557,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_basics_quoted(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: no}\n'
+                '              check-multi-line-strings: false}\n'
                 'document-start: disable\n')
         self.check('"multi\n'
                    ' line"\n', conf)
@@ -1588,7 +1588,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_check_multi_line_quoted(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('"multi\n'
                    'line"\n', conf, problem=(2, 1))
@@ -1644,7 +1644,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_basics_folded_style(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: no}\n'
+                '              check-multi-line-strings: false}\n'
                 'document-start: disable\n')
         self.check('>\n'
                    '  multi\n'
@@ -1682,7 +1682,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_check_multi_line_folded_style(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('>\n'
                    '  multi\n'
@@ -1723,7 +1723,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_basics_literal_style(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: no}\n'
+                '              check-multi-line-strings: false}\n'
                 'document-start: disable\n')
         self.check('|\n'
                    '  multi\n'
@@ -1761,7 +1761,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_check_multi_line_literal_style(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('|\n'
                    '  multi\n'
@@ -1805,7 +1805,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_paragraph_plain(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('- long text: very "long"\n'
                    '             \'string\' with\n'
@@ -1827,7 +1827,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_paragraph_double_quoted(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('- long text: "very \\"long\\"\n'
                    '              \'string\' with\n'
@@ -1855,7 +1855,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_paragraph_single_quoted(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('- long text: \'very "long"\n'
                    '              \'\'string\'\' with\n'
@@ -1883,7 +1883,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_paragraph_folded(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('- long text: >\n'
                    '    very "long"\n'
@@ -1901,7 +1901,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_paragraph_literal(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('- long text: |\n'
                    '    very "long"\n'
@@ -1919,7 +1919,7 @@ class ScalarIndentationTestCase(RuleTestCase):
 
     def test_consistent(self):
         conf = ('indentation: {spaces: consistent,\n'
-                '              check-multi-line-strings: yes}\n'
+                '              check-multi-line-strings: true}\n'
                 'document-start: disable\n')
         self.check('multi\n'
                    'line\n', conf)

tests/rules/test_line_length.py

@@ -66,7 +66,7 @@ class LineLengthTestCase(RuleTestCase):
         self.check('---\n' + 81 * ' ' + '\n', conf, problem=(2, 81))
 
     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'
                    'this:\n'
@@ -91,7 +91,7 @@ class LineLengthTestCase(RuleTestCase):
                    'long_line: http://localhost/very/very/long/url\n', conf,
                    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'
                    'this:\n'
@@ -116,7 +116,7 @@ class LineLengthTestCase(RuleTestCase):
                    'long_line: http://localhost/very/very/long/url\n'
                    '...\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')
         self.check('---\n'
                    'loooooooooong+word+and+some+space+at+the+end       \n',
@@ -124,7 +124,7 @@ class LineLengthTestCase(RuleTestCase):
 
     def test_non_breakable_inline_mappings(self):
         conf = 'line-length: {max: 20, ' \
-               'allow-non-breakable-inline-mappings: yes}'
+               'allow-non-breakable-inline-mappings: true}'
         self.check('---\n'
                    'long_line: http://localhost/very/very/long/url\n'
                    '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 = ('line-length: {max: 20,'
-                '              allow-non-breakable-inline-mappings: yes}\n'
+                '              allow-non-breakable-inline-mappings: true}\n'
                 'trailing-spaces: disable')
         self.check('---\n'
                    'long_line: and+some+space+at+the+end       \n',
@@ -150,7 +150,7 @@ class LineLengthTestCase(RuleTestCase):
                    conf, problem=(2, 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'
                    'content: |\n'
                    '  {% this line is' + 99 * ' really' + ' long %}\n',

tests/rules/test_truthy.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2016 Peter Ericson
+#
+# 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/>.
+
+from tests.common import RuleTestCase
+
+
+class TruthyTestCase(RuleTestCase):
+    rule_id = 'truthy'
+
+    def test_disabled(self):
+        conf = 'truthy: disable'
+        self.check('---\n'
+                   '1: True\n', conf)
+        self.check('---\n'
+                   'True: 1\n', conf)
+
+    def test_enabled(self):
+        conf = 'truthy: enable\n'
+        self.check('---\n'
+                   '1: True\n'
+                   'True: 1\n',
+                   conf, problem1=(2, 4), problem2=(3, 1))
+        self.check('---\n'
+                   '1: "True"\n'
+                   '"True": 1\n', conf)
+        self.check('---\n'
+                   '[\n'
+                   '  true, false,\n'
+                   '  "false", "FALSE",\n'
+                   '  "true", "True",\n'
+                   '  True, FALSE,\n'
+                   '  on, OFF,\n'
+                   '  NO, Yes\n'
+                   ']\n', conf,
+                   problem1=(6, 3), problem2=(6, 9),
+                   problem3=(7, 3), problem4=(7, 7),
+                   problem5=(8, 3), problem6=(8, 7))
+
+    def test_explicit_types(self):
+        conf = 'truthy: enable\n'
+        self.check('---\n'
+                   'string1: !!str True\n'
+                   'string2: !!str yes\n'
+                   'string3: !!str off\n'
+                   'encoded: !!binary |\n'
+                   '           True\n'
+                   '           OFF\n'
+                   '           pad==\n'  # this decodes as 'N\xbb\x9e8Qii'
+                   'boolean1: !!bool true\n'
+                   'boolean2: !!bool "false"\n'
+                   'boolean3: !!bool FALSE\n'
+                   'boolean4: !!bool True\n'
+                   'boolean5: !!bool off\n'
+                   'boolean6: !!bool NO\n',
+                   conf)

tests/test_cli.py

@@ -40,6 +40,10 @@ class CommandLineTestCase(unittest.TestCase):
                     '- 1   \n'
                     '- 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
         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, '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')],
+             os.path.join(self.wd, 'sub/ok.yaml'),
+             os.path.join(self.wd, 'warn.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))
         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):
         file = os.path.join(self.wd, 'sub', 'ok.yaml')
 

tests/test_config.py

@@ -62,6 +62,45 @@ class SimpleConfigTestCase(unittest.TestCase):
                                   '    max-spaces-after: 1\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):
         class Rule(object):
             ID = 'fake'

tests/test_spec_examples.py

@@ -48,6 +48,7 @@ from tests.common import RuleTestCase
 class SpecificationTestCase(RuleTestCase):
     rule_id = None
 
+
 conf_general = ('document-start: disable\n'
                 'comments: {min-spaces-from-content: 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.19': ('empty-lines: {max-end: 1}\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'),
     'example-6.4': ('trailing-spaces: disable\n'),
     'example-6.5': ('trailing-spaces: disable\n'),
@@ -114,11 +115,13 @@ conf_overrides = {
     'example-8.14': ('colons: {max-spaces-before: 1}\n'),
     'example-8.16': ('indentation: {spaces: 1}\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'),
     'example-8.22': ('indentation: disable\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.9': ('truthy: disable\n'),
 }
 
 files = os.listdir(os.path.join(os.path.dirname(os.path.realpath(__file__)),
@@ -131,6 +134,7 @@ def _gen_test(buffer, conf):
         self.check(buffer, conf)
     return test
 
+
 # The following tests are blacklisted (i.e. will not be checked against
 # yamllint), because pyyaml is currently not able to parse the contents
 # (using yaml.parse()).

yamllint/__init__.py

@@ -22,7 +22,7 @@ indentation, etc."""
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.4.1'
+APP_VERSION = '1.6.0'
 APP_DESCRIPTION = __doc__
 
 __author__ = u'Adrien Vergé'

yamllint/cli.py

@@ -22,6 +22,7 @@ import argparse
 
 from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
 from yamllint.config import YamlLintConfig, YamlLintConfigError
+from yamllint.linter import PROBLEM_LEVELS
 from yamllint import linter
 
 
@@ -85,6 +86,10 @@ def run(argv=None):
     parser.add_argument('-f', '--format',
                         choices=('parsable', 'standard'), default='standard',
                         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',
                         version='%s %s' % (APP_NAME, APP_VERSION))
 
@@ -121,7 +126,7 @@ def run(argv=None):
         print(e, file=sys.stderr)
         sys.exit(-1)
 
-    return_code = 0
+    max_level = 0
 
     for file in find_files_recursively(args.files):
         try:
@@ -143,13 +148,19 @@ def run(argv=None):
 
                         print(Format.standard(problem, file))
 
-                    if return_code == 0 and problem.level == 'error':
-                        return_code = 1
+                    max_level = max(max_level, PROBLEM_LEVELS[problem.level])
 
             if not first and args.format != 'parsable':
                 print('')
         except EnvironmentError as e:
             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)

yamllint/conf/default.yaml

@@ -16,14 +16,14 @@ rules:
     max-spaces-after: 1
   comments:
     level: warning
-    require-starting-space: yes
+    require-starting-space: true
     min-spaces-from-content: 2
   comments-indentation:
     level: warning
   document-end: disable
   document-start:
     level: warning
-    present: yes
+    present: true
   empty-lines:
     max: 2
     max-start: 0
@@ -32,14 +32,16 @@ rules:
     max-spaces-after: 1
   indentation:
     spaces: consistent
-    indent-sequences: yes
-    check-multi-line-strings: no
+    indent-sequences: true
+    check-multi-line-strings: false
   key-duplicates: enable
   line-length:
     max: 80
-    allow-non-breakable-words: yes
-    allow-non-breakable-inline-mappings: no
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: false
   new-line-at-end-of-file: enable
   new-lines:
     type: unix
   trailing-spaces: enable
+  truthy:
+    level: warning

yamllint/conf/relaxed.yaml

@@ -25,4 +25,5 @@ rules:
     indent-sequences: consistent
   line-length:
     level: warning
-    allow-non-breakable-inline-mappings: yes
+    allow-non-breakable-inline-mappings: true
+  truthy: disable

yamllint/linter.py

@@ -21,6 +21,16 @@ import yaml
 from yamllint import parser
 
 
+PROBLEM_LEVELS = {
+    0: None,
+    1: 'warning',
+    2: 'error',
+    None: 0,
+    'warning': 1,
+    'error': 2,
+}
+
+
 class LintProblem(object):
     """Represents a linting problem found by yamllint."""
     def __init__(self, line, column, desc='<no description>', rule=None):

yamllint/rules/__init__.py

@@ -31,6 +31,7 @@ from yamllint.rules import (
     new_line_at_end_of_file,
     new_lines,
     trailing_spaces,
+    truthy,
 )
 
 _RULES = {
@@ -50,6 +51,7 @@ _RULES = {
     new_line_at_end_of_file.ID: new_line_at_end_of_file,
     new_lines.ID: new_lines,
     trailing_spaces.ID: trailing_spaces,
+    truthy.ID: truthy,
 }
 
 

yamllint/rules/comments.py

@@ -20,14 +20,14 @@ Use this rule to control the position and formatting of comments.
 .. rubric:: Options
 
 * 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
   content. It defines the minimal required number of spaces between a comment
   and its preceding content.
 
 .. rubric:: Examples
 
-#. With ``comments: {require-starting-space: yes}``
+#. With ``comments: {require-starting-space: true}``
 
    the following code snippet would **PASS**:
    ::

yamllint/rules/document_end.py

@@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document end marker (``...``).
 
 .. rubric:: Options
 
-* Set ``present`` to ``yes`` when the document end marker is required, or to
-  ``no`` when it is forbidden.
+* Set ``present`` to ``true`` when the document end marker is required, or to
+  ``false`` when it is forbidden.
 
 .. rubric:: Examples
 
-#. With ``document-end: {present: yes}``
+#. With ``document-end: {present: true}``
 
    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
     ...
 
-#. With ``document-end: {present: no}``
+#. With ``document-end: {present: false}``
 
    the following code snippet would **PASS**:
    ::

yamllint/rules/document_start.py

@@ -19,12 +19,12 @@ Use this rule to require or forbid the use of document start marker (``---``).
 
 .. rubric:: Options
 
-* Set ``present`` to ``yes`` when the document start marker is required, or to
-  ``no`` when it is forbidden.
+* Set ``present`` to ``true`` when the document start marker is required, or to
+  ``false`` when it is forbidden.
 
 .. rubric:: Examples
 
-#. With ``document-start: {present: yes}``
+#. With ``document-start: {present: true}``
 
    the following code snippet would **PASS**:
    ::
@@ -45,7 +45,7 @@ Use this rule to require or forbid the use of document start marker (``---``).
     - this
     - is: another one
 
-#. With ``document-start: {present: no}``
+#. With ``document-start: {present: false}``
 
    the following code snippet would **PASS**:
    ::

yamllint/rules/indentation.py

@@ -25,12 +25,12 @@ Use this rule to control the indentation.
   same within the file.
 * ``indent-sequences`` defines whether block sequences should be indented or
   not (when in a mapping, this indentation is not mandatory -- some people
-  perceive the ``-`` as part of the indentation). Possible values: ``yes``,
-  ``no``, ``whatever`` and ``consistent``. ``consistent`` requires either all
-  block sequences to be indented, or none to be. ``whatever`` means either
+  perceive the ``-`` as part of the indentation). Possible values: ``true``,
+  ``false``, ``whatever`` and ``consistent``. ``consistent`` requires either
+  all block sequences to be indented, or none to be. ``whatever`` means either
   indenting or not indenting individual block sequences is OK.
 * ``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
 
@@ -99,7 +99,7 @@ Use this rule to control the indentation.
       Russian:
           dolls
 
-#. With ``indentation: {spaces: 2, indent-sequences: no}``
+#. With ``indentation: {spaces: 2, indent-sequences: false}``
 
    the following code snippet would **PASS**:
    ::
@@ -152,7 +152,7 @@ Use this rule to control the indentation.
       - spaghetti
       - 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**:
    ::

yamllint/rules/line_length.py

@@ -22,7 +22,7 @@ Use this rule to set a limit to lines length.
 * ``max`` defines the maximal (inclusive) length of lines.
 * ``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
-  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``
   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
       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**:
    ::
@@ -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
 
-#. With ``line-length: {max: 60, allow-non-breakable-words: yes,
-   allow-non-breakable-inline-mappings: yes}``
+#. With ``line-length: {max: 60, allow-non-breakable-words: true,
+   allow-non-breakable-inline-mappings: true}``
 
    the following code snippet would **PASS**:
    ::
 
     - 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**:
    ::

yamllint/rules/truthy.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2016 Peter Ericson
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Use this rule to forbid truthy values that are not quoted nor explicitly typed.
+
+This would prevent YAML parsers from transforming ``[yes, FALSE, Off]`` into
+``[true, false, false]`` or ``{y: 1, yes: 2, on: 3, true: 4, True: 5}`` into
+``{y: 1, true: 5}``.
+
+.. rubric:: Examples
+
+#. With ``truthy: {}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    boolean: true
+
+    object: {"True": 1, 1: "True"}
+
+    "yes":  1
+    "on":   2
+    "true": 3
+    "True": 4
+
+     explicit:
+       string1: !!str True
+       string2: !!str yes
+       string3: !!str off
+       encoded: !!binary |
+                  True
+                  OFF
+                  pad==  # this decodes as 'N\xbb\x9e8Qii'
+       boolean1: !!bool true
+       boolean2: !!bool "false"
+       boolean3: !!bool FALSE
+       boolean4: !!bool True
+       boolean5: !!bool off
+       boolean6: !!bool NO
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: {True: 1, 1: True}
+
+   the following code snippet would **FAIL**:
+   ::
+
+    yes:  1
+    on:   2
+    true: 3
+    True: 4
+"""
+
+import yaml
+
+from yamllint.linter import LintProblem
+
+ID = 'truthy'
+TYPE = 'token'
+CONF = {}
+
+TRUTHY = ['YES', 'Yes', 'yes',
+          'NO', 'No', 'no',
+          'TRUE', 'True',  # 'true' is a boolean
+          'FALSE', 'False',  # 'false' is a boolean
+          'ON', 'On', 'on',
+          'OFF', 'Off', 'off']
+
+
+def check(conf, token, prev, next, nextnext, context):
+    if prev and isinstance(prev, yaml.tokens.TagToken):
+        return
+
+    if isinstance(token, yaml.tokens.ScalarToken):
+        if token.value in TRUTHY and token.style is None:
+            yield LintProblem(token.start_mark.line + 1,
+                              token.start_mark.column + 1,
+                              "truthy value is not quoted")