.vim/bundle/ale/doc/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
  13 -------------------------------------------------------------------------------
  14 Installation
  15
  16 Install cfn-python-lint using either pip or brew: >
  17
  18   pip install cfn-lint
  19 <
  20 If pip is not available use setuptools. >
  21
  22   python setup.py clean --all
  23   python setup.py install
  24 <
  25 You can install the linter via brew on macOS. >
  26
  27   brew install cfn-lint
  28 <
  29
  30 -------------------------------------------------------------------------------
  31 Configuration
  32
  33 To get cloudformation linter to work on only CloudFormation files we must set
  34 the buffer |filetype| to `yaml.cloudformation`.  This causes ALE to lint the
  35 file with linters configured for cloudformation and YAML files.
  36
  37 Just put the following in `ftdetect/cloudformation.vim`: >
  38
  39   au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
  40
  41 This will get both cloudformation and yaml linters to work on any file with
  42 `.template.yaml` extension.
  43
  44 ===============================================================================
  45   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: