/ doc / ale-cloudformation.txt
ale-cloudformation.txt
 1  ===============================================================================
 2  ALE CloudFormation Integration                      *ale-cloudformation-options*
 3  
 4  
 5  ===============================================================================
 6  cfn-python-lint                             *ale-cloudformation-cfn-python-lint*
 7  
 8  cfn-python-lint is a linter for AWS CloudFormation template file.
 9  
10  Website: https://github.com/awslabs/cfn-python-lint
11  
12  Installation
13  -------------------------------------------------------------------------------
14  
15  
16  Install cfn-python-lint using either pip or brew: >
17  
18  `pip install cfn-lint`. If pip is not available, run
19  `python setup.py clean --all` then `python setup.py install`.
20  
21   Homebrew (macOS):
22  
23  `brew install cfn-lint`
24  
25  <
26  Configuration
27  -------------------------------------------------------------------------------
28  
29  To get cloudformation linter to work on only CloudFormation files  we must set
30  the buffer |filetype| to yaml.cloudformation.
31  This causes ALE to lint the file with linters configured for cloudformation and
32  yaml files.
33  
34  Just put:
35  
36  >
37  
38   au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
39  
40  <
41  
42  on `ftdetect/cloudformation.vim`
43  
44  This will get both cloudformation and yaml linters to work on any file with `.template.yaml` ext.
45  ===============================================================================
46    vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: