document-end: Fix spurious "missing document end"

DocumentStartToken is preceded by DirectiveToken.

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+import-order-style = pep8
+application-import-names = yamllint
+ignore = W503,W504

.github/workflows/ci.yaml

@@ -0,0 +1,61 @@
+---
+
+name: CI
+
+on:  # yamllint disable-line rule:truthy
+  push:
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Linters
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+      - run:
+          pip install flake8 flake8-import-order sphinx rstcheck[sphinx] doc8
+      - run: pip install .
+      - run: flake8 .
+      - run: doc8 $(git ls-files '*.rst')
+      - run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
+      - run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
+      - run: make -C docs html
+      - name: Check for broken links in documentation
+        run: make -C docs linkcheck
+
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.7'
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Append GitHub Actions system path
+        run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+      - run: pip install coverage
+      - run: pip install .
+      # https://github.com/AndreMiras/coveralls-python-action/issues/18
+      - run: echo -e "[run]\nrelative_files = True" > .coveragerc
+      - run: coverage run -m unittest discover
+      - name: Coveralls
+        uses: AndreMiras/coveralls-python-action@develop

.gitignore

@@ -3,3 +3,5 @@ __pycache__
 /docs/_build
 /dist
 /yamllint.egg-info
+/build
+/.eggs

.travis.yml

@@ -1,24 +0,0 @@
----
-language: python
-python:
-  - 2.6
-  - 2.7
-  - 3.3
-  - 3.4
-  - 3.5
-  - 3.6
-  - nightly
-install:
-  - pip install pyyaml flake8 flake8-import-order coveralls
-  - if [[ $TRAVIS_PYTHON_VERSION == 2.6 ]]; then pip install unittest2; fi
-  - if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then pip install sphinx; fi
-  - pip install .
-script:
-  - if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then flake8 .; fi
-  - yamllint --strict $(git ls-files '*.yaml' '*.yml')
-  - coverage run --source=yamllint setup.py test
-  - if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then
-      python setup.py build_sphinx;
-    fi
-after_success:
-  coveralls

CHANGELOG.rst

@@ -1,26 +1,253 @@
 Changelog
 =========
 
+1.32.0 (2023-05-22)
+-------------------
+
+- Look for configuration file in parent directories
+- Rule ``anchors``: add new option ``forbid-unused-anchors``
+
+1.31.0 (2023-04-21)
+-------------------
+
+- Build: migrate from ``setup.py`` to ``pyproject.toml``
+- Docs: update some outdated URLs
+- Rule ``colons``: prevent error when space before is mandatory
+
+1.30.0 (2023-03-22)
+-------------------
+
+- Rule ``anchors``: add new rule to detect undeclared or duplicated anchors
+- Python API: prevent using ``is_file_ignored()`` with null ``filepath``
+- Docs: fix misleading Python API example
+- Docs: fix plain text code snippet example
+- Docs: update pre-commit hook example
+
+1.29.0 (2023-01-10)
+-------------------
+
+- Add support for Python 3.11, drop support for Python 3.6
+- Rule ``float-values``: fix bug on strings containing fordidden values
+- Stop releasing universal wheels
+- Use proper Python 3 I/O type for file reading
+- Rule ``indentation``: fix ``indent-sequences`` in nested collections
+- Docs: clarify ``disable-line`` and parser errors, give a workaround
+- Refactors to apply some pyupgrade suggestions
+- Allow using a list of strings in ``ignore`` configuration
+- Add ``--list-files`` command line option
+
+1.28.0 (2022-09-12)
+-------------------
+
+- Better compress PNG image in documentation
+- Remove ``__future__`` imports specific to Python 2
+- Remove inheritance from ``object`` specific to Python 2
+- Simplify GitHub Actions example in documentation
+- Update ALE vim plugin link in documentation
+- Update license to latest version of GPLv3
+- Pre-compile disable/enable rules regexes
+- Rule ``quoted-strings``: add ``allow-quoted-quotes`` option
+- Add option ``ignore-from-file`` in config
+
+1.27.1 (2022-07-08)
+-------------------
+
+- Fix failing test on ``key-duplicates`` for old PyYAML versions
+
+1.27.0 (2022-07-08)
+-------------------
+
+- Add support for Python 3.10, drop Python 3.5
+- Fix GitHub Actions workflow
+- Refactor ``--format=auto`` logic
+- Update GitHub format output to use groups
+- Rule ``comments``: allow whitespace after the shebang marker
+- Multiple minor fixes in documentation
+- Configure Sphinx to make man page show up in apropos
+- Attempt to clarify configuration file location in documentation
+- Rule ``key-duplicates``: don't crash on redundant closing brackets or braces
+- Use ``rstcheck`` to lint documentation on the CI
+- Remove UTF-8 headers in Python files, since Python 2 isn't supported
+- Add various tests to increase coverage
+- Rule ``octal-values``: pre-compile regex for performance
+- Add sections for Visual Studio Code and IntelliJ in documentation
+- Rule ``new-lines``: add the ``type: platform`` config option
+- Add the new rule ``float-values``
+
+1.26.3 (2021-08-21)
+-------------------
+
+- Restore runtime dependency ``setuptools`` for Python < 3.8
+
+1.26.2 (2021-08-03)
+-------------------
+
+- Fix ``python_requires`` to comply with PEP 345 and PEP 440
+
+1.26.1 (2021-04-06)
+-------------------
+
+- Remove runtime dependency ``setuptools`` for Python < 3.8
+- Fix ``line_length`` to skip all hash signs starting comment
+
+1.26.0 (2021-01-29)
+-------------------
+
+- End support for Python 2 and Python 3.4, add support for Python 3.9
+- Add ``forbid: non-empty`` option to ``braces`` and ``brackets`` rules
+- Fix ``quoted-strings`` for explicit octal recognition
+- Add documentation for integration with Arcanist
+- Fix typos in changelog and README
+- Stop using deprecated ``python setup.py test`` in tests
+
+1.25.0 (2020-09-29)
+-------------------
+
+- Run tests on Travis both with and without UTF-8 locales
+- Improve documentation with default values to rules with options
+- Improve documentation with a Python API usage example
+- Fix documentation on ``commas`` examples
+- Packaging: move setuptools' configuration from ``setup.py`` to ``setup.cfg``
+- Packaging: add extra info in PyPI metadata
+- Improve documentation on ``yaml-files``
+- Fix ``octal-values`` to prevent detection of ``8`` and ``9`` as octal values
+- Fix ``quoted-strings`` Fix detecting strings with hashtag as requiring quotes
+- Add ``forbid`` configuration to the ``braces`` and ``brackets`` rules
+- Fix runtime dependencies missing ``setuptools``
+- Add a new output format for GitHub Annotations (``--format github``)
+- Fix DOS lines messing with rule IDs in directives
+
+1.24.2 (2020-07-16)
+-------------------
+
+- Add ``locale`` config option and make ``key-ordering`` locale-aware
+
+1.24.1 (2020-07-15)
+-------------------
+
+- Revert ``locale`` config option from version 1.24.0 because of a bug
+
+1.24.0 (2020-07-15)
+-------------------
+
+- Specify config with environment variable ``YAMLLINT_CONFIG_FILE``
+- Fix bug with CRLF in ``new-lines`` and ``require-starting-space``
+- Do not run linter on directories whose names look like YAML files
+- Add ``locale`` config option and make ``key-ordering`` locale-aware
+
+1.23.0 (2020-04-17)
+-------------------
+
+- Allow rules to validate their configuration
+- Add options ``extra-required`` and ``extra-allowed`` to ``quoted-strings``
+
+1.22.1 (2020-04-15)
+-------------------
+
+- Fix ``quoted-strings`` rule with ``only-when-needed`` on corner cases
+
+1.22.0 (2020-04-13)
+-------------------
+
+- Add ``check-keys`` option to the ``truthy`` rule
+- Fix ``quoted-strings`` rule not working on sequences items
+- Sunset Python 2
+
+1.21.0 (2020-03-24)
+-------------------
+
+- Fix ``new-lines`` rule on Python 3 with DOS line endings
+- Fix ``quoted-strings`` rule not working for string values matching scalars
+- Add ``required: only-when-needed`` option to the ``quoted-strings`` rule
+
+1.20.0 (2019-12-26)
+-------------------
+
+- Add --no-warnings option to suppress warning messages
+- Use 'syntax' as rule name upon syntax errors
+
+1.19.0 (2019-11-19)
+-------------------
+
+- Allow disabling all checks for a file with ``# yamllint disable-file``
+
+1.18.0 (2019-10-15)
+-------------------
+
+- Lint ``.yamllint`` config file by default
+- Also read config from ``.yamllint.yml`` and ``.yamllint.yaml``
+- Improve documentation for ``yaml-files``
+- Update documentation for ``pre-commit``
+- Explicitly disable ``empty-values`` and ``octal-values`` rules
+
+1.17.0 (2019-08-12)
+-------------------
+
+- Simplify installation instructions in the README
+- Add OpenBSD installation instructions
+- Make YAML file extensions configurable
+
+1.16.0 (2019-06-07)
+-------------------
+
+- Add FreeBSD installation instructions
+- Fix the ``line`` rule to correctly handle DOS new lines
+- Add the ``allowed-values`` option to the ``truthy`` rule
+- Allow configuration options to be a list of enums
+
+1.15.0 (2019-02-11)
+-------------------
+
+- Allow linting from standard input with ``yamllint -``
+
+1.14.0 (2019-01-14)
+-------------------
+
+- Fix documentation code snippets
+- Drop Python 2.6 and 3.3 support, add Python 3.7 support
+- Update documentation and tests for ``line-length`` + Unicode + Python 2
+- Allow rule configurations to lack options
+- Add a new ``ignore-shebangs`` option for the ``comments`` rule
+
+1.13.0 (2018-11-14)
+-------------------
+
+- Use ``isinstance(x, y)`` instead of ``type(x) == y``
+- Add a new ``-f colored`` option
+- Update documentation about colored output when run from CLI
+
+1.12.1 (2018-10-17)
+-------------------
+
+- Fix the ``quoted-strings`` rule, broken implementation
+- Fix missing documentation for the ``quoted-strings`` rule
+
+1.12.0 (2018-10-04)
+-------------------
+
+- Add a new ``quoted-strings`` rule
+- Update installation documentation for pip, CentOS, Debian, Ubuntu, Mac OS
+
 1.11.1 (2018-04-06)
 -------------------
 
-- Handle merge keys (`<<`) in the `key-duplicates` rule
+- Handle merge keys (``<<``) in the ``key-duplicates`` rule
 - Update documentation about pre-commit
-- Make examples for `ignore` rule clearer
+- Make examples for ``ignore`` rule clearer
 - Clarify documentation on the 'truthy' rule
 - Fix crash in parser due to a change in PyYAML > 3.12
 
 1.11.0 (2018-02-21)
 -------------------
 
-- Add a new `octal-values` rule
+- Add a new ``octal-values`` rule
 
 1.10.0 (2017-11-05)
 -------------------
 
 - Fix colored output on Windows
 - Check documentation compilation on continuous integration
-- Add a new `empty-values` rule
+- Add a new ``empty-values`` rule
 - Make sure test files are included in dist bundle
 - Tests: Use en_US.UTF-8 locale when C.UTF-8 not available
 - Tests: Dynamically detect Python executable path
@@ -28,13 +255,13 @@ Changelog
 1.9.0 (2017-10-16)
 ------------------
 
-- Add a new `key-ordering` rule
+- Add a new ``key-ordering`` rule
 - Fix indentation rule for key following empty list
 
 1.8.2 (2017-10-10)
 ------------------
 
-- Be clearer about the `ignore` conf type
+- Be clearer about the ``ignore`` conf type
 - Update pre-commit hook file
 - Add documentation for pre-commit
 

CONTRIBUTING.rst

@@ -0,0 +1,48 @@
+Contributing
+============
+
+Pull requests are the best way to propose changes to the codebase.
+Contributions are welcome, but they have to meet some criteria.
+
+Pull Request Process
+--------------------
+
+1. Fork this Git repository and create your branch from ``master``.
+
+2. Make sure the tests pass:
+
+   .. code:: bash
+
+    pip install --user .
+    python -m unittest discover  # all tests...
+    python -m unittest tests/rules/test_commas.py  # or just some tests (faster)
+
+3. If you add code that should be tested, add tests.
+
+4. Make sure the linters pass:
+
+   .. code:: bash
+
+    flake8 .
+
+   If you added/modified documentation:
+
+   .. code:: bash
+
+    doc8 $(git ls-files '*.rst')
+
+   If you touched YAML files:
+
+   .. code:: bash
+
+    yamllint --strict $(git ls-files '*.yaml' '*.yml')
+
+5. If relevant, update documentation (either in ``docs`` directly or in rules
+   files themselves).
+
+6. Write a `good commit message
+   <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+   If the pull request has multiple commits, each must be atomic (single
+   irreducible change that makes sense on its own).
+
+7. Then, open a pull request.

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     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/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

MANIFEST.in

@@ -1,4 +0,0 @@
-include LICENSE
-include README.rst
-include docs/*
-include tests/*.py tests/rules/*.py tests/yaml-1.2-spec-examples/*

README.rst

@@ -8,8 +8,8 @@ repetition and cosmetic problems such as lines length, trailing spaces,
 indentation, etc.
 
 .. image::
-   https://travis-ci.org/adrienverge/yamllint.svg?branch=master
+   https://github.com/adrienverge/yamllint/actions/workflows/ci.yaml/badge.svg?branch=master
-   :target: https://travis-ci.org/adrienverge/yamllint
+   :target: https://github.com/adrienverge/yamllint/actions/workflows/ci.yaml?query=branch%3Amaster
    :alt: CI tests status
 .. image::
    https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
@@ -19,7 +19,7 @@ indentation, etc.
    :target: https://yamllint.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation status
 
-Written in Python (compatible with Python 2 & 3).
+Written in Python (compatible with Python 3 only).
 
 Documentation
 -------------
@@ -38,23 +38,15 @@ Screenshot
 Installation
 ^^^^^^^^^^^^
 
-On Fedora / CentOS:
+Using pip, the Python package manager:
 
 .. code:: bash
 
- sudo dnf install yamllint
+ pip install --user yamllint
 
-On Debian 8+ / Ubuntu 16.04+:
+yamllint is also packaged for all major operating systems, see installation
-
+examples (``dnf``, ``apt-get``...) `in the documentation
-.. code:: bash
+<https://yamllint.readthedocs.io/en/stable/quickstart.html>`_.
-
- sudo apt-get install yamllint
-
-Alternatively using pip, the Python package manager:
-
-.. code:: bash
-
- sudo pip install yamllint
 
 Usage
 ^^^^^
@@ -82,7 +74,7 @@ Usage
  # Output a parsable format (for syntax checking in editors like Vim, emacs...)
  yamllint -f parsable file.yaml
 
-`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
+`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
 
 Features
 ^^^^^^^^
