fix(types): export interface for module builder type generation #738
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
joaltoroc
reviewed
Apr 19, 2024
| @@ -245,3 +246,16 @@ export default defineNuxtModule<ModuleOptions>({ | |||
| logger.success('`nuxt-auth` setup done') | |||
| } | |||
| }) satisfies NuxtModule<ModuleOptions> | |||
|
|
|||
| // Used by nuxt/module-builder for `types.d.ts` generation | |||
| export type { ModuleOptions } | |||
There was a problem hiding this comment.
If possible, you can export the whole file of types export * from './runtime/types' and this would generate the entire module
There was a problem hiding this comment.
@joaltoroc Thanks for your input, is there a strong reason why that is better?
phoenix-ru
approved these changes
Apr 25, 2024
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
Resolves #797
This moves the type augmentation to
module.tsand exports theModulePublicRuntimeConfiginterface (as well asModuleOptions) which are used by nuxt/module-builder to generate the correct types.The original type augmentation is kept to for type inference in the source code (matches previous behaviour).
Without these changes the types will conflict with those of other modules (nuxt-modules/i18n#2915), I have tested these changes locally with the reproduction provided in the referenced issues and it seems to work.
📝 Checklist