AWS Quick Start cfn-lint rules
This repo provides CloudFormation linting rules specific to AWS Quick Start guidelines, for more information see the Contributors Guide..
Installation and Usage
cd ~/
git clone https://github.com/aws-quickstart/qs-cfn-lint-rules.git
cd qs-cfn-lint-rules
pip install -e .
To add the rules when running on the command line use the -a flag to add the additional rules:
cfn-lint my-cfn-template.yaml -a ~/qs-cfn-lint-rules/qs_cfn_lint_rules/
To use in your IDE install the relevant cfn-lint plugin and add the rules to your cfn-lint config file (~/.cfnlintrc) as follows:
append_rules:
- ~/qs-cfn-lint-rules/qs_cfn_lint_rules/
Vim Specfic Instructions (using vundle and syntastic)
Install the plugins:
Add to syntastic and vim-cfn your ~/.vimrc:
Add to vundle plugin section:
"---------------------------=== Cloudfromation ===------------------------------
Plugin 'scrooloose/syntastic' " Syntax checking plugin for Vim
Plugin 'speshak/vim-cfn' "CloudFormation syntax checking/highlighting
Install plugins
vim +PluginInstall +qall
Set statusline and triggers:
Append to the bottom of your ~/.vimrc:
"cfn-lint
set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*
let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 1
let g:syntastic_check_on_open = 1
let g:syntastic_check_on_wq = 0
let g:syntastic_cloudformation_checkers = ['cfn_lint']
Set FileTypes for vim-cfn:
Add to ~/.vim/bundle/vim-cfn/ftdetect/cloudformation.vim
autocmd BufNewFile,BufRead *.template setfiletype yaml.cloudformation
autocmd BufNewFile,BufRead *.template.yaml setfiletype yaml.cloudformation
Update syntastic pluging
Add the following to ~/.vim/after/plugin/syntastic.vim:
let g:syntastic_cloudformation_checkers = ['cfn_lint']
20 Sep 23, 2022
12 May 18, 2022
41 Oct 25, 2021
13 Sep 29, 2022
10 Jun 17, 2022
49 Feb 10, 2022
4 Feb 18, 2022
5 Aug 30, 2022
36 Oct 13, 2022
1 Dec 03, 2021
2 Dec 20, 2021
592 Jan 04, 2023
56 Dec 11, 2022
7 Dec 19, 2022
10 Aug 13, 2022
7 Jan 30, 2022
1 Dec 22, 2021
13 Jun 21, 2022
2 Jun 25, 2022
1 Jan 21, 2022