@@ -140,7 +132,7 @@ Specific files can be ignored (totally or for some rules only) using a
        *.ignore-trailing-spaces.yaml
        /ascii-art/*
 
-`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
+`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
 
 License
 -------

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # yamllint documentation build configuration file, created by
 # sphinx-quickstart on Thu Jan 21 21:18:52 2016.
 
@@ -6,9 +5,9 @@ import sys
 import os
 from unittest.mock import MagicMock
 
-sys.path.insert(0, os.path.abspath('..'))  # noqa
+sys.path.insert(0, os.path.abspath('..'))
 
-from yamllint import __copyright__, APP_NAME, APP_VERSION
+from yamllint import __copyright__, APP_NAME, APP_VERSION  # noqa
 
 # -- General configuration ------------------------------------------------
 
@@ -21,7 +20,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 project = APP_NAME
-copyright = __copyright__
+copyright = __copyright__.lstrip('Copyright ')
 
 version = APP_VERSION
 release = APP_VERSION
@@ -39,7 +38,7 @@ htmlhelp_basename = 'yamllintdoc'
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'yamllint', '', [u'Adrien Vergé'], 1)
+    ('index', 'yamllint', 'Linter for YAML files', ['Adrien Vergé'], 1)
 ]
 
 # -- Build with sphinx automodule without needing to install third-party libs
@@ -48,7 +47,7 @@ man_pages = [
 class Mock(MagicMock):
     @classmethod
     def __getattr__(cls, name):
-            return MagicMock()
+        return MagicMock()
 
 
 MOCK_MODULES = ['pathspec', 'yaml']

docs/configuration.rst

@@ -14,9 +14,12 @@ To use a custom configuration file, use the ``-c`` option:
 If ``-c`` is not provided, yamllint will look for a configuration file in the
 following locations (by order of preference):
 
-- ``.yamllint`` in the current working directory
+- a file named ``.yamllint``, ``.yamllint.yaml``, or ``.yamllint.yml`` in the
-- ``$XDG_CONFIG_HOME/yamllint/config``
+  current working directory, or a parent directory (the search for this file is
-- ``~/.config/yamllint/config``
+  terminated at the user's home or filesystem root)
+- a filename referenced by ``$YAMLLINT_CONFIG_FILE``, if set
+- a file named ``$XDG_CONFIG_HOME/yamllint/config`` or
+  ``~/.config/yamllint/config``, if present
 
 Finally if no config file is found, the default configuration is applied.
 
@@ -45,9 +48,9 @@ It can be chosen using:
 Extending the default configuration
 -----------------------------------
 
-When writing a custom configuration file, you don't need to redefine every rule.
+When writing a custom configuration file, you don't need to redefine every
-Just extend the ``default`` configuration (or any already-existing configuration
+rule. Just extend the ``default`` configuration (or any already-existing
-file).
+configuration file).
 
 For instance, if you just want to disable the ``comments-indentation`` rule,
 your file could look like this:
@@ -102,11 +105,11 @@ 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``
+The CLI will output them (with different colors when using the ``colored``
-output format).
+output format, or ``auto`` when run from a terminal).
 
-By default the script will exit with a return code ``1`` *only when* there is one or
+By default the script will exit with a return code ``1`` *only when* there is
-more error(s).
+one or more error(s).
 
 However if strict mode is enabled with the ``-s`` (or ``--strict``) option, the
 return code will be:
@@ -115,11 +118,38 @@ return code will be:
  * ``1`` if one or more errors occur
  * ``2`` if no errors occur, but one or more warnings occur
 
+If the script is invoked with the ``--no-warnings`` option, it won't output
+warning level problems, only error level ones.
+
+YAML files extensions
+---------------------
+
+To configure what yamllint should consider as YAML files when listing
+directories, set ``yaml-files`` configuration option. The default is:
+
+.. code-block:: yaml
+
+ yaml-files:
+   - '*.yaml'
+   - '*.yml'
+   - '.yamllint'
+
+The same rules as for ignoring paths apply (``.gitignore``-style path pattern,
+see below).
+
+If you need to know the exact list of files that yamllint would process,
+without really linting them, you can use ``--list-files``:
+
+.. code:: bash
+
+ yamllint --list-files .
+
 Ignoring paths
 --------------
 
 It is possible to exclude specific files or directories, so that the linter
-doesn't process them.
+doesn't process them. They can be provided either as a list of paths, or as a
+bulk string.
 
 You can either totally ignore files (they won't be looked at):
 
@@ -132,6 +162,13 @@ You can either totally ignore files (they won't be looked at):
    all/this/directory/
    *.template.yaml
 
+ # or:
+
+ ignore:
+   - /this/specific/file.yaml
+   - all/this/directory/
+   - '*.template.yaml'
+
 or ignore paths only for specific rules:
 
 .. code-block:: yaml
@@ -144,10 +181,18 @@ or ignore paths only for specific rules:
        /this-file-has-trailing-spaces-but-it-is-OK.yaml
        /generated/*.yaml
 
+ # or:
+
+ rules:
+   trailing-spaces:
+     ignore:
+       - /this-file-has-trailing-spaces-but-it-is-OK.yaml
+       - /generated/*.yaml
+
 Note that this ``.gitignore``-style path pattern allows complex path
 exclusion/inclusion, see the `pathspec README file
-<https://pypi.python.org/pypi/pathspec>`_ for more details.
+<https://pypi.org/project/pathspec/>`_ for more details. Here is a more complex
-Here is a more complex example:
+example:
 
 .. code-block:: yaml
 
@@ -168,3 +213,43 @@ Here is a more complex example:
      ignore: |
        *.ignore-trailing-spaces.yaml
        ascii-art/*
+
+You can also use the ``.gitignore`` file (or any list of files) through:
+
+.. code-block:: yaml
+
+ ignore-from-file: .gitignore
+
+or:
+
+.. code-block:: yaml
+
+ ignore-from-file: [.gitignore, .yamlignore]
+
+.. note:: However, this is mutually exclusive with the ``ignore`` key.
+
+If you need to know the exact list of files that yamllint would process,
+without really linting them, you can use ``--list-files``:
+
+.. code:: bash
+
+ yamllint --list-files .
+
+Setting the locale
+------------------
+
+It is possible to set the ``locale`` option globally. This is passed to Python's
+`locale.setlocale
+<https://docs.python.org/3/library/locale.html#locale.setlocale>`_,
+so an empty string ``""`` will use the system default locale, while e.g.
+``"en_US.UTF-8"`` will use that.
+
+Currently this only affects the ``key-ordering`` rule. The default will order
+by Unicode code point number, while locales will sort case and accents
+properly as well.
+
+.. code-block:: yaml
+
+ extends: default
+
+ locale: en_US.UTF-8

docs/development.rst

@@ -2,7 +2,17 @@ Development
 ===========
 
 yamllint provides both a script and a Python module. The latter can be used to
-write your own linting tools:
+write your own linting tools.
+
+Basic example of running the linter from Python:
+
+.. code-block:: python
+
+   import yamllint
+
+   yaml_config = yamllint.config.YamlLintConfig("extends: default")
+   for p in yamllint.linter.run(open("example.yaml", "r"), yaml_config):
+       print(p.desc, p.line, p.rule)
 
 .. automodule:: yamllint.linter
    :members:

docs/disable_with_comments.rst

@@ -4,9 +4,9 @@ Disable with comments
 Disabling checks for a specific line
 ------------------------------------
 
-To prevent yamllint from reporting problems for a specific line, add a directive
+To prevent yamllint from reporting problems for a specific line, add a
-comment (``# yamllint disable-line ...``) on that line, or on the line above.
+directive comment (``# yamllint disable-line ...``) on that line, or on the
-For instance:
+line above. For instance:
 
 .. code-block:: yaml
 
@@ -40,15 +40,20 @@ specific line:
  # yamllint disable-line
  -  {    all : rules ,are disabled   for this line}
 
+You can't make yamllint ignore invalid YAML syntax on a line (which generates a
+`syntax error`), such as when templating a YAML file with Jinja. In some cases,
+you can workaround this by putting the templating syntax in a YAML comment. See
+`Putting template flow control in comments`_.
+
 If you need to disable multiple rules, it is allowed to chain rules like this:
 ``# yamllint disable-line rule:hyphens rule:commas rule:indentation``.
 
 Disabling checks for all (or part of) the file
 ----------------------------------------------
 
-To prevent yamllint from reporting problems for the whole file, or for a block of
+To prevent yamllint from reporting problems for the whole file, or for a block
-lines within the file, use ``# yamllint disable ...`` and ``# yamllint enable
+of lines within the file, use ``# yamllint disable ...`` and ``# yamllint
-...`` directive comments. For instance:
+enable ...`` directive comments. For instance:
 
 .. code-block:: yaml
 
@@ -73,3 +78,59 @@ It is possible, although not recommend, to disabled **all** rules:
 
 If you need to disable multiple rules, it is allowed to chain rules like this:
 ``# yamllint disable rule:hyphens rule:commas rule:indentation``.
+
+Disabling all checks for a file
+-------------------------------
+
+To prevent yamllint from reporting problems for a specific file, add the
+directive comment ``# yamllint disable-file`` as the first line of the file.
+For instance:
+
+.. code-block:: yaml
+
+ # yamllint disable-file
+ # The following mapping contains the same key twice, but I know what I'm doing:
+ key: value 1
+ key: value 2
+
+ - This line is waaaaaaaaaay too long but yamllint will not report anything about it.
+
+or:
+
+.. code-block:: jinja
+
+ # yamllint disable-file
+ # This file is not valid YAML because it is a Jinja template
+ {% if extra_info %}
+ key1: value1
+ {% endif %}
+ key2: value2
+
+Putting template flow control in comments
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Alternatively for templating you can wrap the template statements in comments
+to make it a valid YAML file. As long as the templating language doesn't use
+the same comment symbol, it should be a valid template and valid YAML (pre and
+post-template processing).
+
+Example of a Jinja2 code that cannot be parsed as YAML because it contains
+invalid tokens ``{%`` and ``%}``:
+
+.. code-block:: text
+
+ # This file IS NOT valid YAML and will produce syntax errors
+ {% if extra_info %}
+ key1: value1
+ {% endif %}
+ key2: value2
+
+But it can be fixed using YAML comments:
+
+.. code-block:: yaml
+
+ # This file IS valid YAML because the Jinja is in a YAML comment
+ # {% if extra_info %}
+ key1: value1
+ # {% endif %}
+ key2: value2

docs/index.rst

@@ -11,7 +11,7 @@ Screenshot
 
 .. note::
 
-   The default output format is inspired by `eslint <http://eslint.org/>`_, a
+   The default output format is inspired by `eslint <https://eslint.org/>`_, a
    great linting tool for Javascript.
 
 Table of contents

docs/integration.rst

@@ -4,14 +4,64 @@ Integration with other software
 Integration with pre-commit
 ---------------------------
 
-You can integrate yamllint in `pre-commit <http://pre-commit.com/>`_ tool.
+You can integrate yamllint in the `pre-commit <https://pre-commit.com/>`_ tool.
 Here is an example, to add in your .pre-commit-config.yaml
 
 .. code:: yaml
 
   ---
-  # Update the sha variable with the release version that you want, from the yamllint repo
+  # Update the rev variable with the release version that you want, from the yamllint repo
-  - repo: https://github.com/adrienverge/yamllint.git
+  # You can pass your custom .yamllint with args attribute.
-    sha: v1.8.1
+  repos:
-    hooks:
+    - repo: https://github.com/adrienverge/yamllint.git
-      - id: yamllint
+      rev: v1.29.0
+      hooks:
+        - id: yamllint
+          args: [--strict, -c=/path/to/.yamllint]
+
+
+Integration with GitHub Actions
+-------------------------------
+
+yamllint auto-detects when it's running inside of `GitHub
+Actions <https://github.com/features/actions>`_ and automatically uses the
+suited output format to decorate code with linting errors. You can also force
+the GitHub Actions output with ``yamllint --format github``.
+
+A minimal example workflow using GitHub Actions:
+
+.. code:: yaml
+
+   ---
+   on: push  # yamllint disable-line rule:truthy
+
+   jobs:
+     lint:
+       runs-on: ubuntu-latest
+       steps:
+         - uses: actions/checkout@v3
+
+         - name: Install yamllint
+           run: pip install yamllint
+
+         - name: Lint YAML files
+           run: yamllint .
+
+Integration with Arcanist
+-------------------------
+
+You can configure yamllint to run on ``arc lint``. Here is an example
+``.arclint`` file that makes use of this configuration.
+
+.. code:: json
+
+  {
+    "linters": {
+      "yamllint": {
+        "type": "script-and-regex",
+        "script-and-regex.script": "yamllint",
+        "script-and-regex.regex": "/^(?P<line>\\d+):(?P<offset>\\d+) +(?P<severity>warning|error) +(?P<message>.*) +\\((?P<name>.*)\\)$/m",
+        "include": "(\\.(yml|yaml)$)"
+      }
+    }
+  }

docs/quickstart.rst

@@ -4,7 +4,8 @@ Quickstart
 Installing yamllint
 -------------------
 
-On Fedora / CentOS:
+On Fedora / CentOS (note: `EPEL <https://docs.fedoraproject.org/en-US/epel/>`_ is
+required on CentOS):
 
 .. code:: bash
 
@@ -16,25 +17,36 @@ On Debian 8+ / Ubuntu 16.04+:
 
  sudo apt-get install yamllint
 
-On older Debian / Ubuntu versions:
+On Mac OS 10.11+:
 
 .. code:: bash
 
- sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
+ brew install yamllint
- sudo apt-get install yamllint
+
+On FreeBSD:
+
+.. code:: sh
+
+  pkg install py36-yamllint
+
+On OpenBSD:
+
+.. code:: sh
+
+  doas pkg_add py3-yamllint
 
 Alternatively using pip, the Python package manager:
 
 .. code:: bash
 
- sudo pip install yamllint
+ pip install --user yamllint
 
 If you prefer installing from source, you can run, from the source directory:
 
 .. code:: bash
 
- python setup.py sdist
+ python -m build
- sudo pip install dist/yamllint-*.tar.gz
+ pip install --user dist/yamllint-*.tar.gz
 
 Running yamllint
 ----------------
@@ -51,6 +63,12 @@ You can also lint all YAML files in a whole directory:
 
  yamllint .
 
+Or lint a YAML stream from standard input:
+
+.. code:: bash
+
+ echo -e 'this: is\nvalid: YAML' | yamllint -
+
 The output will look like (colors are not displayed here):
 
 ::
@@ -69,6 +87,10 @@ The output will look like (colors are not displayed here):
    10:1      error    too many blank lines (4 > 2)  (empty-lines)
    11:4      error    too many spaces inside braces  (braces)
 
+By default, the output of yamllint is colored when run from a terminal, and
+pure text in other cases. Add the ``-f standard`` arguments to force
+non-colored output. Use the ``-f colored`` arguments to force colored output.
+
 Add the ``-f parsable`` arguments if you need an output format parsable by a
 machine (for instance for :doc:`syntax highlighting in text editors
 <text_editors>`). The output will then look like:

docs/rules.rst

@@ -14,6 +14,11 @@ This page describes the rules and their options.
    :local:
    :depth: 1
 
+anchors
+-------
+
+.. automodule:: yamllint.rules.anchors
+
 braces
 ------
 
@@ -64,6 +69,12 @@ empty-values
 
 .. automodule:: yamllint.rules.empty_values
 
+float-values
+------------
+
+.. automodule:: yamllint.rules.float_values
+
+
 hyphens
 -------
 
@@ -104,6 +115,11 @@ octal-values
 
 .. automodule:: yamllint.rules.octal_values
 
+quoted-strings
+--------------
+
+.. automodule:: yamllint.rules.quoted_strings
+
 trailing-spaces
 ---------------
 

docs/text_editors.rst

@@ -9,11 +9,11 @@ text editor.
 Vim
 ---
 
-Assuming that the `ALE <https://github.com/w0rp/ale>`_ plugin is
+Assuming that the `ALE <https://github.com/dense-analysis/ale>`_ plugin is
 installed, yamllint is supported by default. It is automatically enabled when
 editing YAML files.
 
-If you instead use the `syntastic <https://github.com/scrooloose/syntastic>`_
+If you instead use the `syntastic <https://github.com/vim-syntastic/syntastic>`_
 plugin, add this to your ``.vimrc``:
 
 ::
@@ -23,7 +23,7 @@ plugin, add this to your ``.vimrc``:
 Neovim
 ------
 
-Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
+Assuming that the `neomake <https://github.com/neomake/neomake>`_ plugin is
 installed, yamllint is supported by default. It is automatically enabled when
 editing YAML files.
 
@@ -33,6 +33,16 @@ Emacs
 If you are `flycheck <https://github.com/flycheck/flycheck>`_ user, you can use
 `flycheck-yamllint <https://github.com/krzysztof-magosa/flycheck-yamllint>`_ integration.
 
+Visual Studio Code
+------------------
+
+https://marketplace.visualstudio.com/items?itemName=fnando.linter
+
+IntelliJ
+--------
+
+https://plugins.jetbrains.com/plugin/15349-yamllint
+
 Other text editors
 ------------------
 

pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "yamllint"
+description = "A linter for YAML files."
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">=3.7"
+license = {text = "GPL-3.0-or-later"}
+authors = [{name = "Adrien Vergé"}]
+keywords = ["yaml", "lint", "linter", "syntax", "checker"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Debuggers",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = [
+    "pathspec >= 0.5.3",
+    "pyyaml",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+    "doc8",
+    "flake8",
+    "flake8-import-order",
+    "rstcheck[sphinx]",
+    "sphinx",
+]
+
+[project.scripts]
+yamllint = "yamllint.cli:run"
+
+[project.urls]
+homepage = "https://github.com/adrienverge/yamllint"
+repository = "https://github.com/adrienverge/yamllint"
+documentation = "https://yamllint.readthedocs.io"
+
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools >= 61"]
+
+[tool.setuptools]
+packages = ["yamllint", "yamllint.conf", "yamllint.rules"]
+
+[tool.setuptools.package-data]
+yamllint = ["conf/*.yaml"]
+
+[tool.setuptools.dynamic]
+version = {attr = "yamllint.__version__"}

setup.cfg

@@ -1,12 +0,0 @@
-[bdist_wheel]
-universal = 1
-
-[flake8]
-import-order-style = pep8
-application-import-names = yamllint
-
-[build_sphinx]
-all-files = 1
-source-dir = docs
-build-dir = docs/_build
-warning-is-error = 1

setup.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,37 +13,8 @@
 # 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 setuptools import setup, find_packages
+from setuptools import setup
 
-from yamllint import (__author__, __license__,
+# This is only kept for backward-compatibility with older versions that don't
-                      APP_NAME, APP_VERSION, APP_DESCRIPTION)
+# support new packaging standards (e.g. PEP 517 or PEP 660):
-
+setup()
-
-setup(
-    name=APP_NAME,
-    version=APP_VERSION,
-    author=__author__,
-    description=APP_DESCRIPTION.split('\n')[0],
-    long_description=APP_DESCRIPTION,
-    license=__license__,
-    keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
-    url='https://github.com/adrienverge/yamllint',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Environment :: Console',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 3',
-        'Topic :: Software Development',
-        'Topic :: Software Development :: Debuggers',
-        'Topic :: Software Development :: Quality Assurance',
-        'Topic :: Software Development :: Testing',
-    ],
-
-    packages=find_packages(exclude=['tests', 'tests.*']),
-    entry_points={'console_scripts': ['yamllint=yamllint.cli:run']},
-    package_data={'yamllint': ['conf/*.yaml']},
-    install_requires=['pathspec >=0.5.3', 'pyyaml'],
-    test_suite='tests',
-)

tests/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/common.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,14 +13,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import contextlib
 import os
+import shutil
 import tempfile
-import sys
+import unittest
-try:
-    assert sys.version_info >= (2, 7)
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
 import yaml
 
@@ -62,7 +58,7 @@ def build_temp_workspace(files):
     tempdir = tempfile.mkdtemp(prefix='yamllint-tests-')
 
     for path, content in files.items():
-        path = os.path.join(tempdir, path)
+        path = os.path.join(tempdir, path).encode('utf-8')
         if not os.path.exists(os.path.dirname(path)):
             os.makedirs(os.path.dirname(path))
 
@@ -74,3 +70,17 @@ def build_temp_workspace(files):
                 f.write(content)
 
     return tempdir
+
+
+@contextlib.contextmanager
+def temp_workspace(files):
+    """Provide a temporary workspace that is automatically cleaned up."""
+    backup_wd = os.getcwd()
+    wd = build_temp_workspace(files)
+
+    try:
+        os.chdir(wd)
+        yield
+    finally:
+        os.chdir(backup_wd)
+        shutil.rmtree(wd)

tests/rules/test_anchors.py

@@ -0,0 +1,281 @@
+# Copyright (C) 2023 Adrien Vergé
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from tests.common import RuleTestCase
+
+
+class AnchorsTestCase(RuleTestCase):
+    rule_id = 'anchors'
+
+    def test_disabled(self):
+        conf = 'anchors: disable'
+        self.check('---\n'
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- &f_m {k: v}\n'
+                   '- &f_s [1, 2]\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '- *f_m\n'
+                   '- *f_s\n'
+                   '---\n'  # redeclare anchors in a new document
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
+                   '...\n', conf)
+        self.check('---\n'
+                   '- &i 42\n'
+                   '---\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'    # declared in a previous document
+                   '- *f_m\n'  # never declared
+                   '- *f_m\n'
+                   '- *f_m\n'
+                   '- *f_s\n'  # declared after
+                   '- &f_s [1, 2]\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   '---\n'
+                   'block mapping 1: &b_m_bis\n'
+                   '  key: value\n'
+                   'block mapping 2: &b_m_bis\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
+                   '...\n', conf)
+
+    def test_forbid_undeclared_aliases(self):
+        conf = ('anchors:\n'
+                '  forbid-undeclared-aliases: true\n'
+                '  forbid-duplicated-anchors: false\n'
+                '  forbid-unused-anchors: false\n')
+        self.check('---\n'
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- &f_m {k: v}\n'
+                   '- &f_s [1, 2]\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '- *f_m\n'
+                   '- *f_s\n'
+                   '---\n'  # redeclare anchors in a new document
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
+                   '...\n', conf)
+        self.check('---\n'
+                   '- &i 42\n'
+                   '---\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'    # declared in a previous document
+                   '- *f_m\n'  # never declared
+                   '- *f_m\n'
+                   '- *f_m\n'
+                   '- *f_s\n'  # declared after
+                   '- &f_s [1, 2]\n'
+                   '...\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   '---\n'
+                   'block mapping 1: &b_m_bis\n'
+                   '  key: value\n'
+                   'block mapping 2: &b_m_bis\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
+                   '...\n', conf,
+                   problem1=(9, 3),
+                   problem2=(10, 3),
+                   problem3=(11, 3),
+                   problem4=(12, 3),
+                   problem5=(13, 3),
+                   problem6=(25, 7),
+                   problem7=(28, 37))
+
+    def test_forbid_duplicated_anchors(self):
+        conf = ('anchors:\n'
+                '  forbid-undeclared-aliases: false\n'
+                '  forbid-duplicated-anchors: true\n'
+                '  forbid-unused-anchors: false\n')
+        self.check('---\n'
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- &f_m {k: v}\n'
+                   '- &f_s [1, 2]\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '- *f_m\n'
+                   '- *f_s\n'
+                   '---\n'  # redeclare anchors in a new document
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
+                   '...\n', conf)
+        self.check('---\n'
+                   '- &i 42\n'
+                   '---\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'    # declared in a previous document
+                   '- *f_m\n'  # never declared
+                   '- *f_m\n'
+                   '- *f_m\n'
+                   '- *f_s\n'  # declared after
+                   '- &f_s [1, 2]\n'
+                   '...\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   '---\n'
+                   'block mapping 1: &b_m_bis\n'
+                   '  key: value\n'
+                   'block mapping 2: &b_m_bis\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
+                   '...\n', conf,
+                   problem1=(5, 3),
+                   problem2=(6, 3),
+                   problem3=(22, 18),
+                   problem4=(28, 20))
+
+    def test_forbid_unused_anchors(self):
+        conf = ('anchors:\n'
+                '  forbid-undeclared-aliases: false\n'
+                '  forbid-duplicated-anchors: false\n'
+                '  forbid-unused-anchors: true\n')
+
+        self.check('---\n'
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- &f_m {k: v}\n'
+                   '- &f_s [1, 2]\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '- *f_m\n'
+                   '- *f_s\n'
+                   '---\n'  # redeclare anchors in a new document
+                   '- &b true\n'
+                   '- &i 42\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'
+                   '- *s\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
+                   '...\n', conf)
+        self.check('---\n'
+                   '- &i 42\n'
+                   '---\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &b true\n'
+                   '- &s hello\n'
+                   '- *b\n'
+                   '- *i\n'    # declared in a previous document
+                   '- *f_m\n'  # never declared
+                   '- *f_m\n'
+                   '- *f_m\n'
+                   '- *f_s\n'  # declared after
+                   '- &f_s [1, 2]\n'
+                   '...\n'
+                   '---\n'
+                   'block mapping: &b_m\n'
+                   '  key: value\n'
+                   '---\n'
+                   'block mapping 1: &b_m_bis\n'
+                   '  key: value\n'
+                   'block mapping 2: &b_m_bis\n'
+                   '  key: value\n'
+                   'extended:\n'
+                   '  <<: *b_m\n'
+                   '  foo: bar\n'
+                   '---\n'
+                   '{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
+                   '...\n', conf,
+                   problem1=(2, 3),
+                   problem2=(7, 3),
+                   problem3=(14, 3),
+                   problem4=(17, 16),
+                   problem5=(22, 18))

tests/rules/test_braces.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -31,6 +30,60 @@ class ColonTestCase(RuleTestCase):
                    'dict6: {  a: 1, b, c: 3 }\n'
                    'dict7: {   a: 1, b, c: 3 }\n', conf)
 
+    def test_forbid(self):
+        conf = ('braces:\n'
+                '  forbid: false\n')
+        self.check('---\n'
+                   'dict: {}\n', conf)
+        self.check('---\n'
+                   'dict: {a}\n', conf)
+        self.check('---\n'
+                   'dict: {a: 1}\n', conf)
+        self.check('---\n'
+                   'dict: {\n'
+                   '  a: 1\n'
+                   '}\n', conf)
+
+        conf = ('braces:\n'
+                '  forbid: true\n')
+        self.check('---\n'
+                   'dict:\n'
+                   '  a: 1\n', conf)
+        self.check('---\n'
+                   'dict: {}\n', conf, problem=(2, 8))
+        self.check('---\n'
+                   'dict: {a}\n', conf, problem=(2, 8))
+        self.check('---\n'
+                   'dict: {a: 1}\n', conf, problem=(2, 8))
+        self.check('---\n'
+                   'dict: {\n'
+                   '  a: 1\n'
+                   '}\n', conf, problem=(2, 8))
+
+        conf = ('braces:\n'
+                '  forbid: non-empty\n')
+        self.check('---\n'
+                   'dict:\n'
+                   '  a: 1\n', conf)
+        self.check('---\n'
+                   'dict: {}\n', conf)
+        self.check('---\n'
+                   'dict: {\n'
+                   '}\n', conf)
+        self.check('---\n'
+                   'dict: {\n'
+                   '# commented: value\n'
+                   '# another: value2\n'
+                   '}\n', conf)
+        self.check('---\n'
+                   'dict: {a}\n', conf, problem=(2, 8))
+        self.check('---\n'
+                   'dict: {a: 1}\n', conf, problem=(2, 8))
+        self.check('---\n'
+                   'dict: {\n'
+                   '  a: 1\n'
+                   '}\n', conf, problem=(2, 8))
+
     def test_min_spaces(self):
         conf = ('braces:\n'
                 '  max-spaces-inside: -1\n'

tests/rules/test_brackets.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -31,6 +30,58 @@ class ColonTestCase(RuleTestCase):
                    'array6: [  a, b, c ]\n'
                    'array7: [   a, b, c ]\n', conf)
 
+    def test_forbid(self):
+        conf = ('brackets:\n'
+                '  forbid: false\n')
+        self.check('---\n'
+                   'array: []\n', conf)
+        self.check('---\n'
+                   'array: [a, b]\n', conf)
+        self.check('---\n'
+                   'array: [\n'
+                   '  a,\n'
+                   '  b\n'
+                   ']\n', conf)
+
+        conf = ('brackets:\n'
+                '  forbid: true\n')
+        self.check('---\n'
+                   'array:\n'
+                   '  - a\n'
+                   '  - b\n', conf)
+        self.check('---\n'
+                   'array: []\n', conf, problem=(2, 9))
+        self.check('---\n'
+                   'array: [a, b]\n', conf, problem=(2, 9))
+        self.check('---\n'
+                   'array: [\n'
+                   '  a,\n'
+                   '  b\n'
+                   ']\n', conf, problem=(2, 9))
+
+        conf = ('brackets:\n'
+                '  forbid: non-empty\n')
+        self.check('---\n'
+                   'array:\n'
+                   '  - a\n'
+                   '  - b\n', conf)
+        self.check('---\n'
+                   'array: []\n', conf)
+        self.check('---\n'
+                   'array: [\n\n'
+                   ']\n', conf)
+        self.check('---\n'
+                   'array: [\n'
+                   '# a comment\n'
+                   ']\n', conf)
+        self.check('---\n'
+                   'array: [a, b]\n', conf, problem=(2, 9))
+        self.check('---\n'
+                   'array: [\n'
+                   '  a,\n'
+                   '  b\n'
+                   ']\n', conf, problem=(2, 9))
+
     def test_min_spaces(self):
         conf = ('brackets:\n'
                 '  max-spaces-inside: -1\n'

tests/rules/test_colons.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -257,3 +256,19 @@ class ColonTestCase(RuleTestCase):
                    '  property: {a: 1, b:  2, c : 3}\n', conf,
                    problem1=(3, 11), problem2=(4, 4),
                    problem3=(8, 23), problem4=(8, 28))
+
+    # Although accepted by PyYAML, `{*x: 4}` is not valid YAML: it should be
+    # noted `{*x : 4}`. The reason is that a colon can be part of an anchor
+    # name. See commit message for more details.
+    def test_with_alias_as_key(self):
+        conf = 'colons: {max-spaces-before: 0, max-spaces-after: 1}'
+        self.check('---\n'
+                   '- anchor: &a key\n'
+                   '- *a: 42\n'
+                   '- {*a: 42}\n'
+                   '- *a : 42\n'
+                   '- {*a : 42}\n'
+                   '- *a  : 42\n'
+                   '- {*a  : 42}\n',
+                   conf,
+                   problem1=(7, 6), problem2=(8, 7))

tests/rules/test_commas.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_comments.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -80,6 +79,47 @@ class CommentsTestCase(RuleTestCase):
                    problem3=(9, 2), problem4=(10, 4),
                    problem5=(15, 3))
 
+    def test_shebang(self):
+        conf = ('comments:\n'
+                '  require-starting-space: true\n'
+                '  ignore-shebangs: false\n'
+                'comments-indentation: disable\n'
+                'document-start: disable\n')
+        self.check('#!/bin/env my-interpreter\n',
+                   conf, problem1=(1, 2))
+        self.check('# comment\n'
+                   '#!/bin/env my-interpreter\n', conf,
+                   problem1=(2, 2))
+        self.check('#!/bin/env my-interpreter\n'
+                   '---\n'
+                   '#comment\n'
+                   '#!/bin/env my-interpreter\n'
+                   '', conf,
+                   problem1=(1, 2), problem2=(3, 2), problem3=(4, 2))
+        self.check('#! is a valid shebang too\n',
+                   conf, problem1=(1, 2))
+        self.check('key:  #!/not/a/shebang\n',
+                   conf, problem1=(1, 8))
+
+    def test_ignore_shebang(self):
+        conf = ('comments:\n'
+                '  require-starting-space: true\n'
+                '  ignore-shebangs: true\n'
+                'comments-indentation: disable\n'
+                'document-start: disable\n')
+        self.check('#!/bin/env my-interpreter\n', conf)
+        self.check('# comment\n'
+                   '#!/bin/env my-interpreter\n', conf,
+                   problem1=(2, 2))
+        self.check('#!/bin/env my-interpreter\n'
+                   '---\n'
+                   '#comment\n'
+                   '#!/bin/env my-interpreter\n', conf,
+                   problem2=(3, 2), problem3=(4, 2))
+        self.check('#! is a valid shebang too\n', conf)
+        self.check('key:  #!/not/a/shebang\n',
+                   conf, problem1=(1, 8))
+
     def test_spaces_from_content(self):
         conf = ('comments:\n'
                 '  require-starting-space: false\n'
@@ -144,6 +184,27 @@ class CommentsTestCase(RuleTestCase):
                    'inline: comment  #\n'
                    'foo: bar\n', conf)
 
+    def test_empty_comment_crlf_dos_newlines(self):
+        conf = ('comments:\n'
+                '  require-starting-space: true\n'
+                '  min-spaces-from-content: 2\n'
+                'new-lines:\n'
+                '  type: dos\n')
+        self.check('---\r\n'
+                   '# This is paragraph 1.\r\n'
+                   '#\r\n'
+                   '# This is paragraph 2.\r\n', conf)
+
+    def test_empty_comment_crlf_disabled_newlines(self):
+        conf = ('comments:\n'
+                '  require-starting-space: true\n'
+                '  min-spaces-from-content: 2\n'
+                'new-lines: disable\n')
+        self.check('---\r\n'
+                   '# This is paragraph 1.\r\n'
+                   '#\r\n'
+                   '# This is paragraph 2.\r\n', conf)
+
     def test_first_line(self):
         conf = ('comments:\n'
                 '  require-starting-space: true\n'

tests/rules/test_comments_indentation.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_common.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_document_end.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -72,3 +71,22 @@ class DocumentEndTestCase(RuleTestCase):
                    '---\n'
                    'third: document\n'
                    '...\n', conf, problem=(6, 1))
+
+    def test_directives(self):
+        conf = 'document-end: {present: true}'
+        self.check('%YAML 1.2\n'
+                   '---\n'
+                   'document: end\n'
+                   '...\n', conf)
+        self.check('%YAML 1.2\n'
+                   '%TAG ! tag:clarkevans.com,2002:\n'
+                   '---\n'
+                   'document: end\n'
+                   '...\n', conf)
+        self.check('---\n'
+                   'first: document\n'
+                   '...\n'
+                   '%YAML 1.2\n'
+                   '---\n'
+                   'second: document\n'
+                   '...\n', conf)

tests/rules/test_document_start.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_empty_lines.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -78,3 +77,22 @@ class EmptyLinesTestCase(RuleTestCase):
                 'document-start: disable\n')
         self.check('non empty\n', conf)
         self.check('non empty\n\n', conf, problem=(2, 1))
+
+    def test_with_dos_newlines(self):
+        conf = ('empty-lines: {max: 2, max-start: 0, max-end: 0}\n'
+                'new-lines: {type: dos}\n'
+                'document-start: disable\n')
+        self.check('---\r\n', conf)
+        self.check('---\r\ntext\r\n\r\ntext\r\n', conf)
+        self.check('\r\n---\r\ntext\r\n\r\ntext\r\n', conf,
+                   problem=(1, 1))
+        self.check('\r\n\r\n\r\n---\r\ntext\r\n\r\ntext\r\n', conf,
+                   problem=(3, 1))
+        self.check('---\r\ntext\r\n\r\n\r\n\r\ntext\r\n', conf,
+                   problem=(5, 1))
+        self.check('---\r\ntext\r\n\r\n\r\n\r\n\r\n\r\n\r\ntext\r\n', conf,
+                   problem=(8, 1))
+        self.check('---\r\ntext\r\n\r\ntext\r\n\r\n', conf,
+                   problem=(5, 1))
+        self.check('---\r\ntext\r\n\r\ntext\r\n\r\n\r\n\r\n', conf,
+                   problem=(7, 1))

tests/rules/test_empty_values.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Greg Dubicki
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_float_values.py

@@ -0,0 +1,128 @@
+# Copyright (C) 2022 the yamllint contributors
+#
+# 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 FloatValuesTestCase(RuleTestCase):
+    rule_id = 'float-values'
+
+    def test_disabled(self):
+        conf = 'float-values: disable\n'
+        self.check('---\n'
+                   '- 0.0\n'
+                   '- .NaN\n'
+                   '- .INF\n'
+                   '- .1\n'
+                   '- 10e-6\n',
+                   conf)
+
+    def test_numeral_before_decimal(self):
+        conf = (
+            'float-values:\n'
+            '  require-numeral-before-decimal: true\n'
+            '  forbid-scientific-notation: false\n'
+            '  forbid-nan: false\n'
+            '  forbid-inf: false\n')
+        self.check('---\n'
+                   '- 0.0\n'
+                   '- .1\n'
+                   '- \'.1\'\n'
+                   '- string.1\n'
+                   '- .1string\n'
+                   '- !custom_tag .2\n'
+                   '- &angle1 0.0\n'
+                   '- *angle1\n'
+                   '- &angle2 .3\n'
+                   '- *angle2\n',
+                   conf,
+                   problem1=(3, 3),
+                   problem2=(10, 11))
+
+    def test_scientific_notation(self):
+        conf = (
+            'float-values:\n'
+            '  require-numeral-before-decimal: false\n'
+            '  forbid-scientific-notation: true\n'
+            '  forbid-nan: false\n'
+            '  forbid-inf: false\n')
+        self.check('---\n'
+                   '- 10e6\n'
+                   '- 10e-6\n'
+                   '- 0.00001\n'
+                   '- \'10e-6\'\n'
+                   '- string10e-6\n'
+                   '- 10e-6string\n'
+                   '- !custom_tag 10e-6\n'
+                   '- &angle1 0.000001\n'
+                   '- *angle1\n'
+                   '- &angle2 10e-6\n'
+                   '- *angle2\n'
+                   '- &angle3 10e6\n'
+                   '- *angle3\n',
+                   conf,
+                   problem1=(2, 3),
+                   problem2=(3, 3),
+                   problem3=(11, 11),
+                   problem4=(13, 11))
+
+    def test_nan(self):
+        conf = (
+            'float-values:\n'
+            '  require-numeral-before-decimal: false\n'
+            '  forbid-scientific-notation: false\n'
+            '  forbid-nan: true\n'
+            '  forbid-inf: false\n')
+        self.check('---\n'
+                   '- .NaN\n'
+                   '- .NAN\n'
+                   '- \'.NaN\'\n'
+                   '- a.NaN\n'
+                   '- .NaNa\n'
+                   '- !custom_tag .NaN\n'
+                   '- &angle .nan\n'
+                   '- *angle\n',
+                   conf,
+                   problem1=(2, 3),
+                   problem2=(3, 3),
+                   problem3=(8, 10))
+
+    def test_inf(self):
+        conf = (
+            'float-values:\n'
+            '  require-numeral-before-decimal: false\n'
+            '  forbid-scientific-notation: false\n'
+            '  forbid-nan: false\n'
+            '  forbid-inf: true\n')
+        self.check('---\n'
+                   '- .inf\n'
+                   '- .INF\n'
+                   '- -.inf\n'
+                   '- -.INF\n'
+                   '- \'.inf\'\n'
+                   '- ∞.infinity\n'
+                   '- .infinity∞\n'
+                   '- !custom_tag .inf\n'
+                   '- &angle .inf\n'
+                   '- *angle\n'
+                   '- &angle -.inf\n'
+                   '- *angle\n',
+                   conf,
+                   problem1=(2, 3),
+                   problem2=(3, 3),
+                   problem3=(4, 3),
+                   problem4=(5, 3),
+                   problem5=(10, 10),
+                   problem6=(12, 10))

tests/rules/test_hyphens.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_indentation.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -51,8 +50,8 @@ class IndentationStackTestCase(RuleTestCase):
                           .replace('Mapping', 'Map'))
             if token_type in ('StreamStart', 'StreamEnd'):
                 continue
-            output += '%9s %s\n' % (token_type,
+            output += '{:>9} {}\n'.format(token_type,
-                                    self.format_stack(context['stack']))
+                                          self.format_stack(context['stack']))
         return output
 
     def test_simple_mapping(self):
@@ -1371,6 +1370,45 @@ class IndentationTestCase(RuleTestCase):
                    '               key: value\n'
                    '...\n', conf, problem=(2, 2))
 
+    def test_nested_collections_with_spaces_consistent(self):
+        """Tests behavior of {spaces: consistent} in nested collections to
+        ensure wrong-indentation is properly caught--especially when the
+        expected indent value is initially unknown. For details, see
+        https://github.com/adrienverge/yamllint/issues/485.
+        """
+        conf = ('indentation: {spaces: consistent,\n'
+                '              indent-sequences: true}')
+        self.check('---\n'
+                   '- item:\n'
+                   '  - elem\n'
+                   '- item:\n'
+                   '    - elem\n'
+                   '...\n', conf, problem=(3, 3))
+        conf = ('indentation: {spaces: consistent,\n'
+                '              indent-sequences: false}')
+        self.check('---\n'
+                   '- item:\n'
+                   '  - elem\n'
+                   '- item:\n'
+                   '    - elem\n'
+                   '...\n', conf, problem=(5, 5))
+        conf = ('indentation: {spaces: consistent,\n'
+                '              indent-sequences: consistent}')
+        self.check('---\n'
+                   '- item:\n'
+                   '  - elem\n'
+                   '- item:\n'
+                   '    - elem\n'
+                   '...\n', conf, problem=(5, 5))
+        conf = ('indentation: {spaces: consistent,\n'
+                '              indent-sequences: whatever}')
+        self.check('---\n'
+                   '- item:\n'
+                   '  - elem\n'
+                   '- item:\n'
+                   '    - elem\n'
+                   '...\n', conf)
+
     def test_return(self):
         conf = 'indentation: {spaces: consistent}'
         self.check('---\n'

tests/rules/test_key_duplicates.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -87,6 +86,10 @@ class KeyDuplicatesTestCase(RuleTestCase):
                    'anchor_reference:\n'
                    '  <<: *anchor_one\n'
                    '  <<: *anchor_two\n', conf)
+        self.check('---\n'
+                   '{a: 1, b: 2}}\n', conf, problem=(2, 13, 'syntax'))
+        self.check('---\n'
+                   '[a, b, c]]\n', conf, problem=(2, 10, 'syntax'))
 
     def test_enabled(self):
         conf = 'key-duplicates: enable'
@@ -165,6 +168,10 @@ class KeyDuplicatesTestCase(RuleTestCase):
                    'anchor_reference:\n'
                    '  <<: *anchor_one\n'
                    '  <<: *anchor_two\n', conf)
+        self.check('---\n'
+                   '{a: 1, b: 2}}\n', conf, problem=(2, 13, 'syntax'))
+        self.check('---\n'
+                   '[a, b, c]]\n', conf, problem=(2, 10, 'syntax'))
 
     def test_key_tokens_in_flow_sequences(self):
         conf = 'key-duplicates: enable'

tests/rules/test_key_ordering.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Johannes F. Knauf
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,6 +13,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import locale
+
 from tests.common import RuleTestCase
 
 
@@ -103,10 +104,6 @@ class KeyOrderingTestCase(RuleTestCase):
                    'haïr: true\n'
                    'hais: true\n', conf,
                    problem=(3, 1))
-        self.check('---\n'
-                   'haïr: true\n'
-                   'hais: true\n', conf,
-                   problem=(3, 1))
 
     def test_key_tokens_in_flow_sequences(self):
         conf = 'key-ordering: enable'
@@ -114,3 +111,39 @@ class KeyOrderingTestCase(RuleTestCase):
                    '[\n'
                    '  key: value, mappings, in, flow: sequence\n'
                    ']\n', conf)
+
+    def test_locale_case(self):
+        self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
+        try:
+            locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
+        except locale.Error:  # pragma: no cover
+            self.skipTest('locale en_US.UTF-8 not available')
+        conf = ('key-ordering: enable')
+        self.check('---\n'
+                   't-shirt: 1\n'
+                   'T-shirt: 2\n'
+                   't-shirts: 3\n'
+                   'T-shirts: 4\n', conf)
+        self.check('---\n'
+                   't-shirt: 1\n'
+                   't-shirts: 2\n'
+                   'T-shirt: 3\n'
+                   'T-shirts: 4\n', conf,
+                   problem=(4, 1))
+
+    def test_locale_accents(self):
+        self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
+        try:
+            locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
+        except locale.Error:  # pragma: no cover
+            self.skipTest('locale en_US.UTF-8 not available')
+        conf = ('key-ordering: enable')
+        self.check('---\n'
+                   'hair: true\n'
+                   'haïr: true\n'
+                   'hais: true\n'
+                   'haïssable: true\n', conf)
+        self.check('---\n'
+                   'hais: true\n'
+                   'haïr: true\n', conf,
+                   problem=(3, 1))

tests/rules/test_line_length.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -116,6 +115,27 @@ 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: true}'
+        self.check('---\n'
+                   '# http://www.verylongurlurlurlurlurlurlurlurl.com\n'
+                   'key:\n'
+                   '  subkey: value\n', conf)
+        self.check('---\n'
+                   '## http://www.verylongurlurlurlurlurlurlurlurl.com\n'
+                   'key:\n'
+                   '  subkey: value\n', conf)
+        self.check('---\n'
+                   '# # http://www.verylongurlurlurlurlurlurlurlurl.com\n'
+                   'key:\n'
+                   '  subkey: value\n', conf,
+                   problem=(2, 21))
+        self.check('---\n'
+                   '#A http://www.verylongurlurlurlurlurlurlurlurl.com\n'
+                   'key:\n'
+                   '  subkey: value\n', conf,
+                   problem1=(2, 2, 'comments'),
+                   problem2=(2, 21, 'line-length'))
+
         conf = ('line-length: {max: 20, allow-non-breakable-words: true}\n'
                 'trailing-spaces: disable')
         self.check('---\n'
@@ -155,3 +175,24 @@ class LineLengthTestCase(RuleTestCase):
                    'content: |\n'
                    '  {% this line is' + 99 * ' really' + ' long %}\n',
                    conf, problem=(3, 81))
+
+    def test_unicode(self):
+        conf = 'line-length: {max: 53}'
+        self.check('---\n'
+                   '# This is a test to check if “line-length” works nice\n'
+                   'with: “unicode characters” that span across bytes! ↺\n',
+                   conf)
+        conf = 'line-length: {max: 51}'
+        self.check('---\n'
+                   '# This is a test to check if “line-length” works nice\n'
+                   'with: “unicode characters” that span across bytes! ↺\n',
+                   conf, problem1=(2, 52), problem2=(3, 52))
+
+    def test_with_dos_newlines(self):
+        conf = ('line-length: {max: 10}\n'
+                'new-lines: {type: dos}\n'
+                'new-line-at-end-of-file: disable\n')
+        self.check('---\r\nABCD EFGHI', conf)
+        self.check('---\r\nABCD EFGHI\r\n', conf)
+        self.check('---\r\nABCD EFGHIJ', conf, problem=(2, 11))
+        self.check('---\r\nABCD EFGHIJ\r\n', conf, problem=(2, 11))

tests/rules/test_new_line_at_end_of_file.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_new_lines.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,6 +13,8 @@
 # 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 unittest import mock
+
 from tests.common import RuleTestCase
 
 
@@ -31,17 +32,65 @@ class NewLinesTestCase(RuleTestCase):
         self.check('---\r\ntext\r\n', conf)
 
     def test_unix_type(self):
-        conf = 'new-lines: {type: unix}'
+        conf = ('new-line-at-end-of-file: disable\n'
+                'new-lines: {type: unix}\n')
         self.check('', conf)
+        self.check('\r', conf)
         self.check('\n', conf)
         self.check('\r\n', conf, problem=(1, 1))
         self.check('---\ntext\n', conf)
         self.check('---\r\ntext\r\n', conf, problem=(1, 4))
 
+    def test_unix_type_required_st_sp(self):
+        # If we find a CRLF when looking for Unix newlines, yamllint
+        # should always raise, regardless of logic with
+        # require-starting-space.
+        conf = ('new-line-at-end-of-file: disable\n'
+                'new-lines: {type: unix}\n'
+                'comments:\n'
+                '  require-starting-space: true\n')
+        self.check('---\r\n#\r\n', conf, problem=(1, 4))
+
     def test_dos_type(self):
-        conf = 'new-lines: {type: dos}\n'
+        conf = ('new-line-at-end-of-file: disable\n'
+                'new-lines: {type: dos}\n')
         self.check('', conf)
+        self.check('\r', conf)
         self.check('\n', conf, problem=(1, 1))
         self.check('\r\n', conf)
         self.check('---\ntext\n', conf, problem=(1, 4))
         self.check('---\r\ntext\r\n', conf)
+
+    def test_platform_type(self):
+        conf = ('new-line-at-end-of-file: disable\n'
+                'new-lines: {type: platform}\n')
+
+        self.check('', conf)
+
+        # mock the Linux new-line-character
+        with mock.patch('yamllint.rules.new_lines.linesep', '\n'):
+            self.check('\n', conf)
+            self.check('\r\n', conf, problem=(1, 1))
+            self.check('---\ntext\n', conf)
+            self.check('---\r\ntext\r\n', conf, problem=(1, 4))
+            self.check('---\r\ntext\n', conf, problem=(1, 4))
+            # FIXME: the following tests currently don't work
+            # because only the first line is checked for line-endings
+            # see: issue #475
+            # ---
+            # self.check('---\ntext\r\nfoo\n', conf, problem=(2, 4))
+            # self.check('---\ntext\r\n', conf, problem=(2, 4))
+
+        # mock the Windows new-line-character
+        with mock.patch('yamllint.rules.new_lines.linesep', '\r\n'):
+            self.check('\r\n', conf)
+            self.check('\n', conf, problem=(1, 1))
+            self.check('---\r\ntext\r\n', conf)
+            self.check('---\ntext\n', conf, problem=(1, 4))
+            self.check('---\ntext\r\n', conf, problem=(1, 4))
+            # FIXME: the following tests currently don't work
+            # because only the first line is checked for line-endings
+            # see: issue #475
+            # ---
+            # self.check('---\r\ntext\nfoo\r\n', conf, problem=(2, 4))
+            # self.check('---\r\ntext\n', conf, problem=(2, 4))

tests/rules/test_octal_values.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -28,9 +27,12 @@ class OctalValuesTestCase(RuleTestCase):
         self.check('user-city: 0o10', conf)
 
     def test_implicit_octal_values(self):
-        conf = ('octal-values: {forbid-implicit-octal: true}\n'
+        conf = ('octal-values:\n'
+                '  forbid-implicit-octal: true\n'
+                '  forbid-explicit-octal: false\n'
                 'new-line-at-end-of-file: disable\n'
                 'document-start: disable\n')
+        self.check('after-tag: !custom_tag 010', conf)
         self.check('user-city: 010', conf, problem=(1, 15))
         self.check('user-city: abc', conf)
         self.check('user-city: 010,0571', conf)
@@ -48,9 +50,13 @@ class OctalValuesTestCase(RuleTestCase):
                    '  - 0.10\n'
                    '  - .01\n'
                    '  - 0e3\n', conf)
+        self.check('with-decimal-digits: 012345678', conf)
+        self.check('with-decimal-digits: 012345679', conf)
 
     def test_explicit_octal_values(self):
-        conf = ('octal-values: {forbid-explicit-octal: true}\n'
+        conf = ('octal-values:\n'
+                '  forbid-implicit-octal: false\n'
+                '  forbid-explicit-octal: true\n'
                 'new-line-at-end-of-file: disable\n'
                 'document-start: disable\n')
         self.check('user-city: 0o10', conf, problem=(1, 16))
@@ -70,3 +76,5 @@ class OctalValuesTestCase(RuleTestCase):
                    '  - .01\n'
                    '  - 0e3\n', conf)
         self.check('user-city: "010"', conf)
+        self.check('with-decimal-digits: 0o012345678', conf)
+        self.check('with-decimal-digits: 0o012345679', conf)

tests/rules/test_quoted_strings.py

@@ -0,0 +1,558 @@
+# Copyright (C) 2018 ClearScore
+#
+# 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
+
+from yamllint import config
+
+
+class QuotedTestCase(RuleTestCase):
+    rule_id = 'quoted-strings'
+
+    def test_disabled(self):
+        conf = 'quoted-strings: disable'
+
+        self.check('---\n'
+                   'foo: bar\n', conf)
+        self.check('---\n'
+                   'foo: "bar"\n', conf)
+        self.check('---\n'
+                   'foo: \'bar\'\n', conf)
+        self.check('---\n'
+                   'bar: 123\n', conf)
+        self.check('---\n'
+                   'bar: "123"\n', conf)
+
+    def test_quote_type_any(self):
+        conf = 'quoted-strings: {quote-type: any}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'
+                   'string3: "true"\n'
+                   'string4: "123"\n'
+                   'string5: \'bar\'\n'
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'                               # fails
+                   '  - "foo"\n'
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(4, 10), problem2=(17, 5),
+                   problem3=(19, 12), problem4=(20, 15))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'               # fails
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'
+                   '   word 2"\n',
+                   conf, problem1=(9, 3))
+
+    def test_quote_type_single(self):
+        conf = 'quoted-strings: {quote-type: single}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'                        # fails
+                   'string3: "true"\n'                       # fails
+                   'string4: "123"\n'                        # fails
+                   'string5: \'bar\'\n'
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'                               # fails
+                   '  - "foo"\n'                             # fails
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(4, 10), problem2=(5, 10), problem3=(6, 10),
+                   problem4=(7, 10), problem5=(17, 5), problem6=(18, 5),
+                   problem7=(19, 12), problem8=(19, 17), problem9=(20, 15),
+                   problem10=(20, 23))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'               # fails
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'
+                   '   word 2"\n',
+                   conf, problem1=(9, 3), problem2=(12, 3))
+
+    def test_quote_type_double(self):
+        conf = 'quoted-strings: {quote-type: double}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'                          # fails
+                   'string2: "foo"\n'
+                   'string3: "true"\n'
+                   'string4: "123"\n'
+                   'string5: \'bar\'\n'                      # fails
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'                               # fails
+                   '  - "foo"\n'
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(4, 10), problem2=(8, 10), problem3=(17, 5),
+                   problem4=(19, 12), problem5=(20, 15))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'               # fails
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'
+                   '   word 2"\n',
+                   conf, problem1=(9, 3))
+
+    def test_any_quotes_not_required(self):
+        conf = 'quoted-strings: {quote-type: any, required: false}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'
+                   'string2: "foo"\n'
+                   'string3: "true"\n'
+                   'string4: "123"\n'
+                   'string5: \'bar\'\n'
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'                               # fails
+                   '  - "foo"\n'
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf)
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'
+                   '   word 2"\n',
+                   conf)
+
+    def test_single_quotes_not_required(self):
+        conf = 'quoted-strings: {quote-type: single, required: false}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'
+                   'string2: "foo"\n'                        # fails
+                   'string3: "true"\n'                       # fails
+                   'string4: "123"\n'                        # fails
+                   'string5: \'bar\'\n'
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'                               # fails
+                   '  - "foo"\n'
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(5, 10), problem2=(6, 10), problem3=(7, 10),
+                   problem4=(18, 5), problem5=(19, 17), problem6=(20, 23))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'            # fails
+                   '   word 2"\n',
+                   conf, problem1=(12, 3))
+
+    def test_only_when_needed(self):
+        conf = 'quoted-strings: {required: only-when-needed}\n'
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'
+                   'string2: "foo"\n'                        # fails
+                   'string3: "true"\n'
+                   'string4: "123"\n'
+                   'string5: \'bar\'\n'                      # fails
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'
+                   '  - "foo"\n'                             # fails
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(5, 10), problem2=(8, 10), problem3=(18, 5),
+                   problem4=(19, 17), problem5=(20, 23))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'            # fails
+                   '   word 2"\n',
+                   conf, problem1=(12, 3))
+
+    def test_only_when_needed_single_quotes(self):
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: only-when-needed}\n')
+
+        self.check('---\n'
+                   'boolean1: true\n'
+                   'number1: 123\n'
+                   'string1: foo\n'
+                   'string2: "foo"\n'                        # fails
+                   'string3: "true"\n'                       # fails
+                   'string4: "123"\n'                        # fails
+                   'string5: \'bar\'\n'                      # fails
+                   'string6: !!str genericstring\n'
+                   'string7: !!str 456\n'
+                   'string8: !!str "quotedgenericstring"\n'
+                   'binary: !!binary binstring\n'
+                   'integer: !!int intstring\n'
+                   'boolean2: !!bool boolstring\n'
+                   'boolean3: !!bool "quotedboolstring"\n'
+                   'block-seq:\n'
+                   '  - foo\n'
+                   '  - "foo"\n'                             # fails
+                   'flow-seq: [foo, "foo"]\n'                # fails
+                   'flow-map: {a: foo, b: "foo"}\n',         # fails
+                   conf, problem1=(5, 10), problem2=(6, 10), problem3=(7, 10),
+                   problem4=(8, 10), problem5=(18, 5), problem6=(19, 17),
+                   problem7=(20, 23))
+        self.check('---\n'
+                   'multiline string 1: |\n'
+                   '  line 1\n'
+                   '  line 2\n'
+                   'multiline string 2: >\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 3:\n'
+                   '  word 1\n'
+                   '  word 2\n'
+                   'multiline string 4:\n'
+                   '  "word 1\\\n'            # fails
+                   '   word 2"\n',
+                   conf, problem1=(12, 3))
+
+    def test_only_when_needed_corner_cases(self):
+        conf = 'quoted-strings: {required: only-when-needed}\n'
+
+        self.check('---\n'
+                   '- ""\n'
+                   '- "- item"\n'
+                   '- "key: value"\n'
+                   '- "%H:%M:%S"\n'
+                   '- "%wheel ALL=(ALL) NOPASSWD: ALL"\n'
+                   '- \'"quoted"\'\n'
+                   '- "\'foo\' == \'bar\'"\n'
+                   '- "\'Mac\' in ansible_facts.product_name"\n'
+                   '- \'foo # bar\'\n',
+                   conf)
+        self.check('---\n'
+                   'k1: ""\n'
+                   'k2: "- item"\n'
+                   'k3: "key: value"\n'
+                   'k4: "%H:%M:%S"\n'
+                   'k5: "%wheel ALL=(ALL) NOPASSWD: ALL"\n'
+                   'k6: \'"quoted"\'\n'
+                   'k7: "\'foo\' == \'bar\'"\n'
+                   'k8: "\'Mac\' in ansible_facts.product_name"\n',
+                   conf)
+
+        self.check('---\n'
+                   '- ---\n'
+                   '- "---"\n'                     # fails
+                   '- ----------\n'
+                   '- "----------"\n'              # fails
+                   '- :wq\n'
+                   '- ":wq"\n',                    # fails
+                   conf, problem1=(3, 3), problem2=(5, 3), problem3=(7, 3))
+        self.check('---\n'
+                   'k1: ---\n'
+                   'k2: "---"\n'                   # fails
+                   'k3: ----------\n'
+                   'k4: "----------"\n'            # fails
+                   'k5: :wq\n'
+                   'k6: ":wq"\n',                  # fails
+                   conf, problem1=(3, 5), problem2=(5, 5), problem3=(7, 5))
+
+    def test_only_when_needed_extras(self):
+        conf = ('quoted-strings:\n'
+                '  required: true\n'
+                '  extra-allowed: [^http://]\n')
+        self.assertRaises(config.YamlLintConfigError, self.check, '', conf)
+
+        conf = ('quoted-strings:\n'
+                '  required: true\n'
+                '  extra-required: [^http://]\n')
+        self.assertRaises(config.YamlLintConfigError, self.check, '', conf)
+
+        conf = ('quoted-strings:\n'
+                '  required: false\n'
+                '  extra-allowed: [^http://]\n')
+        self.assertRaises(config.YamlLintConfigError, self.check, '', conf)
+
+        conf = ('quoted-strings:\n'
+                '  required: true\n')
+        self.check('---\n'
+                   '- 123\n'
+                   '- "123"\n'
+                   '- localhost\n'                  # fails
+                   '- "localhost"\n'
+                   '- http://localhost\n'           # fails
+                   '- "http://localhost"\n'
+                   '- ftp://localhost\n'            # fails
+                   '- "ftp://localhost"\n',
+                   conf, problem1=(4, 3), problem2=(6, 3), problem3=(8, 3))
+
+        conf = ('quoted-strings:\n'
+                '  required: only-when-needed\n'
+                '  extra-allowed: [^ftp://]\n'
+                '  extra-required: [^http://]\n')
+        self.check('---\n'
+                   '- 123\n'
+                   '- "123"\n'
+                   '- localhost\n'
+                   '- "localhost"\n'                # fails
+                   '- http://localhost\n'           # fails
+                   '- "http://localhost"\n'
+                   '- ftp://localhost\n'
+                   '- "ftp://localhost"\n',
+                   conf, problem1=(5, 3), problem2=(6, 3))
+
+        conf = ('quoted-strings:\n'
+                '  required: false\n'
+                '  extra-required: [^http://, ^ftp://]\n')
+        self.check('---\n'
+                   '- 123\n'
+                   '- "123"\n'
+                   '- localhost\n'
+                   '- "localhost"\n'
+                   '- http://localhost\n'           # fails
+                   '- "http://localhost"\n'
+                   '- ftp://localhost\n'            # fails
+                   '- "ftp://localhost"\n',
+                   conf, problem1=(6, 3), problem2=(8, 3))
+
+        conf = ('quoted-strings:\n'
+                '  required: only-when-needed\n'
+                '  extra-allowed: [^ftp://, ";$", " "]\n')
+        self.check('---\n'
+                   '- localhost\n'
+                   '- "localhost"\n'                # fails
+                   '- ftp://localhost\n'
+                   '- "ftp://localhost"\n'
+                   '- i=i+1\n'
+                   '- "i=i+1"\n'                # fails
+                   '- i=i+2;\n'
+                   '- "i=i+2;"\n'
+                   '- foo\n'
+                   '- "foo"\n'                      # fails
+                   '- foo bar\n'
+                   '- "foo bar"\n',
+                   conf, problem1=(3, 3), problem2=(7, 3), problem3=(11, 3))
+
+    def test_octal_values(self):
+        conf = 'quoted-strings: {required: true}\n'
+
+        self.check('---\n'
+                   '- 100\n'
+                   '- 0100\n'
+                   '- 0o100\n'
+                   '- 777\n'
+                   '- 0777\n'
+                   '- 0o777\n'
+                   '- 800\n'
+                   '- 0800\n'
+                   '- 0o800\n'
+                   '- "0800"\n'
+                   '- "0o800"\n',
+                   conf,
+                   problem1=(9, 3), problem2=(10, 3))
+
+    def test_allow_quoted_quotes(self):
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: false,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: false,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: true,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: true,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: only-when-needed,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: single,\n'
+                '                 required: only-when-needed,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check('---\n'
+                   'foo1: "[barbaz]"\n'          # fails
+                   'foo2: "[bar\'baz]"\n',
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: false,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: false,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: true,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: true,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: only-when-needed,\n'
+                '                 allow-quoted-quotes: false}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",       # fails
+                   conf, problem1=(2, 7), problem2=(3, 7))
+
+        conf = ('quoted-strings: {quote-type: double,\n'
+                '                 required: only-when-needed,\n'
+                '                 allow-quoted-quotes: true}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"          # fails
+                   "foo2: '[bar\"baz]'\n",
+                   conf, problem1=(2, 7))
+
+        conf = ('quoted-strings: {quote-type: any}\n')
+        self.check("---\n"
+                   "foo1: '[barbaz]'\n"
+                   "foo2: '[bar\"baz]'\n",
+                   conf)

tests/rules/test_trailing_spaces.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/rules/test_truthy.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Peter Ericson
 #
 # This program is free software: you can redistribute it and/or modify
@@ -49,6 +48,54 @@ class TruthyTestCase(RuleTestCase):
                    problem3=(7, 3), problem4=(7, 7),
                    problem5=(8, 3), problem6=(8, 7))
 
+    def test_different_allowed_values(self):
+        conf = ('truthy:\n'
+                '  allowed-values: ["yes", "no"]\n')
+        self.check('---\n'
+                   'key1: foo\n'
+                   'key2: yes\n'
+                   'key3: bar\n'
+                   'key4: no\n', conf)
+        self.check('---\n'
+                   'key1: true\n'
+                   'key2: Yes\n'
+                   'key3: false\n'
+                   'key4: no\n'
+                   'key5: yes\n',
+                   conf,
+                   problem1=(2, 7), problem2=(3, 7),
+                   problem3=(4, 7))
+
+    def test_combined_allowed_values(self):
+        conf = ('truthy:\n'
+                '  allowed-values: ["yes", "no", "true", "false"]\n')
+        self.check('---\n'
+                   'key1: foo\n'
+                   'key2: yes\n'
+                   'key3: bar\n'
+                   'key4: no\n', conf)
+        self.check('---\n'
+                   'key1: true\n'
+                   'key2: Yes\n'
+                   'key3: false\n'
+                   'key4: no\n'
+                   'key5: yes\n',
+                   conf, problem1=(3, 7))
+
+    def test_no_allowed_values(self):
+        conf = ('truthy:\n'
+                '  allowed-values: []\n')
+        self.check('---\n'
+                   'key1: foo\n'
+                   'key2: bar\n', conf)
+        self.check('---\n'
+                   'key1: true\n'
+                   'key2: yes\n'
+                   'key3: false\n'
+                   'key4: no\n', conf,
+                   problem1=(2, 7), problem2=(3, 7),
+                   problem3=(4, 7), problem4=(5, 7))
+
     def test_explicit_types(self):
         conf = 'truthy: enable\n'
         self.check('---\n'
@@ -66,3 +113,33 @@ class TruthyTestCase(RuleTestCase):
                    'boolean5: !!bool off\n'
                    'boolean6: !!bool NO\n',
                    conf)
+
+    def test_check_keys_disabled(self):
+        conf = ('truthy:\n'
+                '  allowed-values: []\n'
+                '  check-keys: false\n'
+                'key-duplicates: disable\n')
+        self.check('---\n'
+                   'YES: 0\n'
+                   'Yes: 0\n'
+                   'yes: 0\n'
+                   'No: 0\n'
+                   'No: 0\n'
+                   'no: 0\n'
+                   'TRUE: 0\n'
+                   'True: 0\n'
+                   'true: 0\n'
+                   'FALSE: 0\n'
+                   'False: 0\n'
+                   'false: 0\n'
+                   'ON: 0\n'
+                   'On: 0\n'
+                   'on: 0\n'
+                   'OFF: 0\n'
+                   'Off: 0\n'
+                   'off: 0\n'
+                   'YES:\n'
+                   '  Yes:\n'
+                   '    yes:\n'
+                   '      on: 0\n',
+                   conf)

tests/test_cli.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,28 +13,55 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-try:
+from io import StringIO
-    from cStringIO import StringIO
-except ImportError:
-    from io import StringIO
 import fcntl
 import locale
 import os
 import pty
 import shutil
 import sys
-try:
+import tempfile
-    assert sys.version_info >= (2, 7)
+import unittest
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
-from tests.common import build_temp_workspace
+from tests.common import build_temp_workspace, temp_workspace
 
 from yamllint import cli
+from yamllint import config
+
+
+class RunContext:
+    """Context manager for ``cli.run()`` to capture exit code and streams."""
+
+    def __init__(self, case):
+        self.stdout = self.stderr = None
+        self._raises_ctx = case.assertRaises(SystemExit)
+
+    def __enter__(self):
+        self._raises_ctx.__enter__()
+        sys.stdout = self.outstream = StringIO()
+        sys.stderr = self.errstream = StringIO()
+        return self
+
+    def __exit__(self, *exc_info):
+        self.stdout, sys.stdout = self.outstream.getvalue(), sys.__stdout__
+        self.stderr, sys.stderr = self.errstream.getvalue(), sys.__stderr__
+        return self._raises_ctx.__exit__(*exc_info)
+
+    @property
+    def returncode(self):
+        return self._raises_ctx.exception.code
+
+
+# Check system's UTF-8 availability
+def utf8_available():
+    try:
+        locale.setlocale(locale.LC_ALL, 'C.UTF-8')
+        locale.setlocale(locale.LC_ALL, (None, None))
+        return True
+    except locale.Error:  # pragma: no cover
+        return False
 
 
-@unittest.skipIf(sys.version_info < (2, 7), 'Python 2.6 not supported')
 class CommandLineTestCase(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
@@ -53,6 +79,9 @@ class CommandLineTestCase(unittest.TestCase):
             # file in dir
             'sub/ok.yaml': '---\n'
                            'key: value\n',
+            # directory that looks like a yaml file
+            'sub/directory.yaml/not-yaml.txt': '',
+            'sub/directory.yaml/empty.yml': '',
             # file in very nested dir
             's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml': '---\n'
                                                        'key: value\n'
@@ -63,12 +92,22 @@ class CommandLineTestCase(unittest.TestCase):
             'no-yaml.json': '---\n'
                             'key: value\n',
             # non-ASCII chars
-            'non-ascii/utf-8': (
+            'non-ascii/éçäγλνπ¥/utf-8': (
-                u'---\n'
+                '---\n'
-                u'- hétérogénéité\n'
+                '- hétérogénéité\n'
-                u'# 19.99 €\n'
+                '# 19.99 €\n'
-                u'- お早う御座います。\n'
+                '- お早う御座います。\n'
-                u'# الأَبْجَدِيَّة العَرَبِيَّة\n').encode('utf-8'),
+                '# الأَبْجَدِيَّة العَرَبِيَّة\n').encode('utf-8'),
+            # dos line endings yaml
+            'dos.yml': '---\r\n'
+                       'dos: true',
+            # different key-ordering by locale
+            'c.yaml': '---\n'
+                      'A: true\n'
+                      'a: true',
+            'en.yaml': '---\n'
+                       'a: true\n'
+                       'A: true'
         })
 
     @classmethod
@@ -77,12 +116,19 @@ class CommandLineTestCase(unittest.TestCase):
 
         shutil.rmtree(cls.wd)
 
+    @unittest.skipIf(not utf8_available() and sys.version_info < (3, 7),
+                     'UTF-8 paths not supported')
     def test_find_files_recursively(self):
+        conf = config.YamlLintConfig('extends: default')
         self.assertEqual(
-            sorted(cli.find_files_recursively([self.wd])),
+            sorted(cli.find_files_recursively([self.wd], conf)),
             [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'dos.yml'),
              os.path.join(self.wd, 'empty.yml'),
+             os.path.join(self.wd, 'en.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/directory.yaml/empty.yml'),
              os.path.join(self.wd, 'sub/ok.yaml'),
              os.path.join(self.wd, 'warn.yaml')],
         )
@@ -90,14 +136,14 @@ class CommandLineTestCase(unittest.TestCase):
         items = [os.path.join(self.wd, 'sub/ok.yaml'),
                  os.path.join(self.wd, 'empty-dir')]
         self.assertEqual(
-            sorted(cli.find_files_recursively(items)),
+            sorted(cli.find_files_recursively(items, conf)),
             [os.path.join(self.wd, 'sub/ok.yaml')],
         )
 
         items = [os.path.join(self.wd, 'empty.yml'),
                  os.path.join(self.wd, 's')]
         self.assertEqual(
-            sorted(cli.find_files_recursively(items)),
+            sorted(cli.find_files_recursively(items, conf)),
             [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')],
         )
@@ -105,261 +151,356 @@ class CommandLineTestCase(unittest.TestCase):
         items = [os.path.join(self.wd, 'sub'),
                  os.path.join(self.wd, '/etc/another/file')]
         self.assertEqual(
-            sorted(cli.find_files_recursively(items)),
+            sorted(cli.find_files_recursively(items, conf)),
             [os.path.join(self.wd, '/etc/another/file'),
+             os.path.join(self.wd, 'sub/directory.yaml/empty.yml'),
              os.path.join(self.wd, 'sub/ok.yaml')],
         )
 
-    def test_run_with_bad_arguments(self):
+        conf = config.YamlLintConfig('extends: default\n'
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+                                     'yaml-files:\n'
-        with self.assertRaises(SystemExit) as ctx:
+                                     '  - \'*.yaml\' \n')
-            cli.run(())
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'en.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, 'warn.yaml')]
+        )
 
-        self.assertNotEqual(ctx.exception.code, 0)
+        conf = config.YamlLintConfig('extends: default\n'
+                                     'yaml-files:\n'
+                                     '  - \'*.yml\'\n')
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'dos.yml'),
+             os.path.join(self.wd, 'empty.yml'),
+             os.path.join(self.wd, 'sub/directory.yaml/empty.yml')]
+        )
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        conf = config.YamlLintConfig('extends: default\n'
-        self.assertEqual(out, '')
+                                     'yaml-files:\n'
-        self.assertRegexpMatches(err, r'^usage')
+                                     '  - \'*.json\'\n')
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'no-yaml.json')]
+        )
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        conf = config.YamlLintConfig('extends: default\n'
-        with self.assertRaises(SystemExit) as ctx:
+                                     'yaml-files:\n'
-            cli.run(('--unknown-arg', ))
+                                     '  - \'*\'\n')
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'dos.yml'),
+             os.path.join(self.wd, 'empty.yml'),
+             os.path.join(self.wd, 'en.yaml'),
+             os.path.join(self.wd, 'no-yaml.json'),
+             os.path.join(self.wd, 'non-ascii/éçäγλνπ¥/utf-8'),
+             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/directory.yaml/empty.yml'),
+             os.path.join(self.wd, 'sub/directory.yaml/not-yaml.txt'),
+             os.path.join(self.wd, 'sub/ok.yaml'),
+             os.path.join(self.wd, 'warn.yaml')]
+        )
 
-        self.assertNotEqual(ctx.exception.code, 0)
+        conf = config.YamlLintConfig('extends: default\n'
+                                     'yaml-files:\n'
+                                     '  - \'*.yaml\'\n'
+                                     '  - \'*\'\n'
+                                     '  - \'**\'\n')
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'dos.yml'),
+             os.path.join(self.wd, 'empty.yml'),
+             os.path.join(self.wd, 'en.yaml'),
+             os.path.join(self.wd, 'no-yaml.json'),
+             os.path.join(self.wd, 'non-ascii/éçäγλνπ¥/utf-8'),
+             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/directory.yaml/empty.yml'),
+             os.path.join(self.wd, 'sub/directory.yaml/not-yaml.txt'),
+             os.path.join(self.wd, 'sub/ok.yaml'),
+             os.path.join(self.wd, 'warn.yaml')]
+        )
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        conf = config.YamlLintConfig('extends: default\n'
-        self.assertEqual(out, '')
+                                     'yaml-files:\n'
-        self.assertRegexpMatches(err, r'^usage')
+                                     '  - \'s/**\'\n'
+                                     '  - \'**/utf-8\'\n')
+        self.assertEqual(
+            sorted(cli.find_files_recursively([self.wd], conf)),
+            [os.path.join(self.wd, 'non-ascii/éçäγλνπ¥/utf-8')]
+        )
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+    def test_run_with_bad_arguments(self):
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
-            cli.run(('-c', './conf.yaml', '-d', 'relaxed', 'file'))
+            cli.run(())
+        self.assertNotEqual(ctx.returncode, 0)
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(ctx.stderr, r'^usage')
 
