Debian: Package 1.23.0-1

See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=819866#15

.gitignore

@@ -4,4 +4,3 @@ __pycache__
 /dist
 /yamllint.egg-info
 /build
-/.eggs

.travis.yml

@@ -8,19 +8,15 @@ python:
   - 3.7
   - 3.8
   - nightly
-env:
-  - REMOVE_LOCALES=false
-  - REMOVE_LOCALES=true
 install:
   - pip install pyyaml coveralls flake8 flake8-import-order doc8
   - if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then pip install sphinx; fi
   - pip install .
-  - if [[ $REMOVE_LOCALES = "true" ]]; then sudo rm -rf /usr/lib/locale/*; fi
 script:
   - if [[ $TRAVIS_PYTHON_VERSION != nightly ]]; then flake8 .; fi
   - if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then doc8 $(git ls-files '*.rst'); fi
   - yamllint --strict $(git ls-files '*.yaml' '*.yml')
-  - coverage run --source=yamllint -m unittest discover
+  - coverage run --source=yamllint setup.py test
   - if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then
       python setup.py build_sphinx;
     fi

CHANGELOG.rst

@@ -1,41 +1,6 @@
 Changelog
 =========
 
-1.25.0 (2020-09-29)
--------------------
-
-- Run tests on Travis both with and without UTF-8 locales
-- Improve documentationon 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)
 -------------------
 

CONTRIBUTING.rst

@@ -1,46 +0,0 @@
-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>`_.
-
-7. Then, open a pull request.

docs/conf.py

@@ -6,9 +6,9 @@ import sys
 import os
 from unittest.mock import MagicMock
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('..'))  # noqa
 
-from yamllint import __copyright__, APP_NAME, APP_VERSION  # noqa
+from yamllint import __copyright__, APP_NAME, APP_VERSION
 
 # -- General configuration ------------------------------------------------
 

docs/configuration.rst

@@ -16,7 +16,6 @@ following locations (by order of preference):
 
 - ``.yamllint``, ``.yamllint.yaml`` or ``.yamllint.yml`` in the current working
   directory
-- the file referenced by ``$YAMLLINT_CONFIG_FILE``, if set
 - ``$XDG_CONFIG_HOME/yamllint/config``
 - ``~/.config/yamllint/config``
 
@@ -123,8 +122,8 @@ warning level problems, only error level ones.
 YAML files extensions
 ---------------------
 
-To configure what yamllint should consider as YAML files when listing
+To configure what yamllint should consider as YAML files, set ``yaml-files``
-directories, set ``yaml-files`` configuration option. The default is:
+configuration option. The default is:
 
 .. code-block:: yaml
 
@@ -189,22 +188,3 @@ Here is a more complex example:
      ignore: |
        *.ignore-trailing-spaces.yaml
        ascii-art/*
-
-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,61 +2,7 @@ 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("example.yaml", yaml_config):
-       print(p.desc, p.line, p.rule)
 
 .. automodule:: yamllint.linter
    :members:
-
-Develop rule plugins
----------------------
-
-yamllint provides a plugin mechanism using setuptools (pkg_resources) to allow
-adding custom rules. So, you can extend yamllint and add rules with your own
-custom yamllint rule plugins if you developed them.
-
-Yamllint rule plugins must satisfy the followings.
-
-#. It must be a Python package installable using pip and distributed under
-   GPLv3+ same as yamllint.
-#. It must contains the entry point configuration in ``setup.cfg`` or something
-   similar packaging configuration files, to make it installed and working as a
-   yamllint plugin like below. (``<plugin_name>`` is that plugin name and
-   ``<plugin_src_dir>`` is a dir where the rule modules exist.)
-   ::
-
-     [options.entry_points]
-     yamllint.plugins.rules =
-          <plugin_name> = <plugin_src_dir>
-
-#. It must contain custom yamllint rule modules:
-
-   - Each rule module must define a couple of global variables, ID and TYPE. ID
-     must not conflicts with other rules' ID.
-   - Each rule module must define a function named 'check' to test input data
-     complies with the rule.
-   - Each rule module may have other global variables.
-
-     - CONF to define its configuration parameters and those types.
-     - DEFAULT to provide default values for each configuration parameters.
-
-#. It must define a global variable RULES_MAP to provide mappings of rule ID
-   and rule modules to yamllint like this.
-   ::
-
-     RULES_MAP = {
-         # rule ID: rule module
-         a_custom_rule.ID: a_custom_rule
-     }
-
-To develop yamllint rules, the default rules themselves in yamllint may become
-good references.

docs/integration.rst

@@ -17,37 +17,3 @@ Here is an example, to add in your .pre-commit-config.yaml
     hooks:
       - id: yamllint
         args: [-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 automatically. You can also
-force the GitHub Actions output with ``yamllint --format github``.
-
-An example workflow using GitHub Actions:
-
-.. code:: yaml
-
-   ---
-   name: yamllint test
-
-   on: push
-
-   jobs:
-     test:
-       runs-on: ubuntu-latest
-       steps:
-         - uses: actions/checkout@v2
-
-         - name: Set up Python
-           uses: actions/setup-python@v2
-           with:
-             python-version: 3.8
-
-         - name: Install yamllint
-           run: pip install yamllint
-
-         - name: Lint YAML files
-           run: yamllint .

packaging/debian/README

@@ -0,0 +1,59 @@
+Release new version for Debian
+==============================
+
+VERSION=1.5.0
+WD=/tmp/pkg
+TARGET=vm-debian8
+
+# Build source archive
+python3 setup.py sdist
+
+# Copy files on a Debian system
+ssh $TARGET mkdir $WD
+rsync -av dist/yamllint-$VERSION.tar.gz $TARGET:$WD/yamllint_$VERSION.orig.tar.gz
+ssh $TARGET tar -C $WD -xf $WD/yamllint_$VERSION.orig.tar.gz
+if false; then
+  rsync -av packaging/debian/debian $TARGET:$WD/yamllint-$VERSION
+else
+  ssh $TARGET "cd $WD && sudo apt-get update"
+  ssh $TARGET "cd $WD && apt-get source yamllint"
+  ssh $TARGET mv $WD'/yamllint-*/debian' $WD/yamllint-$VERSION # old version
+fi
+
+ssh $TARGET
+cd $WD/yamllint-$VERSION/debian
+
+# Add a new changelog entry:
+dch -v $VERSION-1
+
+# Build packages and sign dsc
+debuild -S -sa
+
+# Test if it builds
+sudo pbuilder --create
+sudo pbuilder --build ../../yamllint_$VERSION-1.dsc
+
+# Run lintian to detect problems
+lintian -i -I --show-overrides ../../yamllint_$VERSION-1_source.changes
+
+# Retrieve modified files
+rsync -av $TARGET:$WD/yamllint-$VERSION/debian packaging/debian
+
+# Upload to mentors FTP (needed even for updates)
+cat >>~/.dput.cf << EOF
+[mentors]
+fqdn = mentors.debian.net
+incoming = /upload
+method = http
+allow_unsigned_uploads = 0
+progress_indicator = 2
+# Allow uploads for UNRELEASED packages
+allowed_distributions = .*
+EOF
+
+dput mentors ../../yamllint_$VERSION-1_source.changes
+
+# Do no upload to Debian FTP: the sponsor will do it
+
+# File a new RFS bug by sending an email
+See https://mentors.debian.net/sponsors/rfs-howto/yamllint

