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
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.
2019-11-19 11:26:31 +01:00
Hossein Zolfi
579a975b70
docs: Fix pre-commit config file
...
* pre-commit show warning for unsupported key (sha)
* Demonstrate how to use custom yamllint
2019-10-01 11:36:07 +02: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
Remi Pointel
cb5fe2c050
add OpenBSD installation instructions.
2019-07-09 10:04:48 +02:00
Adrien Vergé
930c8eea94
docs: Simplify installation instruction in the README
2019-07-07 18:13:43 +02:00
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.
2019-02-11 14:16:33 +01:00
Adrien Vergé
d6b89e94e4
chore(docs): Fix conf.py styling
2019-02-11 14:09:20 +01: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
Adrien Vergé
e864f57d37
docs: Fix missing quoted-strings module in documentation
2018-10-11 15:27:58 +02:00
Adrien Vergé
203cfc20f0
docs: Remove sudo from pip installation instructions
2018-05-09 20:20:18 +02:00
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
2018-05-09 20:19:03 +02:00
Adrien Vergé
ff9ebde608
docs: Remove old Debian / Ubuntu installation instructions
2018-05-09 20:19:03 +02: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
xieenlong
22e792a433
Feature: checking octal numbers
2017-12-07 18:29:05 +01:00
Greg Dubicki
8537b0a164
Add rule: empty-values, to forbid implicit nulls
...
only in block mappings for now
2017-11-04 16:22:29 +01:00
Johannes F. Knauf
1543d0e435
New rule key-ordering
...
closes #67
2017-10-16 22:49:39 +02:00
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
2017-09-03 16:08:42 +02:00
Sebastian Finke
db57127971
docs(integration): Fix pre-commit config file
2017-08-17 12:07:23 +02:00
blackillzone
c8e516be2f
Add documentation for pre-commit
2017-07-19 14:56:21 +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
Krzysztof Magosa
a825645cbe
Add information about Emacs integration
2017-03-25 18:53:09 +01:00
Daniel M. Capella
f507319419
Doc: Add ALE Vim plugin
2017-02-28 14:01:25 -05:00
Jakub Wilk
2b26cbc56b
Fix typos
2017-02-28 00:22:49 +01:00
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
2016-11-16 18:50:13 +01: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é
073462a87d
docs(rules): Fix missing truthy rule in index
2016-10-01 10:00:23 +02:00
Adrien Vergé
4533b8ae49
doc(config): Show relaxed
conf contents
...
Closes : #15
2016-08-12 11:17:18 +02:00
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
2016-06-27 17:53:23 +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é
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
2016-03-15 10:04:24 +01:00
Adrien Vergé
3a017a5a22
Doc: Update Neovim integration documentation
...
Since it has been merged into Neomake:
https://github.com/benekastah/neomake/commit/45dfc5
https://github.com/benekastah/neomake/pull/289
2016-03-10 08:59:31 +01: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é
688858e639
Doc: Reference Fedora and Ubuntu packages
2016-03-07 11:05:29 +01:00
Adrien Vergé
7688567faa
cli: Add the -d
option to provide inline conf
2016-03-04 16:53:26 +01:00
Adrien Vergé
83384fa4cf
Doc: Fix man page redundant description
2016-02-19 19:34:20 +01:00
Adrien Vergé
2f75e92a66
Doc: Add a configuration example in README
2016-02-19 10:37:52 +01:00
Adrien Vergé
0e04ee29e6
Doc: Update description
2016-02-01 23:03:25 +01:00
Adrien Vergé
3f4f13e848
Doc: Update screenshot to include 'key-duplicates'
2016-02-01 22:41:56 +01:00
Adrien Vergé
f6bab05e8a
Rules: Add the 'key-duplicates' rule
2016-02-01 22:26:18 +01:00
Adrien Vergé
d2b5f69309
Doc: Update Vim integration documentation
...
Since it has been merged into Syntastic:
https://github.com/scrooloose/syntastic/commit/8c4dadc
https://github.com/scrooloose/syntastic/pull/1675
2016-01-26 17:20:22 +01:00
Adrien Vergé
376a6ed484
Doc: Enhance short description
2016-01-24 18:40:48 +01:00