https://github.com/aws-cloudformation/cfn-lint-visual-studio-code

CloudFormation Linter IDE integration, autocompletion, and documentation
https://github.com/aws-cloudformation/cfn-lint-visual-studio-code

aws aws-cloudformation cfn-lint cloudformation cloudformation-linter linter visual-studio-code

Last synced: about 1 month ago
JSON representation

CloudFormation Linter IDE integration, autocompletion, and documentation

• Host: GitHub
• URL: https://github.com/aws-cloudformation/cfn-lint-visual-studio-code
• Owner: aws-cloudformation
• License: apache-2.0
• Created: 2018-05-02T22:27:37.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2025-03-04T08:04:37.000Z (2 months ago)
• Last Synced: 2025-03-04T14:01:51.700Z (2 months ago)
• Topics: aws, aws-cloudformation, cfn-lint, cloudformation, cloudformation-linter, linter, visual-studio-code
• Language: JavaScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint
• Size: 8.62 MB
• Stars: 267
• Watchers: 9
• Forks: 159
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# vscode-cfn-lint

[![Version](https://img.shields.io/visual-studio-marketplace/v/kddejong.vscode-cfn-lint.svg?style=flat)](https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint)

[![Version](https://img.shields.io/visual-studio-marketplace/d/kddejong.vscode-cfn-lint.svg?style=flat)](https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint)

VS Code CloudFormation Linter uses cfn-lint to lint your CloudFormation templates.



## Features

- Uses [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint) to parse the template and show problems with it.

- Uses [pydot](https://pypi.org/project/pydot/) to preview the template as a graph of resources.

![features](/images/features.png)

## Requirements

Requires `cfn-lint` to be installed: `pip install cfn-lint`.

If you want to be able to preview templates as graphs, you also need to install `pydot`: `pip install pydot`.

## Extension Settings

* `cfnLint.path`: path to the `cfn-lint` command, optionally including [parameters](https://github.com/aws-cloudformation/cfn-python-lint/#parameters) as well:

![](/images/settings.png)

## Community

Join us on Discord! Connect & interact with CloudFormation developers &

experts, find channels to discuss and get help for cfn-lint, CloudFormation registry, StackSets,

Guard and more:

[![Join our Discord](https://discordapp.com/api/guilds/981586120448020580/widget.png?style=banner3)](https://discord.gg/9zpd7TTRwq)

## Contribute

The code for this plugin can be found on GitHub at [awslabs/aws-cfn-lint-visual-studio-code](https://github.com/awslabs/aws-cfn-lint-visual-studio-code)