packaging/debian/debian/changelog

@@ -0,0 +1,163 @@
+yamllint (1.23.0-1) unstable; urgency=medium
+
+  * New upstream version 1.23.0
+
+ -- Philipp Huebner <debalance@debian.org>  Sun, 19 Apr 2020 10:19:31 +0200
+
+yamllint (1.21.0-1) unstable; urgency=medium
+
+  * New upstream version 1.21.0
+
+ -- Philipp Huebner <debalance@debian.org>  Sat, 11 Apr 2020 17:15:13 +0200
+
+yamllint (1.20.0-2) unstable; urgency=medium
+
+  * Removed 'Installing yamllint' section in the manpage (Closes: #947440)
+  * Moved maintainership into the Python Applications Packaging Team
+    (Closes: 947416)
+
+ -- Philipp Huebner <debalance@debian.org>  Fri, 28 Feb 2020 14:02:37 +0100
+
+yamllint (1.20.0-1) unstable; urgency=medium
+
+  * New upstream version 1.20.0
+  * Updated Standards-Version: 4.5.0 (no changes needed)
+  * Rules-Requires-Root: no
+
+ -- Philipp Huebner <debalance@debian.org>  Sun, 16 Feb 2020 00:39:28 +0100
+
+yamllint (1.18.0-1) unstable; urgency=medium
+
+  * New upstream version 1.18.0
+  * Added dh-python to build-depends
+  * Updated Standards-Version: 4.4.1 (no changes needed)
+
+ -- Philipp Huebner <debalance@debian.org>  Sun, 20 Oct 2019 19:40:24 +0200
+
+yamllint (1.16.0-1) unstable; urgency=medium
+
+  * New upstream version 1.16.0
+  * Updated debhelper compat version: 12
+  * Updated Standards-Version: 4.4.0 (no changes needed)
+
+ -- Philipp Huebner <debalance@debian.org>  Wed, 24 Jul 2019 17:35:30 +0200
+
+yamllint (1.15.0-1) unstable; urgency=medium
+
+  * New upstream version 1.15.0
+
+ -- Philipp Huebner <debalance@debian.org>  Sat, 16 Feb 2019 10:59:13 +0100
+
+yamllint (1.14.0-1) unstable; urgency=medium
+
+  * New upstream version 1.14.0
+  * Updated Standards-Version: 4.3.0 (no changes needed)
+  * Updated debian/copyright
+
+ -- Philipp Huebner <debalance@debian.org>  Sat, 19 Jan 2019 16:07:26 +0100
+
+yamllint (1.13.0-1) unstable; urgency=medium
+
+  * New upstream version 1.13.0
+  * Updated Standards-Version: 4.2.1 (no changes needed)
+
+ -- Philipp Huebner <debalance@debian.org>  Sun, 18 Nov 2018 19:16:27 +0100
+
+yamllint (1.11.1-1) unstable; urgency=medium
+
+  * New upstream version 1.11.1
+  * Updated Standards-Version: 4.1.4 (no changes needed)
+
+ -- Philipp Huebner <debalance@debian.org>  Wed, 09 May 2018 14:24:10 +0200
+
+yamllint (1.11.0-1) unstable; urgency=medium
+
+  * New upstream version 1.11.0
+  * Update Standards-Version: 4.1.3 (no changes needed)
+  * Switch to debhelper compat level 11
+
+ -- Philipp Huebner <debalance@debian.org>  Tue, 06 Mar 2018 17:35:44 +0100
+
+yamllint (1.10.0-1) unstable; urgency=medium
+
+  * New upstream version 1.10.0
+  * Drop patches (fixed upstream)
+
+ -- Philipp Huebner <debalance@debian.org>  Thu, 16 Nov 2017 19:18:18 +0100
+
+yamllint (1.9.0-1) unstable; urgency=medium
+
+  * New upstream version 1.9.0
+
+ -- Philipp Huebner <debalance@debian.org>  Sun, 22 Oct 2017 09:35:39 +0200
+
+yamllint (1.8.1-1) unstable; urgency=medium
+
+  * New upstream version 1.8.1
+  * Add myself as Uploader
+  * Depend on python3-pkg-resources (Closes: #860075)
+  * Build-Depend on python3-pathspec
+  * Add patch to use python3 in tests
+  * debian/control: set testsuite to autopkgtest-pkg-python
+  * Update Standards-Version: 4.1.1 (no changes needed)
+
+ -- Philipp Huebner <debalance@debian.org>  Wed, 04 Oct 2017 18:50:29 +0200
+
+yamllint (1.5.0-1) unstable; urgency=medium
+
+  * Output color only on TTY
+  * Generalize line-length for mappings
+  * Fix line-length bug by scanning tokens securely
+  * New rule: truthy
+  * Fix distribution (don't distribute tests in site-packages)
+  * Exclude PTY-related test (doesn't work with pbuilder)
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Mon, 07 Nov 2016 18:51:37 +0100
+
+yamllint (1.3.2-1) unstable; urgency=medium
+
+  * Allow disabling yamllint checks using comments
+  * Detect user config using `os.path.expanduser()`
+  * Fix non-ASCII comments bug and add tests
+  * Update standards version to 3.9.8
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Mon, 27 Jun 2016 22:17:05 +0200
+
+yamllint (1.2.2-1) unstable; urgency=medium
+
+  * Update to new upstream version
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Fri, 24 Jun 2016 08:54:59 +0200
+
+yamllint (1.2.1-1) unstable; urgency=medium
+
+  * Update to new upstream version
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Sun, 03 Apr 2016 11:30:02 +0200
+
+yamllint (1.2.0-1) unstable; urgency=medium
+
+  * Update to new upstream version
+  * Build and include man page in package
+  * Fix Vcs-* fields in debian/control
+  * Fix description-synopsis-starts-with-article lintian warning
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Tue, 08 Mar 2016 08:20:23 +0100
+
+yamllint (1.1.0-1) unstable; urgency=medium
+
+  * Update to new upstream version
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Fri, 04 Mar 2016 18:54:19 +0100
+
+yamllint (1.0.4-1) unstable; urgency=medium
+
+  * Update to new upstream version
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Fri, 04 Mar 2016 12:54:19 +0100
+
+yamllint (1.0.3-1) unstable; urgency=medium
+
+  * Initial release (Closes: #816609)
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Thu, 03 Mar 2016 09:10:38 +0100

packaging/debian/debian/control

@@ -0,0 +1,30 @@
+Source: yamllint
+Maintainer: Python Applications Packaging Team <python-apps-team@lists.alioth.debian.org>
+Uploaders: Adrien Vergé <adrienverge@gmail.com>, Philipp Huebner <debalance@debian.org>
+Section: devel
+Priority: optional
+Build-Depends: debhelper,
+               debhelper-compat (= 12),
+               dh-python,
+               python3-all,
+               python3-nose,
+               python3-pathspec,
+               python3-setuptools,
+               python3-sphinx,
+               python3-yaml
+Standards-Version: 4.5.0
+Rules-Requires-Root: no
+Vcs-Browser: https://salsa.debian.org/python-team/applications/yamllint
+Vcs-Git: https://salsa.debian.org/python-team/applications/yamllint.git
+Homepage: https://github.com/adrienverge/yamllint
+
+Package: yamllint
+Architecture: all
+Depends: ${misc:Depends},
+         ${python3:Depends},
+         ${shlibs:Depends},
+         python3-pkg-resources
+Description: Linter for YAML files
+ yamllint does not only check for syntax validity, but for weirdnesses like key
+ repetition and cosmetic problems such as lines length, trailing spaces,
+ indentation, etc.

packaging/debian/debian/copyright

@@ -0,0 +1,29 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: yamllint
+Source: https://github.com/adrienverge/yamllint
+
+Files: *
+Copyright: 2016-2019 Adrien Vergé <adrienverge@gmail.com>
+License: GPL-3+
+
+Files: debian/*
+Copyright: 2016-2019 Adrien Vergé <adrienverge@gmail.com>
+           2017-2019 Philipp Huebner <debalance@debian.org>
+License: GPL-3+
+
+License: GPL-3+
+ 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/>.
+ .
+ On Debian systems, the complete text of the GNU General
+ Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".

packaging/debian/debian/patches/docs.diff

@@ -0,0 +1,62 @@
+Description: clean docs
+ Remove content unsuitable for Debian
+Author: Philipp Huebner <debalance@debian.org>
+
+Index: yamllint/docs/quickstart.rst
+===================================================================
+--- yamllint.orig/docs/quickstart.rst
++++ yamllint/docs/quickstart.rst
+@@ -1,53 +1,6 @@
+ Quickstart
+ ==========
+
+-Installing yamllint
+--------------------
+-
+-On Fedora / CentOS (note: `EPEL <https://fedoraproject.org/wiki/EPEL>`_ is
+-required on CentOS):
+-
+-.. code:: bash
+-
+- sudo dnf install yamllint
+-
+-On Debian 8+ / Ubuntu 16.04+:
+-
+-.. code:: bash
+-
+- sudo apt-get install yamllint
+-
+-On Mac OS 10.11+:
+-
+-.. code:: bash
+-
+- brew 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
+-
+- pip install --user yamllint
+-
+-If you prefer installing from source, you can run, from the source directory:
+-
+-.. code:: bash
+-
+- python setup.py sdist
+- pip install --user dist/yamllint-*.tar.gz
+-
+ Running yamllint
+ ----------------
+

packaging/debian/debian/patches/series

@@ -0,0 +1 @@
+docs.diff

packaging/debian/debian/rules

@@ -0,0 +1,13 @@
+#!/usr/bin/make -f
+export DH_VERBOSE=1
+
+%:
+	NOSE_EXCLUDE=test_run_colored_output \
+	  dh $@ --with python3 --buildsystem=pybuild
+
+override_dh_auto_build:
+	dh_auto_build
+	PYTHONPATH=. http_proxy='127.0.0.1:9' sphinx-build -N -bman docs build/man
+
+override_dh_installman:
+	dh_installman build/man/yamllint.1

packaging/debian/debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

packaging/debian/debian/source/lintian-overrides

@@ -0,0 +1,2 @@
+yamllint source: debian-watch-does-not-check-gpg-signature
+yamllint source: no-dh-sequencer

packaging/debian/debian/upstream/metadata

@@ -0,0 +1,4 @@
+Bug-Database: https://github.com/adrienverge/yamllint/issues
+FAQ: https://yamllint.readthedocs.org/
+Name: yamllint
+Repository: https://github.com/adrienverge/yamllint

packaging/debian/debian/watch

@@ -0,0 +1,3 @@
+# watch control file for uscan
+version=3
+https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz

packaging/links

@@ -0,0 +1,17 @@
+Packaging in Fedora
+-------------------
+
+https://bugzilla.redhat.com/show_bug.cgi?id=1309907
+
+Packaging in Debian
+-------------------
+
+https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=816609
+https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=816611
+https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=817245
+https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=819866
+
+Packaging in Ubuntu
+-------------------
+
+https://bugs.launchpad.net/ubuntu/+bug/1554406

packaging/ubuntu/README

@@ -0,0 +1,30 @@
+Upload new version to PPA
+=========================
+
+WORKDIR=/tmp/yamllint-ubuntu
+VERSION=1.2.0
+
+git clone -b packaging https://github.com/adrienverge/yamllint.git $WORKDIR
+cd $WORKDIR
+
+# Build source archive
+python3 setup.py sdist
+cd dist
+mv yamllint-$VERSION.tar.gz yamllint_$VERSION.orig.tar.gz
+
+tar -xvf yamllint_$VERSION.orig.tar.gz
+cp -r ../packaging/ubuntu/debian yamllint-$VERSION/
+cd yamllint-$VERSION/debian
+
+# Add a new changelog entry:
+dch -v $VERSION-0ubuntu1
+
+# Build packages and sign dsc
+debuild -S -sa
+
+# Test if it builds
+sudo pbuilder --create
+sudo pbuilder --build ../yamllint_$VERSION-0ubuntu1.dsc
+
+# Upload to PPA
+dput ppa:adrienverge/ppa ../yamllint_$VERSION-0ubuntu1_source.changes

packaging/ubuntu/debian/changelog

@@ -0,0 +1,17 @@
+yamllint (1.2.0-0ubuntu1) trusty; urgency=medium
+
+  * Update to new upstream version
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Mon, 07 Mar 2016 07:54:19 +0100
+
+yamllint (1.0.3-0ubuntu2) trusty; urgency=medium
+
+  * Add python3-nose to build dependencies
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Wed, 02 Mar 2016 14:12:07 +0100
+
+yamllint (1.0.3-0ubuntu1) trusty; urgency=low
+
+  * Initial release
+
+ -- Adrien Vergé <adrienverge@gmail.com>  Wed, 02 Mar 2016 13:26:29 +0100

packaging/ubuntu/debian/compat

@@ -0,0 +1 @@
+9

packaging/ubuntu/debian/control

@@ -0,0 +1,27 @@
+Source: yamllint
+Section: devel
+Priority: optional
+Maintainer: Adrien Vergé <adrienverge@gmail.com>
+Build-Depends:
+ debhelper (>=9),
+ python3-all,
+ python3-nose,
+ python3-setuptools,
+ python3-sphinx,
+ python3-yaml,
+Standards-Version: 3.9.7
+Homepage: https://github.com/adrienverge/yamllint
+Vcs-Git: git://anonscm.debian.org/collab-maint/yamllint.git
+Vcs-Browser: https://anonscm.debian.org/cgit/collab-maint/yamllint.git
+
+Package: yamllint
+Architecture: any
+Depends:
+ python3-yaml,
+ ${misc:Depends},
+ ${python3:Depends},
+ ${shlibs:Depends},
+Description: A linter for YAML files
+ yamllint does not only check for syntax validity, but for weirdnesses like key
+ repetition and cosmetic problems such as lines length, trailing spaces,
+ indentation, etc.

packaging/ubuntu/debian/copyright

@@ -0,0 +1,19 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: yamllint
+Source: https://github.com/adrienverge/yamllint
+
+Files: *
+Copyright: 2016 Adrien Vergé <adrienverge@gmail.com>
+License: GPL-3+
+ 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/>.

packaging/ubuntu/debian/docs

@@ -0,0 +1 @@
+README.rst

packaging/ubuntu/debian/rules

@@ -0,0 +1,11 @@
+#!/usr/bin/make -f
+
+%:
+	dh $@ --with python3 --buildsystem=pybuild
+
+override_dh_auto_build:
+	dh_auto_build
+	PYTHONPATH=. http_proxy='127.0.0.1:9' sphinx-build -N -bman docs build/man
+
+override_dh_installman:
+	dh_installman build/man/yamllint.1

packaging/ubuntu/debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

packaging/ubuntu/debian/upstream/metadata

@@ -0,0 +1,4 @@
+Bug-Database: https://github.com/adrienverge/yamllint/issues
+FAQ: https://yamllint.readthedocs.org/
+Name: yamllint
+Repository: https://github.com/adrienverge/yamllint

packaging/ubuntu/debian/watch

@@ -0,0 +1,3 @@
+# watch control file for uscan
+version=3
+https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz

setup.cfg

@@ -4,68 +4,9 @@ universal = 1
 [flake8]
 import-order-style = pep8
 application-import-names = yamllint
-ignore = W503,W504
 
 [build_sphinx]
 all-files = 1
 source-dir = docs
 build-dir = docs/_build
 warning-is-error = 1
-
-[metadata]
-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 :: 2.7
-  Programming Language :: Python :: 3
-  Programming Language :: Python :: 3.4
-  Programming Language :: Python :: 3.5
-  Programming Language :: Python :: 3.6
-  Programming Language :: Python :: 3.7
-  Programming Language :: Python :: 3.8
-  Topic :: Software Development
-  Topic :: Software Development :: Debuggers
-  Topic :: Software Development :: Quality Assurance
-  Topic :: Software Development :: Testing
-
-project_urls =
-  Documentation = https://yamllint.readthedocs.io
-  Download = https://pypi.org/project/yamllint/#files
-  Bug Tracker = https://github.com/adrienverge/yamllint/issues
-  Source Code = https://github.com/adrienverge/yamllint
-
-[options]
-packages = find:
-
-python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
-
-include_package_data = True
-install_requires =
-  pathspec >= 0.5.3
-  pyyaml
-  setuptools
-
-test_suite = tests
-
-[options.packages.find]
-exclude =
-  tests
-  tests.*
-
-[options.package_data]
-yamllint = conf/*.yaml
-
-[options.entry_points]
-console_scripts =
-  yamllint = yamllint.cli:run

setup.py

@@ -14,7 +14,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/>.
 
-from setuptools import setup
+from setuptools import find_packages, setup
 
 from yamllint import (__author__, __license__,
                       APP_NAME, APP_VERSION, APP_DESCRIPTION)
@@ -27,4 +27,30 @@ setup(
     description=APP_DESCRIPTION.split('\n')[0],
     long_description=APP_DESCRIPTION,
     license=__license__,
+    keywords=['yaml', 'lint', 'linter', 'syntax', 'checker'],
+    url='https://github.com/adrienverge/yamllint',
+    python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*',
+    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 :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        '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/common.py

@@ -57,7 +57,7 @@ def build_temp_workspace(files):
     tempdir = tempfile.mkdtemp(prefix='yamllint-tests-')
 
     for path, content in files.items():
-        path = os.path.join(tempdir, path).encode('utf-8')
+        path = os.path.join(tempdir, path)
         if not os.path.exists(os.path.dirname(path)):
             os.makedirs(os.path.dirname(path))
 

tests/plugins/example/__init__.py

@@ -1,26 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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/>.
-
-"""yamllint plugin entry point
-"""
-from __future__ import absolute_import
-
-from . import override_comments
-
-
-RULES_MAP = {
-    override_comments.ID: override_comments
-}

tests/plugins/example/override_comments.py

@@ -1,63 +0,0 @@
-#
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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 override some comments' rules.
-
-.. rubric:: Options
-
-* Use ``forbid`` to control comments. Set to ``true`` to forbid comments
-  completely.
-
-.. rubric:: Examples
-
-#. With ``override-comments: {forbid: true}``
-
-   the following code snippet would **PASS**:
-   ::
-
-    foo: 1
-
-   the following code snippet would **FAIL**:
-   ::
-
-    # baz
-    foo: 1
-
-.. rubric:: Default values (when enabled)
-
-.. code-block:: yaml
-
-rules:
-  override-comments:
-    forbid: False
-
-"""
-from yamllint.linter import LintProblem
-
-
-ID = 'override-comments'
-TYPE = 'comment'
-CONF = {'forbid': bool}
-DEFAULT = {'forbid': False}
-
-
-def check(conf, comment):
-    """Check if comments are found.
-    """
-    if conf['forbid']:
-        yield LintProblem(comment.line_no, comment.column_no,
-                          'forbidden comment')

tests/plugins/yamllint_plugin_example/setup.cfg

@@ -1,11 +0,0 @@
-[metadata]
-name = yamllint_plugin_example
-version = 1.0.0
-
-[options]
-packages = find:
-install_requires = yamllint
-
-[options.entry_points]
-yamllint.plugins.rules =
-    example = yamllint_plugin_example

tests/plugins/yamllint_plugin_example/setup.py

@@ -1,2 +0,0 @@
-import setuptools
-setuptools.setup()

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/__init__.py

@@ -1,27 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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/>.
-
-"""yamllint plugin entry point
-"""
-from __future__ import absolute_import
-
-from . import override_comments, random_failure
-
-
-RULES_MAP = {
-    override_comments.ID: override_comments,
-    random_failure.ID: random_failure,
-}

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/override_comments.py

@@ -1,63 +0,0 @@
-#
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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 override some comments' rules.
-
-.. rubric:: Options
-
-* Use ``forbid`` to control comments. Set to ``true`` to forbid comments
-  completely.
-
-.. rubric:: Examples
-
-#. With ``override-comments: {forbid: true}``
-
-   the following code snippet would **PASS**:
-   ::
-
-    foo: 1
-
-   the following code snippet would **FAIL**:
-   ::
-
-    # baz
-    foo: 1
-
-.. rubric:: Default values (when enabled)
-
-.. code-block:: yaml
-
-rules:
-  override-comments:
-    forbid: False
-
-"""
-from yamllint.linter import LintProblem
-
-
-ID = 'override-comments'
-TYPE = 'comment'
-CONF = {'forbid': bool}
-DEFAULT = {'forbid': False}
-
-
-def check(conf, comment):
-    """Check if comments are found.
-    """
-    if conf['forbid']:
-        yield LintProblem(comment.line_no, comment.column_no,
-                          'forbidden comment')

tests/plugins/yamllint_plugin_example/yamllint_plugin_example/random_failure.py

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 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/>.
-
-
-import random
-
-from yamllint.linter import LintProblem
-
-
-ID = 'random-failure'
-TYPE = 'token'
-
-
-def check(conf, token, prev, next, nextnext, context):
-    if random.random() > 0.9:
-        yield LintProblem(token.start_mark.line + 1,
-                          token.start_mark.column + 1,
-                          'random failure')

tests/rules/test_braces.py

@@ -31,36 +31,6 @@ 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))
-
     def test_min_spaces(self):
         conf = ('braces:\n'
                 '  max-spaces-inside: -1\n'

tests/rules/test_brackets.py

@@ -31,35 +31,6 @@ 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))
-
     def test_min_spaces(self):
         conf = ('brackets:\n'
                 '  max-spaces-inside: -1\n'

tests/rules/test_comments.py

@@ -186,27 +186,6 @@ 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_key_ordering.py

@@ -14,8 +14,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/>.
 
-import locale
-
 from tests.common import RuleTestCase
 
 
@@ -105,6 +103,10 @@ 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'
@@ -112,39 +114,3 @@ 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:
-            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:
-            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_new_lines.py

@@ -40,16 +40,6 @@ class NewLinesTestCase(RuleTestCase):
         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-line-at-end-of-file: disable\n'
                 'new-lines: {type: dos}\n')

tests/rules/test_octal_values.py

@@ -50,8 +50,6 @@ 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:\n'
@@ -76,5 +74,3 @@ 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

@@ -330,8 +330,7 @@ class QuotedTestCase(RuleTestCase):
                    '- "%wheel ALL=(ALL) NOPASSWD: ALL"\n'
                    '- \'"quoted"\'\n'
                    '- "\'foo\' == \'bar\'"\n'
-                   '- "\'Mac\' in ansible_facts.product_name"\n'
+                   '- "\'Mac\' in ansible_facts.product_name"\n',
-                   '- \'foo # bar\'\n',
                    conf)
         self.check('---\n'
                    'k1: ""\n'

tests/test_cli.py

@@ -24,7 +24,6 @@ import os
 import pty
 import shutil
 import sys
-import tempfile
 import unittest
 
 from tests.common import build_temp_workspace
@@ -56,16 +55,6 @@ class RunContext(object):
         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:
-        return False
-
-
 class CommandLineTestCase(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
@@ -83,9 +72,6 @@ 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'
@@ -96,7 +82,7 @@ class CommandLineTestCase(unittest.TestCase):
             'no-yaml.json': '---\n'
                             'key: value\n',
             # non-ASCII chars
-            u'non-ascii/éçäγλνπ¥/utf-8': (
+            'non-ascii/éçäγλνπ¥/utf-8': (
                 u'---\n'
                 u'- hétérogénéité\n'
                 u'# 19.99 €\n'
@@ -105,13 +91,6 @@ class CommandLineTestCase(unittest.TestCase):
             # 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
@@ -120,19 +99,14 @@ 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], 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')],
         )
@@ -157,7 +131,6 @@ class CommandLineTestCase(unittest.TestCase):
         self.assertEqual(
             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')],
         )
 
@@ -167,8 +140,6 @@ class CommandLineTestCase(unittest.TestCase):
         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')]
@@ -180,8 +151,7 @@ class CommandLineTestCase(unittest.TestCase):
         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, 'empty.yml')]
-             os.path.join(self.wd, 'sub/directory.yaml/empty.yml')]
         )
 
         conf = config.YamlLintConfig('extends: default\n'
@@ -198,15 +168,11 @@ class CommandLineTestCase(unittest.TestCase):
         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')]
         )
@@ -219,15 +185,11 @@ class CommandLineTestCase(unittest.TestCase):
         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')]
         )
@@ -323,65 +285,6 @@ class CommandLineTestCase(unittest.TestCase):
             cli.run((os.path.join(self.wd, 'a.yaml'), ))
         self.assertEqual(ctx.returncode, 1)
 
-    def test_run_with_user_yamllint_config_file_in_env(self):
-        self.addCleanup(os.environ.__delitem__, 'YAMLLINT_CONFIG_FILE')
-
-        with tempfile.NamedTemporaryFile('w') as f:
-            os.environ['YAMLLINT_CONFIG_FILE'] = f.name
-            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)
-
-        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:
-            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)
-
     def test_run_version(self):
         with RunContext(self) as ctx:
             cli.run(('--version', ))
@@ -437,12 +340,18 @@ class CommandLineTestCase(unittest.TestCase):
             cli.run(('-f', 'parsable', path))
         self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
 
-    @unittest.skipIf(not utf8_available(), 'C.UTF-8 not available')
     def test_run_non_ascii_file(self):
-        locale.setlocale(locale.LC_ALL, 'C.UTF-8')
-        self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
-
         path = os.path.join(self.wd, 'non-ascii', 'éçäγλνπ¥', 'utf-8')
+
+        # 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')
+        self.addCleanup(locale.setlocale, locale.LC_ALL, loc)
+
         with RunContext(self) as ctx:
             cli.run(('-f', 'parsable', path))
         self.assertEqual((ctx.returncode, ctx.stdout, ctx.stderr), (0, '', ''))
@@ -549,38 +458,6 @@ class CommandLineTestCase(unittest.TestCase):
         self.assertEqual(
             (ctx.returncode, ctx.stdout, ctx.stderr), (1, 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 = (
-            '::error file=%s,line=2,col=4::[trailing-spaces] trailing'
-            ' spaces\n'
-            '::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
-            ' new line character at the end of file\n'
-            % (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 = (
-            '::error file=%s,line=2,col=4::[trailing-spaces] trailing'
-            ' spaces\n'
-            '::error file=%s,line=3,col=4::[new-line-at-end-of-file] no'
-            ' new line character at the end of file\n'
-            % (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

tests/test_plugins.py

@@ -1,80 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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/>.
-import unittest
-import warnings
-
-try:
-    from unittest import mock
-except ImportError:  # for python 2.7
-    mock = False
-
-from tests.plugins import example
-
-import yamllint.plugins
-
-
-class FakeEntryPoint(object):
-    """Fake object to mimic pkg_resources.EntryPoint.
-    """
-    RULES_MAP = example.RULES_MAP
-
-    def load(self):
-        """Fake method to return self.
-        """
-        return self
-
-
-class BrokenEntryPoint(FakeEntryPoint):
-    """Fake object to mimic load failure of pkg_resources.EntryPoint.
-    """
-    def load(self):
-        raise ImportError("This entry point should fail always!")
-
-
-class PluginFunctionsTestCase(unittest.TestCase):
-
-    def test_validate_rule_module(self):
-        fun = yamllint.plugins.validate_rule_module
-        rule_mod = example.override_comments
-
-        self.assertFalse(fun(object()))
-        self.assertTrue(fun(rule_mod))
-
-    @unittest.skipIf(not mock, "unittest.mock is not available")
-    def test_validate_rule_module_using_mock(self):
-        fun = yamllint.plugins.validate_rule_module
-        rule_mod = example.override_comments
-
-        with mock.patch.object(rule_mod, "ID", False):
-            self.assertFalse(fun(rule_mod))
-
-        with mock.patch.object(rule_mod, "TYPE", False):
-            self.assertFalse(fun(rule_mod))
-
-        with mock.patch.object(rule_mod, "check", True):
-            self.assertFalse(fun(rule_mod))
-
-    def test_load_plugin_rules_itr(self):
-        fun = yamllint.plugins.load_plugin_rules_itr
-
-        self.assertEqual(list(fun([])), [])
-        self.assertEqual(sorted(fun([FakeEntryPoint(),
-                                     FakeEntryPoint()])),
-                         sorted(FakeEntryPoint.RULES_MAP.items()))
-
-        with warnings.catch_warnings():
-            warnings.simplefilter("ignore")
-            self.assertEqual(list(fun([BrokenEntryPoint()])), [])

tests/test_rules.py

@@ -1,64 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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/>.
-import unittest
-
-try:
-    from unittest import mock
-except ImportError:  # for python 2.7
-    mock = False
-
-from tests.plugins import example
-
-import yamllint.rules
-
-
-RULE_NEVER_EXISTS = "rule_never_exists"
-PLUGIN_RULES = example.RULES_MAP
-
-
-class TestCase(unittest.TestCase):
-    """Test cases for yamllint.rules.__init__.*.
-    """
-    def test_get_default_rule(self):
-        self.assertEqual(yamllint.rules.get(yamllint.rules.braces.ID),
-                         yamllint.rules.braces)
-
-    def test_get_rule_does_not_exist(self):
-        with self.assertRaises(ValueError):
-            yamllint.rules.get(RULE_NEVER_EXISTS)
-
-
-@unittest.skipIf(not mock, "unittest.mock is not available")
-class TestCaseUsingMock(unittest.TestCase):
-    """Test cases for yamllint.rules.__init__.* using mock.
-    """
-    def test_get_default_rule_with_plugins(self):
-        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
-            self.assertEqual(yamllint.rules.get(yamllint.rules.braces.ID),
-                             yamllint.rules.braces)
-
-    def test_get_plugin_rules(self):
-        plugin_rule_id = example.override_comments.ID
-        plugin_rule_mod = example.override_comments
-
-        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
-            self.assertEqual(yamllint.rules.get(plugin_rule_id),
-                             plugin_rule_mod)
-
-    def test_get_rule_does_not_exist_with_plugins(self):
-        with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
-            with self.assertRaises(ValueError):
-                yamllint.rules.get(RULE_NEVER_EXISTS)

tests/test_yamllint_directives.py

@@ -232,34 +232,6 @@ 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'

yamllint/__init__.py

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

yamllint/cli.py

@@ -18,7 +18,6 @@ from __future__ import print_function
 
 import argparse
 import io
-import locale
 import os
 import platform
 import sys
@@ -85,19 +84,6 @@ 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 += '::'
-        if problem.rule:
-            line += '[' + problem.rule + '] '
-        line += problem.desc
-        return line
-
 
 def show_problems(problems, file, args_format, no_warn):
     max_level = 0
@@ -109,10 +95,6 @@ def show_problems(problems, file, args_format, no_warn):
             continue
         if args_format == 'parsable':
             print(Format.parsable(problem, file))
-        elif args_format == 'github' or (args_format == 'auto' and
-                                         'GITHUB_ACTIONS' in os.environ and
-                                         'GITHUB_WORKFLOW' in os.environ):
-            print(Format.github(problem, file))
         elif args_format == 'colored' or \
                 (args_format == 'auto' and supports_color()):
             if first:
@@ -148,8 +130,7 @@ def run(argv=None):
                               action='store',
                               help='custom configuration (as YAML source)')
     parser.add_argument('-f', '--format',
-                        choices=('parsable', 'standard', 'colored', 'github',
+                        choices=('parsable', 'standard', 'colored', 'auto'),
-                                 'auto'),
                         default='auto', help='format for parsing output')
     parser.add_argument('-s', '--strict',
                         action='store_true',
@@ -163,11 +144,8 @@ def run(argv=None):
 
     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
-    elif 'XDG_CONFIG_HOME' in os.environ:
+    if 'XDG_CONFIG_HOME' in os.environ:
         user_global_config = os.path.join(
             os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
     else:
@@ -194,9 +172,6 @@ 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)
-
     max_level = 0
 
     for file in find_files_recursively(args.files, conf):

yamllint/conf/default.yaml

@@ -29,7 +29,5 @@ rules:
   octal-values: disable
   quoted-strings: disable
   trailing-spaces: enable
-  random-failure: enable
-  override-comments: {forbid: true}
   truthy:
     level: warning

yamllint/config.py

@@ -35,8 +35,6 @@ class YamlLintConfig(object):
         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()
@@ -48,7 +46,7 @@ class YamlLintConfig(object):
         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))
+        return self.yaml_files.match_file(filepath)
 
     def enabled_rules(self, filepath):
         return [yamllint.rules.get(id) for id, val in self.rules.items()
@@ -113,12 +111,6 @@ class YamlLintConfig(object):
             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:
             try:

yamllint/linter.py

@@ -87,8 +87,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
                 return  # this certainly wasn't a yamllint directive comment
 
             if re.match(r'^# yamllint disable( rule:\S+)*\s*$', comment):
-                items = comment[18:].rstrip().split(' ')
+                rules = [item[5:] for item in comment[18:].split(' ')][1:]
-                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules = self.all_rules.copy()
                 else:
@@ -97,8 +96,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
                             self.rules.add(id)
 
             elif re.match(r'^# yamllint enable( rule:\S+)*\s*$', comment):
-                items = comment[17:].rstrip().split(' ')
+                rules = [item[5:] for item in comment[17:].split(' ')][1:]
-                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules.clear()
                 else:
@@ -116,8 +114,7 @@ def get_cosmetic_problems(buffer, conf, filepath):
                 return  # this certainly wasn't a yamllint directive comment
 
             if re.match(r'^# yamllint disable-line( rule:\S+)*\s*$', comment):
-                items = comment[23:].rstrip().split(' ')
+                rules = [item[5:] for item in comment[23:].split(' ')][1:]
-                rules = [item[5:] for item in items][1:]
                 if len(rules) == 0:
                     self.rules = self.all_rules.copy()
                 else:

yamllint/plugins.py

@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright (C) 2020 Satoru SATOH
-#
-# 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/>.
-"""
-Plugin module utilizing setuptools (pkg_resources) to allow users to add their
-own custom lint rules.
-"""
-import warnings
-
-import pkg_resources
-
-
-PACKAGE_GROUP = "yamllint.plugins.rules"
-
-
-def validate_rule_module(rule_mod):
-    """Test if given rule module is valid.
-    """
-    return (getattr(rule_mod, "ID", False) and
-            getattr(rule_mod, "TYPE", False)
-            ) and callable(getattr(rule_mod, "check", False))
-
-
-def load_plugin_rules_itr(entry_points=None, group=PACKAGE_GROUP):
-    """Load custom lint rule plugins."""
-    if not entry_points:
-        entry_points = pkg_resources.iter_entry_points(group)
-
-    rule_ids = set()
-    for entry in entry_points:
-        try:
-            rules = entry.load()
-            for rule_id, rule_mod in rules.RULES_MAP.items():
-                if rule_id in rule_ids or not validate_rule_module(rule_mod):
-                    continue
-
-                print(rule_id, rule_mod)###
-                yield (rule_id, rule_mod)
-                rule_ids.add(rule_id)
-
-        # pkg_resources.EntryPoint.resolve may throw ImportError.
-        except (AttributeError, ImportError):
-            warnings.warn("Could not load the plugin: {}".format(entry),
-                          RuntimeWarning)
-
-
-def get_plugin_rules_map():
-    """Get a mappings of plugin rule's IDs and rules."""
-    return dict((rule_id, rule_mod)
-                for rule_id, rule_mod in load_plugin_rules_itr())

yamllint/rules/__init__.py

@@ -14,7 +14,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/>.
 
-import yamllint.plugins
 from yamllint.rules import (
     braces,
     brackets,
@@ -63,14 +62,9 @@ _RULES = {
     truthy.ID: truthy,
 }
 
-_EXTERNAL_RULES = yamllint.plugins.get_plugin_rules_map()
 
+def get(id):
+    if id not in _RULES:
+        raise ValueError('no such rule: "%s"' % id)
 
-def get(rule_id):
+    return _RULES[id]
-    if rule_id in _RULES:
-        return _RULES[rule_id]
-
-    if rule_id in _EXTERNAL_RULES:
-        return _EXTERNAL_RULES[rule_id]
-
-    raise ValueError('no such rule: "%s"' % rule_id)

yamllint/rules/braces.py

@@ -15,14 +15,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Use this rule to control the use of flow mappings or number of spaces inside
+Use this rule to control the number of spaces inside braces (``{`` and ``}``).
-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.
 * ``min-spaces-inside`` defines the minimal number of spaces required inside
   braces.
 * ``max-spaces-inside`` defines the maximal number of spaces allowed inside
@@ -32,34 +28,8 @@ 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: {min-spaces-inside: 0, max-spaces-inside: 0}``
 
    the following code snippet would **PASS**:
@@ -122,31 +92,23 @@ braces (``{`` and ``}``).
 
 import yaml
 
-from yamllint.linter import LintProblem
 from yamllint.rules.common import spaces_after, spaces_before
 
 
 ID = 'braces'
 TYPE = 'token'
-CONF = {'forbid': bool,
+CONF = {'min-spaces-inside': int,
-        'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
         'max-spaces-inside-empty': int}
-DEFAULT = {'forbid': False,
+DEFAULT = {'min-spaces-inside': 0,
-           '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 conf['forbid'] and isinstance(token, yaml.FlowMappingStartToken):
+    if (isinstance(token, yaml.FlowMappingStartToken) and
-        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

@@ -15,14 +15,11 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Use this rule to control the use of flow sequences or the number of spaces
+Use this rule to control the number of spaces inside brackets (``[`` and
-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.
 * ``min-spaces-inside`` defines the minimal number of spaces required inside
   brackets.
 * ``max-spaces-inside`` defines the maximal number of spaces allowed inside
@@ -32,35 +29,8 @@ 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: {min-spaces-inside: 0, max-spaces-inside: 0}``
 
    the following code snippet would **PASS**:
@@ -123,31 +93,23 @@ inside brackets (``[`` and ``]``).
 
 import yaml
 
-from yamllint.linter import LintProblem
 from yamllint.rules.common import spaces_after, spaces_before
 
 
 ID = 'brackets'
 TYPE = 'token'
-CONF = {'forbid': bool,
+CONF = {'min-spaces-inside': int,
-        'min-spaces-inside': int,
         'max-spaces-inside': int,
         'min-spaces-inside-empty': int,
         'max-spaces-inside-empty': int}
-DEFAULT = {'forbid': False,
+DEFAULT = {'min-spaces-inside': 0,
-           '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 conf['forbid'] and isinstance(token, yaml.FlowSequenceStartToken):
+    if (isinstance(token, yaml.FlowSequenceStartToken) and
-        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

@@ -24,15 +24,6 @@ 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}``

yamllint/rules/commas.py

@@ -26,16 +26,6 @@ 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}``
@@ -76,7 +66,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**:
    ::

yamllint/rules/comments.py

@@ -28,16 +28,6 @@ Use this rule to control the position and formatting of comments.
   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}``
@@ -107,9 +97,7 @@ def check(conf, comment):
                     comment.column_no == 1 and
                     re.match(r'^!\S', comment.buffer[text_start:])):
                 return
-            # We can test for both \r and \r\n just by checking first char
+            elif comment.buffer[text_start] not in (' ', '\n', '\0'):
-            # \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,

yamllint/rules/document_end.py

@@ -22,14 +22,6 @@ 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}``

yamllint/rules/document_start.py

@@ -22,14 +22,6 @@ 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}``

yamllint/rules/empty_lines.py

@@ -25,16 +25,6 @@ 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}``

yamllint/rules/empty_values.py

@@ -23,15 +23,6 @@ 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}``

yamllint/rules/hyphens.py

@@ -22,14 +22,6 @@ 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}``

yamllint/rules/indentation.py

@@ -32,16 +32,6 @@ 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}``

yamllint/rules/key_ordering.py

@@ -16,10 +16,8 @@
 
 """
 Use this rule to enforce alphabetical ordering of keys in mappings. The sorting
-order uses the Unicode code point number as a default. As a result, the
+order uses the Unicode code point number. As a result, the ordering is
-ordering is case-sensitive and not accent-friendly (see examples below).
+case-sensitive and not accent-friendly (see examples below).
-This can be changed by setting the global ``locale`` option.  This allows to
-sort case and accents properly.
 
 .. rubric:: Examples
 
@@ -65,24 +63,8 @@ sort case and accents properly.
 
     - 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
@@ -119,8 +101,7 @@ 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(strcoll(next.value, key) < 0
+            if any(next.value < key for key in context['stack'][-1].keys):
-                   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

@@ -30,16 +30,6 @@ recommend running yamllint with Python 3.
 * ``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}``

yamllint/rules/new_lines.py

@@ -21,14 +21,6 @@ Use this rule to force the type of new line characters.
 
 * Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
   ``dos`` to use DOS-typed new line characters (``\\r\\n``).
-
-.. rubric:: Default values (when enabled)
-
-.. code-block:: yaml
-
- rules:
-   new-lines:
-     type: unix
 """
 
 

yamllint/rules/octal_values.py

@@ -20,20 +20,6 @@ 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}``
@@ -71,8 +57,6 @@ converted to ``8``.
       city-code: 0o10
 """
 
-import re
-
 import yaml
 
 from yamllint.linter import LintProblem
@@ -86,10 +70,6 @@ DEFAULT = {'forbid-implicit-octal': True,
            'forbid-explicit-octal': True}
 
 
-def _is_octal_number(string):
-    return re.match(r'^[0-7]+$', string) is not None
-
-
 def check(conf, token, prev, next, nextnext, context):
     if prev and isinstance(prev, yaml.tokens.TagToken):
         return
@@ -98,8 +78,7 @@ 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' and
+                if val.isdigit() and len(val) > 1 and val[0] == '0':
-                        _is_octal_number(val[1:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden implicit octal value "%s"' %
@@ -109,8 +88,7 @@ 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
+                if len(val) > 2 and val[:2] == '0o' and val[2:].isdigit():
-                        _is_octal_number(val[2:])):
                     yield LintProblem(
                         token.start_mark.line + 1, token.end_mark.column + 1,
                         'forbidden explicit octal value "%s"' %

yamllint/rules/quoted_strings.py

@@ -34,17 +34,6 @@ used.
 
 **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: []
-
 .. rubric:: Examples
 
 #. With ``quoted-strings: {quote-type: any, required: true}``
@@ -160,7 +149,7 @@ def _quotes_are_needed(string):
     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):
+                isinstance(b, yaml.BlockEndToken)):
             return False
         return True
     except yaml.scanner.ScannerError:

yamllint/rules/truthy.py

@@ -34,15 +34,6 @@ This can be useful to prevent surprises from YAML parsers transforming
   ``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: {}``