feat(toolkit): add 'cdk context' command #1169
Conversation
Add a command to view and manage cached context values. Fixes #311.
docs/src/context.rst
Outdated
| Viewing and managing context | ||
| ########################### | ||
|
|
||
| Context is used to retrieve things like Availability Zones available to you, or |
There was a problem hiding this comment.
"Availability zone available" sounds weird
docs/src/context.rst
Outdated
| │ │ 64-gp2:region=us-east-1 │ │ | ||
| └───┴────────────────────────────────────────────────────┴────────────────────────────────────────────────────┘ | ||
|
|
||
| Run cdk context --invalidate KEY_OR_NUMBER to invalidate a context key. It will be refreshed on the next CDK synthesis run. |
There was a problem hiding this comment.
- I wonder if
--clearor--resetare more intuitive in this context - Can you invalidate everything?
There was a problem hiding this comment.
--clear actually clears everything. cdk context --help will show it.
There was a problem hiding this comment.
I will call it reset.
| return 0; | ||
| } | ||
|
|
||
| function listContext(context: any) { |
There was a problem hiding this comment.
Can we add a --json flag that will output the context as JSON for machines?
| } | ||
|
|
||
| // Unset! | ||
| if (!(key in context)) { |
There was a problem hiding this comment.
Can probably be a no-op (think scripts that want to ensure that a context is invalidated)
| return key; | ||
| } | ||
| } | ||
| throw new Error(`No context key with number: ${n}`); |
There was a problem hiding this comment.
Maybe add --force and this will be no-op (similar to rm -f)
There was a problem hiding this comment.
This is for a semi-interactive usage, where copying the key is a bother and you simply supply the number. Blindly deleting by key # is dangerous, given that the numbering is not unique.
But yeah, just deleting a nonexistant key will be a no-op.
|
Yas |
Add a command to view and manage cached context values.
Fixes #311.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.