]> git.madduck.net Git - etc/vim.git/blobdiff - .vim/bundle/ale/doc/ale-cloudformation.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'
[etc/vim.git] / .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 (file)
index 0000000..5639014
--- /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:
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.