@nuxt/module-builder 0.5.3 → 0.5.5

package/README.md

@@ -42,7 +42,7 @@ The entrypoint for module definition.
 
 A default export using `defineNuxtModule` and `ModuleOptions` type export is expected.
 
-You could also optionally export `ModuleHooks` to annotate any custom hooks the module uses.
+You could also optionally export `ModuleHooks` or `ModuleRuntimeHooks` to annotate any custom hooks the module uses.
 
 ```ts [src/module.ts]
 import { defineNuxtModule } from '@nuxt/kit'
@@ -55,14 +55,18 @@ export interface ModuleHooks {
   'my-module:init': any
 }
 
-export interface ModulePublicRuntimeConfig {
-  NAME: string
+export interface ModuleRuntimeHooks {
+  'my-module:runtime-hook': any
 }
 
-export interface ModulePrivateRuntimeConfig {
+export interface ModuleRuntimeConfig {
   PRIVATE_NAME: string
 }
 
+export interface ModulePublicRuntimeConfig {
+  NAME: string
+}
+
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: 'my-module',
@@ -141,7 +145,6 @@ Module builder generates dist files in `dist/` directory:
 
 [MIT](./LICENSE) - Made with 💚
 
-
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/@nuxt/module-builder/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
 [npm-version-href]: https://npmjs.com/package/@nuxt/module-builder

package/dist/chunks/build.mjs

@@ -73,7 +73,7 @@ const build = defineCommand({
           if (!moduleFn) {
             return;
           }
-          const moduleMeta = await moduleFn.getMeta();
+          const moduleMeta = await moduleFn.getMeta?.() || {};
           if (ctx.pkg) {
             if (!moduleMeta.name) {
               moduleMeta.name = ctx.pkg.name;
@@ -106,6 +106,7 @@ async function writeTypes(distDir, meta) {
     )
   );
   const isStub = moduleTypes.includes("export *");
+  const appShims = [];
   const schemaShims = [];
   const moduleImports = [];
   const hasTypeExport = (name) => isStub || typeExports.find((exp) => exp.names.includes(name));
@@ -118,6 +119,18 @@ async function writeTypes(distDir, meta) {
     moduleImports.push("ModuleHooks");
     schemaShims.push("  interface NuxtHooks extends ModuleHooks {}");
   }
+  if (hasTypeExport("RuntimeModuleHooks") || hasTypeExport("ModuleRuntimeHooks")) {
+    const runtimeHooksInterfaces = [];
+    if (hasTypeExport("RuntimeModuleHooks")) {
+      consola.warn("`RuntimeModuleHooks` is a deprecated naming and will be removed in the future. Please use `ModuleRuntimeHooks` instead.");
+      runtimeHooksInterfaces.push("RuntimeModuleHooks");
+    }
+    if (hasTypeExport("ModuleRuntimeHooks")) {
+      runtimeHooksInterfaces.push("ModuleRuntimeHooks");
+    }
+    moduleImports.push(...runtimeHooksInterfaces);
+    appShims.push(`  interface RuntimeNuxtHooks extends ${runtimeHooksInterfaces.join(", ")} {}`);
+  }
   if (hasTypeExport("ModuleRuntimeConfig")) {
     moduleImports.push("ModuleRuntimeConfig");
     schemaShims.push("  interface RuntimeConfig extends ModuleRuntimeConfig {}");
@@ -127,8 +140,12 @@ async function writeTypes(distDir, meta) {
     schemaShims.push("  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}");
   }
   const dtsContents = `
-import { ${moduleImports.join(", ")} } from './module'
+import type { ${moduleImports.join(", ")} } from './module'
 
+${appShims.length ? `declare module '#app' {
+${appShims.join("\n")}
+}
+` : ""}
 ${schemaShims.length ? `declare module '@nuxt/schema' {
 ${schemaShims.join("\n")}
 }
@@ -138,11 +155,11 @@ ${schemaShims.join("\n")}
 }
 ` : ""}
 
-export { ${typeExports[0].names.join(", ")} } from './module'
+export type { ${typeExports[0].names.join(", ")} } from './module'
 `;
   await promises.writeFile(dtsFile, dtsContents, "utf8");
   if (!existsSync(dtsFileMts)) {
-    await promises.writeFile(dtsFileMts, dtsContents, "utf8");
+    await promises.writeFile(dtsFileMts, dtsContents.replaceAll("./module", "./module.js"), "utf8");
   }
 }
 async function writeCJSStub(distDir) {

package/dist/cli.mjs

@@ -3,7 +3,7 @@ import { defineCommand, runMain } from 'citty';
 import { consola } from 'consola';
 
 const name = "@nuxt/module-builder";
-const version = "0.5.3";
+const version = "0.5.5";
 const description = "Complete solution for building Nuxt modules";
 
 const _rDefault = (r) => r.default || r;
@@ -19,7 +19,7 @@ const main = defineCommand({
   },
   setup(context) {
     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");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "repository": "nuxt/module-builder",
   "description": "Complete solution for building Nuxt modules",
   "license": "MIT",
@@ -19,37 +19,38 @@
   "files": [
     "dist"
   ],
-  "packageManager": "pnpm@8.10.2",
+  "packageManager": "pnpm@8.12.1",
   "dependencies": {
-    "citty": "^0.1.4",
+    "citty": "^0.1.5",
     "consola": "^3.2.3",
     "mlly": "^1.4.2",
     "pathe": "^1.1.1",
     "unbuild": "^2.0.0"
   },
   "peerDependencies": {
-    "@nuxt/kit": "^3.8.0",
-    "nuxi": "^3.9.1"
+    "@nuxt/kit": "^3.8.2",
+    "nuxi": "^3.10.0"
   },
   "devDependencies": {
-    "@nuxt/kit": "^3.8.0",
-    "@nuxt/schema": "^3.8.0",
+    "@nuxt/kit": "^3.8.2",
+    "@nuxt/schema": "^3.8.2",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@types/node": "^20.8.10",
-    "@vitest/coverage-v8": "^0.34.6",
+    "@types/node": "^20.10.5",
+    "@vitest/coverage-v8": "^1.1.0",
     "changelogen": "^0.5.5",
-    "eslint": "^8.53.0",
+    "eslint": "^8.56.0",
     "jiti": "^1.21.0",
-    "nuxi": "^3.9.1",
-    "nuxt": "^3.8.0",
-    "vitest": "^0.34.6"
+    "nuxi": "^3.10.0",
+    "nuxt": "^3.8.2",
+    "vitest": "^1.1.0"
   },
   "scripts": {
     "build": "unbuild",
-    "example:build": "pnpm nuxt-module-build ./example",
+    "example:build": "pnpm nuxt-module-build build ./example",
     "lint": "eslint --ext .ts,.js,.mjs .",
     "nuxt-module-build": "JITI_ESM_RESOLVE=1 jiti ./src/cli.ts",
     "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"
   }
 }