Skip to content
This repository has been archived by the owner on Mar 31, 2023. It is now read-only.

Commit

Permalink
Advise yamllint installation and use (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaciazek authored Aug 4, 2021
1 parent 6a089e6 commit aeeec82
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ rules/tags added to `warn_list`
(see [Ansible Lint Documentation](https://ansible-lint.readthedocs.io/en/latest/configuring.html))
are shown as warnings instead.

> If you also install `yamllint`, `ansible-lint` will detect it and incorporate
> into the linting process. Any findings reported by `yamllint` will be exposed
> in VSCode as errors/warnings.
### Smart autocompletion
![Autocompletion](images/smart-completions.gif)

Expand Down Expand Up @@ -68,7 +72,8 @@ holding `ctrl`/`cmd`.
## Requirements
- [Ansible 2.9+](https://docs.ansible.com/ansible/latest/index.html)
- [Ansible Lint](https://ansible-lint.readthedocs.io/en/latest/) (required,
unless you disable linter support; install without `yamllint`)
unless you disable linter support)
- [yamllint](https://yamllint.readthedocs.io/en/stable/) (optional)

For Windows users, this extension works perfectly well with extensions such as
`Remote - WSL` and `Remote - Containers`.
Expand Down

0 comments on commit aeeec82

Please sign in to comment.