feat(cli): DO NOT MERGE cdk synth --watch re-synthesizes on file changes - #1851
Draft
iankhou wants to merge 1 commit into
Draft
feat(cli): DO NOT MERGE cdk synth --watch re-synthesizes on file changes#1851iankhou wants to merge 1 commit into
iankhou wants to merge 1 commit into
Conversation
Adds a --watch flag to `cdk synth` that continuously observes the project files (configured via the "watch" key of cdk.json, like `cdk deploy --watch`) and re-synthesizes the selected stacks whenever a change is detected. Never deploys, and never prints templates to stdout. Mirrors the `cdk validate --watch` precedent end to end: - toolkit-lib: new public `Toolkit.watchSynth()` and `WatchSynthOptions`, built on the existing generic `_watch` loop (chokidar, change batching, error resilience, dispose/waitForEnd). The body of `Toolkit.synth` is extracted into a private `_synth(assembly, options)` so both share it, matching the existing `validate`/`_validate` split. - CLI: new `watch` option on the synth command, regenerated parser files, and a `CdkToolkit.synthWatch()` that requires the cdk.json "watch" key (WatchConfigMissing otherwise) and passes an uncached assembly source so every iteration re-synthesizes.
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1851 +/- ##
==========================================
+ Coverage 90.31% 90.91% +0.59%
==========================================
Files 80 80
Lines 12159 12302 +143
Branches 1725 1759 +34
==========================================
+ Hits 10982 11184 +202
+ Misses 1143 1081 -62
- Partials 34 37 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
iankhou
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Do not merge. Waiting on consolidation of CLI and Toolkit Lib synth implementations, which are still separate now.
Description
Adds a --watch flag to
cdk synth, allowing developers to synth on file changes.Very similar to
cdk validate --watch(which also synths on file changes, but 1. returns the validation report, 2. performs online validation by default)CLI synth and Toolkit synth do not currently follow the same code path, but implement the same behavior (migration needed).
toolkit-lib: new public
Toolkit.watchSynth()andWatchSynthOptions, built on the existing generic_watchloop (chokidar, change batching, error resilience, dispose/waitForEnd). The body ofToolkit.synthis extracted into a private_synth(assembly, options)so both can share it, matching the existingvalidate/_validatesplit.CLI: new
watchoption on the synth command, regenerated parser files, and aCdkToolkit.synthWatch()that requires the cdk.json "watch" key (WatchConfigMissing otherwise) and passes an uncached assembly source so every iteration re-synthesizes.Testing
Unit tests
Integ tests pending
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license