feat: enhance WriteToFileAsJSON with pretty-printing support
#783
Conversation
📝 Walkthrough📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe changes in this pull request focus on the Changes
Suggested labels
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
pkg/utils/json_utils.go (1)
91-91: Consider extracting common jsoniter config.While the short declaration is good, I notice that we have similar jsoniter configs repeated in multiple functions. Consider extracting this into a shared config variable.
package utils import (...) +var defaultJSONConfig = jsoniter.Config{ + EscapeHTML: false, + MarshalFloatWith6Digits: true, + ObjectFieldMustBeSimpleString: true, + SortMapKeys: true, + ValidateJsonRawMessage: true, +} // ... rest of the fileThis would reduce duplication and make config changes easier to maintain.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pkg/utils/json_utils.go(4 hunks)
🔇 Additional comments (2)
pkg/utils/json_utils.go (2)
58-58: LGTM! Clean variable declaration.
The short variable declaration style is idiomatic Go and improves readability.
74-74: LGTM! Consistent style.
The short variable declaration maintains consistency with the previous changes.
|
These changes were released in v1.106.1. |
what
ConvertToJSONutility withjson.MarshalIndentto produce formatted JSONwhy
This PR improves the
WriteToFileAsJSONfunction by introducing pretty-printing for JSON outputs. Previously, the function serialized JSON using a compact format, which could make the resulting files harder to read. With this change, all JSON written by this function will now be formatted with indentation, making it easier for developers and users to inspect and debug the generated filesThis specifically addresses Pretty Json Formatting from auto backend generation #778 , which previously rendered auto-generated backends as:
{ "terraform": { "backend": { "s3": { "acl": "bucket-owner-full-control", "bucket": "my-tfstate-bucket", "dynamodb_table": "some-dynamo-table", "encrypt": true, "key": "terraform.tfstate", "profile": "main", "region": "us-west-2", "workspace_key_prefix": "something" } } } }With this addition, the output appears as:
{ "terraform": { "backend": { "s3": { "acl": "bucket-owner-full-control", "bucket": "my-tfstate-bucket", "dynamodb_table": "some-dynamo-table", "encrypt": true, "key": "terraform.tfstate", "profile": "main", "region": "us-west-2", "workspace_key_prefix": "something" } } } }references
Summary by CodeRabbit
Summary by CodeRabbit