hashicorp / hashicorp/hcl

Add the mapping from HCL -> JSON to the README?

Open
#10 7 comments 0 reactions 0 assignees View on GitHub
v1
Dominant language
Go
Stars
5.8k
Forks
657
Avg merge
20h 36m
Merged PRs (30d)
6

Description

The mapping from HCL to JSON (and vice versa) isn't immediately clear. I haven't been able to find concrete documentation for this yet. The fixtures help, but there seems to be a mix of valid/invalid examples.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the README and the existing fixtures, which the issue identifies as the available context for HCL-to-JSON and JSON-to-HCL behavior. Compare the valid and invalid examples, then document the mapping clearly in the README, including enough distinction that readers can understand which examples are valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.