Andrew Imeson
c34c962691
Remove the repeated word "automatically" in GHA doc
3 years ago
Madison Swain-Bowden
4f1bbc33dc
docs: Fix link syntax on integration.rst
3 years ago
Rex Ledesma
0f9dffde23
docs: Add configuration for integration with Arcanist
4 years ago
Andrew Imeson
67cb4eb24d
Auto-change output format if GitHub Actions detected
4 years ago
Adrien Vergé
597e88bb7b
docs: Make 'yaml-file' config documentation clearer
...
Related to https://github.com/adrienverge/yamllint/issues/311 .
4 years ago
Sorin Sbarnea
d274543b72
docs: Add Python API usage example
...
Fixes : #297
4 years ago
Wolfgang Walther
b5b436a3a4
Add global "locale" config option and make key-ordering rule locale-aware
...
Support sorting by locale with strcoll(). Properly handle case and accents.
Note: this is a second implementation, for context see:
https://github.com/adrienverge/yamllint/pull/280
https://github.com/adrienverge/yamllint/issues/285
https://github.com/adrienverge/yamllint/pull/288
5 years ago
Adrien Vergé
9403f1f3ec
Revert "Add global "locale" config option"
...
This reverts commit 9e90c77
, because it caused a bug that affected
different people just after being released:
https://github.com/adrienverge/yamllint/issues/285
https://github.com/adrienverge/yamllint/issues/286
5 years ago
Wolfgang Walther
9e90c777cb
Add global "locale" config option and make key-ordering rule locale-aware
...
Support sorting by locale with strcoll(). Properly handle case and accents.
5 years ago
Adrien Vergé
954fdd5e8f
style: Fix 'noqa' for flake8 3.8.0
...
There was a change in behavior of E402, see:
https://gitlab.com/pycqa/flake8/-/issues/638#note_345108633
5 years ago
Will Badart
278a79f093
Mention YAMLLINT_CONFIG_FILE in the documentation
5 years ago
ffapitalle
8fa9eb3ced
Add --no-warnings option to suppress warning messages
...
Use `--no-warnings` option to hide warning messages. It only shows
problems marked as errors.
5 years ago
Joel Baranick
fb400dc64b
Allow disabling all checks for a file
...
Allow disabling of a file, even if it is invalid YAML (syntax error) by
including `# yamllint disable-file` in the first line.
5 years ago
Hossein Zolfi
579a975b70
docs: Fix pre-commit config file
...
* pre-commit show warning for unsupported key (sha)
* Demonstrate how to use custom yamllint
5 years ago
Imran Iqbal
f3d9196aa0
docs(configuration): improve `yaml-files` code example
...
* A straight copy/paste of the existing example into the `.yamllint` file results in a `yamllint` error!
5 years ago
Ibrahim AshShohail
881d301883
feat: Support reading config from .yamllint.yml and .yamllint.yaml
...
Signed-off-by: Ibrahim AshShohail <me@ibrasho.com>
5 years ago
Adrien Vergé
b62b424dd4
feat: Lint .yamllint by default
5 years ago
grzesuav
063c854658
feat: Make YAML file extensions configurable
6 years ago
Remi Pointel
cb5fe2c050
add OpenBSD installation instructions.
6 years ago
Adrien Vergé
930c8eea94
docs: Simplify installation instruction in the README
6 years ago
Adrien Vergé
f66661e36d
docs(cli): Add a paragraph about standard input
...
See commit 05dfcbc
"cli: Add command line option - to read from standard
input", cc @miguelbarao.
6 years ago
Adrien Vergé
d6b89e94e4
chore(docs): Fix conf.py styling
6 years ago
Adrien Vergé
a56a1015f0
style(docs): Fix RST lint errors reported by doc8
6 years ago
Adrien Vergé
66adaee66c
docs: Add documentation on the new -f colored option
6 years ago
Adrien Vergé
e864f57d37
docs: Fix missing quoted-strings module in documentation
6 years ago
Adrien Vergé
203cfc20f0
docs: Remove sudo from pip installation instructions
7 years ago
Adrien Vergé
51c30505b5
docs: Add Mac OS installation instructions
...
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
7 years ago
Adrien Vergé
ff9ebde608
docs: Remove old Debian / Ubuntu installation instructions
7 years ago
Eimert
8ab680635b
docs: Make `ignore` examples clearer
...
[Solved](https://github.com/metacloud/molecule/issues/1228 ), when
yamllint is used by molecule.
7 years ago
xieenlong
22e792a433
Feature: checking octal numbers
7 years ago
Greg Dubicki
8537b0a164
Add rule: empty-values, to forbid implicit nulls
...
only in block mappings for now
7 years ago
Johannes F. Knauf
1543d0e435
New rule key-ordering
...
closes #67
7 years ago
Adrien Vergé
c4a3e15ff0
docs(readthedocs): Fix builds on yamllint.readthedocs.io
...
Documentation builds on readthedocs.io partly fail because some modules
imported by yammlint cannot be imported in Sphinx automodule.
This commit fixes that using the tip at [1].
Closes #66
[1]: http://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
7 years ago
Sebastian Finke
db57127971
docs(integration): Fix pre-commit config file
8 years ago
blackillzone
c8e516be2f
Add documentation for pre-commit
8 years ago
Adrien Vergé
df26cc0438
feat(config): Add support to ignore paths on per-rule basis
...
Example of configuration to use this feature:
# For all rules
ignore: |
*.dont-lint-me.yaml
/bin/
!/bin/*.lint-me-anyway.yaml
rules:
key-duplicates:
ignore: |
generated
*.template.yaml
trailing-spaces:
ignore: |
*.ignore-trailing-spaces.yaml
/ascii-art/*
Closes #43 .
8 years ago
Krzysztof Magosa
a825645cbe
Add information about Emacs integration
8 years ago
Daniel M. Capella
f507319419
Doc: Add ALE Vim plugin
8 years ago
Jakub Wilk
2b26cbc56b
Fix typos
8 years ago
Adrien Vergé
2b7f5c5e72
docs(install): Update Debian version
...
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
8 years ago
Adrien Vergé
64369db9a2
docs(configuration): Fix typo
8 years ago
Jonathan Sokolowski
bf386b3c90
docs: Explain strict mode return codes
8 years ago
Adrien Vergé
073462a87d
docs(rules): Fix missing truthy rule in index
8 years ago
Adrien Vergé
4533b8ae49
doc(config): Show `relaxed` conf contents
...
Closes : #15
9 years ago
Adrien Vergé
0eb310e102
Allow disabling yamllint checks using comments
...
Implement problem report disabling with comments in YAML source, for
instance:
# The following mapping contains the same key twice,
# but I know what I'm doing:
key: value 1
key: value 2 # yamllint disable-line rule:key-duplicates
or:
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable rule:colons
Closes : #8
9 years ago
Adrien Vergé
8c839a20c2
Config: Detect user config using `os.path.expanduser()`
...
Instead of `$HOME`, since the former works when `$HOME` is not set.
[1]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=828033#10
9 years ago
Adrien Vergé
598e5e4370
Doc: Fix typo on configuration page intro
9 years ago
Adrien Vergé
03076ee214
Doc: Add a pointer to rules on configuration page intro
9 years ago
Adrien Vergé
eabd349902
Config: Allow a user-global configuration file
...
Instead of just looking for `.yamllint` in the current working
directory, also look for `~/.config/yamllint/config` (using
`$XDG_CONFIG_HOME` or `$HOME`, see [1] and [2] for information).
[1]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
[2]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support
Closes : #6
9 years ago
Adrien Vergé
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
9 years ago