X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0ee596c5c5e11fc79598407eaf22f83d279f7e9e..5a4872f466ebd76ddd532bdf2798554421c53df4:/.vim/bundle/ale/doc/ale-cloudformation.txt

diff --git a/.vim/bundle/ale/doc/ale-cloudformation.txt b/.vim/bundle/ale/doc/ale-cloudformation.txt
new file mode 100644
index 00000000..56390149
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-cloudformation.txt
@@ -0,0 +1,45 @@
+===============================================================================
+ALE CloudFormation Integration                     *ale-cloudformation-options*
+
+
+===============================================================================
+cfn-python-lint                            *ale-cloudformation-cfn-python-lint*
+
+cfn-python-lint is a linter for AWS CloudFormation template file.
+
+Website: https://github.com/awslabs/cfn-python-lint
+
+
+-------------------------------------------------------------------------------
+Installation
+
+Install cfn-python-lint using either pip or brew: >
+
+  pip install cfn-lint
+<
+If pip is not available use setuptools. >
+
+  python setup.py clean --all
+  python setup.py install
+<
+You can install the linter via brew on macOS. >
+
+  brew install cfn-lint
+<
+
+-------------------------------------------------------------------------------
+Configuration
+
+To get cloudformation linter to work on only CloudFormation files we must set
+the buffer |filetype| to `yaml.cloudformation`.  This causes ALE to lint the
+file with linters configured for cloudformation and YAML files.
+
+Just put the following in `ftdetect/cloudformation.vim`: >
+
+  au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
+
+This will get both cloudformation and yaml linters to work on any file with
+`.template.yaml` extension.
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: