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
This commit is contained in:
Adrien Vergé
2016-04-21 22:24:24 +02:00
parent 1f1757ced4
commit eabd349902
4 changed files with 66 additions and 4 deletions

View File

@@ -5,12 +5,20 @@ yamllint uses a set of *rules* to check sources files for problems. Each rule is
independent from the others, and can be enabled, disabled or tweaked. All these
settings can be gathered in a configuration file.
To use a custom configuration file, either name it ``.yamllint`` in your working
directory, or use the ``-c`` option:
To use a custom configuration file, use the ``-c`` option:
.. code:: bash
yamllint -c ~/myconfig file.yaml
yamllint -c /path/to/myconfig file-to-lint.yaml
If ``-c`` is not provided, yamllint will look for a configuration file in the
following locations (by order of preference):
- ``.yamllint`` in the current working directory
- ``$XDG_CONFIG_HOME/yamllint/config``
- ``$HOME/.config/yamllint/config``
Finally if no config file is found, the default configuration is applied.
Default configuration
---------------------