-        self.assertNotEqual(ctx.exception.code, 0)
+        with RunContext(self) as ctx:
+            cli.run(('--unknown-arg', ))
+        self.assertNotEqual(ctx.returncode, 0)
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(ctx.stderr, r'^usage')
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        with RunContext(self) as ctx:
-        self.assertEqual(out, '')
+            cli.run(('-c', './conf.yaml', '-d', 'relaxed', 'file'))
-        self.assertRegexpMatches(
+        self.assertNotEqual(ctx.returncode, 0)
-            err.splitlines()[-1],
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(
+            ctx.stderr.splitlines()[-1],
             r'^yamllint: error: argument -d\/--config-data: '
             r'not allowed with argument -c\/--config-file$'
         )
 
+        # checks if reading from stdin and files are mutually exclusive
+        with RunContext(self) as ctx:
+            cli.run(('-', 'file'))
+        self.assertNotEqual(ctx.returncode, 0)
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(ctx.stderr, r'^usage')
+
     def test_run_with_bad_config(self):
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
             cli.run(('-d', 'rules: {a: b}', 'file'))
-
+        self.assertEqual(ctx.returncode, -1)
-        self.assertEqual(ctx.exception.code, -1)
+        self.assertEqual(ctx.stdout, '')
-
+        self.assertRegex(ctx.stderr, r'^invalid config: no such rule')
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
-        self.assertEqual(out, '')
-        self.assertRegexpMatches(err, r'^invalid config: no such rule')
 
     def test_run_with_empty_config(self):
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
             cli.run(('-d', '', 'file'))
+        self.assertEqual(ctx.returncode, -1)
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(ctx.stderr, r'^invalid config: not a dict')
 
-        self.assertEqual(ctx.exception.code, -1)
+    def test_run_with_implicit_extends_config(self):
+        path = os.path.join(self.wd, 'warn.yaml')
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        with RunContext(self) as ctx:
-        self.assertEqual(out, '')
+            cli.run(('-d', 'default', '-f', 'parsable', path))
-        self.assertRegexpMatches(err, r'^invalid config: not a dict')
+        expected_out = ('%s:1:1: [warning] missing document start "---" '
+                        '(document-start)\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (0, expected_out, ''))
 
     def test_run_with_config_file(self):
         with open(os.path.join(self.wd, 'config'), 'w') as f:
             f.write('rules: {trailing-spaces: disable}')
 
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
             cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
-        self.assertEqual(ctx.exception.code, 0)
+        self.assertEqual(ctx.returncode, 0)
 
         with open(os.path.join(self.wd, 'config'), 'w') as f:
             f.write('rules: {trailing-spaces: enable}')
 
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
             cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
-        self.assertEqual(ctx.exception.code, 1)
+        self.assertEqual(ctx.returncode, 1)
 
+    @unittest.skipIf(os.environ.get('GITHUB_RUN_ID'), '$HOME not overridable')
     def test_run_with_user_global_config_file(self):
         home = os.path.join(self.wd, 'fake-home')
-        os.mkdir(home)
+        dir = os.path.join(home, '.config', 'yamllint')
-        dir = os.path.join(home, '.config')
+        os.makedirs(dir)
-        os.mkdir(dir)
-        dir = os.path.join(dir, 'yamllint')
-        os.mkdir(dir)
         config = os.path.join(dir, 'config')
 
-        temp = os.environ['HOME']
+        self.addCleanup(os.environ.update, HOME=os.environ['HOME'])
         os.environ['HOME'] = home
 
         with open(config, 'w') as f:
             f.write('rules: {trailing-spaces: disable}')
 
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
             cli.run((os.path.join(self.wd, 'a.yaml'), ))
-        self.assertEqual(ctx.exception.code, 0)
+        self.assertEqual(ctx.returncode, 0)
 
         with open(config, 'w') as f:
             f.write('rules: {trailing-spaces: enable}')
 
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
             cli.run((os.path.join(self.wd, 'a.yaml'), ))
-        self.assertEqual(ctx.exception.code, 1)
+        self.assertEqual(ctx.returncode, 1)
-
-        os.environ['HOME'] = temp
 
-    def test_run_version(self):
+    def test_run_with_user_xdg_config_home_in_env(self):
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        self.addCleanup(os.environ.__delitem__, 'XDG_CONFIG_HOME')
-        with self.assertRaises(SystemExit) as ctx:
-            cli.run(('--version', ))
 
-        self.assertEqual(ctx.exception.code, 0)
+        with tempfile.TemporaryDirectory('w') as d:
+            os.environ['XDG_CONFIG_HOME'] = d
+            os.makedirs(os.path.join(d, 'yamllint'))
+            with open(os.path.join(d, 'yamllint', 'config'), 'w') as f:
+                f.write('extends: relaxed')
+            with RunContext(self) as ctx:
+                cli.run(('-f', 'parsable', os.path.join(self.wd, 'warn.yaml')))
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
-        self.assertRegexpMatches(out + err, r'yamllint \d+\.\d+')
 
-    def test_run_non_existing_file(self):
+    def test_run_with_user_yamllint_config_file_in_env(self):
-        file = os.path.join(self.wd, 'i-do-not-exist.yaml')
+        self.addCleanup(os.environ.__delitem__, 'YAMLLINT_CONFIG_FILE')
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with tempfile.NamedTemporaryFile('w') as f:
-        with self.assertRaises(SystemExit) as ctx:
+            os.environ['YAMLLINT_CONFIG_FILE'] = f.name
-            cli.run(('-f', 'parsable', file))
+            f.write('rules: {trailing-spaces: disable}')
+            f.flush()
+            with RunContext(self) as ctx:
+                cli.run((os.path.join(self.wd, 'a.yaml'), ))
+            self.assertEqual(ctx.returncode, 0)
 
-        self.assertEqual(ctx.exception.code, -1)
+        with tempfile.NamedTemporaryFile('w') as f:
+            os.environ['YAMLLINT_CONFIG_FILE'] = f.name
+            f.write('rules: {trailing-spaces: enable}')
+            f.flush()
+            with RunContext(self) as ctx:
+                cli.run((os.path.join(self.wd, 'a.yaml'), ))
+            self.assertEqual(ctx.returncode, 1)
+
+    def test_run_with_locale(self):
+        # check for availability of locale, otherwise skip the test
+        # reset to default before running the test,
+        # as the first two runs don't use setlocale()
+        try:
+            locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
+        except locale.Error:  # pragma: no cover
+            self.skipTest('locale en_US.UTF-8 not available')
+        locale.setlocale(locale.LC_ALL, (None, None))
+
+        # C + en.yaml should fail
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'rules: { key-ordering: enable }',
+                     os.path.join(self.wd, 'en.yaml')))
+        self.assertEqual(ctx.returncode, 1)
+
+        # C + c.yaml should pass
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'rules: { key-ordering: enable }',
+                    os.path.join(self.wd, 'c.yaml')))
+        self.assertEqual(ctx.returncode, 0)
+
+        # the next two runs use setlocale() inside,
+        # so we need to clean up afterwards
+        self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
+
+        # en_US + en.yaml should pass
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'locale: en_US.UTF-8\n'
+                           'rules: { key-ordering: enable }',
+                     os.path.join(self.wd, 'en.yaml')))
+        self.assertEqual(ctx.returncode, 0)
+
+        # en_US + c.yaml should fail
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'locale: en_US.UTF-8\n'
+                           'rules: { key-ordering: enable }',
+                     os.path.join(self.wd, 'c.yaml')))
+        self.assertEqual(ctx.returncode, 1)
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+    def test_run_version(self):
-        self.assertEqual(out, '')
+        with RunContext(self) as ctx:
-        self.assertRegexpMatches(err, r'No such file or directory')
+            cli.run(('--version', ))
+        self.assertEqual(ctx.returncode, 0)
+        self.assertRegex(ctx.stdout + ctx.stderr, r'yamllint \d+\.\d+')
 
