CloudFormation templates in JSON format
- Dominant language
- TypeScript
- Stars
- 2k
- Forks
- 807
- Avg merge
- 10h 12m
- Merged PRs (30d)
- 7
Description
CloudFormation supports both yaml and json formats, but the toolkit only supports yaml.
Although the yaml variation is less verbose (has support for `!Ref` and other shortcuts), many template samples are given in json. Users may be disappointed that they can't work with these templates. Additionally, they may just prefer to use json over yaml.
**Describe the solution you'd like**
Add support for json templates.
**Describe alternatives you've considered**
Users can convert their json templates to yaml. The CloudFormation designer UI lets you easy switch between the formats. But this might be annoying since they might prefer json for its simplicity or uniformity with other config files in their codebases.
Toolkit can detect and offer to convert these templates. This solves the confusion aspect around the inability to run these templates. However, it doesn't help users that prefer sticking with json.
**Additional context**
Looking for feedback from users that encounter / prefer json cfn templates.
Contributor guide
Research direction
Start by locating the toolkit's CloudFormation template handling entry point and checking how YAML templates are currently detected and processed. Define the JSON-template path and verify that representative CloudFormation JSON samples can be used without conversion; the issue names no specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cloud, infrastructure
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100