(settings): ability to specific developer's local settings via cdk.local.json

[kornicameister]

Describe the feature

I'd want my developers to be able to specify certain context settings via untracked cdk.local.json file.
Something similar to .env.local that is untracked and presents an opportunity for developers to configure their stacks without stepping on each other toes.

I am aware that there is ~/cdk.json being a global configuration developer can apply but this particular's setting issue is its global impact on anything that's developed/deployed whereas I am looking for more isolated approach that allows to define settings per project.

Use Case

Point here is not to bloat either cdk.json or cdk.context.json files that are tracked, or in my case can be tracked when it comes to cdk.context.json. Reason for not tracking cdk.context.json lies in a fact that my organization develops various services as L3 components (packaged as NPM packages) that are combined with preview. Preview actually uses the L3 component to deploy isolated micro service. Given that all developers have their accounts it would be quite problematic to manage cdk.context.json if it were submitted to repository.

Later all components are integrated in bigger application which itself can benefit from cdk.local.json allowing developers to test integration.

Proposed Solution

Modify settings.ts by adding export const PROJECT_LOCAL_CONFIG = 'cdk.local.json'; and adjusting code to load it up similarly to USER_DEFAULTS.

Other Information

No response

Acknowledgements

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

CDK version used

2.137.0

Environment details (OS name and version, etc.)

MacOS Sierra

[kornicameister]

@khushail care to verify if PR is in the right direction and if it even makes sense?

[khushail]

@kornicameister ,Yes, we have requested more input from the maintainers but feel free to add any description about your suggested solution if you like.