chore: include vuetify in types and update plugin hook signature (#1)

vuetifyjs · Jul 1, 2023 · d0e3bfd · d0e3bfd
1 parent 552627f
commit d0e3bfd
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 14 deletions.
diff --git a/playground/plugins/vuetify.ts b/playground/plugins/vuetify.ts
@@ -1,6 +1,8 @@
 export default defineNuxtPlugin((nuxtApp) => {
-  nuxtApp.hook('vuetify:configuration', (vuetifyOptions) => {
-    // eslint-disable-next-line no-console
-    console.log('vuetify:plugin:hook', vuetifyOptions)
+  nuxtApp.hook('vuetify:configuration', (isDev, vuetifyOptions) => {
+    if (process.client && isDev) {
+      // eslint-disable-next-line no-console
+      console.log('vuetify:plugin:hook', vuetifyOptions)
+    }
   })
 })
diff --git a/src/module.ts b/src/module.ts
@@ -77,7 +77,7 @@ export default defineNuxtModule<ModuleOptions>({
 
     nuxt.hook('prepare:types', ({ references }) => {
       references.push({ types: 'vuetify-nuxt-module/configuration' })
-      references.push({ types: 'vuetify/components' })
+      references.push({ types: 'vuetify' })
     })
 
     nuxt.hook('vite:extendConfig', (viteInlineConfig) => {
@@ -105,8 +105,6 @@ export default defineNuxtModule<ModuleOptions>({
     addPluginTemplate({
       src: resolver.resolve(runtimeDir, 'templates/plugin.mts'),
       write: nuxt.options.dev || writePlugin,
-    }, {
-      append: true,
     })
   },
 })

diff --git a/src/runtime/templates/plugin.mts b/src/runtime/templates/plugin.mts
@@ -10,13 +10,13 @@ export default defineNuxtPlugin({
     const nuxtApp = useNuxtApp()
     const options = vuetifyConfiguration()
 
-    await nuxtApp.hooks.callHook('vuetify:configuration', options)
+    await nuxtApp.hooks.callHook('vuetify:configuration', isDev, options)
 
     const vuetify = createVuetify(vuetifyConfiguration())
 
     nuxtApp.vueApp.use(vuetify)
 
-    if (!process.server && isDev) {
+    if (process.client && isDev) {
       // eslint-disable-next-line no-console
       console.log('Vuetify 3 initialized', vuetify)
     }

diff --git a/src/types.ts b/src/types.ts
@@ -39,6 +39,6 @@ export interface ModuleOptions {
 
 declare module '#app' {
   interface RuntimeNuxtHooks {
-    'vuetify:configuration': (vuetifyOptions: VuetifyOptions) => void
+    'vuetify:configuration': (isDev: boolean, vuetifyOptions: VuetifyOptions) => Promise<void> | void
   }
 }
diff --git a/src/vuetify-configuration-plugin.ts b/src/vuetify-configuration-plugin.ts
@@ -14,7 +14,10 @@ export function vuetifyConfigurationPlugin(
   vuetifyAppOptions: VuetifyOptions,
 ) {
   const VIRTUAL_VUETIFY_CONFIGURATION = 'virtual:vuetify-configuration'
-  const RESOLVED_VIRTUAL_VUETIFY_CONFIGURATION = `\0${VIRTUAL_VUETIFY_CONFIGURATION}`
+  // TODO: ask Daniel Roe, I guess it is some internal nuxt module that shouldn't intercept this
+  // Nuxt DevTools doesn't shows the virtual when using Vite's default but it does when removing virtual: prefix
+  // const RESOLVED_VIRTUAL_VUETIFY_CONFIGURATION = `\0${VIRTUAL_VUETIFY_CONFIGURATION}`
+  const RESOLVED_VIRTUAL_VUETIFY_CONFIGURATION = `/@nuxt-vuetify-configuration/${VIRTUAL_VUETIFY_CONFIGURATION.slice('virtual:'.length)}`
 
   return <Plugin>{
     name: 'vuetify:configuration:nuxt',
@@ -26,16 +29,16 @@ export function vuetifyConfigurationPlugin(
     async load(id) {
       if (id === RESOLVED_VIRTUAL_VUETIFY_CONFIGURATION) {
         const directivesResult = buildDirectives()
-        const labsComponentsResult = buildLabsComponents()
+        const labComponentsResult = buildLabComponents()
 
         return `${directivesResult.imports}
-${labsComponentsResult.imports}
+${labComponentsResult.imports}
 
 export const isDev = ${isDev}
 export function vuetifyConfiguration() {
   const options = ${JSON.stringify(vuetifyAppOptions)}
   ${directivesResult.expression}
-  ${labsComponentsResult.expression}
+  ${labComponentsResult.expression}
   return options
 }
 `
@@ -61,7 +64,7 @@ export function vuetifyConfiguration() {
     }
   }
 
-  function buildLabsComponents() {
+  function buildLabComponents() {
     if (!labComponents)
       return <ImportsResult>{ imports: '', expression: '' }