feat(kit): addTypeTemplate helper with auto-registration
#21331
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
✅ Live Preview ready!
|
Hebilicious
force-pushed
the
kit-add-types
branch
from
2e3fdb3
to
634fcc8
Compare
danielroe
reviewed
Jun 7, 2023
danielroe
approved these changes
Jun 8, 2023
danielroe
changed the title
addTypeTemplate helper with auto-registration
Merged
Hebilicious
commented
Jun 10, 2023
| const template = addTemplate(_template) | ||
|
|
||
| if (!template.filename.endsWith('.d.ts')) { | ||
| throw new Error(`Invalid type template. Filename must end with .d.ts : "${template.filename}"`) |
There was a problem hiding this comment.
I avoided doing it like this, because this can throw while the template is written. Is this behaviour fine?
|
|
||
| #### Adding Type Declarations | ||
|
|
||
| You might also want to add a type declaration to the user's project (for example, to augment an Nuxt interface |
There was a problem hiding this comment.
to augment an Nuxt interface => to augment a Nuxt interface
|
|
||
| You might also want to add a type declaration to the user's project (for example, to augment an Nuxt interface | ||
| or provide a global type of your own). For this, Nuxt provides the `addTypeTemplate` utility that both | ||
| writes a template to disk and adds a reference to it in the generated `nuxt.d.ts` file that. |
There was a problem hiding this comment.
writes a template to the disk ?
|
@danielroe I forgot to click submit review 🤦🏽 I can open another PR for the typos |
|
Thank you 😊 |
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.
🔗 Linked issue
❓ Type of change
📚 Description
This PR adds an
addTypesutility to@nuxt/kit.It also improves the documentation section regarding adding types, by including a general usecase for
addTemplateand documented an use-case ofupdateTemplate.📝 Checklist