Compare commits
34 Commits
Author | SHA1 | Date |
---|---|---|
Philipp Huebner | 2c6493c2e9 | 5 years ago |
Philipp Huebner | f5d8c765c7 | 5 years ago |
Philipp Huebner | 7cee10f77c | 5 years ago |
Philipp Huebner | d457b37add | 5 years ago |
Philipp Huebner | f90ef91ebc | 5 years ago |
Philipp Huebner | 0ee814561d | 5 years ago |
Philipp Huebner | 790662d369 | 6 years ago |
Philipp Huebner | 92c5440d22 | 6 years ago |
Philipp Huebner | cc8d56fb94 | 6 years ago |
Philipp Huebner | d77cb4e2f6 | 6 years ago |
Philipp Huebner | 1c31952230 | 6 years ago |
Philipp Huebner | 8e97e6b151 | 6 years ago |
Philipp Huebner | 5cd261d6cb | 6 years ago |
Philipp Huebner | becf9fe98b | 6 years ago |
Philipp Huebner | 251260c382 | 7 years ago |
Philipp Huebner | c0f7ae1102 | 7 years ago |
Philipp Huebner | b47f0f2451 | 7 years ago |
Philipp Huebner | 5ca5add463 | 7 years ago |
Philipp Huebner | 542b6738a6 | 7 years ago |
Philipp Huebner | 2c3097ca78 | 7 years ago |
Philipp Huebner | 5fbfcb13b1 | 7 years ago |
Philipp Huebner | b8200259a2 | 7 years ago |
Philipp Huebner | 0fd8b76eea | 7 years ago |
Philipp Huebner | a4ab40c51a | 7 years ago |
Adrien Vergé | aeb353159b | 8 years ago |
Adrien Vergé | c57d2784df | 8 years ago |
Adrien Vergé | c0da5eac54 | 8 years ago |
Adrien Vergé | 69278a4553 | 8 years ago |
Adrien Vergé | e3baeefc81 | 8 years ago |
Adrien Vergé | d4d1d78ce6 | 8 years ago |
Adrien Vergé | c88cdf5316 | 8 years ago |
Adrien Vergé | 1fb673be2e | 8 years ago |
Adrien Vergé | ea658ec3d6 | 8 years ago |
Adrien Vergé | 014a6d2db4 | 8 years ago |
@ -1,4 +0,0 @@
|
|||||||
[flake8]
|
|
||||||
import-order-style = pep8
|
|
||||||
application-import-names = yamllint
|
|
||||||
ignore = W503,W504
|
|
@ -1,61 +0,0 @@
|
|||||||
---
|
|
||||||
|
|
||||||
name: CI
|
|
||||||
|
|
||||||
on: # yamllint disable-line rule:truthy
|
|
||||||
push:
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
name: Linters
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v4
|
|
||||||
- run:
|
|
||||||
pip install flake8 flake8-import-order sphinx rstcheck[sphinx] doc8
|
|
||||||
- run: pip install .
|
|
||||||
- run: flake8 .
|
|
||||||
- run: doc8 $(git ls-files '*.rst')
|
|
||||||
- run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
|
|
||||||
- run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
|
|
||||||
- run: make -C docs html
|
|
||||||
- name: Check for broken links in documentation
|
|
||||||
run: make -C docs linkcheck
|
|
||||||
|
|
||||||
test:
|
|
||||||
name: Tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
python-version:
|
|
||||||
- '3.7'
|
|
||||||
- '3.8'
|
|
||||||
- '3.9'
|
|
||||||
- '3.10'
|
|
||||||
- '3.11'
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Set up Python ${{ matrix.python-version }}
|
|
||||||
uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: ${{ matrix.python-version }}
|
|
||||||
- name: Append GitHub Actions system path
|
|
||||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
|
||||||
- run: pip install coverage
|
|
||||||
- run: pip install .
|
|
||||||
# https://github.com/AndreMiras/coveralls-python-action/issues/18
|
|
||||||
- run: echo -e "[run]\nrelative_files = True" > .coveragerc
|
|
||||||
- run: coverage run -m unittest discover
|
|
||||||
- name: Coveralls
|
|
||||||
uses: AndreMiras/coveralls-python-action@develop
|
|
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
dist: xenial # required for Python >= 3.7 (travis-ci/travis-ci#9069)
|
||||||
|
language: python
|
||||||
|
python:
|
||||||
|
- 2.7
|
||||||
|
- 3.5
|
||||||
|
- 3.6
|
||||||
|
- 3.7
|
||||||
|
- 3.8
|
||||||
|
- nightly
|
||||||
|
install:
|
||||||
|
- pip install pyyaml coveralls flake8 flake8-import-order doc8
|
||||||
|
- if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then pip install sphinx; fi
|
||||||
|
- pip install .
|
||||||
|
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 setup.py test
|
||||||
|
- if [[ $TRAVIS_PYTHON_VERSION != 2* ]]; then
|
||||||
|
python setup.py build_sphinx;
|
||||||
|
fi
|
||||||
|
after_success:
|
||||||
|
coveralls
|
@ -1,48 +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>`_.
|
|
||||||
If the pull request has multiple commits, each must be atomic (single
|
|
||||||
irreducible change that makes sense on its own).
|
|
||||||
|
|
||||||
7. Then, open a pull request.
|
|
@ -0,0 +1,4 @@
|
|||||||
|
include LICENSE
|
||||||
|
include README.rst
|
||||||
|
include docs/*
|
||||||
|
include tests/*.py tests/rules/*.py tests/yaml-1.2-spec-examples/*
|
Binary file not shown.
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 41 KiB |
@ -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
|
@ -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
|
@ -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.
|
@ -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".
|
@ -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
|
||||||
|
----------------
|
||||||
|
|
@ -0,0 +1 @@
|
|||||||
|
docs.diff
|
@ -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
|
@ -0,0 +1 @@
|
|||||||
|
3.0 (quilt)
|
@ -0,0 +1,2 @@
|
|||||||
|
yamllint source: debian-watch-does-not-check-gpg-signature
|
||||||
|
yamllint source: no-dh-sequencer
|
@ -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
|
@ -0,0 +1,3 @@
|
|||||||
|
# watch control file for uscan
|
||||||
|
version=3
|
||||||
|
https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz
|
@ -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
|
@ -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
|
@ -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
|
@ -0,0 +1 @@
|
|||||||
|
9
|
@ -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.
|
@ -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/>.
|
@ -0,0 +1 @@
|
|||||||
|
README.rst
|
@ -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
|
@ -0,0 +1 @@
|
|||||||
|
3.0 (quilt)
|
@ -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
|
@ -0,0 +1,3 @@
|
|||||||
|
# watch control file for uscan
|
||||||
|
version=3
|
||||||
|
https://github.com/adrienverge/yamllint/tags .*/archive/v(\d\S*)\.tar\.gz
|
@ -1,54 +0,0 @@
|
|||||||
[project]
|
|
||||||
name = "yamllint"
|
|
||||||
description = "A linter for YAML files."
|
|
||||||
readme = {file = "README.rst", content-type = "text/x-rst"}
|
|
||||||
requires-python = ">=3.7"
|
|
||||||
license = {text = "GPL-3.0-or-later"}
|
|
||||||
authors = [{name = "Adrien Vergé"}]
|
|
||||||
keywords = ["yaml", "lint", "linter", "syntax", "checker"]
|
|
||||||
classifiers = [
|
|
||||||
"Development Status :: 5 - Production/Stable",
|
|
||||||
"Environment :: Console",
|
|
||||||
"Intended Audience :: Developers",
|
|
||||||
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
|
||||||
"Programming Language :: Python",
|
|
||||||
"Topic :: Software Development",
|
|
||||||
"Topic :: Software Development :: Debuggers",
|
|
||||||
"Topic :: Software Development :: Quality Assurance",
|
|
||||||
"Topic :: Software Development :: Testing",
|
|
||||||
]
|
|
||||||
dependencies = [
|
|
||||||
"pathspec >= 0.5.3",
|
|
||||||
"pyyaml",
|
|
||||||
]
|
|
||||||
dynamic = ["version"]
|
|
||||||
|
|
||||||
[project.optional-dependencies]
|
|
||||||
dev = [
|
|
||||||
"doc8",
|
|
||||||
"flake8",
|
|
||||||
"flake8-import-order",
|
|
||||||
"rstcheck[sphinx]",
|
|
||||||
"sphinx",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.scripts]
|
|
||||||
yamllint = "yamllint.cli:run"
|
|
||||||
|
|
||||||
[project.urls]
|
|
||||||
homepage = "https://github.com/adrienverge/yamllint"
|
|
||||||
repository = "https://github.com/adrienverge/yamllint"
|
|
||||||
documentation = "https://yamllint.readthedocs.io"
|
|
||||||
|
|
||||||
[build-system]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
requires = ["setuptools >= 61"]
|
|
||||||
|
|
||||||
[tool.setuptools]
|
|
||||||
packages = ["yamllint", "yamllint.conf", "yamllint.rules"]
|
|
||||||
|
|
||||||
[tool.setuptools.package-data]
|
|
||||||
yamllint = ["conf/*.yaml"]
|
|
||||||
|
|
||||||
[tool.setuptools.dynamic]
|
|
||||||
version = {attr = "yamllint.__version__"}
|
|
@ -0,0 +1,12 @@
|
|||||||
|
[bdist_wheel]
|
||||||
|
universal = 1
|
||||||
|
|
||||||
|
[flake8]
|
||||||
|
import-order-style = pep8
|
||||||
|
application-import-names = yamllint
|
||||||
|
|
||||||
|
[build_sphinx]
|
||||||
|
all-files = 1
|
||||||
|
source-dir = docs
|
||||||
|
build-dir = docs/_build
|
||||||
|
warning-is-error = 1
|
@ -1,281 +0,0 @@
|
|||||||
# Copyright (C) 2023 Adrien Vergé
|
|
||||||
#
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
from tests.common import RuleTestCase
|
|
||||||
|
|
||||||
|
|
||||||
class AnchorsTestCase(RuleTestCase):
|
|
||||||
rule_id = 'anchors'
|
|
||||||
|
|
||||||
def test_disabled(self):
|
|
||||||
conf = 'anchors: disable'
|
|
||||||
self.check('---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- &f_m {k: v}\n'
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n'
|
|
||||||
'---\n' # redeclare anchors in a new document
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf)
|
|
||||||
self.check('---\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n' # declared in a previous document
|
|
||||||
'- *f_m\n' # never declared
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n' # declared after
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping 1: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'block mapping 2: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf)
|
|
||||||
|
|
||||||
def test_forbid_undeclared_aliases(self):
|
|
||||||
conf = ('anchors:\n'
|
|
||||||
' forbid-undeclared-aliases: true\n'
|
|
||||||
' forbid-duplicated-anchors: false\n'
|
|
||||||
' forbid-unused-anchors: false\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- &f_m {k: v}\n'
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n'
|
|
||||||
'---\n' # redeclare anchors in a new document
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf)
|
|
||||||
self.check('---\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n' # declared in a previous document
|
|
||||||
'- *f_m\n' # never declared
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n' # declared after
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'...\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping 1: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'block mapping 2: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf,
|
|
||||||
problem1=(9, 3),
|
|
||||||
problem2=(10, 3),
|
|
||||||
problem3=(11, 3),
|
|
||||||
problem4=(12, 3),
|
|
||||||
problem5=(13, 3),
|
|
||||||
problem6=(25, 7),
|
|
||||||
problem7=(28, 37))
|
|
||||||
|
|
||||||
def test_forbid_duplicated_anchors(self):
|
|
||||||
conf = ('anchors:\n'
|
|
||||||
' forbid-undeclared-aliases: false\n'
|
|
||||||
' forbid-duplicated-anchors: true\n'
|
|
||||||
' forbid-unused-anchors: false\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- &f_m {k: v}\n'
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n'
|
|
||||||
'---\n' # redeclare anchors in a new document
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf)
|
|
||||||
self.check('---\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n' # declared in a previous document
|
|
||||||
'- *f_m\n' # never declared
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n' # declared after
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'...\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping 1: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'block mapping 2: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf,
|
|
||||||
problem1=(5, 3),
|
|
||||||
problem2=(6, 3),
|
|
||||||
problem3=(22, 18),
|
|
||||||
problem4=(28, 20))
|
|
||||||
|
|
||||||
def test_forbid_unused_anchors(self):
|
|
||||||
conf = ('anchors:\n'
|
|
||||||
' forbid-undeclared-aliases: false\n'
|
|
||||||
' forbid-duplicated-anchors: false\n'
|
|
||||||
' forbid-unused-anchors: true\n')
|
|
||||||
|
|
||||||
self.check('---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- &f_m {k: v}\n'
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n'
|
|
||||||
'---\n' # redeclare anchors in a new document
|
|
||||||
'- &b true\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n'
|
|
||||||
'- *s\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &y 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf)
|
|
||||||
self.check('---\n'
|
|
||||||
'- &i 42\n'
|
|
||||||
'---\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &b true\n'
|
|
||||||
'- &s hello\n'
|
|
||||||
'- *b\n'
|
|
||||||
'- *i\n' # declared in a previous document
|
|
||||||
'- *f_m\n' # never declared
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_m\n'
|
|
||||||
'- *f_s\n' # declared after
|
|
||||||
'- &f_s [1, 2]\n'
|
|
||||||
'...\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping: &b_m\n'
|
|
||||||
' key: value\n'
|
|
||||||
'---\n'
|
|
||||||
'block mapping 1: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'block mapping 2: &b_m_bis\n'
|
|
||||||
' key: value\n'
|
|
||||||
'extended:\n'
|
|
||||||
' <<: *b_m\n'
|
|
||||||
' foo: bar\n'
|
|
||||||
'---\n'
|
|
||||||
'{a: 1, &x b: 2, c: &x 3, *x : 4, e: *y}\n'
|
|
||||||
'...\n', conf,
|
|
||||||
problem1=(2, 3),
|
|
||||||
problem2=(7, 3),
|
|
||||||
problem3=(14, 3),
|
|
||||||
problem4=(17, 16),
|
|
||||||
problem5=(22, 18))
|
|
@ -1,128 +0,0 @@
|
|||||||
# Copyright (C) 2022 the yamllint contributors
|
|
||||||
#
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
from tests.common import RuleTestCase
|
|
||||||
|
|
||||||
|
|
||||||
class FloatValuesTestCase(RuleTestCase):
|
|
||||||
rule_id = 'float-values'
|
|
||||||
|
|
||||||
def test_disabled(self):
|
|
||||||
conf = 'float-values: disable\n'
|
|
||||||
self.check('---\n'
|
|
||||||
'- 0.0\n'
|
|
||||||
'- .NaN\n'
|
|
||||||
'- .INF\n'
|
|
||||||
'- .1\n'
|
|
||||||
'- 10e-6\n',
|
|
||||||
conf)
|
|
||||||
|
|
||||||
def test_numeral_before_decimal(self):
|
|
||||||
conf = (
|
|
||||||
'float-values:\n'
|
|
||||||
' require-numeral-before-decimal: true\n'
|
|
||||||
' forbid-scientific-notation: false\n'
|
|
||||||
' forbid-nan: false\n'
|
|
||||||
' forbid-inf: false\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- 0.0\n'
|
|
||||||
'- .1\n'
|
|
||||||
'- \'.1\'\n'
|
|
||||||
'- string.1\n'
|
|
||||||
'- .1string\n'
|
|
||||||
'- !custom_tag .2\n'
|
|
||||||
'- &angle1 0.0\n'
|
|
||||||
'- *angle1\n'
|
|
||||||
'- &angle2 .3\n'
|
|
||||||
'- *angle2\n',
|
|
||||||
conf,
|
|
||||||
problem1=(3, 3),
|
|
||||||
problem2=(10, 11))
|
|
||||||
|
|
||||||
def test_scientific_notation(self):
|
|
||||||
conf = (
|
|
||||||
'float-values:\n'
|
|
||||||
' require-numeral-before-decimal: false\n'
|
|
||||||
' forbid-scientific-notation: true\n'
|
|
||||||
' forbid-nan: false\n'
|
|
||||||
' forbid-inf: false\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- 10e6\n'
|
|
||||||
'- 10e-6\n'
|
|
||||||
'- 0.00001\n'
|
|
||||||
'- \'10e-6\'\n'
|
|
||||||
'- string10e-6\n'
|
|
||||||
'- 10e-6string\n'
|
|
||||||
'- !custom_tag 10e-6\n'
|
|
||||||
'- &angle1 0.000001\n'
|
|
||||||
'- *angle1\n'
|
|
||||||
'- &angle2 10e-6\n'
|
|
||||||
'- *angle2\n'
|
|
||||||
'- &angle3 10e6\n'
|
|
||||||
'- *angle3\n',
|
|
||||||
conf,
|
|
||||||
problem1=(2, 3),
|
|
||||||
problem2=(3, 3),
|
|
||||||
problem3=(11, 11),
|
|
||||||
problem4=(13, 11))
|
|
||||||
|
|
||||||
def test_nan(self):
|
|
||||||
conf = (
|
|
||||||
'float-values:\n'
|
|
||||||
' require-numeral-before-decimal: false\n'
|
|
||||||
' forbid-scientific-notation: false\n'
|
|
||||||
' forbid-nan: true\n'
|
|
||||||
' forbid-inf: false\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- .NaN\n'
|
|
||||||
'- .NAN\n'
|
|
||||||
'- \'.NaN\'\n'
|
|
||||||
'- a.NaN\n'
|
|
||||||
'- .NaNa\n'
|
|
||||||
'- !custom_tag .NaN\n'
|
|
||||||
'- &angle .nan\n'
|
|
||||||
'- *angle\n',
|
|
||||||
conf,
|
|
||||||
problem1=(2, 3),
|
|
||||||
problem2=(3, 3),
|
|
||||||
problem3=(8, 10))
|
|
||||||
|
|
||||||
def test_inf(self):
|
|
||||||
conf = (
|
|
||||||
'float-values:\n'
|
|
||||||
' require-numeral-before-decimal: false\n'
|
|
||||||
' forbid-scientific-notation: false\n'
|
|
||||||
' forbid-nan: false\n'
|
|
||||||
' forbid-inf: true\n')
|
|
||||||
self.check('---\n'
|
|
||||||
'- .inf\n'
|
|
||||||
'- .INF\n'
|
|
||||||
'- -.inf\n'
|
|
||||||
'- -.INF\n'
|
|
||||||
'- \'.inf\'\n'
|
|
||||||
'- ∞.infinity\n'
|
|
||||||
'- .infinity∞\n'
|
|
||||||
'- !custom_tag .inf\n'
|
|
||||||
'- &angle .inf\n'
|
|
||||||
'- *angle\n'
|
|
||||||
'- &angle -.inf\n'
|
|
||||||
'- *angle\n',
|
|
||||||
conf,
|
|
||||||
problem1=(2, 3),
|
|
||||||
problem2=(3, 3),
|
|
||||||
problem3=(4, 3),
|
|
||||||
problem4=(5, 3),
|
|
||||||
problem5=(10, 10),
|
|
||||||
problem6=(12, 10))
|
|
@ -1,174 +0,0 @@
|
|||||||
# Copyright (C) 2023 Adrien Vergé
|
|
||||||
#
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
"""
|
|
||||||
Use this rule to report duplicated anchors and aliases referencing undeclared
|
|
||||||
anchors.
|
|
||||||
|
|
||||||
.. rubric:: Options
|
|
||||||
|
|
||||||
* Set ``forbid-undeclared-aliases`` to ``true`` to avoid aliases that reference
|
|
||||||
an anchor that hasn't been declared (either not declared at all, or declared
|
|
||||||
later in the document).
|
|
||||||
* Set ``forbid-duplicated-anchors`` to ``true`` to avoid duplications of a same
|
|
||||||
anchor.
|
|
||||||
* Set ``forbid-unused-anchors`` to ``true`` to avoid anchors being declared but
|
|
||||||
not used anywhere in the YAML document via alias.
|
|
||||||
|
|
||||||
.. rubric:: Default values (when enabled)
|
|
||||||
|
|
||||||
.. code-block:: yaml
|
|
||||||
|
|
||||||
rules:
|
|
||||||
anchors:
|
|
||||||
forbid-undeclared-aliases: true
|
|
||||||
forbid-duplicated-anchors: false
|
|
||||||
forbid-unused-anchors: false
|
|
||||||
|
|
||||||
.. rubric:: Examples
|
|
||||||
|
|
||||||
#. With ``anchors: {forbid-undeclared-aliases: true}``
|
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor
|
|
||||||
foo: bar
|
|
||||||
- *anchor
|
|
||||||
|
|
||||||
the following code snippet would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor
|
|
||||||
foo: bar
|
|
||||||
- *unknown
|
|
||||||
|
|
||||||
the following code snippet would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor
|
|
||||||
foo: bar
|
|
||||||
- <<: *unknown
|
|
||||||
extra: value
|
|
||||||
|
|
||||||
#. With ``anchors: {forbid-duplicated-anchors: true}``
|
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor1 Foo Bar
|
|
||||||
- &anchor2 [item 1, item 2]
|
|
||||||
|
|
||||||
the following code snippet would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor Foo Bar
|
|
||||||
- &anchor [item 1, item 2]
|
|
||||||
|
|
||||||
#. With ``anchors: {forbid-unused-anchors: true}``
|
|
||||||
|
|
||||||
the following code snippet would **PASS**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor
|
|
||||||
foo: bar
|
|
||||||
- *anchor
|
|
||||||
|
|
||||||
the following code snippet would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
---
|
|
||||||
- &anchor
|
|
||||||
foo: bar
|
|
||||||
- items:
|
|
||||||
- item1
|
|
||||||
- item2
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
import yaml
|
|
||||||
|
|
||||||
from yamllint.linter import LintProblem
|
|
||||||
|
|
||||||
|
|
||||||
ID = 'anchors'
|
|
||||||
TYPE = 'token'
|
|
||||||
CONF = {'forbid-undeclared-aliases': bool,
|
|
||||||
'forbid-duplicated-anchors': bool,
|
|
||||||
'forbid-unused-anchors': bool}
|
|
||||||
DEFAULT = {'forbid-undeclared-aliases': True,
|
|
||||||
'forbid-duplicated-anchors': False,
|
|
||||||
'forbid-unused-anchors': False}
|
|
||||||
|
|
||||||
|
|
||||||
def check(conf, token, prev, next, nextnext, context):
|
|
||||||
if (conf['forbid-undeclared-aliases'] or
|
|
||||||
conf['forbid-duplicated-anchors'] or
|
|
||||||
conf['forbid-unused-anchors']):
|
|
||||||
if isinstance(token, (
|
|
||||||
yaml.StreamStartToken,
|
|
||||||
yaml.DocumentStartToken,
|
|
||||||
yaml.DocumentEndToken)):
|
|
||||||
context['anchors'] = {}
|
|
||||||
|
|
||||||
if (conf['forbid-undeclared-aliases'] and
|
|
||||||
isinstance(token, yaml.AliasToken) and
|
|
||||||
token.value not in context['anchors']):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1, token.start_mark.column + 1,
|
|
||||||
f'found undeclared alias "{token.value}"')
|
|
||||||
|
|
||||||
if (conf['forbid-duplicated-anchors'] and
|
|
||||||
isinstance(token, yaml.AnchorToken) and
|
|
||||||
token.value in context['anchors']):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1, token.start_mark.column + 1,
|
|
||||||
f'found duplicated anchor "{token.value}"')
|
|
||||||
|
|
||||||
if conf['forbid-unused-anchors']:
|
|
||||||
# Unused anchors can only be detected at the end of Document.
|
|
||||||
# End of document can be either
|
|
||||||
# - end of stream
|
|
||||||
# - end of document sign '...'
|
|
||||||
# - start of a new document sign '---'
|
|
||||||
# If next token indicates end of document,
|
|
||||||
# check if the anchors have been used or not.
|
|
||||||
# If they haven't been used, report problem on those anchors.
|
|
||||||
if isinstance(next, (yaml.StreamEndToken,
|
|
||||||
yaml.DocumentStartToken,
|
|
||||||
yaml.DocumentEndToken)):
|
|
||||||
for anchor, info in context['anchors'].items():
|
|
||||||
if not info['used']:
|
|
||||||
yield LintProblem(info['line'] + 1,
|
|
||||||
info['column'] + 1,
|
|
||||||
f'found unused anchor "{anchor}"')
|
|
||||||
elif isinstance(token, yaml.AliasToken):
|
|
||||||
context['anchors'].get(token.value, {})['used'] = True
|
|
||||||
|
|
||||||
if (conf['forbid-undeclared-aliases'] or
|
|
||||||
conf['forbid-duplicated-anchors'] or
|
|
||||||
conf['forbid-unused-anchors']):
|
|
||||||
if isinstance(token, yaml.AnchorToken):
|
|
||||||
context['anchors'][token.value] = {
|
|
||||||
'line': token.start_mark.line,
|
|
||||||
'column': token.start_mark.column,
|
|
||||||
'used': False
|
|
||||||
}
|
|
@ -1,158 +0,0 @@
|
|||||||
# Copyright (C) 2022 the yamllint contributors
|
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation, either version 3 of the License, or
|
|
||||||
# (at your option) any later version.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
"""
|
|
||||||
Use this rule to limit the permitted values for floating-point numbers.
|
|
||||||
YAML permits three classes of float expressions: approximation to real numbers,
|
|
||||||
positive and negative infinity and "not a number".
|
|
||||||
|
|
||||||
.. rubric:: Options
|
|
||||||
|
|
||||||
* Use ``require-numeral-before-decimal`` to require floats to start
|
|
||||||
with a numeral (ex ``0.0`` instead of ``.0``).
|
|
||||||
* Use ``forbid-scientific-notation`` to forbid scientific notation.
|
|
||||||
* Use ``forbid-nan`` to forbid NaN (not a number) values.
|
|
||||||
* Use ``forbid-inf`` to forbid infinite values.
|
|
||||||
|
|
||||||
.. rubric:: Default values (when enabled)
|
|
||||||
|
|
||||||
.. code-block:: yaml
|
|
||||||
|
|
||||||
rules:
|
|
||||||
float-values:
|
|
||||||
forbid-inf: false
|
|
||||||
forbid-nan: false
|
|
||||||
forbid-scientific-notation: false
|
|
||||||
require-numeral-before-decimal: false
|
|
||||||
|
|
||||||
.. rubric:: Examples
|
|
||||||
|
|
||||||
#. With ``float-values: {require-numeral-before-decimal: true}``
|
|
||||||
|
|
||||||
the following code snippets would **PASS**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: 0.0
|
|
||||||
|
|
||||||
the following code snippets would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: .0
|
|
||||||
|
|
||||||
#. With ``float-values: {forbid-scientific-notation: true}``
|
|
||||||
|
|
||||||
the following code snippets would **PASS**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: 0.00001
|
|
||||||
|
|
||||||
the following code snippets would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: 10e-6
|
|
||||||
|
|
||||||
#. With ``float-values: {forbid-nan: true}``
|
|
||||||
|
|
||||||
the following code snippets would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: .NaN
|
|
||||||
|
|
||||||
#. With ``float-values: {forbid-inf: true}``
|
|
||||||
|
|
||||||
the following code snippets would **FAIL**:
|
|
||||||
::
|
|
||||||
|
|
||||||
anemometer:
|
|
||||||
angle: .inf
|
|
||||||
"""
|
|
||||||
|
|
||||||
import re
|
|
||||||
|
|
||||||
import yaml
|
|
||||||
|
|
||||||
from yamllint.linter import LintProblem
|
|
||||||
|
|
||||||
|
|
||||||
ID = 'float-values'
|
|
||||||
TYPE = 'token'
|
|
||||||
CONF = {
|
|
||||||
'require-numeral-before-decimal': bool,
|
|
||||||
'forbid-scientific-notation': bool,
|
|
||||||
'forbid-nan': bool,
|
|
||||||
'forbid-inf': bool,
|
|
||||||
}
|
|
||||||
DEFAULT = {
|
|
||||||
'require-numeral-before-decimal': False,
|
|
||||||
'forbid-scientific-notation': False,
|
|
||||||
'forbid-nan': False,
|
|
||||||
'forbid-inf': False,
|
|
||||||
}
|
|
||||||
|
|
||||||
IS_NUMERAL_BEFORE_DECIMAL_PATTERN = (
|
|
||||||
re.compile('[-+]?(\\.[0-9]+)([eE][-+]?[0-9]+)?$')
|
|
||||||
)
|
|
||||||
IS_SCIENTIFIC_NOTATION_PATTERN = re.compile(
|
|
||||||
'[-+]?(\\.[0-9]+|[0-9]+(\\.[0-9]*)?)([eE][-+]?[0-9]+)$'
|
|
||||||
)
|
|
||||||
IS_INF_PATTERN = re.compile('[-+]?(\\.inf|\\.Inf|\\.INF)$')
|
|
||||||
IS_NAN_PATTERN = re.compile('(\\.nan|\\.NaN|\\.NAN)$')
|
|
||||||
|
|
||||||
|
|
||||||
def check(conf, token, prev, next, nextnext, context):
|
|
||||||
if prev and isinstance(prev, yaml.tokens.TagToken):
|
|
||||||
return
|
|
||||||
if not isinstance(token, yaml.tokens.ScalarToken):
|
|
||||||
return
|
|
||||||
if token.style:
|
|
||||||
return
|
|
||||||
val = token.value
|
|
||||||
|
|
||||||
if conf['forbid-nan'] and IS_NAN_PATTERN.match(val):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1,
|
|
||||||
token.start_mark.column + 1,
|
|
||||||
f'forbidden not a number value "{token.value}"',
|
|
||||||
)
|
|
||||||
|
|
||||||
if conf['forbid-inf'] and IS_INF_PATTERN.match(val):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1,
|
|
||||||
token.start_mark.column + 1,
|
|
||||||
f'forbidden infinite value "{token.value}"',
|
|
||||||
)
|
|
||||||
|
|
||||||
if conf[
|
|
||||||
'forbid-scientific-notation'
|
|
||||||
] and IS_SCIENTIFIC_NOTATION_PATTERN.match(val):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1,
|
|
||||||
token.start_mark.column + 1,
|
|
||||||
f'forbidden scientific notation "{token.value}"',
|
|
||||||
)
|
|
||||||
|
|
||||||
if conf[
|
|
||||||
'require-numeral-before-decimal'
|
|
||||||
] and IS_NUMERAL_BEFORE_DECIMAL_PATTERN.match(val):
|
|
||||||
yield LintProblem(
|
|
||||||
token.start_mark.line + 1,
|
|
||||||
token.start_mark.column + 1,
|
|
||||||
f'forbidden decimal missing 0 prefix "{token.value}"',
|
|
||||||
)
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue