Compare commits
34 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2c6493c2e9 | ||
|
|
f5d8c765c7 | ||
|
|
7cee10f77c | ||
|
|
d457b37add | ||
|
|
f90ef91ebc | ||
|
|
0ee814561d | ||
|
|
790662d369 | ||
|
|
92c5440d22 | ||
|
|
cc8d56fb94 | ||
|
|
d77cb4e2f6 | ||
|
|
1c31952230 | ||
|
|
8e97e6b151 | ||
|
|
5cd261d6cb | ||
|
|
becf9fe98b | ||
|
|
251260c382 | ||
|
|
c0f7ae1102 | ||
|
|
b47f0f2451 | ||
|
|
5ca5add463 | ||
|
|
542b6738a6 | ||
|
|
2c3097ca78 | ||
|
|
5fbfcb13b1 | ||
|
|
b8200259a2 | ||
|
|
0fd8b76eea | ||
|
|
a4ab40c51a | ||
|
|
aeb353159b | ||
|
|
c57d2784df | ||
|
|
c0da5eac54 | ||
|
|
69278a4553 | ||
|
|
e3baeefc81 | ||
|
|
d4d1d78ce6 | ||
|
|
c88cdf5316 | ||
|
|
1fb673be2e | ||
|
|
ea658ec3d6 | ||
|
|
014a6d2db4 |
@@ -1,24 +1,6 @@
|
|||||||
Changelog
|
Changelog
|
||||||
=========
|
=========
|
||||||
|
|
||||||
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)
|
1.23.0 (2020-04-17)
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
|
|||||||
@@ -1,44 +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
|
|
||||||
|
|
||||||
python setup.py test
|
|
||||||
|
|
||||||
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.
|
|
||||||
@@ -6,9 +6,9 @@ import sys
|
|||||||
import os
|
import os
|
||||||
from unittest.mock import MagicMock
|
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 ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ following locations (by order of preference):
|
|||||||
|
|
||||||
- ``.yamllint``, ``.yamllint.yaml`` or ``.yamllint.yml`` in the current working
|
- ``.yamllint``, ``.yamllint.yaml`` or ``.yamllint.yml`` in the current working
|
||||||
directory
|
directory
|
||||||
- the file referenced by ``$YAMLLINT_CONFIG_FILE``, if set
|
|
||||||
- ``$XDG_CONFIG_HOME/yamllint/config``
|
- ``$XDG_CONFIG_HOME/yamllint/config``
|
||||||
- ``~/.config/yamllint/config``
|
- ``~/.config/yamllint/config``
|
||||||
|
|
||||||
@@ -189,22 +188,3 @@ Here is a more complex example:
|
|||||||
ignore: |
|
ignore: |
|
||||||
*.ignore-trailing-spaces.yaml
|
*.ignore-trailing-spaces.yaml
|
||||||
ascii-art/*
|
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
|
|
||||||
|
|||||||
59
packaging/debian/README
Normal file
59
packaging/debian/README
Normal file
@@ -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
|
||||||
163
packaging/debian/debian/changelog
Normal file
163
packaging/debian/debian/changelog
Normal file
@@ -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
|
||||||
30
packaging/debian/debian/control
Normal file
30
packaging/debian/debian/control
Normal file
@@ -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.
|
||||||
29
packaging/debian/debian/copyright
Normal file
29
packaging/debian/debian/copyright
Normal file
@@ -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".
|
||||||
62
packaging/debian/debian/patches/docs.diff
Normal file
62
packaging/debian/debian/patches/docs.diff
Normal file
@@ -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
|
||||||
|
----------------
|
||||||
|
|
||||||
1
packaging/debian/debian/patches/series
Normal file
1
packaging/debian/debian/patches/series
Normal file
@@ -0,0 +1 @@
|
|||||||
|
docs.diff
|
||||||
13
packaging/debian/debian/rules
Executable file
13
packaging/debian/debian/rules
Executable file
@@ -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
|
||||||
1
packaging/debian/debian/source/format
Normal file
1
packaging/debian/debian/source/format
Normal file
@@ -0,0 +1 @@
|
|||||||
|
3.0 (quilt)
|
||||||
2
packaging/debian/debian/source/lintian-overrides
Normal file
2
packaging/debian/debian/source/lintian-overrides
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
yamllint source: debian-watch-does-not-check-gpg-signature
|
||||||
|
yamllint source: no-dh-sequencer
|
||||||
4
packaging/debian/debian/upstream/metadata
Normal file
4
packaging/debian/debian/upstream/metadata
Normal file
@@ -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
|
||||||
3
packaging/debian/debian/watch
Normal file
3
packaging/debian/debian/watch
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# watch control file for uscan
|
||||||
|
version=3
|
||||||
|
https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz
|
||||||
17
packaging/links
Normal file
17
packaging/links
Normal file
@@ -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
|
||||||
30
packaging/ubuntu/README
Normal file
30
packaging/ubuntu/README
Normal file
@@ -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
|
||||||
17
packaging/ubuntu/debian/changelog
Normal file
17
packaging/ubuntu/debian/changelog
Normal file
@@ -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
|
||||||
1
packaging/ubuntu/debian/compat
Normal file
1
packaging/ubuntu/debian/compat
Normal file
@@ -0,0 +1 @@
|
|||||||
|
9
|
||||||
27
packaging/ubuntu/debian/control
Normal file
27
packaging/ubuntu/debian/control
Normal file
@@ -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.
|
||||||
19
packaging/ubuntu/debian/copyright
Normal file
19
packaging/ubuntu/debian/copyright
Normal file
@@ -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/>.
|
||||||
1
packaging/ubuntu/debian/docs
Normal file
1
packaging/ubuntu/debian/docs
Normal file
@@ -0,0 +1 @@
|
|||||||
|
README.rst
|
||||||
11
packaging/ubuntu/debian/rules
Executable file
11
packaging/ubuntu/debian/rules
Executable file
@@ -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
|
||||||
1
packaging/ubuntu/debian/source/format
Normal file
1
packaging/ubuntu/debian/source/format
Normal file
@@ -0,0 +1 @@
|
|||||||
|
3.0 (quilt)
|
||||||
4
packaging/ubuntu/debian/upstream/metadata
Normal file
4
packaging/ubuntu/debian/upstream/metadata
Normal file
@@ -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
|
||||||
3
packaging/ubuntu/debian/watch
Normal file
3
packaging/ubuntu/debian/watch
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# watch control file for uscan
|
||||||
|
version=3
|
||||||
|
https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz
|
||||||
@@ -4,7 +4,6 @@ universal = 1
|
|||||||
[flake8]
|
[flake8]
|
||||||
import-order-style = pep8
|
import-order-style = pep8
|
||||||
application-import-names = yamllint
|
application-import-names = yamllint
|
||||||
ignore = W503,W504
|
|
||||||
|
|
||||||
[build_sphinx]
|
[build_sphinx]
|
||||||
all-files = 1
|
all-files = 1
|
||||||
|
|||||||
1
setup.py
1
setup.py
@@ -42,7 +42,6 @@ setup(
|
|||||||
'Programming Language :: Python :: 3.5',
|
'Programming Language :: Python :: 3.5',
|
||||||
'Programming Language :: Python :: 3.6',
|
'Programming Language :: Python :: 3.6',
|
||||||
'Programming Language :: Python :: 3.7',
|
'Programming Language :: Python :: 3.7',
|
||||||
'Programming Language :: Python :: 3.8',
|
|
||||||
'Topic :: Software Development',
|
'Topic :: Software Development',
|
||||||
'Topic :: Software Development :: Debuggers',
|
'Topic :: Software Development :: Debuggers',
|
||||||
'Topic :: Software Development :: Quality Assurance',
|
'Topic :: Software Development :: Quality Assurance',
|
||||||
|
|||||||
@@ -186,27 +186,6 @@ class CommentsTestCase(RuleTestCase):
|
|||||||
'inline: comment #\n'
|
'inline: comment #\n'
|
||||||
'foo: bar\n', conf)
|
'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):
|
def test_first_line(self):
|
||||||
conf = ('comments:\n'
|
conf = ('comments:\n'
|
||||||
' require-starting-space: true\n'
|
' require-starting-space: true\n'
|
||||||
|
|||||||
@@ -14,8 +14,6 @@
|
|||||||
# You should have received a copy of the GNU General Public License
|
# 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 <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
import locale
|
|
||||||
|
|
||||||
from tests.common import RuleTestCase
|
from tests.common import RuleTestCase
|
||||||
|
|
||||||
|
|
||||||
@@ -105,6 +103,10 @@ class KeyOrderingTestCase(RuleTestCase):
|
|||||||
'haïr: true\n'
|
'haïr: true\n'
|
||||||
'hais: true\n', conf,
|
'hais: true\n', conf,
|
||||||
problem=(3, 1))
|
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):
|
def test_key_tokens_in_flow_sequences(self):
|
||||||
conf = 'key-ordering: enable'
|
conf = 'key-ordering: enable'
|
||||||
@@ -112,39 +114,3 @@ class KeyOrderingTestCase(RuleTestCase):
|
|||||||
'[\n'
|
'[\n'
|
||||||
' key: value, mappings, in, flow: sequence\n'
|
' key: value, mappings, in, flow: sequence\n'
|
||||||
']\n', conf)
|
']\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))
|
|
||||||
|
|||||||
@@ -40,16 +40,6 @@ class NewLinesTestCase(RuleTestCase):
|
|||||||
self.check('---\ntext\n', conf)
|
self.check('---\ntext\n', conf)
|
||||||
self.check('---\r\ntext\r\n', conf, problem=(1, 4))
|
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):
|
def test_dos_type(self):
|
||||||
conf = ('new-line-at-end-of-file: disable\n'
|
conf = ('new-line-at-end-of-file: disable\n'
|
||||||
'new-lines: {type: dos}\n')
|
'new-lines: {type: dos}\n')
|
||||||
|
|||||||
@@ -24,7 +24,6 @@ import os
|
|||||||
import pty
|
import pty
|
||||||
import shutil
|
import shutil
|
||||||
import sys
|
import sys
|
||||||
import tempfile
|
|
||||||
import unittest
|
import unittest
|
||||||
|
|
||||||
from tests.common import build_temp_workspace
|
from tests.common import build_temp_workspace
|
||||||
@@ -73,9 +72,6 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
# file in dir
|
# file in dir
|
||||||
'sub/ok.yaml': '---\n'
|
'sub/ok.yaml': '---\n'
|
||||||
'key: value\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
|
# file in very nested dir
|
||||||
's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml': '---\n'
|
's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml': '---\n'
|
||||||
'key: value\n'
|
'key: value\n'
|
||||||
@@ -95,13 +91,6 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
# dos line endings yaml
|
# dos line endings yaml
|
||||||
'dos.yml': '---\r\n'
|
'dos.yml': '---\r\n'
|
||||||
'dos: true',
|
'dos: true',
|
||||||
# different key-ordering by locale
|
|
||||||
'c.yaml': '---\n'
|
|
||||||
'A: true\n'
|
|
||||||
'a: true',
|
|
||||||
'en.yaml': '---\n'
|
|
||||||
'a: true\n'
|
|
||||||
'A: true'
|
|
||||||
})
|
})
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
@@ -115,12 +104,9 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively([self.wd], conf)),
|
sorted(cli.find_files_recursively([self.wd], conf)),
|
||||||
[os.path.join(self.wd, 'a.yaml'),
|
[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, 'dos.yml'),
|
||||||
os.path.join(self.wd, 'empty.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, '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, 'sub/ok.yaml'),
|
||||||
os.path.join(self.wd, 'warn.yaml')],
|
os.path.join(self.wd, 'warn.yaml')],
|
||||||
)
|
)
|
||||||
@@ -145,7 +131,6 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively(items, conf)),
|
sorted(cli.find_files_recursively(items, conf)),
|
||||||
[os.path.join(self.wd, '/etc/another/file'),
|
[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')],
|
os.path.join(self.wd, 'sub/ok.yaml')],
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -155,8 +140,6 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively([self.wd], conf)),
|
sorted(cli.find_files_recursively([self.wd], conf)),
|
||||||
[os.path.join(self.wd, 'a.yaml'),
|
[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, 's/s/s/s/s/s/s/s/s/s/s/s/s/s/s/file.yaml'),
|
||||||
os.path.join(self.wd, 'sub/ok.yaml'),
|
os.path.join(self.wd, 'sub/ok.yaml'),
|
||||||
os.path.join(self.wd, 'warn.yaml')]
|
os.path.join(self.wd, 'warn.yaml')]
|
||||||
@@ -168,8 +151,7 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively([self.wd], conf)),
|
sorted(cli.find_files_recursively([self.wd], conf)),
|
||||||
[os.path.join(self.wd, 'dos.yml'),
|
[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'
|
conf = config.YamlLintConfig('extends: default\n'
|
||||||
@@ -186,15 +168,11 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively([self.wd], conf)),
|
sorted(cli.find_files_recursively([self.wd], conf)),
|
||||||
[os.path.join(self.wd, 'a.yaml'),
|
[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, 'dos.yml'),
|
||||||
os.path.join(self.wd, 'empty.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, 'no-yaml.json'),
|
||||||
os.path.join(self.wd, 'non-ascii/éçäγλνπ¥/utf-8'),
|
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, '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, 'sub/ok.yaml'),
|
||||||
os.path.join(self.wd, 'warn.yaml')]
|
os.path.join(self.wd, 'warn.yaml')]
|
||||||
)
|
)
|
||||||
@@ -207,15 +185,11 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
sorted(cli.find_files_recursively([self.wd], conf)),
|
sorted(cli.find_files_recursively([self.wd], conf)),
|
||||||
[os.path.join(self.wd, 'a.yaml'),
|
[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, 'dos.yml'),
|
||||||
os.path.join(self.wd, 'empty.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, 'no-yaml.json'),
|
||||||
os.path.join(self.wd, 'non-ascii/éçäγλνπ¥/utf-8'),
|
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, '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, 'sub/ok.yaml'),
|
||||||
os.path.join(self.wd, 'warn.yaml')]
|
os.path.join(self.wd, 'warn.yaml')]
|
||||||
)
|
)
|
||||||
@@ -311,65 +285,6 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
cli.run((os.path.join(self.wd, 'a.yaml'), ))
|
||||||
self.assertEqual(ctx.returncode, 1)
|
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):
|
def test_run_version(self):
|
||||||
with RunContext(self) as ctx:
|
with RunContext(self) as ctx:
|
||||||
cli.run(('--version', ))
|
cli.run(('--version', ))
|
||||||
@@ -430,11 +345,12 @@ class CommandLineTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
# Make sure the default localization conditions on this "system"
|
# Make sure the default localization conditions on this "system"
|
||||||
# support UTF-8 encoding.
|
# support UTF-8 encoding.
|
||||||
|
loc = locale.getlocale()
|
||||||
try:
|
try:
|
||||||
locale.setlocale(locale.LC_ALL, (None, 'UTF-8'))
|
locale.setlocale(locale.LC_ALL, 'C.UTF-8')
|
||||||
except locale.Error:
|
except locale.Error:
|
||||||
self.skipTest('no UTF-8 locale available')
|
locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
|
||||||
self.addCleanup(locale.setlocale, locale.LC_ALL, (None, None))
|
self.addCleanup(locale.setlocale, locale.LC_ALL, loc)
|
||||||
|
|
||||||
with RunContext(self) as ctx:
|
with RunContext(self) as ctx:
|
||||||
cli.run(('-f', 'parsable', path))
|
cli.run(('-f', 'parsable', path))
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ indentation, etc."""
|
|||||||
|
|
||||||
|
|
||||||
APP_NAME = 'yamllint'
|
APP_NAME = 'yamllint'
|
||||||
APP_VERSION = '1.24.2'
|
APP_VERSION = '1.23.0'
|
||||||
APP_DESCRIPTION = __doc__
|
APP_DESCRIPTION = __doc__
|
||||||
|
|
||||||
__author__ = u'Adrien Vergé'
|
__author__ = u'Adrien Vergé'
|
||||||
|
|||||||
@@ -18,7 +18,6 @@ from __future__ import print_function
|
|||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import io
|
import io
|
||||||
import locale
|
|
||||||
import os
|
import os
|
||||||
import platform
|
import platform
|
||||||
import sys
|
import sys
|
||||||
@@ -145,11 +144,8 @@ def run(argv=None):
|
|||||||
|
|
||||||
args = parser.parse_args(argv)
|
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
|
# 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(
|
user_global_config = os.path.join(
|
||||||
os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
|
os.environ['XDG_CONFIG_HOME'], 'yamllint', 'config')
|
||||||
else:
|
else:
|
||||||
@@ -176,9 +172,6 @@ def run(argv=None):
|
|||||||
print(e, file=sys.stderr)
|
print(e, file=sys.stderr)
|
||||||
sys.exit(-1)
|
sys.exit(-1)
|
||||||
|
|
||||||
if conf.locale is not None:
|
|
||||||
locale.setlocale(locale.LC_ALL, conf.locale)
|
|
||||||
|
|
||||||
max_level = 0
|
max_level = 0
|
||||||
|
|
||||||
for file in find_files_recursively(args.files, conf):
|
for file in find_files_recursively(args.files, conf):
|
||||||
|
|||||||
@@ -35,8 +35,6 @@ class YamlLintConfig(object):
|
|||||||
self.yaml_files = pathspec.PathSpec.from_lines(
|
self.yaml_files = pathspec.PathSpec.from_lines(
|
||||||
'gitwildmatch', ['*.yaml', '*.yml', '.yamllint'])
|
'gitwildmatch', ['*.yaml', '*.yml', '.yamllint'])
|
||||||
|
|
||||||
self.locale = None
|
|
||||||
|
|
||||||
if file is not None:
|
if file is not None:
|
||||||
with open(file) as f:
|
with open(file) as f:
|
||||||
content = f.read()
|
content = f.read()
|
||||||
@@ -48,7 +46,7 @@ class YamlLintConfig(object):
|
|||||||
return self.ignore and self.ignore.match_file(filepath)
|
return self.ignore and self.ignore.match_file(filepath)
|
||||||
|
|
||||||
def is_yaml_file(self, 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):
|
def enabled_rules(self, filepath):
|
||||||
return [yamllint.rules.get(id) for id, val in self.rules.items()
|
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',
|
self.yaml_files = pathspec.PathSpec.from_lines('gitwildmatch',
|
||||||
conf['yaml-files'])
|
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):
|
def validate(self):
|
||||||
for id in self.rules:
|
for id in self.rules:
|
||||||
try:
|
try:
|
||||||
|
|||||||
@@ -97,9 +97,7 @@ def check(conf, comment):
|
|||||||
comment.column_no == 1 and
|
comment.column_no == 1 and
|
||||||
re.match(r'^!\S', comment.buffer[text_start:])):
|
re.match(r'^!\S', comment.buffer[text_start:])):
|
||||||
return
|
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
|
column = comment.column_no + text_start - comment.pointer
|
||||||
yield LintProblem(comment.line_no,
|
yield LintProblem(comment.line_no,
|
||||||
column,
|
column,
|
||||||
|
|||||||
@@ -16,10 +16,8 @@
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
Use this rule to enforce alphabetical ordering of keys in mappings. The sorting
|
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
|
.. rubric:: Examples
|
||||||
|
|
||||||
@@ -65,24 +63,8 @@ sort case and accents properly.
|
|||||||
|
|
||||||
- haïr: true
|
- haïr: true
|
||||||
hais: 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
|
import yaml
|
||||||
|
|
||||||
from yamllint.linter import LintProblem
|
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
|
# This check is done because KeyTokens can be found inside flow
|
||||||
# sequences... strange, but allowed.
|
# sequences... strange, but allowed.
|
||||||
if len(context['stack']) > 0 and context['stack'][-1].type == MAP:
|
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(
|
yield LintProblem(
|
||||||
next.start_mark.line + 1, next.start_mark.column + 1,
|
next.start_mark.line + 1, next.start_mark.column + 1,
|
||||||
'wrong ordering of key "%s" in mapping' % next.value)
|
'wrong ordering of key "%s" in mapping' % next.value)
|
||||||
|
|||||||
Reference in New Issue
Block a user