-    def test_run_one_problem_file(self):
+    def test_run_non_existing_file(self):
-        file = os.path.join(self.wd, 'a.yaml')
+        path = os.path.join(self.wd, 'i-do-not-exist.yaml')
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
+            cli.run(('-f', 'parsable', path))
-            cli.run(('-f', 'parsable', file))
+        self.assertEqual(ctx.returncode, -1)
+        self.assertEqual(ctx.stdout, '')
+        self.assertRegex(ctx.stderr, r'No such file or directory')
 
-        self.assertEqual(ctx.exception.code, 1)
+    def test_run_one_problem_file(self):
+        path = os.path.join(self.wd, 'a.yaml')
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        with RunContext(self) as ctx:
-        self.assertEqual(out, (
+            cli.run(('-f', 'parsable', path))
+        self.assertEqual(ctx.returncode, 1)
+        self.assertEqual(ctx.stdout, (
             '%s:2:4: [error] trailing spaces (trailing-spaces)\n'
             '%s:3:4: [error] no new line character at the end of file '
-            '(new-line-at-end-of-file)\n') % (file, file))
+            '(new-line-at-end-of-file)\n' % (path, path)))
-        self.assertEqual(err, '')
+        self.assertEqual(ctx.stderr, '')
 
     def test_run_one_warning(self):
-        file = os.path.join(self.wd, 'warn.yaml')
+        path = os.path.join(self.wd, 'warn.yaml')
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
+            cli.run(('-f', 'parsable', path))
-            cli.run(('-f', 'parsable', file))
+        self.assertEqual(ctx.returncode, 0)
-
-        self.assertEqual(ctx.exception.code, 0)
 
     def test_run_warning_in_strict_mode(self):
-        file = os.path.join(self.wd, 'warn.yaml')
+        path = 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)
+        with RunContext(self) as ctx:
+            cli.run(('-f', 'parsable', '--strict', path))
+        self.assertEqual(ctx.returncode, 2)
 
     def test_run_one_ok_file(self):
-        file = os.path.join(self.wd, 'sub', 'ok.yaml')
+        path = os.path.join(self.wd, 'sub', 'ok.yaml')
-
-        sys.stdout, sys.stderr = StringIO(), StringIO()
-        with self.assertRaises(SystemExit) as ctx:
-            cli.run(('-f', 'parsable', file))
 
-        self.assertEqual(ctx.exception.code, 0)
+        with RunContext(self) as ctx:
-
+            cli.run(('-f', 'parsable', path))
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
-        self.assertEqual(out, '')
-        self.assertEqual(err, '')
 
     def test_run_empty_file(self):
-        file = os.path.join(self.wd, 'empty.yml')
+        path = os.path.join(self.wd, 'empty.yml')
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
+            cli.run(('-f', 'parsable', path))
-            cli.run(('-f', 'parsable', file))
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
-
-        self.assertEqual(ctx.exception.code, 0)
-
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
-        self.assertEqual(out, '')
-        self.assertEqual(err, '')
 
+    @unittest.skipIf(not utf8_available(), 'C.UTF-8 not available')
     def test_run_non_ascii_file(self):
-        file = os.path.join(self.wd, 'non-ascii', 'utf-8')
+        locale.setlocale(locale.LC_ALL, 'C.UTF-8')
-
+        self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
-        # Make sure the default localization conditions on this "system"
-        # support UTF-8 encoding.
-        loc = locale.getlocale()
-        try:
-            locale.setlocale(locale.LC_ALL, 'C.UTF-8')
-        except locale.Error:
-            locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        path = os.path.join(self.wd, 'non-ascii', 'éçäγλνπ¥', 'utf-8')
-        with self.assertRaises(SystemExit) as ctx:
+        with RunContext(self) as ctx:
-            cli.run(('-f', 'parsable', file))
+            cli.run(('-f', 'parsable', path))
-
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
-        locale.setlocale(locale.LC_ALL, loc)
-
-        self.assertEqual(ctx.exception.code, 0)
-
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
-        self.assertEqual(out, '')
-        self.assertEqual(err, '')
 
     def test_run_multiple_files(self):
         items = [os.path.join(self.wd, 'empty.yml'),
                  os.path.join(self.wd, 's')]
-        file = items[1] + '/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'
+        path = items[1] + '/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'
 
-        sys.stdout, sys.stderr = StringIO(), StringIO()
+        with RunContext(self) as ctx:
-        with self.assertRaises(SystemExit) as ctx:
             cli.run(['-f', 'parsable'] + items)
-
+        self.assertEqual((ctx.returncode, ctx.stderr), (1, ''))
-        self.assertEqual(ctx.exception.code, 1)
+        self.assertEqual(ctx.stdout, (
-
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
-        self.assertEqual(out, (
             '%s:3:1: [error] duplication of key "key" in mapping '
-            '(key-duplicates)\n') % file)
+            '(key-duplicates)\n') % path)
-        self.assertEqual(err, '')
 
     def test_run_piped_output_nocolor(self):
-        file = os.path.join(self.wd, 'a.yaml')
+        path = os.path.join(self.wd, 'a.yaml')
-
-        sys.stdout, sys.stderr = StringIO(), StringIO()
-        with self.assertRaises(SystemExit) as ctx:
-            cli.run((file, ))
-
-        self.assertEqual(ctx.exception.code, 1)
 
-        out, err = sys.stdout.getvalue(), sys.stderr.getvalue()
+        with RunContext(self) as ctx:
-        self.assertEqual(out, (
+            cli.run((path, ))
+        self.assertEqual((ctx.returncode, ctx.stderr), (1, ''))
+        self.assertEqual(ctx.stdout, (
             '%s\n'
             '  2:4       error    trailing spaces  (trailing-spaces)\n'
             '  3:4       error    no new line character at the end of file  '
             '(new-line-at-end-of-file)\n'
-            '\n' % file))
+            '\n' % path))
-        self.assertEqual(err, '')
 
-    def test_run_colored_output(self):
+    def test_run_default_format_output_in_tty(self):
-        file = os.path.join(self.wd, 'a.yaml')
+        path = os.path.join(self.wd, 'a.yaml')
 
         # Create a pseudo-TTY and redirect stdout to it
         master, slave = pty.openpty()
         sys.stdout = sys.stderr = os.fdopen(slave, 'w')
 
         with self.assertRaises(SystemExit) as ctx:
-            cli.run((file, ))
+            cli.run((path, ))
         sys.stdout.flush()
 
         self.assertEqual(ctx.exception.code, 1)
@@ -382,4 +523,275 @@ class CommandLineTestCase(unittest.TestCase):
             '  \033[2m3:4\033[0m       \033[31merror\033[0m    '
             'no new line character at the end of file  '
             '\033[2m(new-line-at-end-of-file)\033[0m\n'
-            '\n' % file))
+            '\n' % path))
+
+    def test_run_default_format_output_without_tty(self):
+        path = os.path.join(self.wd, 'a.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, ))
+        expected_out = (
+            '%s\n'
+            '  2:4       error    trailing spaces  (trailing-spaces)\n'
+            '  3:4       error    no new line character at the end of file  '
+            '(new-line-at-end-of-file)\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_auto_output_without_tty_output(self):
+        path = os.path.join(self.wd, 'a.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--format', 'auto'))
+        expected_out = (
+            '%s\n'
+            '  2:4       error    trailing spaces  (trailing-spaces)\n'
+            '  3:4       error    no new line character at the end of file  '
+            '(new-line-at-end-of-file)\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_format_colored(self):
+        path = os.path.join(self.wd, 'a.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--format', 'colored'))
+        expected_out = (
+            '\033[4m%s\033[0m\n'
+            '  \033[2m2:4\033[0m       \033[31merror\033[0m    '
+            'trailing spaces  \033[2m(trailing-spaces)\033[0m\n'
+            '  \033[2m3:4\033[0m       \033[31merror\033[0m    '
+            'no new line character at the end of file  '
+            '\033[2m(new-line-at-end-of-file)\033[0m\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_format_colored_warning(self):
+        path = os.path.join(self.wd, 'warn.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--format', 'colored'))
+        expected_out = (
+            '\033[4m%s\033[0m\n'
+            '  \033[2m1:1\033[0m       \033[33mwarning\033[0m  '
+            'missing document start "---"  \033[2m(document-start)\033[0m\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (0, expected_out, ''))
+
+    def test_run_format_github(self):
+        path = os.path.join(self.wd, 'a.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--format', 'github'))
+        expected_out = (
+            '::group::%s\n'
+            '::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
+            ' spaces\n'
+            '::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
+            ' new line character at the end of file\n'
+            '::endgroup::\n\n'
+            % (path, path, path))
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_github_actions_detection(self):
+        path = os.path.join(self.wd, 'a.yaml')
+        self.addCleanup(os.environ.__delitem__, 'GITHUB_ACTIONS')
+        self.addCleanup(os.environ.__delitem__, 'GITHUB_WORKFLOW')
+
+        with RunContext(self) as ctx:
+            os.environ['GITHUB_ACTIONS'] = 'something'
+            os.environ['GITHUB_WORKFLOW'] = 'something'
+            cli.run((path, ))
+        expected_out = (
+            '::group::%s\n'
+            '::error file=%s,line=2,col=4::2:4 [trailing-spaces] trailing'
+            ' spaces\n'
+            '::error file=%s,line=3,col=4::3:4 [new-line-at-end-of-file] no'
+            ' new line character at the end of file\n'
+            '::endgroup::\n\n'
+            % (path, path, path))
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_read_from_stdin(self):
+        # prepares stdin with an invalid yaml string so that we can check
+        # for its specific error, and be assured that stdin was read
+        self.addCleanup(setattr, sys, 'stdin', sys.__stdin__)
+        sys.stdin = StringIO(
+            'I am a string\n'
+            'therefore: I am an error\n')
+
+        with RunContext(self) as ctx:
+            cli.run(('-', '-f', 'parsable'))
+        expected_out = (
+            'stdin:2:10: [error] syntax error: '
+            'mapping values are not allowed here (syntax)\n')
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_no_warnings(self):
+        path = os.path.join(self.wd, 'a.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--no-warnings', '-f', 'auto'))
+        expected_out = (
+            '%s\n'
+            '  2:4       error    trailing spaces  (trailing-spaces)\n'
+            '  3:4       error    no new line character at the end of file  '
+            '(new-line-at-end-of-file)\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+        path = os.path.join(self.wd, 'warn.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--no-warnings', '-f', 'auto'))
+        self.assertEqual(ctx.returncode, 0)
+
+    def test_run_no_warnings_and_strict(self):
+        path = os.path.join(self.wd, 'warn.yaml')
+
+        with RunContext(self) as ctx:
+            cli.run((path, '--no-warnings', '-s'))
+        self.assertEqual(ctx.returncode, 2)
+
+    def test_run_non_universal_newline(self):
+        path = os.path.join(self.wd, 'dos.yml')
+
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'rules:\n  new-lines:\n    type: dos', path))
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
+
+        with RunContext(self) as ctx:
+            cli.run(('-d', 'rules:\n  new-lines:\n    type: unix', path))
+        expected_out = (
+            '%s\n'
+            '  1:4       error    wrong new line character: expected \\n'
+            '  (new-lines)\n'
+            '\n' % path)
+        self.assertEqual(
+            (ctx.returncode, ctx.stdout, ctx.stderr), (1, expected_out, ''))
+
+    def test_run_list_files(self):
+        with RunContext(self) as ctx:
+            cli.run(('--list-files', self.wd))
+        self.assertEqual(ctx.returncode, 0)
+        self.assertEqual(
+            sorted(ctx.stdout.splitlines()),
+            [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'dos.yml'),
+             os.path.join(self.wd, 'empty.yml'),
+             os.path.join(self.wd, 'en.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/directory.yaml/empty.yml'),
+             os.path.join(self.wd, 'sub/ok.yaml'),
+             os.path.join(self.wd, 'warn.yaml')]
+        )
+
+        config = '{ignore: "*.yml", yaml-files: ["*.*"]}'
+        with RunContext(self) as ctx:
+            cli.run(('--list-files', '-d', config, self.wd))
+        self.assertEqual(ctx.returncode, 0)
+        self.assertEqual(
+            sorted(ctx.stdout.splitlines()),
+            [os.path.join(self.wd, 'a.yaml'),
+             os.path.join(self.wd, 'c.yaml'),
+             os.path.join(self.wd, 'en.yaml'),
+             os.path.join(self.wd, 'no-yaml.json'),
+             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/directory.yaml/not-yaml.txt'),
+             os.path.join(self.wd, 'sub/ok.yaml'),
+             os.path.join(self.wd, 'warn.yaml')]
+        )
+
+
+class CommandLineConfigTestCase(unittest.TestCase):
+    def test_config_file(self):
+        workspace = {'a.yml': 'hello: world\n'}
+        conf = ('---\n'
+                'extends: relaxed\n')
+
+        for conf_file in ('.yamllint', '.yamllint.yml', '.yamllint.yaml'):
+            with self.subTest(conf_file):
+                with temp_workspace(workspace):
+                    with RunContext(self) as ctx:
+                        cli.run(('-f', 'parsable', '.'))
+
+                self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                                 (0, './a.yml:1:1: [warning] missing document '
+                                     'start "---" (document-start)\n', ''))
+
+                with temp_workspace({**workspace, **{conf_file: conf}}):
+                    with RunContext(self) as ctx:
+                        cli.run(('-f', 'parsable', '.'))
+
+                self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                                 (0, '', ''))
+
+    def test_parent_config_file(self):
+        workspace = {'a/b/c/d/e/f/g/a.yml': 'hello: world\n'}
+        conf = ('---\n'
+                'extends: relaxed\n')
+
+        for conf_file in ('.yamllint', '.yamllint.yml', '.yamllint.yaml'):
+            with self.subTest(conf_file):
+                with temp_workspace(workspace):
+                    with RunContext(self) as ctx:
+                        os.chdir('a/b/c/d/e/f')
+                        cli.run(('-f', 'parsable', '.'))
+
+                self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                                 (0, './g/a.yml:1:1: [warning] missing '
+                                     'document start "---" (document-start)\n',
+                                     ''))
+
+                with temp_workspace({**workspace, **{conf_file: conf}}):
+                    with RunContext(self) as ctx:
+                        os.chdir('a/b/c/d/e/f')
+                        cli.run(('-f', 'parsable', '.'))
+
+                self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                                 (0, '', ''))
+
+    def test_multiple_parent_config_file(self):
+        workspace = {'a/b/c/3spaces.yml': 'array:\n'
+                                          '   - item\n',
+                     'a/b/c/4spaces.yml': 'array:\n'
+                                          '    - item\n',
+                     'a/.yamllint': '---\n'
+                                    'extends: relaxed\n'
+                                    'rules:\n'
+                                    '  indentation:\n'
+                                    '    spaces: 4\n',
+                     }
+
+        conf3 = ('---\n'
+                 'extends: relaxed\n'
+                 'rules:\n'
+                 '  indentation:\n'
+                 '    spaces: 3\n')
+
+        with temp_workspace(workspace):
+            with RunContext(self) as ctx:
+                os.chdir('a/b/c')
+                cli.run(('-f', 'parsable', '.'))
+
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                         (0, './3spaces.yml:2:4: [warning] wrong indentation: '
+                         'expected 4 but found 3 (indentation)\n', ''))
+
+        with temp_workspace({**workspace, **{'a/b/.yamllint.yml': conf3}}):
+            with RunContext(self) as ctx:
+                os.chdir('a/b/c')
+                cli.run(('-f', 'parsable', '.'))
+
+        self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr),
+                         (0, './4spaces.yml:2:5: [warning] wrong indentation: '
+                         'expected 3 but found 4 (indentation)\n', ''))

tests/test_config.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,21 +13,16 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-try:
+from io import StringIO
-    from cStringIO import StringIO
-except ImportError:
-    from io import StringIO
 import os
 import shutil
 import sys
-try:
+import tempfile
-    assert sys.version_info >= (2, 7)
+import unittest
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
 from tests.common import build_temp_workspace
 
+from yamllint.config import YamlLintConfigError
 from yamllint import cli
 from yamllint import config
 
@@ -51,23 +45,26 @@ class SimpleConfigTestCase(unittest.TestCase):
             config.YamlLintConfig('not: valid: yaml')
 
     def test_unknown_rule(self):
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
                 config.YamlLintConfigError,
                 'invalid config: no such rule: "this-one-does-not-exist"'):
             config.YamlLintConfig('rules:\n'
                                   '  this-one-does-not-exist: enable\n')
 
     def test_missing_option(self):
-        with self.assertRaisesRegexp(
+        c = config.YamlLintConfig('rules:\n'
-                config.YamlLintConfigError,
+                                  '  colons: enable\n')
-                'invalid config: missing option "max-spaces-before" '
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 0)
-                'for rule "colons"'):
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
-            config.YamlLintConfig('rules:\n'
+
+        c = config.YamlLintConfig('rules:\n'
                                   '  colons:\n'
-                                  '    max-spaces-after: 1\n')
+                                  '    max-spaces-before: 9\n')
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 9)
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
 
     def test_unknown_option(self):
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
                 config.YamlLintConfigError,
                 'invalid config: unknown option "abcdef" for rule "colons"'):
             config.YamlLintConfig('rules:\n'
@@ -82,7 +79,7 @@ class SimpleConfigTestCase(unittest.TestCase):
                                   '    spaces: 2\n'
                                   '    indent-sequences: true\n'
                                   '    check-multi-line-strings: false\n')
-        self.assertEqual(c.rules['indentation']['indent-sequences'], True)
+        self.assertTrue(c.rules['indentation']['indent-sequences'])
         self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
                          False)
 
@@ -91,7 +88,7 @@ class SimpleConfigTestCase(unittest.TestCase):
                                   '    spaces: 2\n'
                                   '    indent-sequences: yes\n'
                                   '    check-multi-line-strings: false\n')
-        self.assertEqual(c.rules['indentation']['indent-sequences'], True)
+        self.assertTrue(c.rules['indentation']['indent-sequences'])
         self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
                          False)
 
@@ -105,7 +102,7 @@ class SimpleConfigTestCase(unittest.TestCase):
         self.assertEqual(c.rules['indentation']['check-multi-line-strings'],
                          False)
 
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
                 config.YamlLintConfigError,
                 'invalid config: option "indent-sequences" of "indentation" '
                 'should be in '):
@@ -115,17 +112,22 @@ class SimpleConfigTestCase(unittest.TestCase):
                                       '    indent-sequences: YES!\n'
                                       '    check-multi-line-strings: false\n')
 
+    def test_enable_disable_keywords(self):
+        c = config.YamlLintConfig('rules:\n'
+                                  '  colons: enable\n'
+                                  '  hyphens: disable\n')
+        self.assertEqual(c.rules['colons'], {'level': 'error',
+                                             'max-spaces-after': 1,
+                                             'max-spaces-before': 0})
+        self.assertEqual(c.rules['hyphens'], False)
+
     def test_validate_rule_conf(self):
-        class Rule(object):
+        class Rule:
             ID = 'fake'
 
-        self.assertEqual(config.validate_rule_conf(Rule, False), False)
+        self.assertFalse(config.validate_rule_conf(Rule, False))
-        self.assertEqual(config.validate_rule_conf(Rule, 'disable'), False)
-
         self.assertEqual(config.validate_rule_conf(Rule, {}),
                          {'level': 'error'})
