sst/examples/create-sst-rds: Add dynamic JSDoc database type to migration template #3459
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.
The problem
The
migration.ejs.t
file uses JSDoc to provide some autocompletion to thedb
type, but it doesn't make use of the auto-generated types insql.generated
.This has led to some folks in the SST Discord (and myself) trying to set up TypeScript compilation for these files. But there is a simpler solution.
The solution
JSDoc supports imported types from other files. This makes for some really nice autocompletion without requiring a separate build step or having to worry about anything happening with runtime of the migration itself.