Resolves #4583 Add JSDoc (TS flavor) to stub files #4809
Merged
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 ts
option. 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-before](https://user-images.githubusercontent.com/44092779/140579311-c23905d1-81f5-4350-aedb-14c81f7e9db5.png)
Seed, PR
![seed-after](https://user-images.githubusercontent.com/44092779/140579313-53c94ab4-599d-4ef0-bcf7-56cba85bd26f.png)
Knexfile, current
![knexfile-before](https://user-images.githubusercontent.com/44092779/140579314-87867725-a7c4-4cdc-a363-34c828beb9b3.png)
Knexfile, PR
![knexfile-after](https://user-images.githubusercontent.com/44092779/140579315-6e7bed85-54c7-4d84-b96b-f43d65c14fe3.png)
Migrations, current
![migrations-before](https://user-images.githubusercontent.com/44092779/140579316-616662da-c288-437a-b094-cfcb24769aad.png)
Migrations , PR
![migrations-after](https://user-images.githubusercontent.com/44092779/140579318-b77a69d4-10f5-4205-a3b8-c95dce06cc25.png)