jbuiss0n/cf-plugin

A plugin to help with authoring CloudFormation templates

Author templates for AWS CloudFormation

This extension help you author AWS CloudFormation templates with ease.

It uses JSON schema validation features of VSCode to validate your template files against a schema for AWS CloudFormation (currently uses cloudformation-jsonschema)

Capabilities

• Supports authoring of CloudFormation templates in JSON
• Highlights errors with a helpful error message (in the "Problems" pane, and as a pop-up message visible on hover)
  • Highlights errors when JSON is malformed
  • Highlights errors for required elements, required properties, invalid document structure, etc.
• Suggests top-level elements (such as Parameters, Resources, etc.)
• Auto-completes known elements (such as AWSTemplateFormatVersion)
• Auto-completes structure of elements, intrinsic functions, etc.
• Suggests supported properties for elements in Parameters, Resources, Outputs, etc.
• Suggests supported Type information for Parameters and Resources
• Suggests required and supported properties for each resource (by Type)
• Suggests intrinsic function names and 'shape'
• Currently relies upon a JSON schema for CloudFormation as published at cloudformation-jsonschema

Coming soon ...

See TODO and requirements

Illustration

1. Suggest top-level elements

2. Validate that JSON is well-formed

3. Suggest properties for Parameters elements

4. Validate required Type for Parameters elements

5. Suggest Type for Parameters elements

6. Validate Type value for Parameters

7. Suggest properties for Resources elements

8. Suggest Type for Resources elements

9. Validate required properties for a given resource (by Type)

10. Suggest properties for a given resource (by Type)

11. Suggest intrinsic function names

12. Suggest intrinsic function 'shape'

Requirements

This extension is active when working with templates with a filename ending in .cf.json

Source

The source for this extension is maintained at Github repository cf-plugin