Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sst/examples/create-sst-rds: Add dynamic JSDoc database type to migration template #3459

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

stevenschmatz
Copy link

The problem

The migration.ejs.t file uses JSDoc to provide some autocompletion to the db type, but it doesn't make use of the auto-generated types in sql.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.

CleanShot 2023-10-30 at 17 30 19@2x

@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2023

⚠️ No Changeset found

Latest commit: 8a95311

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jayair
Copy link
Contributor

jayair commented Nov 1, 2023

Oh that's interesting. Thanks for tracking down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants