Georgi Georgiev
e636848ddc
config: Look for configuration file in parent directories
...
Inspired be ESLint's search, it looks for configuration files in all
parent directories up until it reaches the user's home or root.
closes #571
2023-05-22 17:59:56 +02:00
Andrew Imeson
6bfd6756e2
docs: Update links that redirect
2023-03-23 18:50:09 +01:00
Peter Leitzen
fa0bb03f9a
cli: Add --list-files command line option
...
This option lists the files to lint by yamllint, taking into account `ignore`
and `yaml-files` configuration options.
2023-01-10 18:48:38 +01:00
Matthew Gamble
2a904f8fc1
configuration: Allow using a list of strings in ignore configuration
...
This may feel more natural for some users, rather than embedding
multiple entries in a multi-line string.
2023-01-10 18:45:09 +01:00
andrewnaguib
2f8ad7003a
config: Implement for ignore-from-file option
...
Closes https://github.com/adrienverge/yamllint/issues/360
Co-authored-by: Adrien Vergé <@adrienverge>
2022-08-10 08:35:40 +02:00
Andrew Imeson
2f423117c1
docs: Attempt to clarify configuration file location
...
Closes #96 , Closes #212
2022-03-24 10:23:39 +01:00
Adrien Vergé
597e88bb7b
docs: Make 'yaml-file' config documentation clearer
...
Related to https://github.com/adrienverge/yamllint/issues/311 .
2020-09-02 18:23:51 +02:00
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
2020-07-16 09:34:13 +02:00
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
2020-07-15 14:48:48 +02:00
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.
2020-07-15 11:46:05 +02:00
Will Badart
278a79f093
Mention YAMLLINT_CONFIG_FILE in the documentation
2020-04-29 09:43:16 +02:00
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.
2019-12-12 09:12:53 +01:00
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!
2019-09-10 19:47:25 +02:00
Ibrahim AshShohail
881d301883
feat: Support reading config from .yamllint.yml and .yamllint.yaml
...
Signed-off-by: Ibrahim AshShohail <me@ibrasho.com >
2019-08-27 09:49:09 +02:00
Adrien Vergé
b62b424dd4
feat: Lint .yamllint by default
2019-08-26 10:01:40 +02:00
grzesuav
063c854658
feat: Make YAML file extensions configurable
2019-08-12 16:53:30 +02:00
Adrien Vergé
a56a1015f0
style(docs): Fix RST lint errors reported by doc8
2018-12-08 11:21:02 +01:00
Adrien Vergé
66adaee66c
docs: Add documentation on the new -f colored option
2018-11-14 19:02:52 +01:00
Eimert
8ab680635b
docs: Make ignore examples clearer
...
[Solved](https://github.com/metacloud/molecule/issues/1228 ), when
yamllint is used by molecule.
2018-04-02 20:06:17 +02:00
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 .
2017-06-28 15:14:46 +02:00
Adrien Vergé
64369db9a2
docs(configuration): Fix typo
2016-11-07 18:11:33 +01:00
Jonathan Sokolowski
bf386b3c90
docs: Explain strict mode return codes
2016-10-24 14:15:23 +11:00
Adrien Vergé
4533b8ae49
doc(config): Show relaxed conf contents
...
Closes : #15
2016-08-12 11:17:18 +02:00
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
2016-06-24 18:41:45 +02:00
Adrien Vergé
598e5e4370
Doc: Fix typo on configuration page intro
2016-04-21 22:39:46 +02:00
Adrien Vergé
03076ee214
Doc: Add a pointer to rules on configuration page intro
2016-04-21 22:37:48 +02:00
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
2016-04-21 22:24:24 +02:00
Adrien Vergé
41733fc7a5
Use '.yaml' extension as default, not '.yml'
...
As someone said [1] on the internet:
Say ".yaml" not ".yml".
This is not MS-DOS, and YML is a Yahoo XML dialect.
Similarly, we use '.json', not '.jsn'.
[1]: https://github.com/ceph/s3-tests/commit/e17c56a
2016-03-07 11:15:04 +01:00
Adrien Vergé
7688567faa
cli: Add the -d option to provide inline conf
2016-03-04 16:53:26 +01:00
Adrien Vergé
2f75e92a66
Doc: Add a configuration example in README
2016-02-19 10:37:52 +01:00
Adrien Vergé
ba8a9d0ba1
Doc: Give an explicit link from configuration to rules
2016-01-22 18:42:03 +01:00
Adrien Vergé
47d6534e75
Doc: Write the configuration page
2016-01-22 18:20:31 +01:00
Adrien Vergé
38234a1d3c
Doc: Generate documentation with Sphinx
...
HTML documentation should be built with sphinx. This enables easy
integration with Read The Docs [1]. It can also be generated manually by
running:
make -C docs html
A man page can be generated by running:
make -C docs man
[1]: http://yamllint.readthedocs.org/
2016-01-22 18:20:28 +01:00