-        self.assertEqual(config.validate_rule_conf(Rule, 'enable'),
-                         {'level': 'error'})
 
         config.validate_rule_conf(Rule, {'level': 'error'})
         config.validate_rule_conf(Rule, {'level': 'warning'})
@@ -133,22 +135,22 @@ class SimpleConfigTestCase(unittest.TestCase):
                           config.validate_rule_conf, Rule, {'level': 'warn'})
 
         Rule.CONF = {'length': int}
+        Rule.DEFAULT = {'length': 80}
         config.validate_rule_conf(Rule, {'length': 8})
-        self.assertRaises(config.YamlLintConfigError,
+        config.validate_rule_conf(Rule, {})
-                          config.validate_rule_conf, Rule, {})
         self.assertRaises(config.YamlLintConfigError,
                           config.validate_rule_conf, Rule, {'height': 8})
 
         Rule.CONF = {'a': bool, 'b': int}
+        Rule.DEFAULT = {'a': True, 'b': -42}
         config.validate_rule_conf(Rule, {'a': True, 'b': 0})
-        self.assertRaises(config.YamlLintConfigError,
+        config.validate_rule_conf(Rule, {'a': True})
-                          config.validate_rule_conf, Rule, {'a': True})
+        config.validate_rule_conf(Rule, {'b': 0})
-        self.assertRaises(config.YamlLintConfigError,
-                          config.validate_rule_conf, Rule, {'b': 0})
         self.assertRaises(config.YamlLintConfigError,
                           config.validate_rule_conf, Rule, {'a': 1, 'b': 0})
 
         Rule.CONF = {'choice': (True, 88, 'str')}
+        Rule.DEFAULT = {'choice': 88}
         config.validate_rule_conf(Rule, {'choice': True})
         config.validate_rule_conf(Rule, {'choice': 88})
         config.validate_rule_conf(Rule, {'choice': 'str'})
@@ -160,16 +162,72 @@ class SimpleConfigTestCase(unittest.TestCase):
                           config.validate_rule_conf, Rule, {'choice': 'abc'})
 
         Rule.CONF = {'choice': (int, 'hardcoded')}
+        Rule.DEFAULT = {'choice': 1337}
         config.validate_rule_conf(Rule, {'choice': 42})
         config.validate_rule_conf(Rule, {'choice': 'hardcoded'})
+        config.validate_rule_conf(Rule, {})
         self.assertRaises(config.YamlLintConfigError,
                           config.validate_rule_conf, Rule, {'choice': False})
         self.assertRaises(config.YamlLintConfigError,
                           config.validate_rule_conf, Rule, {'choice': 'abc'})
 
+        Rule.CONF = {'multiple': ['item1', 'item2', 'item3']}
+        Rule.DEFAULT = {'multiple': ['item1']}
+        config.validate_rule_conf(Rule, {'multiple': []})
+        config.validate_rule_conf(Rule, {'multiple': ['item2']})
+        config.validate_rule_conf(Rule, {'multiple': ['item2', 'item3']})
+        config.validate_rule_conf(Rule, {})
+        self.assertRaises(config.YamlLintConfigError,
+                          config.validate_rule_conf, Rule,
+                          {'multiple': 'item1'})
+        self.assertRaises(config.YamlLintConfigError,
+                          config.validate_rule_conf, Rule,
+                          {'multiple': ['']})
+        self.assertRaises(config.YamlLintConfigError,
+                          config.validate_rule_conf, Rule,
+                          {'multiple': ['item1', 4]})
+        self.assertRaises(config.YamlLintConfigError,
+                          config.validate_rule_conf, Rule,
+                          {'multiple': ['item4']})
+
+    def test_invalid_rule(self):
+        with self.assertRaisesRegex(
+                config.YamlLintConfigError,
+                'invalid config: rule "colons": should be either '
+                '"enable", "disable" or a dict'):
+            config.YamlLintConfig('rules:\n'
+                                  '  colons: invalid\n')
+
+    def test_invalid_ignore(self):
+        with self.assertRaisesRegex(
+                config.YamlLintConfigError,
+                'invalid config: ignore should contain file patterns'):
+            config.YamlLintConfig('ignore: yes\n')
+
+    def test_invalid_rule_ignore(self):
+        with self.assertRaisesRegex(
+                config.YamlLintConfigError,
+                'invalid config: ignore should contain file patterns'):
+            config.YamlLintConfig('rules:\n'
+                                  '  colons:\n'
+                                  '    ignore: yes\n')
+
+    def test_invalid_locale(self):
+        with self.assertRaisesRegex(
+                config.YamlLintConfigError,
+                'invalid config: locale should be a string'):
+            config.YamlLintConfig('locale: yes\n')
+
+    def test_invalid_yaml_files(self):
+        with self.assertRaisesRegex(
+                config.YamlLintConfigError,
+                'invalid config: yaml-files should be a list of file '
+                'patterns'):
+            config.YamlLintConfig('yaml-files: yes\n')
+
 
 class ExtendedConfigTestCase(unittest.TestCase):
-    def test_extend_add_rule(self):
+    def test_extend_on_object(self):
         old = config.YamlLintConfig('rules:\n'
                                     '  colons:\n'
                                     '    max-spaces-before: 0\n'
@@ -186,60 +244,150 @@ class ExtendedConfigTestCase(unittest.TestCase):
 
         self.assertEqual(len(new.enabled_rules(None)), 2)
 
-    def test_extend_remove_rule(self):
+    def test_extend_on_file(self):
-        old = config.YamlLintConfig('rules:\n'
+        with tempfile.NamedTemporaryFile('w') as f:
-                                    '  colons:\n'
+            f.write('rules:\n'
-                                    '    max-spaces-before: 0\n'
+                    '  colons:\n'
-                                    '    max-spaces-after: 1\n'
+                    '    max-spaces-before: 0\n'
-                                    '  hyphens:\n'
+                    '    max-spaces-after: 1\n')
-                                    '    max-spaces-after: 2\n')
+            f.flush()
-        new = config.YamlLintConfig('rules:\n'
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
-                                    '  colons: disable\n')
+                                      'rules:\n'
-        new.extend(old)
+                                      '  hyphens:\n'
-
+                                      '    max-spaces-after: 2\n')
-        self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
+
-        self.assertEqual(new.rules['colons'], False)
+        self.assertEqual(sorted(c.rules.keys()), ['colons', 'hyphens'])
-        self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 0)
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
+        self.assertEqual(c.rules['hyphens']['max-spaces-after'], 2)
+
+        self.assertEqual(len(c.enabled_rules(None)), 2)
 
-        self.assertEqual(len(new.enabled_rules(None)), 1)
+    def test_extend_remove_rule(self):
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('rules:\n'
+                    '  colons:\n'
+                    '    max-spaces-before: 0\n'
+                    '    max-spaces-after: 1\n'
+                    '  hyphens:\n'
+                    '    max-spaces-after: 2\n')
+            f.flush()
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
+                                      'rules:\n'
+                                      '  colons: disable\n')
+
+        self.assertEqual(sorted(c.rules.keys()), ['colons', 'hyphens'])
+        self.assertFalse(c.rules['colons'])
+        self.assertEqual(c.rules['hyphens']['max-spaces-after'], 2)
+
+        self.assertEqual(len(c.enabled_rules(None)), 1)
 
     def test_extend_edit_rule(self):
-        old = config.YamlLintConfig('rules:\n'
+        with tempfile.NamedTemporaryFile('w') as f:
-                                    '  colons:\n'
+            f.write('rules:\n'
-                                    '    max-spaces-before: 0\n'
+                    '  colons:\n'
-                                    '    max-spaces-after: 1\n'
+                    '    max-spaces-before: 0\n'
-                                    '  hyphens:\n'
+                    '    max-spaces-after: 1\n'
-                                    '    max-spaces-after: 2\n')
+                    '  hyphens:\n'
-        new = config.YamlLintConfig('rules:\n'
+                    '    max-spaces-after: 2\n')
-                                    '  colons:\n'
+            f.flush()
-                                    '    max-spaces-before: 3\n'
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
-                                    '    max-spaces-after: 4\n')
+                                      'rules:\n'
-        new.extend(old)
+                                      '  colons:\n'
-
+                                      '    max-spaces-before: 3\n'
-        self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
+                                      '    max-spaces-after: 4\n')
-        self.assertEqual(new.rules['colons']['max-spaces-before'], 3)
+
-        self.assertEqual(new.rules['colons']['max-spaces-after'], 4)
+        self.assertEqual(sorted(c.rules.keys()), ['colons', 'hyphens'])
-        self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 3)
-
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 4)
-        self.assertEqual(len(new.enabled_rules(None)), 2)
+        self.assertEqual(c.rules['hyphens']['max-spaces-after'], 2)
+
+        self.assertEqual(len(c.enabled_rules(None)), 2)
 
     def test_extend_reenable_rule(self):
-        old = config.YamlLintConfig('rules:\n'
+        with tempfile.NamedTemporaryFile('w') as f:
-                                    '  colons:\n'
+            f.write('rules:\n'
-                                    '    max-spaces-before: 0\n'
+                    '  colons:\n'
-                                    '    max-spaces-after: 1\n'
+                    '    max-spaces-before: 0\n'
-                                    '  hyphens: disable\n')
+                    '    max-spaces-after: 1\n'
-        new = config.YamlLintConfig('rules:\n'
+                    '  hyphens: disable\n')
-                                    '  hyphens:\n'
+            f.flush()
-                                    '    max-spaces-after: 2\n')
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
-        new.extend(old)
+                                      'rules:\n'
-
+                                      '  hyphens:\n'
-        self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
+                                      '    max-spaces-after: 2\n')
-        self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
+
-        self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
+        self.assertEqual(sorted(c.rules.keys()), ['colons', 'hyphens'])
-        self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 0)
-
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
-        self.assertEqual(len(new.enabled_rules(None)), 2)
+        self.assertEqual(c.rules['hyphens']['max-spaces-after'], 2)
+
+        self.assertEqual(len(c.enabled_rules(None)), 2)
+
+    def test_extend_recursive_default_values(self):
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('rules:\n'
+                    '  braces:\n'
+                    '    max-spaces-inside: 1248\n')
+            f.flush()
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
+                                      'rules:\n'
+                                      '  braces:\n'
+                                      '    min-spaces-inside-empty: 2357\n')
+
+        self.assertEqual(c.rules['braces']['min-spaces-inside'], 0)
+        self.assertEqual(c.rules['braces']['max-spaces-inside'], 1248)
+        self.assertEqual(c.rules['braces']['min-spaces-inside-empty'], 2357)
+        self.assertEqual(c.rules['braces']['max-spaces-inside-empty'], -1)
+
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('rules:\n'
+                    '  colons:\n'
+                    '    max-spaces-before: 1337\n')
+            f.flush()
+            c = config.YamlLintConfig('extends: ' + f.name + '\n'
+                                      'rules:\n'
+                                      '  colons: enable\n')
+
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 1337)
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
+
+        with tempfile.NamedTemporaryFile('w') as f1, \
+                tempfile.NamedTemporaryFile('w') as f2:
+            f1.write('rules:\n'
+                     '  colons:\n'
+                     '    max-spaces-before: 1337\n')
+            f1.flush()
+            f2.write('extends: ' + f1.name + '\n'
+                     'rules:\n'
+                     '  colons: disable\n')
+            f2.flush()
+            c = config.YamlLintConfig('extends: ' + f2.name + '\n'
+                                      'rules:\n'
+                                      '  colons: enable\n')
+
+        self.assertEqual(c.rules['colons']['max-spaces-before'], 0)
+        self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
+
+    def test_extended_ignore_str(self):
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('ignore: |\n'
+                    '  *.template.yaml\n')
+            f.flush()
+            c = config.YamlLintConfig('extends: ' + f.name + '\n')
+
+        self.assertEqual(c.ignore.match_file('test.template.yaml'), True)
+        self.assertEqual(c.ignore.match_file('test.yaml'), False)
+
+    def test_extended_ignore_list(self):
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('ignore:\n'
+                    '  - "*.template.yaml"\n')
+            f.flush()
+            c = config.YamlLintConfig('extends: ' + f.name + '\n')
+
+        self.assertEqual(c.ignore.match_file('test.template.yaml'), True)
+        self.assertEqual(c.ignore.match_file('test.yaml'), False)
 
 
 class ExtendedLibraryConfigTestCase(unittest.TestCase):
@@ -271,6 +419,9 @@ class ExtendedLibraryConfigTestCase(unittest.TestCase):
         self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
         for rule in new.rules:
             self.assertEqual(new.rules[rule], old.rules[rule])
+        self.assertEqual(new.rules['empty-lines']['max'], 42)
+        self.assertEqual(new.rules['empty-lines']['max-start'], 43)
+        self.assertEqual(new.rules['empty-lines']['max-end'], 44)
 
     def test_extend_config_override_rule_partly(self):
         old = config.YamlLintConfig('extends: default')
@@ -284,12 +435,15 @@ class ExtendedLibraryConfigTestCase(unittest.TestCase):
         self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
         for rule in new.rules:
             self.assertEqual(new.rules[rule], old.rules[rule])
+        self.assertEqual(new.rules['empty-lines']['max'], 2)
+        self.assertEqual(new.rules['empty-lines']['max-start'], 42)
+        self.assertEqual(new.rules['empty-lines']['max-end'], 0)
 
 
-class IgnorePathConfigTestCase(unittest.TestCase):
+class IgnoreConfigTestCase(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
-        super(IgnorePathConfigTestCase, cls).setUpClass()
+        super().setUpClass()
 
         bad_yaml = ('---\n'
                     '- key: val1\n'
@@ -309,22 +463,6 @@ class IgnorePathConfigTestCase(unittest.TestCase):
             's/s/ign-trail/file.yaml': bad_yaml,
             's/s/ign-trail/s/s/file.yaml': bad_yaml,
             's/s/ign-trail/s/s/file2.lint-me-anyway.yaml': bad_yaml,
-
-            '.yamllint': 'ignore: |\n'
-                         '  *.dont-lint-me.yaml\n'
-                         '  /bin/\n'
-                         '  !/bin/*.lint-me-anyway.yaml\n'
-                         '\n'
-                         'extends: default\n'
-                         '\n'
-                         'rules:\n'
-                         '  key-duplicates:\n'
-                         '    ignore: |\n'
-                         '      /ign-dup\n'
-                         '  trailing-spaces:\n'
-                         '    ignore: |\n'
-                         '      ign-trail\n'
-                         '      !*.lint-me-anyway.yaml\n',
         })
 
         cls.backup_wd = os.getcwd()
@@ -332,14 +470,255 @@ class IgnorePathConfigTestCase(unittest.TestCase):
 
     @classmethod
     def tearDownClass(cls):
-        super(IgnorePathConfigTestCase, cls).tearDownClass()
+        super().tearDownClass()
 
         os.chdir(cls.backup_wd)
 
         shutil.rmtree(cls.wd)
 
-    @unittest.skipIf(sys.version_info < (2, 7), 'Python 2.6 not supported')
+    def test_mutually_exclusive_ignore_keys(self):
-    def test_run_with_ignored_path(self):
+        self.assertRaises(
+            YamlLintConfigError,
+            config.YamlLintConfig, 'extends: default\n'
+                                   'ignore-from-file: .gitignore\n'
+                                   'ignore: |\n'
+                                   '  *.dont-lint-me.yaml\n'
+                                   '  /bin/\n')
+
+    def test_ignore_from_file_not_exist(self):
+        self.assertRaises(
+            FileNotFoundError,
+            config.YamlLintConfig, 'extends: default\n'
+                                   'ignore-from-file: not_found_file\n')
+
+    def test_ignore_from_file_incorrect_type(self):
+        self.assertRaises(
+            YamlLintConfigError,
+            config.YamlLintConfig, 'extends: default\n'
+                                   'ignore-from-file: 0\n')
+        self.assertRaises(
+            YamlLintConfigError,
+            config.YamlLintConfig, 'extends: default\n'
+                                   'ignore-from-file: [0]\n')
+
+    def test_no_ignore(self):
+        sys.stdout = StringIO()
+        with self.assertRaises(SystemExit):
+            cli.run(('-f', 'parsable', '.'))
+
+        out = sys.stdout.getvalue()
+        out = '\n'.join(sorted(out.splitlines()))
+
+        keydup = '[error] duplication of key "key" in mapping (key-duplicates)'
+        trailing = '[error] trailing spaces (trailing-spaces)'
+        hyphen = '[error] too many spaces after hyphen (hyphens)'
+
+        self.assertEqual(out, '\n'.join((
+            './bin/file.lint-me-anyway.yaml:3:3: ' + keydup,
+            './bin/file.lint-me-anyway.yaml:4:17: ' + trailing,
+            './bin/file.lint-me-anyway.yaml:5:5: ' + hyphen,
+            './bin/file.yaml:3:3: ' + keydup,
+            './bin/file.yaml:4:17: ' + trailing,
+            './bin/file.yaml:5:5: ' + hyphen,
+            './file-at-root.yaml:3:3: ' + keydup,
+            './file-at-root.yaml:4:17: ' + trailing,
+            './file-at-root.yaml:5:5: ' + hyphen,
+            './file.dont-lint-me.yaml:3:3: ' + keydup,
+            './file.dont-lint-me.yaml:4:17: ' + trailing,
+            './file.dont-lint-me.yaml:5:5: ' + hyphen,
+            './ign-dup/file.yaml:3:3: ' + keydup,
+            './ign-dup/file.yaml:4:17: ' + trailing,
+            './ign-dup/file.yaml:5:5: ' + hyphen,
+            './ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './ign-trail/file.yaml:3:3: ' + keydup,
+            './ign-trail/file.yaml:4:17: ' + trailing,
+            './ign-trail/file.yaml:5:5: ' + hyphen,
+            './include/ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './include/ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './include/ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/file.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:5:5: ' + hyphen,
+        )))
+
+    def test_run_with_ignore_str(self):
+        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+            f.write('extends: default\n'
+                    'ignore: |\n'
+                    '  *.dont-lint-me.yaml\n'
+                    '  /bin/\n'
+                    '  !/bin/*.lint-me-anyway.yaml\n'
+                    'rules:\n'
+                    '  key-duplicates:\n'
+                    '    ignore: |\n'
+                    '      /ign-dup\n'
+                    '  trailing-spaces:\n'
+                    '    ignore: |\n'
+                    '      ign-trail\n'
+                    '      !*.lint-me-anyway.yaml\n')
+
+        sys.stdout = StringIO()
+        with self.assertRaises(SystemExit):
+            cli.run(('-f', 'parsable', '.'))
+
+        out = sys.stdout.getvalue()
+        out = '\n'.join(sorted(out.splitlines()))
+
+        docstart = '[warning] missing document start "---" (document-start)'
+        keydup = '[error] duplication of key "key" in mapping (key-duplicates)'
+        trailing = '[error] trailing spaces (trailing-spaces)'
+        hyphen = '[error] too many spaces after hyphen (hyphens)'
+
+        self.assertEqual(out, '\n'.join((
+            './.yamllint:1:1: ' + docstart,
+            './bin/file.lint-me-anyway.yaml:3:3: ' + keydup,
+            './bin/file.lint-me-anyway.yaml:4:17: ' + trailing,
+            './bin/file.lint-me-anyway.yaml:5:5: ' + hyphen,
+            './file-at-root.yaml:3:3: ' + keydup,
+            './file-at-root.yaml:4:17: ' + trailing,
+            './file-at-root.yaml:5:5: ' + hyphen,
+            './ign-dup/file.yaml:4:17: ' + trailing,
+            './ign-dup/file.yaml:5:5: ' + hyphen,
+            './ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './ign-trail/file.yaml:3:3: ' + keydup,
+            './ign-trail/file.yaml:5:5: ' + hyphen,
+            './include/ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './include/ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './include/ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:5:5: ' + hyphen,
+        )))
+
+    def test_run_with_ignore_list(self):
+        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+            f.write('extends: default\n'
+                    'ignore:\n'
+                    '  - "*.dont-lint-me.yaml"\n'
+                    '  - "/bin/"\n'
+                    '  - "!/bin/*.lint-me-anyway.yaml"\n'
+                    'rules:\n'
+                    '  key-duplicates:\n'
+                    '    ignore:\n'
+                    '      - "/ign-dup"\n'
+                    '  trailing-spaces:\n'
+                    '    ignore:\n'
+                    '      - "ign-trail"\n'
+                    '      - "!*.lint-me-anyway.yaml"\n')
+
+        sys.stdout = StringIO()
+        with self.assertRaises(SystemExit):
+            cli.run(('-f', 'parsable', '.'))
+
+        out = sys.stdout.getvalue()
+        out = '\n'.join(sorted(out.splitlines()))
+
+        docstart = '[warning] missing document start "---" (document-start)'
+        keydup = '[error] duplication of key "key" in mapping (key-duplicates)'
+        trailing = '[error] trailing spaces (trailing-spaces)'
+        hyphen = '[error] too many spaces after hyphen (hyphens)'
+
+        self.assertEqual(out, '\n'.join((
+            './.yamllint:1:1: ' + docstart,
+            './bin/file.lint-me-anyway.yaml:3:3: ' + keydup,
+            './bin/file.lint-me-anyway.yaml:4:17: ' + trailing,
+            './bin/file.lint-me-anyway.yaml:5:5: ' + hyphen,
+            './file-at-root.yaml:3:3: ' + keydup,
+            './file-at-root.yaml:4:17: ' + trailing,
+            './file-at-root.yaml:5:5: ' + hyphen,
+            './ign-dup/file.yaml:4:17: ' + trailing,
+            './ign-dup/file.yaml:5:5: ' + hyphen,
+            './ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './ign-trail/file.yaml:3:3: ' + keydup,
+            './ign-trail/file.yaml:5:5: ' + hyphen,
+            './include/ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './include/ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './include/ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:5:5: ' + hyphen,
+        )))
+
+    def test_run_with_ignore_from_file(self):
+        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+            f.write('extends: default\n'
+                    'ignore-from-file: .gitignore\n')
+        with open(os.path.join(self.wd, '.gitignore'), 'w') as f:
+            f.write('*.dont-lint-me.yaml\n'
+                    '/bin/\n'
+                    '!/bin/*.lint-me-anyway.yaml\n')
+
+        sys.stdout = StringIO()
+        with self.assertRaises(SystemExit):
+            cli.run(('-f', 'parsable', '.'))
+
+        out = sys.stdout.getvalue()
+        out = '\n'.join(sorted(out.splitlines()))
+
+        docstart = '[warning] missing document start "---" (document-start)'
+        keydup = '[error] duplication of key "key" in mapping (key-duplicates)'
+        trailing = '[error] trailing spaces (trailing-spaces)'
+        hyphen = '[error] too many spaces after hyphen (hyphens)'
+
+        self.assertEqual(out, '\n'.join((
+            './.yamllint:1:1: ' + docstart,
+            './bin/file.lint-me-anyway.yaml:3:3: ' + keydup,
+            './bin/file.lint-me-anyway.yaml:4:17: ' + trailing,
+            './bin/file.lint-me-anyway.yaml:5:5: ' + hyphen,
+            './file-at-root.yaml:3:3: ' + keydup,
+            './file-at-root.yaml:4:17: ' + trailing,
+            './file-at-root.yaml:5:5: ' + hyphen,
+            './ign-dup/file.yaml:3:3: ' + keydup,
+            './ign-dup/file.yaml:4:17: ' + trailing,
+            './ign-dup/file.yaml:5:5: ' + hyphen,
+            './ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './ign-trail/file.yaml:3:3: ' + keydup,
+            './ign-trail/file.yaml:4:17: ' + trailing,
+            './ign-trail/file.yaml:5:5: ' + hyphen,
+            './include/ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
+            './include/ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
+            './include/ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/file.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file.yaml:5:5: ' + hyphen,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:4:17: ' + trailing,
+            './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:5:5: ' + hyphen,
+        )))
+
+    def test_run_with_ignored_from_file(self):
+        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+            f.write('ignore-from-file: [.gitignore, .yamlignore]\n'
+                    'extends: default\n')
+        with open(os.path.join(self.wd, '.gitignore'), 'w') as f:
+            f.write('*.dont-lint-me.yaml\n'
+                    '/bin/\n')
+        with open(os.path.join(self.wd, '.yamlignore'), 'w') as f:
+            f.write('!/bin/*.lint-me-anyway.yaml\n')
+
         sys.stdout = StringIO()
         with self.assertRaises(SystemExit):
             cli.run(('-f', 'parsable', '.'))
@@ -347,29 +726,36 @@ class IgnorePathConfigTestCase(unittest.TestCase):
         out = sys.stdout.getvalue()
         out = '\n'.join(sorted(out.splitlines()))
 
