Add feature flags for enabling breaking changes

[jsteinich]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

While working on #329 it was realized that it would cause a breaking change. While currently that may be acceptable, as the project grows, we'll want to introduce more potentially breaking changes and won't want to be forced to wait for a new major version.

Feature flags serve as a way to conditionally enable breaking behavior. Following CDK feature flags makes a lot of sense...

• Easy central definition
• Automatic use in new projects

The naming convention can probably be loosened since this project isn't made up of 100s of modules.
We also need to decide where to put them. Some options:

1. cdktf.json - this is a close equivalent of cdk.json so would match well
2. Directly in code - already possible to set via node.setContext. Could be added to template projects

I'm in favor of the first option since it keeps the code cleaner and has a cleaner boundary of effect.

References

#329
CDK feature flags

[skorfmann]

I'm in favor of the first option since it keeps the code cleaner and has a cleaner boundary of effect.

Yes, I'd prefer cdktf.json as well 👍

[cmclaughlin]

I think this can be closed since PR #329 was merged - excited to try that!

[jsteinich]

Resolved with #329

[github-actions]

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.