test: add root + module type tests

.github/workflows/ci.yml

@@ -24,5 +24,6 @@ jobs:
       - run: pnpm test -- --coverage
       - run: pnpm build
       - run: pnpm example:build
+      - run: pnpm test:types
       - run: npx publint
         working-directory: example

.gitignore

@@ -9,3 +9,4 @@ package-lock.json
 .nuxt
 .output
 .idea/
+example/playground/.nuxtrc

example/playground/nuxt.config.ts

@@ -1,4 +1,11 @@
 export default defineNuxtConfig({
-  modules: ['../src/module'],
-  myModule: {}
+  modules: ['my-module'],
+  myModule: {
+    apiKey: '',
+    // @ts-expect-error invalid configuration key
+    api: ''
+  },
+  hooks: {
+    'my-module:init' () {}
+  }
 })

example/playground/package.json

@@ -1,8 +1,17 @@
 {
   "private": true,
   "name": "my-module-playground",
+  "scripts": {
+    "test:types": "pnpm test:types:bundler && pnpm test:types:node10",
+    "test:types:bundler": "echo typescript.tsConfig.compilerOptions.moduleResolution=bundler > .nuxtrc && nuxt prepare && vue-tsc --noEmit",
+    "test:types:node10": "echo typescript.tsConfig.compilerOptions.moduleResolution=node10 > .nuxtrc && nuxt prepare && vue-tsc --noEmit"
+  },
   "dependencies": {
     "my-module": "workspace:*",
     "nuxt": "latest"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2",
+    "vue-tsc": "^1.8.22"
   }
 }

example/playground/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}

example/playground/types.ts

@@ -0,0 +1,15 @@
+import { describe, expectTypeOf, it } from 'vitest'
+import { useNuxtApp } from '#app'
+
+describe('', () => {
+  it('should have typed injection', () => {
+    expectTypeOf(useNuxtApp().$injection).toEqualTypeOf<'injected'>()
+  })
+  it('should have typed runtime hooks', () => {
+    useNuxtApp().hook('my-module:runtime-hook', () => {})
+  })
+  it('should have typed runtime config', () => {
+    expectTypeOf(useRuntimeConfig().public.NAME).toEqualTypeOf<string>()
+    expectTypeOf(useRuntimeConfig().PRIVATE_NAME).toEqualTypeOf<string>()
+  })
+})

example/src/module.ts

@@ -6,11 +6,11 @@ export interface ModuleOptions {
 }
 
 export interface ModuleHooks {
-  'my-module:init': any
+  'my-module:init': () => void
 }
 
 export interface RuntimeModuleHooks {
-  'my-module:runtime-hook': any
+  'my-module:runtime-hook': () => void
 }
 
 export interface ModulePublicRuntimeConfig {

example/src/runtime/plugin.ts

@@ -1,6 +1,13 @@
+// TODO: fix module-builder failing to emit correct types
+import type { Plugin } from 'nuxt/app'
 import { defineNuxtPlugin } from '#imports'
 
-export default defineNuxtPlugin((_nuxtApp) => {
+export default defineNuxtPlugin(() => {
   // eslint-disable-next-line no-console
   console.log('Plugin injected by my-module!')
-})
+  return {
+    provide: {
+      injection: 'injected' as const
+    }
+  }
+}) as Plugin<{ injection: 'injected' }>

package.json

@@ -26,7 +26,8 @@
     "nuxt-module-build": "JITI_ESM_RESOLVE=1 jiti ./src/cli.ts",
     "prepack": "pnpm build",
     "release": "pnpm vitest run && pnpm build && changelogen --release && pnpm publish && git push --follow-tags",
-    "test": "pnpm vitest"
+    "test": "pnpm vitest",
+    "test:types": "tsc --noEmit && pnpm -r test:types"
   },
   "packageManager": "[email protected]",
   "dependencies": {

src/cli.ts

@@ -19,7 +19,7 @@ const main = defineCommand({
   setup (context) {
     // TODO: support 'default command' in citty?
     const firstArg = context.rawArgs[0]
-    if (!(firstArg in context.cmd.subCommands)) {
+    if (context.cmd.subCommands && !(firstArg in context.cmd.subCommands)) {
       consola.warn('Please specify the `build` command explicitly. In a future version of `@nuxt/module-builder`, the implicit default build command will be removed.')
       context.rawArgs.unshift('build')
     }