+        docstart = '[warning] missing document start "---" (document-start)'
         keydup = '[error] duplication of key "key" in mapping (key-duplicates)'
         trailing = '[error] trailing spaces (trailing-spaces)'
         hyphen = '[error] too many spaces after hyphen (hyphens)'
 
         self.assertEqual(out, '\n'.join((
+            './.yamllint:1:1: ' + docstart,
             './bin/file.lint-me-anyway.yaml:3:3: ' + keydup,
             './bin/file.lint-me-anyway.yaml:4:17: ' + trailing,
             './bin/file.lint-me-anyway.yaml:5:5: ' + hyphen,
             './file-at-root.yaml:3:3: ' + keydup,
             './file-at-root.yaml:4:17: ' + trailing,
             './file-at-root.yaml:5:5: ' + hyphen,
+            './ign-dup/file.yaml:3:3: ' + keydup,
             './ign-dup/file.yaml:4:17: ' + trailing,
             './ign-dup/file.yaml:5:5: ' + hyphen,
+            './ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
             './ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
             './ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
             './ign-trail/file.yaml:3:3: ' + keydup,
+            './ign-trail/file.yaml:4:17: ' + trailing,
             './ign-trail/file.yaml:5:5: ' + hyphen,
             './include/ign-dup/sub/dir/file.yaml:3:3: ' + keydup,
             './include/ign-dup/sub/dir/file.yaml:4:17: ' + trailing,
             './include/ign-dup/sub/dir/file.yaml:5:5: ' + hyphen,
             './s/s/ign-trail/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/file.yaml:4:17: ' + trailing,
             './s/s/ign-trail/file.yaml:5:5: ' + hyphen,
             './s/s/ign-trail/s/s/file.yaml:3:3: ' + keydup,
+            './s/s/ign-trail/s/s/file.yaml:4:17: ' + trailing,
             './s/s/ign-trail/s/s/file.yaml:5:5: ' + hyphen,
             './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:3:3: ' + keydup,
             './s/s/ign-trail/s/s/file2.lint-me-anyway.yaml:4:17: ' + trailing,

tests/test_linter.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,12 +14,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import io
-import sys
+import unittest
-try:
-    assert sys.version_info >= (2, 7)
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
 from yamllint.config import YamlLintConfig
 from yamllint import linter
@@ -37,10 +31,10 @@ class LinterTestCase(unittest.TestCase):
         linter.run(b'test: document', self.fake_config())
 
     def test_run_on_unicode(self):
-        linter.run(u'test: document', self.fake_config())
+        linter.run('test: document', self.fake_config())
 
     def test_run_on_stream(self):
-        linter.run(io.StringIO(u'hello'), self.fake_config())
+        linter.run(io.StringIO('hello'), self.fake_config())
 
     def test_run_on_int(self):
         self.assertRaises(TypeError, linter.run, 42, self.fake_config())
@@ -50,13 +44,23 @@ class LinterTestCase(unittest.TestCase):
                           ['h', 'e', 'l', 'l', 'o'], self.fake_config())
 
     def test_run_on_non_ascii_chars(self):
-        s = (u'- hétérogénéité\n'
+        s = ('- hétérogénéité\n'
-             u'# 19.99 €\n')
+             '# 19.99 €\n')
         linter.run(s, self.fake_config())
         linter.run(s.encode('utf-8'), self.fake_config())
         linter.run(s.encode('iso-8859-15'), self.fake_config())
 
-        s = (u'- お早う御座います。\n'
+        s = ('- お早う御座います。\n'
-             u'# الأَبْجَدِيَّة العَرَبِيَّة\n')
+             '# الأَبْجَدِيَّة العَرَبِيَّة\n')
         linter.run(s, self.fake_config())
         linter.run(s.encode('utf-8'), self.fake_config())
+
+    def test_linter_problem_repr_without_rule(self):
+        problem = linter.LintProblem(1, 2, 'problem')
+
+        self.assertEqual(str(problem), '1:2: problem')
+
+    def test_linter_problem_repr_with_rule(self):
+        problem = linter.LintProblem(1, 2, 'problem', 'rule-id')
+
+        self.assertEqual(str(problem), '1:2: problem (rule-id)')

tests/test_module.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,17 +18,12 @@ import shutil
 import subprocess
 import tempfile
 import sys
-try:
+import unittest
-    assert sys.version_info >= (2, 7)
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
 
 PYTHON = sys.executable or 'python'
 
 
-@unittest.skipIf(sys.version_info < (2, 7), 'Python 2.6 not supported')
 class ModuleTestCase(unittest.TestCase):
     def setUp(self):
         self.wd = tempfile.mkdtemp(prefix='yamllint-tests-')
@@ -52,16 +46,15 @@ class ModuleTestCase(unittest.TestCase):
             subprocess.check_output([PYTHON, '-m', 'yamllint'],
                                     stderr=subprocess.STDOUT)
         self.assertEqual(ctx.exception.returncode, 2)
-        self.assertRegexpMatches(ctx.exception.output.decode(),
+        self.assertRegex(ctx.exception.output.decode(), r'^usage: yamllint')
-                                 r'^usage: yamllint')
 
     def test_run_module_on_bad_dir(self):
         with self.assertRaises(subprocess.CalledProcessError) as ctx:
             subprocess.check_output([PYTHON, '-m', 'yamllint',
                                      '/does/not/exist'],
                                     stderr=subprocess.STDOUT)
-        self.assertRegexpMatches(ctx.exception.output.decode(),
+        self.assertRegex(ctx.exception.output.decode(),
-                                 r'No such file or directory')
+                         r'No such file or directory')
 
     def test_run_module_on_file(self):
         out = subprocess.check_output(

tests/test_parser.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,12 +13,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import sys
+import unittest
-try:
-    assert sys.version_info >= (2, 7)
-    import unittest
-except AssertionError:
-    import unittest2 as unittest
 
 import yaml
 
@@ -70,12 +64,12 @@ class ParserTestCase(unittest.TestCase):
     def test_token_or_comment_generator(self):
         e = list(token_or_comment_generator(''))
         self.assertEqual(len(e), 2)
-        self.assertEqual(e[0].prev, None)
+        self.assertIsNone(e[0].prev)
         self.assertIsInstance(e[0].curr, yaml.Token)
         self.assertIsInstance(e[0].next, yaml.Token)
         self.assertEqual(e[1].prev, e[0].curr)
         self.assertEqual(e[1].curr, e[0].next)
-        self.assertEqual(e[1].next, None)
+        self.assertIsNone(e[1].next)
 
         e = list(token_or_comment_generator('---\n'
                                             'k: v\n'))

tests/test_spec_examples.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,7 +13,6 @@
 # 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 io import open
 import os
 
 from tests.common import RuleTestCase
@@ -54,8 +52,8 @@ conf_general = ('document-start: disable\n'
                 'braces: {min-spaces-inside: 1, max-spaces-inside: 1}\n'
                 'brackets: {min-spaces-inside: 1, max-spaces-inside: 1}\n')
 conf_overrides = {
-    'example-2.2': ('colons: {max-spaces-after: 2}\n'),
+    'example-2.2': 'colons: {max-spaces-after: 2}\n',
-    'example-2.4': ('colons: {max-spaces-after: 3}\n'),
+    'example-2.4': 'colons: {max-spaces-after: 3}\n',
     'example-2.5': ('empty-lines: {max-end: 2}\n'
                     'brackets: {min-spaces-inside: 0, max-spaces-inside: 2}\n'
                     'commas: {max-spaces-before: -1}\n'),
@@ -63,65 +61,65 @@ conf_overrides = {
                     'indentation: disable\n'),
     'example-2.12': ('empty-lines: {max-end: 1}\n'
                      'colons: {max-spaces-before: -1}\n'),
-    'example-2.16': ('empty-lines: {max-end: 1}\n'),
+    'example-2.16': 'empty-lines: {max-end: 1}\n',
-    '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: false}\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',
-    'example-6.6': ('trailing-spaces: disable\n'),
+    'example-6.6': 'trailing-spaces: disable\n',
-    'example-6.7': ('trailing-spaces: disable\n'),
+    'example-6.7': 'trailing-spaces: disable\n',
-    'example-6.8': ('trailing-spaces: disable\n'),
+    'example-6.8': 'trailing-spaces: disable\n',
     'example-6.10': ('empty-lines: {max-end: 2}\n'
                      'trailing-spaces: disable\n'
                      'comments-indentation: disable\n'),
     'example-6.11': ('empty-lines: {max-end: 1}\n'
                      'comments-indentation: disable\n'),
-    'example-6.13': ('comments-indentation: disable\n'),
+    'example-6.13': 'comments-indentation: disable\n',
-    'example-6.14': ('comments-indentation: disable\n'),
+    'example-6.14': 'comments-indentation: disable\n',
-    'example-6.23': ('colons: {max-spaces-before: 1}\n'),
+    'example-6.23': 'colons: {max-spaces-before: 1}\n',
     'example-7.4': ('colons: {max-spaces-before: 1}\n'
                     'indentation: disable\n'),
-    'example-7.5': ('trailing-spaces: disable\n'),
+    'example-7.5': 'trailing-spaces: disable\n',
-    'example-7.6': ('trailing-spaces: disable\n'),
+    'example-7.6': 'trailing-spaces: disable\n',
-    'example-7.7': ('indentation: disable\n'),
+    'example-7.7': 'indentation: disable\n',
     'example-7.8': ('colons: {max-spaces-before: 1}\n'
                     'indentation: disable\n'),
-    'example-7.9': ('trailing-spaces: disable\n'),
+    'example-7.9': 'trailing-spaces: disable\n',
     'example-7.11': ('colons: {max-spaces-before: 1}\n'
                      'indentation: disable\n'),
     'example-7.13': ('brackets: {min-spaces-inside: 0, max-spaces-inside: 1}\n'
                      'commas: {max-spaces-before: 1, min-spaces-after: 0}\n'),
-    'example-7.14': ('indentation: disable\n'),
+    'example-7.14': 'indentation: disable\n',
     'example-7.15': ('braces: {min-spaces-inside: 0, max-spaces-inside: 1}\n'
                      'commas: {max-spaces-before: 1, min-spaces-after: 0}\n'
                      'colons: {max-spaces-before: 1}\n'),
-    'example-7.16': ('indentation: disable\n'),
+    'example-7.16': 'indentation: disable\n',
-    'example-7.17': ('indentation: disable\n'),
+    'example-7.17': 'indentation: disable\n',
-    'example-7.18': ('indentation: disable\n'),
+    'example-7.18': 'indentation: disable\n',
-    'example-7.19': ('indentation: disable\n'),
+    'example-7.19': 'indentation: disable\n',
     'example-7.20': ('colons: {max-spaces-before: 1}\n'
                      'indentation: disable\n'),
-    'example-8.1': ('empty-lines: {max-end: 1}\n'),
+    'example-8.1': 'empty-lines: {max-end: 1}\n',
-    'example-8.2': ('trailing-spaces: disable\n'),
+    'example-8.2': 'trailing-spaces: disable\n',
     'example-8.5': ('comments-indentation: disable\n'
                     'trailing-spaces: disable\n'),
-    'example-8.6': ('empty-lines: {max-end: 1}\n'),
+    'example-8.6': 'empty-lines: {max-end: 1}\n',
-    'example-8.7': ('empty-lines: {max-end: 1}\n'),
+    'example-8.7': 'empty-lines: {max-end: 1}\n',
-    'example-8.8': ('trailing-spaces: disable\n'),
+    'example-8.8': 'trailing-spaces: disable\n',
-    'example-8.9': ('empty-lines: {max-end: 1}\n'),
+    'example-8.9': 'empty-lines: {max-end: 1}\n',
-    '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: false}\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: false}\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',
 }
 
 files = os.listdir(os.path.join(os.path.dirname(os.path.realpath(__file__)),

tests/test_syntax_errors.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

tests/test_yamllint_directives.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -232,6 +231,34 @@ class YamllintDirectivesTestCase(RuleTestCase):
                    problem1=(3, 18, 'trailing-spaces'),
                    problem2=(4, 8, 'colons'))
 
+    def test_disable_directive_with_rules_and_dos_lines(self):
+        conf = self.conf + 'new-lines: {type: dos}\n'
+        self.check('---\r\n'
+                   '- [valid , YAML]\r\n'
+                   '# yamllint disable rule:trailing-spaces\r\n'
+                   '- trailing spaces    \r\n'
+                   '- bad   : colon\r\n'
+                   '- [valid , YAML]\r\n'
+                   '# yamllint enable rule:trailing-spaces\r\n'
+                   '- bad  : colon and spaces   \r\n'
+                   '- [valid , YAML]\r\n',
+                   conf,
+                   problem1=(5, 8, 'colons'),
+                   problem2=(8, 7, 'colons'),
+                   problem3=(8, 26, 'trailing-spaces'))
+        self.check('---\r\n'
+                   '- [valid , YAML]\r\n'
+                   '- trailing spaces    \r\n'
+                   '- bad   : colon\r\n'
+                   '- [valid , YAML]\r\n'
+                   '# yamllint disable-line rule:colons\r\n'
+                   '- bad  : colon and spaces   \r\n'
+                   '- [valid , YAML]\r\n',
+                   conf,
+                   problem1=(3, 18, 'trailing-spaces'),
+                   problem2=(4, 8, 'colons'),
+                   problem3=(7, 26, 'trailing-spaces'))
+
     def test_directive_on_last_line(self):
         conf = 'new-line-at-end-of-file: {}'
         self.check('---\n'
@@ -302,3 +329,104 @@ class YamllintDirectivesTestCase(RuleTestCase):
                    '    c: [x]\n',
                    conf,
                    problem=(6, 2, 'comments-indentation'))
+
+    def test_disable_file_directive(self):
+        conf = ('comments: {min-spaces-from-content: 2}\n'
+                'comments-indentation: {}\n')
+        self.check('# yamllint disable-file\n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf)
+        self.check('#    yamllint disable-file\n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf)
+        self.check('#yamllint disable-file\n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf)
+        self.check('#yamllint disable-file    \n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf)
+        self.check('---\n'
+                   '# yamllint disable-file\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf,
+                   problem1=(3, 8, 'comments'),
+                   problem2=(5, 2, 'comments-indentation'))
+        self.check('# yamllint disable-file: rules cannot be specified\n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf,
+                   problem1=(3, 8, 'comments'),
+                   problem2=(5, 2, 'comments-indentation'))
+        self.check('AAAA yamllint disable-file\n'
+                   '---\n'
+                   '- a: 1 # comment too close\n'
+                   '  b:\n'
+                   ' # wrong indentation\n'
+                   '    c: [x]\n',
+                   conf,
+                   problem1=(1, 1, 'document-start'),
+                   problem2=(3, 8, 'comments'),
+                   problem3=(5, 2, 'comments-indentation'))
+
+    def test_disable_file_directive_not_at_first_position(self):
+        self.check('# yamllint disable-file\n'
+                   '---\n'
+                   '- bad  : colon and spaces   \n',
+                   self.conf)
+        self.check('---\n'
+                   '# yamllint disable-file\n'
+                   '- bad  : colon and spaces   \n',
+                   self.conf,
+                   problem1=(3, 7, 'colons'),
+                   problem2=(3, 26, 'trailing-spaces'))
+
+    def test_disable_file_directive_with_syntax_error(self):
+        self.check('# This file is not valid YAML (it is a Jinja template)\n'
+                   '{% if extra_info %}\n'
+                   'key1: value1\n'
+                   '{% endif %}\n'
+                   'key2: value2\n',
+                   self.conf,
+                   problem=(2, 2, 'syntax'))
+        self.check('# yamllint disable-file\n'
+                   '# This file is not valid YAML (it is a Jinja template)\n'
+                   '{% if extra_info %}\n'
+                   'key1: value1\n'
+                   '{% endif %}\n'
+                   'key2: value2\n',
+                   self.conf)
+
+    def test_disable_file_directive_with_dos_lines(self):
+        self.check('# yamllint disable-file\r\n'
+                   '---\r\n'
+                   '- bad  : colon and spaces   \r\n',
+                   self.conf)
+        self.check('# yamllint disable-file\r\n'
+                   '# This file is not valid YAML (it is a Jinja template)\r\n'
+                   '{% if extra_info %}\r\n'
+                   'key1: value1\r\n'
+                   '{% endif %}\r\n'
+                   'key2: value2\r\n',
+                   self.conf)

yamllint/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -22,10 +21,10 @@ indentation, etc."""
 
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.11.1'
+APP_VERSION = '1.32.0'
 APP_DESCRIPTION = __doc__
 
-__author__ = u'Adrien Vergé'
+__author__ = 'Adrien Vergé'
-__copyright__ = u'Copyright 2016, Adrien Vergé'
+__copyright__ = 'Copyright 2022, Adrien Vergé'
 __license__ = 'GPLv3'
 __version__ = APP_VERSION

yamllint/cli.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,26 +13,26 @@
 # 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 __future__ import print_function
+import argparse
-
+import locale
 import os
-import sys
 import platform
-import argparse
+import sys
 
 from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
+from yamllint import linter
 from yamllint.config import YamlLintConfig, YamlLintConfigError
 from yamllint.linter import PROBLEM_LEVELS
-from yamllint import linter
 
 
-def find_files_recursively(items):
+def find_files_recursively(items, conf):
     for item in items:
         if os.path.isdir(item):
             for root, dirnames, filenames in os.walk(item):
-                for filename in [f for f in filenames
+                for f in filenames:
-                                 if f.endswith(('.yml', '.yaml'))]:
+                    filepath = os.path.join(root, f)
-                    yield os.path.join(root, filename)
+                    if conf.is_yaml_file(filepath):
+                        yield filepath
         else:
             yield item
 
@@ -47,7 +46,7 @@ def supports_color():
             hasattr(sys.stdout, 'isatty') and sys.stdout.isatty())
 
 
-class Format(object):
+class Format:
     @staticmethod
     def parsable(problem, filename):
         return ('%(file)s:%(line)s:%(column)s: [%(level)s] %(message)s' %
@@ -82,12 +81,88 @@ class Format(object):
             line += '  \033[2m(%s)\033[0m' % problem.rule
         return line
 
+    @staticmethod
+    def github(problem, filename):
+        line = '::'
+        line += problem.level
+        line += ' file=' + filename + ','
+        line += 'line=' + format(problem.line) + ','
+        line += 'col=' + format(problem.column)
+        line += '::'
+        line += format(problem.line)
+        line += ':'
+        line += format(problem.column)
+        line += ' '
+        if problem.rule:
+            line += '[' + problem.rule + '] '
+        line += problem.desc
+        return line
+
+
+def show_problems(problems, file, args_format, no_warn):
+    max_level = 0
+    first = True
+
+    if args_format == 'auto':
+        if ('GITHUB_ACTIONS' in os.environ and
+                'GITHUB_WORKFLOW' in os.environ):
+            args_format = 'github'
+        elif supports_color():
+            args_format = 'colored'
+
+    for problem in problems:
+        max_level = max(max_level, PROBLEM_LEVELS[problem.level])
+        if no_warn and (problem.level != 'error'):
+            continue
+        if args_format == 'parsable':
+            print(Format.parsable(problem, file))
+        elif args_format == 'github':
+            if first:
+                print('::group::%s' % file)
+                first = False
+            print(Format.github(problem, file))
+        elif args_format == 'colored':
+            if first:
+                print('\033[4m%s\033[0m' % file)
+                first = False
+            print(Format.standard_color(problem, file))
+        else:
+            if first:
+                print(file)
+                first = False
+            print(Format.standard(problem, file))
+
+    if not first and args_format == 'github':
+        print('::endgroup::')
+
+    if not first and args_format != 'parsable':
+        print('')
+
+    return max_level
+
+
+def find_project_config_filepath(path='.'):
+    for filename in ('.yamllint', '.yamllint.yaml', '.yamllint.yml'):
+        filepath = os.path.join(path, filename)
+        if os.path.isfile(filepath):
+            return filepath
+
+    if os.path.abspath(path) == os.path.abspath(os.path.expanduser('~')):
+        return None
+    if os.path.abspath(path) == os.path.abspath(os.path.join(path, '..')):
+        return None
+    return find_project_config_filepath(path=os.path.join(path, '..'))
+
 
 def run(argv=None):
     parser = argparse.ArgumentParser(prog=APP_NAME,
                                      description=APP_DESCRIPTION)
-    parser.add_argument('files', metavar='FILE_OR_DIR', nargs='+',
+    files_group = parser.add_mutually_exclusive_group(required=True)
-                        help='files to check')
+    files_group.add_argument('files', metavar='FILE_OR_DIR', nargs='*',
+                             default=(),
+                             help='files to check')
+    files_group.add_argument('-', action='store_true', dest='stdin',
+                             help='read from standard input')
     config_group = parser.add_mutually_exclusive_group()
     config_group.add_argument('-c', '--config-file', dest='config_file',
                               action='store',
@@ -95,27 +170,35 @@ def run(argv=None):
     config_group.add_argument('-d', '--config-data', dest='config_data',
                               action='store',
                               help='custom configuration (as YAML source)')
+    parser.add_argument('--list-files', action='store_true', dest='list_files',
+                        help='list files to lint and exit')
     parser.add_argument('-f', '--format',
-                        choices=('parsable', 'standard'), default='standard',
+                        choices=('parsable', 'standard', 'colored', 'github',
-                        help='format for parsing output')
+                                 'auto'),
+                        default='auto', 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('--no-warnings',
+                        action='store_true',
+                        help='output only error level problems')
     parser.add_argument('-v', '--version', action='version',
-                        version='%s %s' % (APP_NAME, APP_VERSION))
+                        version='{} {}'.format(APP_NAME, APP_VERSION))
-
-    # TODO: read from stdin when no filename?
 
     args = parser.parse_args(argv)
 
+    if 'YAMLLINT_CONFIG_FILE' in os.environ:
+        user_global_config = os.path.expanduser(
+            os.environ['YAMLLINT_CONFIG_FILE'])
     # User-global config is supposed to be in ~/.config/yamllint/config
-    if 'XDG_CONFIG_HOME' in os.environ:
+    elif 'XDG_CONFIG_HOME' in os.environ:
         user_global_config = os.path.join(
             os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
     else:
         user_global_config = os.path.expanduser('~/.config/yamllint/config')
 
+    project_config_filepath = find_project_config_filepath()
     try:
         if args.config_data is not None:
             if args.config_data != '' and ':' not in args.config_data:
@@ -123,8 +206,8 @@ def run(argv=None):
             conf = YamlLintConfig(content=args.config_data)
         elif args.config_file is not None:
             conf = YamlLintConfig(file=args.config_file)
-        elif os.path.isfile('.yamllint'):
+        elif project_config_filepath:
-            conf = YamlLintConfig(file='.yamllint')
+            conf = YamlLintConfig(file=project_config_filepath)
         elif os.path.isfile(user_global_config):
             conf = YamlLintConfig(file=user_global_config)
         else:
@@ -133,36 +216,39 @@ def run(argv=None):
         print(e, file=sys.stderr)
         sys.exit(-1)
 
+    if conf.locale is not None:
+        locale.setlocale(locale.LC_ALL, conf.locale)
+
+    if args.list_files:
+        for file in find_files_recursively(args.files, conf):
+            if not conf.is_file_ignored(file):
+                print(file)
+        sys.exit(0)
+
     max_level = 0
 
-    for file in find_files_recursively(args.files):
+    for file in find_files_recursively(args.files, conf):
         filepath = file[2:] if file.startswith('./') else file
         try:
-            first = True
+            with open(file, newline='') as f:
-            with open(file) as f:
+                problems = linter.run(f, conf, filepath)
-                for problem in linter.run(f, conf, filepath):
+        except OSError as e:
-                    if args.format == 'parsable':
+            print(e, file=sys.stderr)
-                        print(Format.parsable(problem, file))
+            sys.exit(-1)
-                    elif supports_color():
+        prob_level = show_problems(problems, file, args_format=args.format,
-                        if first:
+                                   no_warn=args.no_warnings)
-                            print('\033[4m%s\033[0m' % file)
+        max_level = max(max_level, prob_level)
-                            first = False
+
-
+    # read yaml from stdin
-                        print(Format.standard_color(problem, file))
+    if args.stdin:
-                    else:
+        try:
-                        if first:
+            problems = linter.run(sys.stdin, conf, '')
-                            print(file)
+        except OSError as e:
-                            first = False
-
-                        print(Format.standard(problem, file))
-
-                    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)
             sys.exit(-1)
+        prob_level = show_problems(problems, 'stdin', args_format=args.format,
+                                   no_warn=args.no_warnings)
+        max_level = max(max_level, prob_level)
 
     if max_level == PROBLEM_LEVELS['error']:
         return_code = 1

yamllint/conf/default.yaml

@@ -1,58 +1,35 @@
 ---
 
+yaml-files:
+  - '*.yaml'
+  - '*.yml'
+  - '.yamllint'
+
 rules:
-  braces:
+  anchors: enable
-    min-spaces-inside: 0
+  braces: enable
-    max-spaces-inside: 0
+  brackets: enable
-    min-spaces-inside-empty: -1
+  colons: enable
-    max-spaces-inside-empty: -1
+  commas: enable
-  brackets:
-    min-spaces-inside: 0
-    max-spaces-inside: 0
-    min-spaces-inside-empty: -1
-    max-spaces-inside-empty: -1
-  colons:
-    max-spaces-before: 0
-    max-spaces-after: 1
-  commas:
-    max-spaces-before: 0
-    min-spaces-after: 1
-    max-spaces-after: 1
   comments:
     level: warning
-    require-starting-space: true
-    min-spaces-from-content: 2
   comments-indentation:
     level: warning
   document-end: disable
   document-start:
     level: warning
-    present: true
+  empty-lines: enable
-  empty-lines:
+  empty-values: disable
-    max: 2
+  float-values: disable
-    max-start: 0
+  hyphens: enable
-    max-end: 0
+  indentation: enable
-  empty-values:
-    forbid-in-block-mappings: false
-    forbid-in-flow-mappings: false
-  hyphens:
-    max-spaces-after: 1
-  indentation:
-    spaces: consistent
-    indent-sequences: true
-    check-multi-line-strings: false
   key-duplicates: enable
   key-ordering: disable
-  line-length:
+  line-length: enable
-    max: 80
-    allow-non-breakable-words: true
-    allow-non-breakable-inline-mappings: false
   new-line-at-end-of-file: enable
-  new-lines:
+  new-lines: enable
-    type: unix
+  octal-values: disable
-  octal-values:
+  quoted-strings: disable
-    forbid-implicit-octal: false
-    forbid-explicit-octal: false
   trailing-spaces: enable
   truthy:
     level: warning

yamllint/config.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,6 +13,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import fileinput
 import os.path
 
 import pathspec
@@ -26,12 +26,17 @@ class YamlLintConfigError(Exception):
     pass
 
 
-class YamlLintConfig(object):
+class YamlLintConfig:
     def __init__(self, content=None, file=None):
         assert (content is None) ^ (file is None)
 
         self.ignore = None
 
+        self.yaml_files = pathspec.PathSpec.from_lines(
+            'gitwildmatch', ['*.yaml', '*.yml', '.yamllint'])
+
+        self.locale = None
+
         if file is not None:
             with open(file) as f:
                 content = f.read()
@@ -42,6 +47,9 @@ class YamlLintConfig(object):
     def is_file_ignored(self, filepath):
         return self.ignore and self.ignore.match_file(filepath)
 
+    def is_yaml_file(self, filepath):
+        return self.yaml_files.match_file(os.path.basename(filepath))
+
     def enabled_rules(self, filepath):
         return [yamllint.rules.get(id) for id, val in self.rules.items()
                 if val is not False and (
@@ -52,7 +60,7 @@ class YamlLintConfig(object):
         assert isinstance(base_config, YamlLintConfig)
 
         for rule in self.rules:
-            if (type(self.rules[rule]) == dict and
+            if (isinstance(self.rules[rule], dict) and
                     rule in base_config.rules and
                     base_config.rules[rule] is not False):
                 base_config.rules[rule].update(self.rules[rule])
@@ -70,10 +78,15 @@ class YamlLintConfig(object):
         except Exception as e:
             raise YamlLintConfigError('invalid config: %s' % e)
 
-        if type(conf) != dict:
+        if not isinstance(conf, dict):
             raise YamlLintConfigError('invalid config: not a dict')
 
         self.rules = conf.get('rules', {})
+        for rule in self.rules:
+            if self.rules[rule] == 'enable':
+                self.rules[rule] = {}
+            elif self.rules[rule] == 'disable':
+                self.rules[rule] = False
 
         # Does this conf override another conf that we need to load?
         if 'extends' in conf:
@@ -84,12 +97,46 @@ class YamlLintConfig(object):
             except Exception as e:
                 raise YamlLintConfigError('invalid config: %s' % e)
 
-        if 'ignore' in conf:
+        if 'ignore' in conf and 'ignore-from-file' in conf:
-            if type(conf['ignore']) != str:
+            raise YamlLintConfigError(
+                'invalid config: ignore and ignore-from-file keys cannot be '
+                'used together')
+        elif 'ignore-from-file' in conf:
+            if isinstance(conf['ignore-from-file'], str):
+                conf['ignore-from-file'] = [conf['ignore-from-file']]
+            if not (isinstance(conf['ignore-from-file'], list) and all(
+                    isinstance(ln, str) for ln in conf['ignore-from-file'])):
+                raise YamlLintConfigError(
+                    'invalid config: ignore-from-file should contain '
+                    'filename(s), either as a list or string')
+            with fileinput.input(conf['ignore-from-file']) as f:
+                self.ignore = pathspec.PathSpec.from_lines('gitwildmatch', f)
+        elif 'ignore' in conf:
+            if isinstance(conf['ignore'], str):
+                self.ignore = pathspec.PathSpec.from_lines(
+                    'gitwildmatch', conf['ignore'].splitlines())
+            elif (isinstance(conf['ignore'], list) and
+                    all(isinstance(line, str) for line in conf['ignore'])):
+                self.ignore = pathspec.PathSpec.from_lines(
+                    'gitwildmatch', conf['ignore'])
+            else:
                 raise YamlLintConfigError(
                     'invalid config: ignore should contain file patterns')
-            self.ignore = pathspec.PathSpec.from_lines(
+
-                'gitwildmatch', conf['ignore'].splitlines())
+        if 'yaml-files' in conf:
+            if not (isinstance(conf['yaml-files'], list)
+                    and all(isinstance(i, str) for i in conf['yaml-files'])):
+                raise YamlLintConfigError(
+                    'invalid config: yaml-files '
+                    'should be a list of file patterns')
+            self.yaml_files = pathspec.PathSpec.from_lines('gitwildmatch',
+                                                           conf['yaml-files'])
+
+        if 'locale' in conf:
+            if not isinstance(conf['locale'], str):
+                raise YamlLintConfigError(
+                    'invalid config: locale should be a string')
+            self.locale = conf['locale']
 
     def validate(self):
         for id in self.rules:
@@ -102,19 +149,22 @@ class YamlLintConfig(object):
 
 
 def validate_rule_conf(rule, conf):
-    if conf is False or conf == 'disable':
+    if conf is False:  # disable
         return False
-    elif conf == 'enable':
-        conf = {}
 
-    if type(conf) == dict:
+    if isinstance(conf, dict):
         if ('ignore' in conf and
-                type(conf['ignore']) != pathspec.pathspec.PathSpec):
+                not isinstance(conf['ignore'], pathspec.pathspec.PathSpec)):
-            if type(conf['ignore']) != str:
+            if isinstance(conf['ignore'], str):
+                conf['ignore'] = pathspec.PathSpec.from_lines(
+                    'gitwildmatch', conf['ignore'].splitlines())
+            elif (isinstance(conf['ignore'], list) and
+                    all(isinstance(line, str) for line in conf['ignore'])):
+                conf['ignore'] = pathspec.PathSpec.from_lines(
+                    'gitwildmatch', conf['ignore'])
+            else:
                 raise YamlLintConfigError(
                     'invalid config: ignore should contain file patterns')
-            conf['ignore'] = pathspec.PathSpec.from_lines(
-                'gitwildmatch', conf['ignore'].splitlines())
 
         if 'level' not in conf:
             conf['level'] = 'error'
@@ -123,29 +173,49 @@ def validate_rule_conf(rule, conf):
                 'invalid config: level should be "error" or "warning"')
 
         options = getattr(rule, 'CONF', {})
+        options_default = getattr(rule, 'DEFAULT', {})
         for optkey in conf:
-            if optkey in ('ignore', 'level'):
+            if optkey in ('ignore', 'ignore-from-file', 'level'):
                 continue
             if optkey not in options:
                 raise YamlLintConfigError(
                     'invalid config: unknown option "%s" for rule "%s"' %
                     (optkey, rule.ID))
-            if type(options[optkey]) == tuple:
+            # Example: CONF = {option: (bool, 'mixed')}
+            #          → {option: true}         → {option: mixed}
+            if isinstance(options[optkey], tuple):
                 if (conf[optkey] not in options[optkey] and
                         type(conf[optkey]) not in options[optkey]):
                     raise YamlLintConfigError(
                         'invalid config: option "%s" of "%s" should be in %s'
                         % (optkey, rule.ID, options[optkey]))
+            # Example: CONF = {option: ['flag1', 'flag2', int]}
+            #          → {option: [flag1]}      → {option: [42, flag1, flag2]}
+            elif isinstance(options[optkey], list):
+                if (type(conf[optkey]) is not list or
+                        any(flag not in options[optkey] and
+                            type(flag) not in options[optkey]
+                            for flag in conf[optkey])):
+                    raise YamlLintConfigError(
+                        ('invalid config: option "%s" of "%s" should only '
+                         'contain values in %s')
+                        % (optkey, rule.ID, str(options[optkey])))
+            # Example: CONF = {option: int}
+            #          → {option: 42}
             else:
-                if type(conf[optkey]) != options[optkey]:
+                if not isinstance(conf[optkey], options[optkey]):
                     raise YamlLintConfigError(
                         'invalid config: option "%s" of "%s" should be %s'
                         % (optkey, rule.ID, options[optkey].__name__))
         for optkey in options:
             if optkey not in conf:
-                raise YamlLintConfigError(
+                conf[optkey] = options_default[optkey]
-                    'invalid config: missing option "%s" for rule "%s"' %
+
-                    (optkey, rule.ID))
+        if hasattr(rule, 'VALIDATE'):
+            res = rule.VALIDATE(conf)
+            if res:
+                raise YamlLintConfigError('invalid config: %s: %s' %
+                                          (rule.ID, res))
     else:
         raise YamlLintConfigError(('invalid config: rule "%s": should be '
                                    'either "enable", "disable" or a dict')

yamllint/linter.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,6 +14,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import re
+import io
 
 import yaml
 
@@ -30,8 +30,11 @@ PROBLEM_LEVELS = {
     'error': 2,
 }
 
+DISABLE_RULE_PATTERN = re.compile(r'^# yamllint disable( rule:\S+)*\s*$')
+ENABLE_RULE_PATTERN = re.compile(r'^# yamllint enable( rule:\S+)*\s*$')
 
-class LintProblem(object):
+
+class LintProblem:
     """Represents a linting problem found by yamllint."""
     def __init__(self, line, column, desc='<no description>', rule=None):
         #: Line on which the problem was found (starting at 1)
@@ -47,7 +50,7 @@ class LintProblem(object):
     @property
     def message(self):
         if self.rule is not None:
-            return '%s (%s)' % (self.desc, self.rule)
+            return '{} ({})'.format(self.desc, self.rule)
         return self.desc
 
     def __eq__(self, other):
@@ -75,19 +78,17 @@ def get_cosmetic_problems(buffer, conf, filepath):
     for rule in token_rules:
         context[rule.ID] = {}
 
-    class DisableDirective():
+    class DisableDirective:
         def __init__(self):
             self.rules = set()
-            self.all_rules = set([r.ID for r in rules])
+            self.all_rules = {r.ID for r in rules}
 
         def process_comment(self, comment):
-            try:
+            comment = str(comment)
-                comment = str(comment)
-            except UnicodeError:
-                return  # this certainly wasn't a yamllint directive comment
 
-            if re.match(r'^# yamllint disable( rule:\S+)*\s*$', comment):
+            if DISABLE_RULE_PATTERN.match(comment):
-                rules = [item[5:] for item in comment[18:].split(' ')][1:]
+                items = comment[18:].rstrip().split(' ')
+                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules = self.all_rules.copy()
                 else:
@@ -95,8 +96,9 @@ def get_cosmetic_problems(buffer, conf, filepath):
                         if id in self.all_rules:
                             self.rules.add(id)
 
-            elif re.match(r'^# yamllint enable( rule:\S+)*\s*$', comment):
+            elif ENABLE_RULE_PATTERN.match(comment):
-                rules = [item[5:] for item in comment[17:].split(' ')][1:]
+                items = comment[17:].rstrip().split(' ')
+                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules.clear()
                 else:
@@ -108,13 +110,11 @@ def get_cosmetic_problems(buffer, conf, filepath):
 
     class DisableLineDirective(DisableDirective):
         def process_comment(self, comment):
-            try:
+            comment = str(comment)
-                comment = str(comment)
-            except UnicodeError:
-                return  # this certainly wasn't a yamllint directive comment
 
             if re.match(r'^# yamllint disable-line( rule:\S+)*\s*$', comment):
-                rules = [item[5:] for item in comment[23:].split(' ')][1:]
+                items = comment[23:].rstrip().split(' ')
+                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules = self.all_rules.copy()
                 else:
@@ -122,7 +122,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
                         if id in self.all_rules:
                             self.rules.add(id)
 
-    # Use a cache to store problems and flush it only when a end of line is
+    # Use a cache to store problems and flush it only when an end of line is
     # found. This allows the use of yamllint directive to disable some rules on
     # some lines.
     cache = []
@@ -180,7 +180,7 @@ def get_syntax_error(buffer):
     except yaml.error.MarkedYAMLError as e:
         problem = LintProblem(e.problem_mark.line + 1,
                               e.problem_mark.column + 1,
-                              'syntax error: ' + e.problem)
+                              'syntax error: ' + e.problem + ' (syntax)')
         problem.level = 'error'
         return problem
 
@@ -189,6 +189,10 @@ def _run(buffer, conf, filepath):
     assert hasattr(buffer, '__getitem__'), \
         '_run() argument must be a buffer, not a stream'
 
+    first_line = next(parser.line_generator(buffer)).content
+    if re.match(r'^#\s*yamllint disable-file\s*$', first_line):
+        return
+
     # If the document contains a syntax error, save it and yield it at the
     # right line
     syntax_error = get_syntax_error(buffer)
@@ -199,15 +203,11 @@ def _run(buffer, conf, filepath):
                 syntax_error.column <= problem.column):
             yield syntax_error
 
-            # If there is already a yamllint error at the same place, discard
+            # Discard the problem since it is at the same place as the syntax
-            # it as it is probably redundant (and maybe it's just a 'warning',
+            # error and is probably redundant (and maybe it's just a 'warning',
             # in which case the script won't even exit with a failure status).
-            if (syntax_error.line == problem.line and
-                    syntax_error.column == problem.column):
-                syntax_error = None
-                continue
-
             syntax_error = None
+            continue
 
         yield problem
 
@@ -223,12 +223,12 @@ def run(input, conf, filepath=None):
     :param input: buffer, string or stream to read from
     :param conf: yamllint configuration object
     """
-    if conf.is_file_ignored(filepath):
+    if filepath is not None and conf.is_file_ignored(filepath):
         return ()
 
-    if type(input) in (type(b''), type(u'')):  # compat with Python 2 & 3
+    if isinstance(input, (bytes, str)):
         return _run(input, conf, filepath)
-    elif hasattr(input, 'read'):  # Python 2's file or Python 3's io.IOBase
+    elif isinstance(input, io.IOBase):
         # We need to have everything in memory to parse correctly
         content = input.read()
         return _run(content, conf, filepath)

yamllint/parser.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,7 +16,7 @@
 import yaml
 
 
-class Line(object):
+class Line:
     def __init__(self, line_no, buffer, start, end):
         self.line_no = line_no
         self.start = start
@@ -29,7 +28,7 @@ class Line(object):
         return self.buffer[self.start:self.end]
 
 
-class Token(object):
+class Token:
     def __init__(self, line_no, curr, prev, next, nextnext):
         self.line_no = line_no
         self.curr = curr
@@ -38,7 +37,7 @@ class Token(object):
         self.nextnext = nextnext
 
 
-class Comment(object):
+class Comment:
     def __init__(self, line_no, column_no, buffer, pointer,
                  token_before=None, token_after=None, comment_before=None):
         self.line_no = line_no
@@ -77,7 +76,10 @@ def line_generator(buffer):
     cur = 0
     next = buffer.find('\n')
     while next != -1:
-        yield Line(line_no, buffer, start=cur, end=next)
+        if next > 0 and buffer[next - 1] == '\r':
+            yield Line(line_no, buffer, start=cur, end=next - 1)
+        else:
+            yield Line(line_no, buffer, start=cur, end=next)
         cur = next + 1
         next = buffer.find('\n', cur)
         line_no += 1
@@ -130,8 +132,7 @@ def token_or_comment_generator(buffer):
 
             yield Token(curr.start_mark.line + 1, curr, prev, next, nextnext)
 
-            for comment in comments_between_tokens(curr, next):
+            yield from comments_between_tokens(curr, next)
-                yield comment
 
             prev = curr
             curr = next

yamllint/rules/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,6 +14,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from yamllint.rules import (
+    anchors,
     braces,
     brackets,
     colons,
@@ -33,11 +33,14 @@ from yamllint.rules import (
     new_line_at_end_of_file,
     new_lines,
     octal_values,
+    float_values,
+    quoted_strings,
     trailing_spaces,
     truthy,
 )
 
 _RULES = {
+    anchors.ID: anchors,
     braces.ID: braces,
     brackets.ID: brackets,
     colons.ID: colons,
@@ -48,6 +51,7 @@ _RULES = {
     document_start.ID: document_start,
     empty_lines.ID: empty_lines,
     empty_values.ID: empty_values,
+    float_values.ID: float_values,
     hyphens.ID: hyphens,
     indentation.ID: indentation,
     key_duplicates.ID: key_duplicates,
@@ -56,6 +60,7 @@ _RULES = {
     new_line_at_end_of_file.ID: new_line_at_end_of_file,
     new_lines.ID: new_lines,
     octal_values.ID: octal_values,
+    quoted_strings.ID: quoted_strings,
     trailing_spaces.ID: trailing_spaces,
     truthy.ID: truthy,
 }

yamllint/rules/anchors.py

@@ -0,0 +1,174 @@
+# Copyright (C) 2023 Adrien Vergé
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Use this rule to report duplicated anchors and aliases referencing undeclared
+anchors.
+
+.. rubric:: Options
+
+* Set ``forbid-undeclared-aliases`` to ``true`` to avoid aliases that reference
+  an anchor that hasn't been declared (either not declared at all, or declared
+  later in the document).
+* Set ``forbid-duplicated-anchors`` to ``true`` to avoid duplications of a same
+  anchor.
+* Set ``forbid-unused-anchors`` to ``true`` to avoid anchors being declared but
+  not used anywhere in the YAML document via alias.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   anchors:
+     forbid-undeclared-aliases: true
+     forbid-duplicated-anchors: false
+     forbid-unused-anchors: false
+
+.. rubric:: Examples
+
+#. With ``anchors: {forbid-undeclared-aliases: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    - &anchor
+      foo: bar
+    - *anchor
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    - &anchor
+      foo: bar
+    - *unknown
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    - &anchor
+      foo: bar
+    - <<: *unknown
+      extra: value
+
+#. With ``anchors: {forbid-duplicated-anchors: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    - &anchor1 Foo Bar
+    - &anchor2 [item 1, item 2]
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    - &anchor Foo Bar
+    - &anchor [item 1, item 2]
+
+#. With ``anchors: {forbid-unused-anchors: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    ---
+    - &anchor
+      foo: bar
+    - *anchor
+
+   the following code snippet would **FAIL**:
+   ::
+
+    ---
+    - &anchor
+      foo: bar
+    - items:
+      - item1
+      - item2
+"""
+
+
+import yaml
+
+from yamllint.linter import LintProblem
+
+
+ID = 'anchors'
+TYPE = 'token'
+CONF = {'forbid-undeclared-aliases': bool,
+        'forbid-duplicated-anchors': bool,
+        'forbid-unused-anchors': bool}
+DEFAULT = {'forbid-undeclared-aliases': True,
+           'forbid-duplicated-anchors': False,
+           'forbid-unused-anchors': False}
+
+
+def check(conf, token, prev, next, nextnext, context):
+    if (conf['forbid-undeclared-aliases'] or
+            conf['forbid-duplicated-anchors'] or
+            conf['forbid-unused-anchors']):
+        if isinstance(token, (
+                yaml.StreamStartToken,
+                yaml.DocumentStartToken,
+                yaml.DocumentEndToken)):
+            context['anchors'] = {}
+
+    if (conf['forbid-undeclared-aliases'] and
+            isinstance(token, yaml.AliasToken) and
+            token.value not in context['anchors']):
+        yield LintProblem(
+            token.start_mark.line + 1, token.start_mark.column + 1,
+            f'found undeclared alias "{token.value}"')
+
+    if (conf['forbid-duplicated-anchors'] and
+            isinstance(token, yaml.AnchorToken) and
+            token.value in context['anchors']):
+        yield LintProblem(
+            token.start_mark.line + 1, token.start_mark.column + 1,
+            f'found duplicated anchor "{token.value}"')
+
+    if conf['forbid-unused-anchors']:
+        # Unused anchors can only be detected at the end of Document.
+        # End of document can be either
+        #   - end of stream
+        #   - end of document sign '...'
+        #   - start of a new document sign '---'
+        # If next token indicates end of document,
+        # check if the anchors have been used or not.
+        # If they haven't been used, report problem on those anchors.
+        if isinstance(next, (yaml.StreamEndToken,
+                             yaml.DocumentStartToken,
+                             yaml.DocumentEndToken)):
+            for anchor, info in context['anchors'].items():
+                if not info['used']:
+                    yield LintProblem(info['line'] + 1,
+                                      info['column'] + 1,
+                                      f'found unused anchor "{anchor}"')
+        elif isinstance(token, yaml.AliasToken):
+            context['anchors'].get(token.value, {})['used'] = True
+
+    if (conf['forbid-undeclared-aliases'] or
+            conf['forbid-duplicated-anchors'] or
+            conf['forbid-unused-anchors']):
+        if isinstance(token, yaml.AnchorToken):
+            context['anchors'][token.value] = {
+                'line': token.start_mark.line,
+                'column': token.start_mark.column,
+                'used': False
+            }

yamllint/rules/braces.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,10 +14,15 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Use this rule to control the number of spaces inside braces (``{`` and ``}``).
+Use this rule to control the use of flow mappings or number of spaces inside
+braces (``{`` and ``}``).
 
 .. rubric:: Options
 
+* ``forbid`` is used to forbid the use of flow mappings which are denoted by
+  surrounding braces (``{`` and ``}``). Use ``true`` to forbid the use of flow
+  mappings completely. Use ``non-empty`` to forbid the use of all flow
+  mappings except for empty ones.
 * ``min-spaces-inside`` defines the minimal number of spaces required inside
   braces.
 * ``max-spaces-inside`` defines the maximal number of spaces allowed inside
@@ -28,8 +32,46 @@ Use this rule to control the number of spaces inside braces (``{`` and ``}``).
 * ``max-spaces-inside-empty`` defines the maximal number of spaces allowed
   inside empty braces.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   braces:
+     forbid: false
+     min-spaces-inside: 0
+     max-spaces-inside: 0
+     min-spaces-inside-empty: -1
+     max-spaces-inside-empty: -1
+
 .. rubric:: Examples
 
+#. With ``braces: {forbid: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object:
+      key1: 4
+      key2: 8
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: { key1: 4, key2: 8 }
+
+#. With ``braces: {forbid: non-empty}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: {}
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: { key1: 4, key2: 8 }
+
 #. With ``braces: {min-spaces-inside: 0, max-spaces-inside: 0}``
 
    the following code snippet would **PASS**:
@@ -92,19 +134,39 @@ Use this rule to control the number of spaces inside braces (``{`` and ``}``).
 
 import yaml
 
+from yamllint.linter import LintProblem
 from yamllint.rules.common import spaces_after, spaces_before
 
 
 ID = 'braces'
 TYPE = 'token'
-CONF = {'min-spaces-inside': int,
+CONF = {'forbid': (bool, 'non-empty'),
+        'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
         'max-spaces-inside-empty': int}
+DEFAULT = {'forbid': False,
+           'min-spaces-inside': 0,
+           'max-spaces-inside': 0,
+           'min-spaces-inside-empty': -1,
+           'max-spaces-inside-empty': -1}
 
 
 def check(conf, token, prev, next, nextnext, context):
-    if (isinstance(token, yaml.FlowMappingStartToken) and
+    if (conf['forbid'] is True and
+            isinstance(token, yaml.FlowMappingStartToken)):
+        yield LintProblem(token.start_mark.line + 1,
+                          token.end_mark.column + 1,
+                          'forbidden flow mapping')
+
+    elif (conf['forbid'] == 'non-empty' and
+            isinstance(token, yaml.FlowMappingStartToken) and
+            not isinstance(next, yaml.FlowMappingEndToken)):
+        yield LintProblem(token.start_mark.line + 1,
+                          token.end_mark.column + 1,
+                          'forbidden flow mapping')
+
+    elif (isinstance(token, yaml.FlowMappingStartToken) and
             isinstance(next, yaml.FlowMappingEndToken)):
         problem = spaces_after(token, prev, next,
                                min=(conf['min-spaces-inside-empty']

yamllint/rules/brackets.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,11 +14,15 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Use this rule to control the number of spaces inside brackets (``[`` and
+Use this rule to control the use of flow sequences or the number of spaces
-``]``).
+inside brackets (``[`` and ``]``).
 
 .. rubric:: Options
 
+* ``forbid`` is used to forbid the use of flow sequences which are denoted by
+  surrounding brackets (``[`` and ``]``). Use ``true`` to forbid the use of
+  flow sequences completely. Use ``non-empty`` to forbid the use of all flow
+  sequences except for empty ones.
 * ``min-spaces-inside`` defines the minimal number of spaces required inside
   brackets.
 * ``max-spaces-inside`` defines the maximal number of spaces allowed inside
@@ -29,8 +32,47 @@ Use this rule to control the number of spaces inside brackets (``[`` and
 * ``max-spaces-inside-empty`` defines the maximal number of spaces allowed
   inside empty brackets.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   brackets:
+     forbid: false
+     min-spaces-inside: 0
+     max-spaces-inside: 0
+     min-spaces-inside-empty: -1
+     max-spaces-inside-empty: -1
+
 .. rubric:: Examples
 
+#. With ``brackets: {forbid: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object:
+      - 1
+      - 2
+      - abc
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: [ 1, 2, abc ]
+
+#. With ``brackets: {forbid: non-empty}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    object: []
+
+   the following code snippet would **FAIL**:
+   ::
+
+    object: [ 1, 2, abc ]
+
 #. With ``brackets: {min-spaces-inside: 0, max-spaces-inside: 0}``
 
    the following code snippet would **PASS**:
@@ -93,19 +135,39 @@ Use this rule to control the number of spaces inside brackets (``[`` and
 
 import yaml
 
+from yamllint.linter import LintProblem
 from yamllint.rules.common import spaces_after, spaces_before
 
 
 ID = 'brackets'
 TYPE = 'token'
-CONF = {'min-spaces-inside': int,
+CONF = {'forbid': (bool, 'non-empty'),
+        'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
         'max-spaces-inside-empty': int}
+DEFAULT = {'forbid': False,
+           'min-spaces-inside': 0,
+           'max-spaces-inside': 0,
+           'min-spaces-inside-empty': -1,
+           'max-spaces-inside-empty': -1}
 
 
 def check(conf, token, prev, next, nextnext, context):
-    if (isinstance(token, yaml.FlowSequenceStartToken) and
+    if (conf['forbid'] is True and
+            isinstance(token, yaml.FlowSequenceStartToken)):
+        yield LintProblem(token.start_mark.line + 1,
+                          token.end_mark.column + 1,
+                          'forbidden flow sequence')
+
+    elif (conf['forbid'] == 'non-empty' and
+            isinstance(token, yaml.FlowSequenceStartToken) and
+            not isinstance(next, yaml.FlowSequenceEndToken)):
+        yield LintProblem(token.start_mark.line + 1,
+                          token.end_mark.column + 1,
+                          'forbidden flow sequence')
+
+    elif (isinstance(token, yaml.FlowSequenceStartToken) and
             isinstance(next, yaml.FlowSequenceEndToken)):
         problem = spaces_after(token, prev, next,
                                min=(conf['min-spaces-inside-empty']

yamllint/rules/colons.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,6 +23,15 @@ Use this rule to control the number of spaces before and after colons (``:``).
 * ``max-spaces-after`` defines the maximal number of spaces allowed after
   colons (use ``-1`` to disable).
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   colons:
+     max-spaces-before: 0
+     max-spaces-after: 1
+
 .. rubric:: Examples
 
 #. With ``colons: {max-spaces-before: 0, max-spaces-after: 1}``
@@ -72,17 +80,21 @@ Use this rule to control the number of spaces before and after colons (``:``).
 
 import yaml
 
-from yamllint.rules.common import spaces_after, spaces_before, is_explicit_key
+from yamllint.rules.common import is_explicit_key, spaces_after, spaces_before
 
 
 ID = 'colons'
 TYPE = 'token'
 CONF = {'max-spaces-before': int,
         'max-spaces-after': int}
+DEFAULT = {'max-spaces-before': 0,
+           'max-spaces-after': 1}
 
 
 def check(conf, token, prev, next, nextnext, context):
-    if isinstance(token, yaml.ValueToken):
+    if isinstance(token, yaml.ValueToken) and not (
+            isinstance(prev, yaml.AliasToken) and
+            token.start_mark.pointer - prev.end_mark.pointer == 1):
         problem = spaces_before(token, prev, next,
                                 max=conf['max-spaces-before'],
                                 max_desc='too many spaces before colon')

yamllint/rules/commas.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -26,6 +25,16 @@ Use this rule to control the number of spaces before and after commas (``,``).
 * ``max-spaces-after`` defines the maximal number of spaces allowed after
   commas (use ``-1`` to disable).
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   commas:
+     max-spaces-before: 0
+     min-spaces-after: 1
+     max-spaces-after: 1
+
 .. rubric:: Examples
 
 #. With ``commas: {max-spaces-before: 0}``
@@ -66,7 +75,7 @@ Use this rule to control the number of spaces before and after commas (``,``).
    ::
 
     strange var:
-      [10, 20,30, {x: 1, y: 2}]
+      [10, 20, 30, {x: 1, y: 2}]
 
    the following code snippet would **FAIL**:
    ::
@@ -103,6 +112,9 @@ TYPE = 'token'
 CONF = {'max-spaces-before': int,
         'min-spaces-after': int,
         'max-spaces-after': int}
+DEFAULT = {'max-spaces-before': 0,
+           'min-spaces-after': 1,
+           'max-spaces-after': 1}
 
 
 def check(conf, token, prev, next, nextnext, context):

yamllint/rules/comments.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -21,10 +20,23 @@ Use this rule to control the position and formatting of comments.
 
 * Use ``require-starting-space`` to require a space character right after the
   ``#``. Set to ``true`` to enable, ``false`` to disable.
+* Use ``ignore-shebangs`` to ignore a
+  `shebang <https://en.wikipedia.org/wiki/Shebang_(Unix)>`_ at the beginning of
+  the file when ``require-starting-space`` is set.
 * ``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:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   comments:
+     require-starting-space: true
+     ignore-shebangs: true
+     min-spaces-from-content: 2
+
 .. rubric:: Examples
 
 #. With ``comments: {require-starting-space: true}``
@@ -67,7 +79,11 @@ from yamllint.linter import LintProblem
 ID = 'comments'
 TYPE = 'comment'
 CONF = {'require-starting-space': bool,
+        'ignore-shebangs': bool,
         'min-spaces-from-content': int}
+DEFAULT = {'require-starting-space': True,
+           'ignore-shebangs': True,
+           'min-spaces-from-content': 2}
 
 
 def check(conf, comment):
@@ -82,8 +98,16 @@ def check(conf, comment):
         while (comment.buffer[text_start] == '#' and
                text_start < len(comment.buffer)):
             text_start += 1
-        if (text_start < len(comment.buffer) and
+        if text_start < len(comment.buffer):
-                comment.buffer[text_start] not in (' ', '\n', '\0')):
+            if (conf['ignore-shebangs'] and
-            yield LintProblem(comment.line_no,
+                    comment.line_no == 1 and
-                              comment.column_no + text_start - comment.pointer,
+                    comment.column_no == 1 and
-                              'missing starting space in comment')
+                    comment.buffer[text_start] == '!'):
+                return
+            # We can test for both \r and \r\n just by checking first char
+            # \r itself is a valid newline on some older OS.
+            elif comment.buffer[text_start] not in {' ', '\n', '\r', '\x00'}:
+                column = comment.column_no + text_start - comment.pointer
+                yield LintProblem(comment.line_no,
+                                  column,
+                                  'missing starting space in comment')

yamllint/rules/comments_indentation.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -118,8 +117,7 @@ def check(conf, comment):
     #         # comment
     #         - 1
     #         - 2
-    if prev_line_indent <= next_line_indent:
+    prev_line_indent = max(prev_line_indent, next_line_indent)
-        prev_line_indent = next_line_indent
 
     # If two indents are valid but a previous comment went back to normal
     # indent, for the next ones to do the same. In other words, avoid this:

yamllint/rules/common.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/document_end.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -22,6 +21,14 @@ Use this rule to require or forbid the use of document end marker (``...``).
 * Set ``present`` to ``true`` when the document end marker is required, or to
   ``false`` when it is forbidden.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   document-end:
+     present: true
+
 .. rubric:: Examples
 
 #. With ``document-end: {present: true}``
@@ -82,18 +89,23 @@ from yamllint.linter import LintProblem
 ID = 'document-end'
 TYPE = 'token'
 CONF = {'present': bool}
+DEFAULT = {'present': True}
 
 
 def check(conf, token, prev, next, nextnext, context):
     if conf['present']:
-        if (isinstance(token, yaml.StreamEndToken) and
+        is_stream_end = isinstance(token, yaml.StreamEndToken)
-                not (isinstance(prev, yaml.DocumentEndToken) or
+        is_start = isinstance(token, yaml.DocumentStartToken)
-                     isinstance(prev, yaml.StreamStartToken))):
+        prev_is_end_or_stream_start = isinstance(
+            prev, (yaml.DocumentEndToken, yaml.StreamStartToken)
+        )
+        prev_is_directive = isinstance(prev, yaml.DirectiveToken)
+
+        if is_stream_end and not prev_is_end_or_stream_start:
             yield LintProblem(token.start_mark.line, 1,
                               'missing document end "..."')
-        elif (isinstance(token, yaml.DocumentStartToken) and
+        elif is_start and not (prev_is_end_or_stream_start
-                not (isinstance(prev, yaml.DocumentEndToken) or
+                               or prev_is_directive):
-                     isinstance(prev, yaml.StreamStartToken))):
             yield LintProblem(token.start_mark.line + 1, 1,
                               'missing document end "..."')
 

yamllint/rules/document_start.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -22,6 +21,14 @@ Use this rule to require or forbid the use of document start marker (``---``).
 * Set ``present`` to ``true`` when the document start marker is required, or to
   ``false`` when it is forbidden.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   document-start:
+     present: true
+
 .. rubric:: Examples
 
 #. With ``document-start: {present: true}``
@@ -72,6 +79,7 @@ from yamllint.linter import LintProblem
 ID = 'document-start'
 TYPE = 'token'
 CONF = {'present': bool}
+DEFAULT = {'present': True}
 
 
 def check(conf, token, prev, next, nextnext, context):

yamllint/rules/empty_lines.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -25,6 +24,16 @@ Use this rule to set a maximal number of allowed consecutive blank lines.
 * ``max-end`` defines the maximal number of empty lines allowed at the end of
   the file.  This option takes precedence over ``max``.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   empty-lines:
+     max: 2
+     max-start: 0
+     max-end: 0
+
 .. rubric:: Examples
 
 #. With ``empty-lines: {max: 1}``
@@ -58,32 +67,45 @@ TYPE = 'line'
 CONF = {'max': int,
         'max-start': int,
         'max-end': int}
+DEFAULT = {'max': 2,
+           'max-start': 0,
+           'max-end': 0}
 
 
 def check(conf, line):
     if line.start == line.end and line.end < len(line.buffer):
         # Only alert on the last blank line of a series
-        if (line.end < len(line.buffer) - 1 and
+        if (line.end + 2 <= len(line.buffer) and
-                line.buffer[line.end + 1] == '\n'):
+                line.buffer[line.end:line.end + 2] == '\n\n'):
+            return
+        elif (line.end + 4 <= len(line.buffer) and
+              line.buffer[line.end:line.end + 4] == '\r\n\r\n'):
             return
 
         blank_lines = 0
 
-        while (line.start > blank_lines and
+        start = line.start
-               line.buffer[line.start - blank_lines - 1] == '\n'):
+        while start >= 2 and line.buffer[start - 2:start] == '\r\n':
+            blank_lines += 1
+            start -= 2
+        while start >= 1 and line.buffer[start - 1] == '\n':
             blank_lines += 1
+            start -= 1
 
         max = conf['max']
 
         # Special case: start of document
-        if line.start - blank_lines == 0:
+        if start == 0:
             blank_lines += 1  # first line doesn't have a preceding \n
             max = conf['max-start']
 
         # Special case: end of document
         # NOTE: The last line of a file is always supposed to end with a new
         # line. See POSIX definition of a line at:
-        if line.end == len(line.buffer) - 1 and line.buffer[line.end] == '\n':
+        if ((line.end == len(line.buffer) - 1 and
+             line.buffer[line.end] == '\n') or
+            (line.end == len(line.buffer) - 2 and
+             line.buffer[line.end:line.end + 2] == '\r\n')):
             # Allow the exception of the one-byte file containing '\n'
             if line.end == 0:
                 return

yamllint/rules/empty_values.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Greg Dubicki
 #
 # This program is free software: you can redistribute it and/or modify
@@ -23,6 +22,15 @@ Use this rule to prevent nodes with empty content, that implicitly result in
 * Use ``forbid-in-block-mappings`` to prevent empty values in block mappings.
 * Use ``forbid-in-flow-mappings`` to prevent empty values in flow mappings.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   empty-values:
+     forbid-in-block-mappings: true
+     forbid-in-flow-mappings: true
+
 .. rubric:: Examples
 
 #. With ``empty-values: {forbid-in-block-mappings: true}``
@@ -75,6 +83,8 @@ ID = 'empty-values'
 TYPE = 'token'
 CONF = {'forbid-in-block-mappings': bool,
         'forbid-in-flow-mappings': bool}
+DEFAULT = {'forbid-in-block-mappings': True,
+           'forbid-in-flow-mappings': True}
 
 
 def check(conf, token, prev, next, nextnext, context):

yamllint/rules/float_values.py

@@ -0,0 +1,158 @@
+# Copyright (C) 2022 the yamllint contributors
+
+# 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 limit the permitted values for floating-point numbers.
+YAML permits three classes of float expressions: approximation to real numbers,
+positive and negative infinity and "not a number".
+
+.. rubric:: Options
+
+* Use ``require-numeral-before-decimal`` to require floats to start
+  with a numeral (ex ``0.0`` instead of ``.0``).
+* Use ``forbid-scientific-notation`` to forbid scientific notation.
+* Use ``forbid-nan`` to forbid NaN (not a number) values.
+* Use ``forbid-inf`` to forbid infinite values.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+    rules:
+      float-values:
+        forbid-inf: false
+        forbid-nan: false
+        forbid-scientific-notation: false
+        require-numeral-before-decimal: false
+
+.. rubric:: Examples
+
+#. With ``float-values: {require-numeral-before-decimal: true}``
+
+   the following code snippets would **PASS**:
+   ::
+
+    anemometer:
+      angle: 0.0
+
+   the following code snippets would **FAIL**:
+   ::
+
+    anemometer:
+      angle: .0
+
+#. With ``float-values: {forbid-scientific-notation: true}``
+
+   the following code snippets would **PASS**:
+   ::
+
+    anemometer:
+      angle: 0.00001
+
+   the following code snippets would **FAIL**:
+   ::
+
+    anemometer:
+      angle: 10e-6
+
+#. With ``float-values: {forbid-nan: true}``
+
+   the following code snippets would **FAIL**:
+   ::
+
+    anemometer:
+      angle: .NaN
+
+ #. With ``float-values: {forbid-inf: true}``
+
+   the following code snippets would **FAIL**:
+   ::
+
+    anemometer:
+      angle: .inf
+"""
+
+import re
+
+import yaml
+
+from yamllint.linter import LintProblem
+
+
+ID = 'float-values'
+TYPE = 'token'
+CONF = {
+    'require-numeral-before-decimal': bool,
+    'forbid-scientific-notation': bool,
+    'forbid-nan': bool,
+    'forbid-inf': bool,
+}
+DEFAULT = {
+    'require-numeral-before-decimal': False,
+    'forbid-scientific-notation': False,
+    'forbid-nan': False,
+    'forbid-inf': False,
+}
+
+IS_NUMERAL_BEFORE_DECIMAL_PATTERN = (
+    re.compile('[-+]?(\\.[0-9]+)([eE][-+]?[0-9]+)?$')
+)
+IS_SCIENTIFIC_NOTATION_PATTERN = re.compile(
+    '[-+]?(\\.[0-9]+|[0-9]+(\\.[0-9]*)?)([eE][-+]?[0-9]+)$'
+)
+IS_INF_PATTERN = re.compile('[-+]?(\\.inf|\\.Inf|\\.INF)$')
+IS_NAN_PATTERN = re.compile('(\\.nan|\\.NaN|\\.NAN)$')
+
+
+def check(conf, token, prev, next, nextnext, context):
+    if prev and isinstance(prev, yaml.tokens.TagToken):
+        return
+    if not isinstance(token, yaml.tokens.ScalarToken):
+        return
+    if token.style:
+        return
+    val = token.value
+
+    if conf['forbid-nan'] and IS_NAN_PATTERN.match(val):
+        yield LintProblem(
+            token.start_mark.line + 1,
+            token.start_mark.column + 1,
+            f'forbidden not a number value "{token.value}"',
+        )
+
+    if conf['forbid-inf'] and IS_INF_PATTERN.match(val):
+        yield LintProblem(
+            token.start_mark.line + 1,
+            token.start_mark.column + 1,
+            f'forbidden infinite value "{token.value}"',
+        )
+
+    if conf[
+        'forbid-scientific-notation'
+    ] and IS_SCIENTIFIC_NOTATION_PATTERN.match(val):
+        yield LintProblem(
+            token.start_mark.line + 1,
+            token.start_mark.column + 1,
+            f'forbidden scientific notation "{token.value}"',
+        )
+
+    if conf[
+        'require-numeral-before-decimal'
+    ] and IS_NUMERAL_BEFORE_DECIMAL_PATTERN.match(val):
+        yield LintProblem(
+            token.start_mark.line + 1,
+            token.start_mark.column + 1,
+            f'forbidden decimal missing 0 prefix "{token.value}"',
+        )

yamllint/rules/hyphens.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -22,6 +21,14 @@ Use this rule to control the number of spaces after hyphens (``-``).
 * ``max-spaces-after`` defines the maximal number of spaces allowed after
   hyphens.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   hyphens:
+     max-spaces-after: 1
+
 .. rubric:: Examples
 
 #. With ``hyphens: {max-spaces-after: 1}``
@@ -76,6 +83,7 @@ from yamllint.rules.common import spaces_after
 ID = 'hyphens'
 TYPE = 'token'
 CONF = {'max-spaces-after': int}
+DEFAULT = {'max-spaces-after': 1}
 
 
 def check(conf, token, prev, next, nextnext, context):

yamllint/rules/indentation.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -32,6 +31,16 @@ Use this rule to control the indentation.
 * ``check-multi-line-strings`` defines whether to lint indentation in
   multi-line strings. Set to ``true`` to enable, ``false`` to disable.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   indentation:
+     spaces: consistent
+     indent-sequences: true
+     check-multi-line-strings: false
+
 .. rubric:: Examples
 
 #. With ``indentation: {spaces: 1}``
@@ -193,7 +202,7 @@ Use this rule to control the indentation.
 import yaml
 
 from yamllint.linter import LintProblem
-from yamllint.rules.common import is_explicit_key, get_real_end_line
+from yamllint.rules.common import get_real_end_line, is_explicit_key
 
 
 ID = 'indentation'
@@ -201,12 +210,15 @@ TYPE = 'token'
 CONF = {'spaces': (int, 'consistent'),
         'indent-sequences': (bool, 'whatever', 'consistent'),
         'check-multi-line-strings': bool}
+DEFAULT = {'spaces': 'consistent',
+           'indent-sequences': True,
+           'check-multi-line-strings': False}
 
 ROOT, B_MAP, F_MAP, B_SEQ, F_SEQ, B_ENT, KEY, VAL = range(8)
 labels = ('ROOT', 'B_MAP', 'F_MAP', 'B_SEQ', 'F_SEQ', 'B_ENT', 'KEY', 'VAL')
 
 
-class Parent(object):
+class Parent:
     def __init__(self, type, indent, line_indent=None):
         self.type = type
         self.indent = indent
@@ -224,7 +236,7 @@ def check_scalar_indentation(conf, token, context):
 
     def compute_expected_indent(found_indent):
         def detect_indent(base_indent):
-            if type(context['spaces']) is not int:
+            if not isinstance(context['spaces'], int):
                 context['spaces'] = found_indent - base_indent
             return base_indent + context['spaces']
 
@@ -312,7 +324,7 @@ def _check(conf, token, prev, next, nextnext, context):
                      token.start_mark.line + 1 > context['cur_line'])
 
     def detect_indent(base_indent, next):
-        if type(context['spaces']) is not int:
+        if not isinstance(context['spaces'], int):
             context['spaces'] = next.start_mark.column - base_indent
         return base_indent + context['spaces']
 
@@ -329,14 +341,18 @@ def _check(conf, token, prev, next, nextnext, context):
             expected = detect_indent(expected, token)
 
         if found_indentation != expected:
-            yield LintProblem(token.start_mark.line + 1, found_indentation + 1,
+            if expected < 0:
-                              'wrong indentation: expected %d but found %d' %
+                message = 'wrong indentation: expected at least %d' % \
-                              (expected, found_indentation))
+                          (found_indentation + 1)
+            else:
+                message = 'wrong indentation: expected %d but found %d' % \
+                          (expected, found_indentation)
+            yield LintProblem(token.start_mark.line + 1,
+                              found_indentation + 1, message)
 
     if (isinstance(token, yaml.ScalarToken) and
             conf['check-multi-line-strings']):
-        for problem in check_scalar_indentation(conf, token, context):
+        yield from check_scalar_indentation(conf, token, context)
-            yield problem
 
     # Step 2.a:
 
@@ -481,8 +497,8 @@ def _check(conf, token, prev, next, nextnext, context):
                         # 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).
+                        # So we choose an unknown value (-1).
-                        indent = 2
+                        indent = -1
                     else:
                         indent = detect_indent(context['stack'][-1].indent,
                                                next)
@@ -564,8 +580,7 @@ def _check(conf, token, prev, next, nextnext, context):
 
 def check(conf, token, prev, next, nextnext, context):
     try:
-        for problem in _check(conf, token, prev, next, nextnext, context):
+        yield from _check(conf, token, prev, next, nextnext, context)
-            yield problem
     except AssertionError:
         yield LintProblem(token.start_mark.line + 1,
                           token.start_mark.column + 1,

yamllint/rules/key_duplicates.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -61,12 +60,11 @@ from yamllint.linter import LintProblem
 
 ID = 'key-duplicates'
 TYPE = 'token'
-CONF = {}
 
 MAP, SEQ = range(2)
 
 
-class Parent(object):
+class Parent:
     def __init__(self, type):
         self.type = type
         self.keys = []
@@ -85,7 +83,8 @@ def check(conf, token, prev, next, nextnext, context):
     elif isinstance(token, (yaml.BlockEndToken,
                             yaml.FlowMappingEndToken,
                             yaml.FlowSequenceEndToken)):
-        context['stack'].pop()
+        if len(context['stack']) > 0:
+            context['stack'].pop()
     elif (isinstance(token, yaml.KeyToken) and
           isinstance(next, yaml.ScalarToken)):
         # This check is done because KeyTokens can be found inside flow

yamllint/rules/key_ordering.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 Johannes F. Knauf
 #
 # This program is free software: you can redistribute it and/or modify
@@ -16,8 +15,10 @@
 
 """
 Use this rule to enforce alphabetical ordering of keys in mappings. The sorting
-order uses the Unicode code point number. As a result, the ordering is
+order uses the Unicode code point number as a default. As a result, the
-case-sensitive and not accent-friendly (see examples below).
+ordering is case-sensitive and not accent-friendly (see examples below).
+This can be changed by setting the global ``locale`` option.  This allows one
+to sort case and accents properly.
 
 .. rubric:: Examples
 
@@ -63,8 +64,24 @@ case-sensitive and not accent-friendly (see examples below).
 
     - haïr: true
       hais: true
+
+#. With global option ``locale: "en_US.UTF-8"`` and rule ``key-ordering: {}``
+
+   as opposed to before, the following code snippet would now **PASS**:
+   ::
+
+    - t-shirt: 1
+      T-shirt: 2
+      t-shirts: 3
+      T-shirts: 4
+    - hair: true
+      haïr: true
+      hais: true
+      haïssable: true
 """
 
+from locale import strcoll
+
 import yaml
 
 from yamllint.linter import LintProblem
@@ -72,12 +89,11 @@ from yamllint.linter import LintProblem
 
 ID = 'key-ordering'
 TYPE = 'token'
-CONF = {}
 
 MAP, SEQ = range(2)
 
 
-class Parent(object):
+class Parent:
     def __init__(self, type):
         self.type = type
         self.keys = []
@@ -102,7 +118,8 @@ def check(conf, token, prev, next, nextnext, context):
         # This check is done because KeyTokens can be found inside flow
         # sequences... strange, but allowed.
         if len(context['stack']) > 0 and context['stack'][-1].type == MAP:
-            if any(next.value < key for key in context['stack'][-1].keys):
+            if any(strcoll(next.value, key) < 0
+                   for key in context['stack'][-1].keys):
                 yield LintProblem(
                     next.start_mark.line + 1, next.start_mark.column + 1,
                     'wrong ordering of key "%s" in mapping' % next.value)

yamllint/rules/line_length.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -26,6 +25,16 @@ Use this rule to set a limit to lines length.
 * ``allow-non-breakable-inline-mappings`` implies ``allow-non-breakable-words``
   and extends it to also allow non-breakable words in inline mappings.
 
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   line-length:
+     max: 80
+     allow-non-breakable-words: true
+     allow-non-breakable-inline-mappings: false
+
 .. rubric:: Examples
 
 #. With ``line-length: {max: 70}``
@@ -98,6 +107,9 @@ TYPE = 'line'
 CONF = {'max': int,
         'allow-non-breakable-words': bool,
         'allow-non-breakable-inline-mappings': bool}
+DEFAULT = {'max': 80,
+           'allow-non-breakable-words': True,
+           'allow-non-breakable-inline-mappings': False}
 
 
 def check_inline_mapping(line):
@@ -127,7 +139,11 @@ def check(conf, line):
                 start += 1
 
             if start != line.end:
-                if line.buffer[start] in ('#', '-'):
+                if line.buffer[start] == '#':
+                    while line.buffer[start] == '#':
+                        start += 1
+                    start += 1
+                elif line.buffer[start] == '-':
                     start += 2
 
                 if line.buffer.find(' ', start, line.end) == -1:

yamllint/rules/new_line_at_end_of_file.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,7 +17,7 @@
 Use this rule to require a new line character (``\\n``) at the end of files.
 
 The POSIX standard `requires the last line to end with a new line character
-<http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206>`_.
+<https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206>`_.
 All UNIX tools expect a new line at the end of files. Most text editors use
 this convention too.
 """

yamllint/rules/new_lines.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,26 +18,42 @@ Use this rule to force the type of new line characters.
 
 .. rubric:: Options
 
-* Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
+* Set ``type`` to ``unix`` to enforce UNIX-typed new line characters (``\\n``),
-  ``dos`` to use DOS-typed new line characters (``\\r\\n``).
+  set ``type`` to ``dos`` to enforce DOS-typed new line characters
+  (``\\r\\n``), or set ``type`` to ``platform`` to infer the type from the
+  system running yamllint (``\\n`` on POSIX / UNIX / Linux / Mac OS systems or
+  ``\\r\\n`` on DOS / Windows systems).
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   new-lines:
+     type: unix
 """
 
+from os import linesep
 
 from yamllint.linter import LintProblem
 
 
 ID = 'new-lines'
 TYPE = 'line'
-CONF = {'type': ('unix', 'dos')}
+CONF = {'type': ('unix', 'dos', 'platform')}
+DEFAULT = {'type': 'unix'}
 
 
 def check(conf, line):
+    if conf['type'] == 'unix':
+        newline_char = '\n'
+    elif conf['type'] == 'platform':
+        newline_char = linesep
+    elif conf['type'] == 'dos':
+        newline_char = '\r\n'
+
     if line.start == 0 and len(line.buffer) > line.end:
-        if conf['type'] == 'dos':
+        if line.buffer[line.end:line.end + len(newline_char)] != newline_char:
-            if line.buffer[line.end - 1:line.end + 1] != '\r\n':
+            yield LintProblem(1, line.end - line.start + 1,
-                yield LintProblem(1, line.end - line.start + 1,
+                              'wrong new line character: expected {}'
-                                  'wrong new line character: expected \\r\\n')
+                              .format(repr(newline_char).strip('\'')))
-        else:
-            if line.end > 0 and line.buffer[line.end - 1] == '\r':
-                yield LintProblem(1, line.end - line.start,
-                                  'wrong new line character: expected \\n')

yamllint/rules/octal_values.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2017 ScienJus
 #
 # This program is free software: you can redistribute it and/or modify
@@ -20,6 +19,20 @@ start with ``0`` are interpreted as octal, but this is not always wanted.
 For instance ``010`` is the city code of Beijing, and should not be
 converted to ``8``.
 
+.. rubric:: Options
+
+* Use ``forbid-implicit-octal`` to prevent numbers starting with ``0``.
+* Use ``forbid-explicit-octal`` to prevent numbers starting with ``0o``.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   octal-values:
+     forbid-implicit-octal: true
+     forbid-explicit-octal: true
+
 .. rubric:: Examples
 
 #. With ``octal-values: {forbid-implicit-octal: true}``
@@ -57,6 +70,8 @@ converted to ``8``.
       city-code: 0o10
 """
 
+import re
+
 import yaml
 
 from yamllint.linter import LintProblem
@@ -66,6 +81,10 @@ ID = 'octal-values'
 TYPE = 'token'
 CONF = {'forbid-implicit-octal': bool,
         'forbid-explicit-octal': bool}
+DEFAULT = {'forbid-implicit-octal': True,
+           'forbid-explicit-octal': True}
+
+IS_OCTAL_NUMBER_PATTERN = re.compile(r'^[0-7]+$')
 
 
 def check(conf, token, prev, next, nextnext, context):
@@ -76,7 +95,8 @@ def check(conf, token, prev, next, nextnext, context):
         if isinstance(token, yaml.tokens.ScalarToken):
             if not token.style:
                 val = token.value
-                if val.isdigit() and len(val) > 1 and val[0] == '0':
+                if (val.isdigit() and len(val) > 1 and val[0] == '0' and
+                        IS_OCTAL_NUMBER_PATTERN.match(val[1:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden implicit octal value "%s"' %
@@ -86,7 +106,8 @@ def check(conf, token, prev, next, nextnext, context):
         if isinstance(token, yaml.tokens.ScalarToken):
             if not token.style:
                 val = token.value
-                if len(val) > 2 and val[:2] == '0o' and val[2:].isdigit():
+                if (len(val) > 2 and val[:2] == '0o' and
+                        IS_OCTAL_NUMBER_PATTERN.match(val[2:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden explicit octal value "%s"' %

yamllint/rules/quoted_strings.py

@@ -0,0 +1,289 @@
+# Copyright (C) 2018 ClearScore
+#
+# 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 any string values that are not quoted, or to prevent
+quoted strings without needing it. You can also enforce the type of the quote
+used.
+
+.. rubric:: Options
+
+* ``quote-type`` defines allowed quotes: ``single``, ``double`` or ``any``
+  (default).
+* ``required`` defines whether using quotes in string values is required
+  (``true``, default) or not (``false``), or only allowed when really needed
+  (``only-when-needed``).
+* ``extra-required`` is a list of PCRE regexes to force string values to be
+  quoted, if they match any regex. This option can only be used with
+  ``required: false`` and  ``required: only-when-needed``.
+* ``extra-allowed`` is a list of PCRE regexes to allow quoted string values,
+  even if ``required: only-when-needed`` is set.
+* ``allow-quoted-quotes`` allows (``true``) using disallowed quotes for strings
+  with allowed quotes inside. Default ``false``.
+
+**Note**: Multi-line strings (with ``|`` or ``>``) will not be checked.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   quoted-strings:
+     quote-type: any
+     required: true
+     extra-required: []
+     extra-allowed: []
+     allow-quoted-quotes: false
+
+.. rubric:: Examples
+
+#. With ``quoted-strings: {quote-type: any, required: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: "bar"
+    bar: 'foo'
+    number: 123
+    boolean: true
+
+   the following code snippet would **FAIL**:
+   ::
+
+    foo: bar
+
+#. With ``quoted-strings: {quote-type: single, required: only-when-needed}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: bar
+    bar: foo
+    not_number: '123'
+    not_boolean: 'true'
+    not_comment: '# comment'
+    not_list: '[1, 2, 3]'
+    not_map: '{a: 1, b: 2}'
+
+   the following code snippet would **FAIL**:
+   ::
+
+    foo: 'bar'
+
+#. With ``quoted-strings: {required: false, extra-required: [^http://,
+   ^ftp://]}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - localhost
+    - "localhost"
+    - "http://localhost"
+    - "ftp://localhost"
+
+   the following code snippet would **FAIL**:
+   ::
+
+    - http://localhost
+    - ftp://localhost
+
+#. With ``quoted-strings: {required: only-when-needed, extra-allowed:
+   [^http://, ^ftp://], extra-required: [QUOTED]}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - localhost
+    - "http://localhost"
+    - "ftp://localhost"
+    - "this is a string that needs to be QUOTED"
+
+   the following code snippet would **FAIL**:
+   ::
+
+    - "localhost"
+    - this is a string that needs to be QUOTED
+
+#. With ``quoted-strings: {quote-type: double, allow-quoted-quotes: false}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: "bar\\"baz"
+
+   the following code snippet would **FAIL**:
+   ::
+
+    foo: 'bar"baz'
+
+#. With ``quoted-strings: {quote-type: double, allow-quoted-quotes: true}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    foo: 'bar"baz'
+
+"""
+
+import re
+
+import yaml
+
+from yamllint.linter import LintProblem
+
+ID = 'quoted-strings'
+TYPE = 'token'
+CONF = {'quote-type': ('any', 'single', 'double'),
+        'required': (True, False, 'only-when-needed'),
+        'extra-required': [str],
+        'extra-allowed': [str],
+        'allow-quoted-quotes': bool}
+DEFAULT = {'quote-type': 'any',
+           'required': True,
+           'extra-required': [],
+           'extra-allowed': [],
+           'allow-quoted-quotes': False}
+
+
+def VALIDATE(conf):
+    if conf['required'] is True and len(conf['extra-allowed']) > 0:
+        return 'cannot use both "required: true" and "extra-allowed"'
+    if conf['required'] is True and len(conf['extra-required']) > 0:
+        return 'cannot use both "required: true" and "extra-required"'
+    if conf['required'] is False and len(conf['extra-allowed']) > 0:
+        return 'cannot use both "required: false" and "extra-allowed"'
+
+
+DEFAULT_SCALAR_TAG = 'tag:yaml.org,2002:str'
+
+# https://stackoverflow.com/a/36514274
+yaml.resolver.Resolver.add_implicit_resolver(
+    'tag:yaml.org,2002:int',
+    re.compile(r'''^(?:[-+]?0b[0-1_]+
+               |[-+]?0o?[0-7_]+
+               |[-+]?0[0-7_]+
+               |[-+]?(?:0|[1-9][0-9_]*)
+               |[-+]?0x[0-9a-fA-F_]+
+               |[-+]?[1-9][0-9_]*(?::[0-5]?[0-9])+)$''', re.X),
+    list('-+0123456789'))
+
+
+def _quote_match(quote_type, token_style):
+    return ((quote_type == 'any') or
+            (quote_type == 'single' and token_style == "'") or
+            (quote_type == 'double' and token_style == '"'))
+
+
+def _quotes_are_needed(string):
+    loader = yaml.BaseLoader('key: ' + string)
+    # Remove the 5 first tokens corresponding to 'key: ' (StreamStartToken,
+    # BlockMappingStartToken, KeyToken, ScalarToken(value=key), ValueToken)
+    for _ in range(5):
+        loader.get_token()
+    try:
+        a, b = loader.get_token(), loader.get_token()
+        if (isinstance(a, yaml.ScalarToken) and a.style is None and
+                isinstance(b, yaml.BlockEndToken) and a.value == string):
+            return False
+        return True
+    except yaml.scanner.ScannerError:
+        return True
+
+
+def _has_quoted_quotes(token):
+    return ((not token.plain) and
+            ((token.style == "'" and '"' in token.value) or
+             (token.style == '"' and "'" in token.value)))
+
+
+def check(conf, token, prev, next, nextnext, context):
+    if not (isinstance(token, yaml.tokens.ScalarToken) and
+            isinstance(prev, (yaml.BlockEntryToken, yaml.FlowEntryToken,
+                              yaml.FlowSequenceStartToken, yaml.TagToken,
+                              yaml.ValueToken))):
+
+        return
+
+    # Ignore explicit types, e.g. !!str testtest or !!int 42
+    if (prev and isinstance(prev, yaml.tokens.TagToken) and
+            prev.value[0] == '!!'):
+        return
+
+    # Ignore numbers, booleans, etc.
+    resolver = yaml.resolver.Resolver()
+    tag = resolver.resolve(yaml.nodes.ScalarNode, token.value, (True, False))
+    if token.plain and tag != DEFAULT_SCALAR_TAG:
+        return
+
+    # Ignore multi-line strings
+    if not token.plain and token.style in ("|", ">"):
+        return
+
+    quote_type = conf['quote-type']
+
+    msg = None
+    if conf['required'] is True:
+
+        # Quotes are mandatory and need to match config
+        if (token.style is None or
+            not (_quote_match(quote_type, token.style) or
+                 (conf['allow-quoted-quotes'] and _has_quoted_quotes(token)))):
+            msg = "string value is not quoted with %s quotes" % quote_type
+
+    elif conf['required'] is False:
+
+        # Quotes are not mandatory but when used need to match config
+        if (token.style and
+                not _quote_match(quote_type, token.style) and
+                not (conf['allow-quoted-quotes'] and
+                     _has_quoted_quotes(token))):
+            msg = "string value is not quoted with %s quotes" % quote_type
+
+        elif not token.style:
+            is_extra_required = any(re.search(r, token.value)
+                                    for r in conf['extra-required'])
+            if is_extra_required:
+                msg = "string value is not quoted"
+
+    elif conf['required'] == 'only-when-needed':
+
+        # Quotes are not strictly needed here
+        if (token.style and tag == DEFAULT_SCALAR_TAG and token.value and
+                not _quotes_are_needed(token.value)):
+            is_extra_required = any(re.search(r, token.value)
+                                    for r in conf['extra-required'])
+            is_extra_allowed = any(re.search(r, token.value)
+                                   for r in conf['extra-allowed'])
+            if not (is_extra_required or is_extra_allowed):
+                msg = "string value is redundantly quoted with %s quotes" % (
+                    quote_type)
+
+        # But when used need to match config
+        elif (token.style and
+              not _quote_match(quote_type, token.style) and
+              not (conf['allow-quoted-quotes'] and _has_quoted_quotes(token))):
+            msg = "string value is not quoted with %s quotes" % quote_type
+
+        elif not token.style:
+            is_extra_required = len(conf['extra-required']) and any(
+                re.search(r, token.value) for r in conf['extra-required'])
+            if is_extra_required:
+                msg = "string value is not quoted"
+
+    if msg is not None:
+        yield LintProblem(
+            token.start_mark.line + 1,
+            token.start_mark.column + 1,
+            msg)

yamllint/rules/trailing_spaces.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Adrien Vergé
 #
 # This program is free software: you can redistribute it and/or modify

yamllint/rules/truthy.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (C) 2016 Peter Ericson
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,13 +14,34 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Use this rule to forbid non-explictly typed truthy values other than ``true``
+Use this rule to forbid non-explicitly typed truthy values other than allowed
-and ``false``, for example ``YES``, ``False`` and ``off``.
+ones (by default: ``true`` and ``false``), for example ``YES`` or ``off``.
 
 This can be useful to prevent surprises from YAML parsers 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:: Options
+
+* ``allowed-values`` defines the list of truthy values which will be ignored
+  during linting. The default is ``['true', 'false']``, but can be changed to
+  any list containing: ``'TRUE'``, ``'True'``,  ``'true'``, ``'FALSE'``,
+  ``'False'``, ``'false'``, ``'YES'``, ``'Yes'``, ``'yes'``, ``'NO'``,
+  ``'No'``, ``'no'``, ``'ON'``, ``'On'``, ``'on'``, ``'OFF'``, ``'Off'``,
+  ``'off'``.
+* ``check-keys`` disables verification for keys in mappings. By default,
+  ``truthy`` rule applies to both keys and values. Set this option to ``false``
+  to prevent this.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   truthy:
+     allowed-values: ['true', 'false']
+     check-keys: true
+
 .. rubric:: Examples
 
 #. With ``truthy: {}``
@@ -63,30 +83,75 @@ This can be useful to prevent surprises from YAML parsers transforming
     yes:  1
     on:   2
     True: 3
+
+#. With ``truthy: {allowed-values: ["yes", "no"]}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    - yes
+    - no
+    - "true"
+    - 'false'
+    - foo
+    - bar
+
+   the following code snippet would **FAIL**:
+   ::
+
+    - true
+    - false
+    - on
+    - off
+
+#. With ``truthy: {check-keys: false}``
+
+   the following code snippet would **PASS**:
+   ::
+
+    yes:  1
+    on:   2
+    true: 3
+
+   the following code snippet would **FAIL**:
+   ::
+
+    yes:  Yes
+    on:   On
+    true: True
 """
 
 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
+          'TRUE', 'True', 'true',
-          'FALSE', 'False',  # 'false' is a boolean
+          'FALSE', 'False', 'false',
           'ON', 'On', 'on',
           'OFF', 'Off', 'off']
 
 
+ID = 'truthy'
+TYPE = 'token'
+CONF = {'allowed-values': list(TRUTHY), 'check-keys': bool}
+DEFAULT = {'allowed-values': ['true', 'false'], 'check-keys': True}
+
+
 def check(conf, token, prev, next, nextnext, context):
     if prev and isinstance(prev, yaml.tokens.TagToken):
         return
 
+    if (not conf['check-keys'] and isinstance(prev, yaml.tokens.KeyToken) and
+            isinstance(token, yaml.tokens.ScalarToken)):
+        return
+
     if isinstance(token, yaml.tokens.ScalarToken):
-        if token.value in TRUTHY and token.style is None:
+        if (token.value in (set(TRUTHY) - set(conf['allowed-values'])) and
+                token.style is None):
             yield LintProblem(token.start_mark.line + 1,
                               token.start_mark.column + 1,
-                              "truthy value should be true or false")
+                              "truthy value should be one of [" +
+                              ", ".join(sorted(conf['allowed-values'])) + "]")