Resolves #4583 Add JSDoc (TS flavor) to stub files #4809
Merged
Conversation
This file contains 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
Documents the types of the cli-generated files for init, migrate:make and seed:make. Uses the TS-specific flavor of JSDoc described in the Typescript Handbook.
OlivierCavadenti
approved these changes
Nov 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documents the types of the cli-generated files for init, migrate:make and seed:make. Uses the TS-specific flavor of JSDoc described in the TypeScript Handbook. This enables code hinting. Typescript users can use the checkJs in their project to raise a compilation error e.g. if they forget to return a Promise from the migration function. So this provides an alternative to making the cli generate TS directly with the
-x tsoption. Being JSDoc, it does not assume any specific module system on the user's machine to import the Knex.Some screenshots with IntelliSense in Visual Studio Code
Seed, current
Seed, PR
Knexfile, current
Knexfile, PR
Migrations, current
Migrations , PR
