e864f57d37
docs: Fix missing quoted-strings module in documentation
6 years ago
203cfc20f0
docs: Remove sudo from pip installation instructions
7 years ago
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
ff9ebde608
docs: Remove old Debian / Ubuntu installation instructions
7 years ago
8ab680635b
docs: Make `ignore` examples clearer
...
[Solved](https://github.com/metacloud/molecule/issues/1228 ), when
yamllint is used by molecule.
7 years ago
22e792a433
Feature: checking octal numbers
7 years ago
8537b0a164
Add rule: empty-values, to forbid implicit nulls
...
only in block mappings for now
7 years ago
1543d0e435
New rule key-ordering
...
closes #67
7 years ago
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
db57127971
docs(integration): Fix pre-commit config file
8 years ago
c8e516be2f
Add documentation for pre-commit
8 years ago
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
a825645cbe
Add information about Emacs integration
8 years ago
f507319419
Doc: Add ALE Vim plugin
8 years ago
2b26cbc56b
Fix typos
8 years ago
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
64369db9a2
docs(configuration): Fix typo
8 years ago
bf386b3c90
docs: Explain strict mode return codes
8 years ago
073462a87d
docs(rules): Fix missing truthy rule in index
8 years ago
4533b8ae49
doc(config): Show `relaxed` conf contents
...
Closes : #15
9 years ago
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
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
598e5e4370
Doc: Fix typo on configuration page intro
9 years ago
03076ee214
Doc: Add a pointer to rules on configuration page intro
9 years ago
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
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
9 years ago
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
9 years ago
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
9 years ago
688858e639
Doc: Reference Fedora and Ubuntu packages
9 years ago
7688567faa
cli: Add the `-d` option to provide inline conf
9 years ago
83384fa4cf
Doc: Fix man page redundant description
9 years ago
2f75e92a66
Doc: Add a configuration example in README
9 years ago
0e04ee29e6
Doc: Update description
9 years ago
3f4f13e848
Doc: Update screenshot to include 'key-duplicates'
9 years ago
f6bab05e8a
Rules: Add the 'key-duplicates' rule
9 years ago
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
9 years ago
376a6ed484
Doc: Enhance short description
9 years ago
dbbecb5875
Refactor project layout to import yamllint alone
...
Currently importing yamllint recursively imports its submodules, which
finally requires having pyyaml installed. This is a problem when you
just want to import APP_VERSION from yamllint. For instance, setup.py
imports yamllint to know the version, but doesn't know yet that pyyaml
is to be installed, because it is stated in setup.py itself.
To solve this, yamllint/__init__.py will only contain constants. The
linting functions will be in yamllint/linter.py.
9 years ago
fee72d484e
Doc: Add a screenshot
9 years ago
ba8a9d0ba1
Doc: Give an explicit link from configuration to rules
9 years ago
47d6534e75
Doc: Write the configuration page
9 years ago
237db5aeef
Doc: Document how to use the yamllint Python module
9 years ago
6e9de02eac
Doc: Update index
...
Add a brief description and remove unused links.
9 years ago
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/
9 years ago
Adrien Vergé
Eimert
xieenlong
Greg Dubicki
Johannes F. Knauf
Sebastian Finke
blackillzone
Krzysztof Magosa
Daniel M. Capella
Jakub Wilk
Jonathan Sokolowski