Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

CDK: allow comments in context.json (via jsonc?) #30688

Open
2 tasks done
kidbrax opened this issue Jun 26, 2024 · 1 comment
Open
2 tasks done

CDK: allow comments in context.json (via jsonc?) #30688

kidbrax opened this issue Jun 26, 2024 · 1 comment
Labels
@aws-cdk/core Related to core CDK functionality effort/medium Medium work item – several days of effort feature/enhancement A new API to make things easier or more intuitive. A catch-all for general feature requests. feature-request A feature should be added or improved. p2 package/tools Related to AWS CDK Tools or CLI

Comments

@kidbrax
Copy link

kidbrax commented Jun 26, 2024

Describe the feature

I would like to be able to leave comments in the context.json file. Possibly by allowing jsonc files.

Use Case

To be able to leave useful comments in the cdk.json file for other developers to see.

Proposed Solution

Allow jsonc files as context files

Other Information

This would be an alternative to #15529

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.142.0

Environment details (OS name and version, etc.)

MacOS 14.4.1
@kidbrax kidbrax added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jun 26, 2024
@khushail
Copy link
Contributor

@kidbrax thanks for reaching out. sounds useful to have.

@khushail khushail added @aws-cdk/core Related to core CDK functionality feature/enhancement A new API to make things easier or more intuitive. A catch-all for general feature requests. package/tools Related to AWS CDK Tools or CLI and removed needs-triage This issue or PR still needs to be triaged. labels Jun 26, 2024
@khushail khushail removed their assignment Jun 26, 2024
@khushail khushail added p2 effort/medium Medium work item – several days of effort labels Jun 26, 2024
This was referenced Jul 1, 2024
Closed
Closed
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
@aws-cdk/core Related to core CDK functionality effort/medium Medium work item – several days of effort feature/enhancement A new API to make things easier or more intuitive. A catch-all for general feature requests. feature-request A feature should be added or improved. p2 package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kidbrax @khushail