feat: auto generate module options from schema meta (#33)

Author: ricardogobbosouza

package.json

@@ -40,7 +40,8 @@
     "pathe": "^1.1.2",
     "pkg-types": "^1.1.1",
     "tsconfck": "^3.0.3",
-    "unbuild": "^2.0.0"
+    "unbuild": "^2.0.0",
+    "untyped": "^1.4.2"
   },
   "peerDependencies": {
     "@nuxt/kit": "^3.11.2",

pnpm-lock.yaml

@@ -10,7 +10,10 @@ import { anyOf, createRegExp } from 'magic-regexp'
 import { consola } from 'consola'
 import type { ModuleMeta, NuxtModule } from '@nuxt/schema'
 import { findExports, resolvePath } from 'mlly'
+import { resolveSchema, generateTypes } from 'untyped'
+import type { InputObject } from 'untyped'
 import { defineCommand } from 'citty'
+import { loadNuxt } from '@nuxt/kit'
 
 import { name, version } from '../../package.json'
 
@@ -169,14 +172,24 @@ export default defineCommand({
           await fsp.writeFile(metaFile, JSON.stringify(moduleMeta, null, 2), 'utf8')
 
           // Generate types
-          await writeTypes(ctx.options.outDir, moduleMeta)
+          await writeTypes(ctx.options.outDir, moduleMeta, async () => {
+            const nuxt = await loadNuxt({
+              cwd,
+              overrides: {
+                modules: [resolve(cwd, './src/module')],
+              },
+            })
+            const moduleOptions = await moduleFn.getOptions?.({}, nuxt) || {}
+            await nuxt.close()
+            return moduleOptions
+          })
         },
       },
     })
   },
 })
 
-async function writeTypes(distDir: string, meta: ModuleMeta) {
+async function writeTypes(distDir: string, meta: ModuleMeta, getOptions: () => Promise<Record<string, unknown>>) {
   const dtsFile = resolve(distDir, 'types.d.ts')
   const dtsFileMts = resolve(distDir, 'types.d.mts')
   if (existsSync(dtsFile)) {
@@ -206,6 +219,9 @@ async function writeTypes(distDir: string, meta: ModuleMeta) {
     schemaShims.push(`  interface NuxtConfig { ['${meta.configKey}']?: Partial<ModuleOptions> }`)
     schemaShims.push(`  interface NuxtOptions { ['${meta.configKey}']?: ModuleOptions }`)
   }
+  else if (meta.configKey) {
+    schemaShims.push(`  ${generateTypes(await resolveSchema(await getOptions() as InputObject), { interfaceName: 'ModuleOptions' })}`)
+  }
   if (hasTypeExport('ModuleHooks')) {
     moduleImports.push('ModuleHooks')
     schemaShims.push('  interface NuxtHooks extends ModuleHooks {}')