8537b0a164
Add rule: empty-values, to forbid implicit nulls
...
only in block mappings for now
2017-11-04 16:22:29 +01:00
1543d0e435
New rule key-ordering
...
closes #67
2017-10-16 22:49:39 +02:00
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
db57127971
docs(integration): Fix pre-commit config file
2017-08-17 12:07:23 +02:00
c8e516be2f
Add documentation for pre-commit
2017-07-19 14:56:21 +02:00
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
a825645cbe
Add information about Emacs integration
2017-03-25 18:53:09 +01:00
f507319419
Doc: Add ALE Vim plugin
2017-02-28 14:01:25 -05:00
2b26cbc56b
Fix typos
2017-02-28 00:22:49 +01:00
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
64369db9a2
docs(configuration): Fix typo
2016-11-07 18:11:33 +01:00
bf386b3c90
docs: Explain strict mode return codes
2016-10-24 14:15:23 +11:00
073462a87d
docs(rules): Fix missing truthy rule in index
2016-10-01 10:00:23 +02:00
4533b8ae49
doc(config): Show relaxed conf contents
...
Closes : #15
2016-08-12 11:17:18 +02:00
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
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
598e5e4370
Doc: Fix typo on configuration page intro
2016-04-21 22:39:46 +02:00
03076ee214
Doc: Add a pointer to rules on configuration page intro
2016-04-21 22:37:48 +02:00
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
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
2016-03-15 10:04:24 +01:00
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
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
688858e639
Doc: Reference Fedora and Ubuntu packages
2016-03-07 11:05:29 +01:00
7688567faa
cli: Add the -d option to provide inline conf
2016-03-04 16:53:26 +01:00
83384fa4cf
Doc: Fix man page redundant description
2016-02-19 19:34:20 +01:00
2f75e92a66
Doc: Add a configuration example in README
2016-02-19 10:37:52 +01:00
0e04ee29e6
Doc: Update description
2016-02-01 23:03:25 +01:00
3f4f13e848
Doc: Update screenshot to include 'key-duplicates'
2016-02-01 22:41:56 +01:00
f6bab05e8a
Rules: Add the 'key-duplicates' rule
2016-02-01 22:26:18 +01:00
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
376a6ed484
Doc: Enhance short description
2016-01-24 18:40:48 +01:00
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.
2016-01-24 17:48:20 +01:00
fee72d484e
Doc: Add a screenshot
2016-01-23 14:30:24 +01:00
ba8a9d0ba1
Doc: Give an explicit link from configuration to rules
2016-01-22 18:42:03 +01:00
47d6534e75
Doc: Write the configuration page
2016-01-22 18:20:31 +01:00
237db5aeef
Doc: Document how to use the yamllint Python module
2016-01-22 18:20:31 +01:00
6e9de02eac
Doc: Update index
...
Add a brief description and remove unused links.
2016-01-22 18:20:31 +01:00
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
Greg Dubicki