@nuxt/module-builder 0.1.6 → 0.2.0

package/README.md

@@ -2,8 +2,6 @@
 
 > Complete solution to build Nuxt Modules.
 
-**🧪 This tool is still under heavy development for Nuxt3. Feedback is more than welcome!**
-
 ## Features
 
 - Unified build with [unjs/unbuild](https://github.com/unjs/unbuild)
@@ -14,12 +12,22 @@
 - Auto generated types and shims for `@nuxt/schema`
 
 
+## Learn More
+
+Check the new [Guide for Nuxt Modules](https://v3.nuxtjs.org/docs/advanced/modules/) before starting with module-builder.
+
+### Requirements
+
+For a user to use a module generated from module-builder, it's recommended they have:
+- Node.js >= 14.x. _Latest Node LTS preferred_
+- Nuxt 3 or Nuxt Bridge. _Nuxt 2 is functional but not advised_
+
 ## Quick start
 
-You can quickly get started with pre-configured [module starter](https://github.com/nuxt/starter/tree/module):
+You can quickly get started with the pre-configured [module starter](https://github.com/nuxt/starter/tree/module):
 
 ```bash
-$ npx nuxi init -t "nuxt/starter#module" my-module
+$ npx nuxi init -t module my-module
 ```
 
 ## Project structure
@@ -32,9 +40,9 @@ This is 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 module uses.
+You could also optionally export `ModuleHooks` to annotate any custom hooks the module uses.
 
-```js [src/module.ts]
+```ts [src/module.ts]
 import { defineNuxtModule } from '@nuxt/kit'
 
 export interface ModuleOptions {
@@ -45,6 +53,14 @@ export interface ModuleHooks {
   'my-module:init': any
 }
 
+export interface ModulePublicRuntimeConfig {
+  NAME: string
+}
+
+export interface ModulePrivateRuntimeConfig {
+  PRIVATE_NAME: string
+}
+
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: 'my-module',
@@ -110,9 +126,7 @@ Module builder generates dist files in `dist/` directory:
 - `runtime/*`: Individually transformed files using [unjs/mkdist](https://github.com/unjs/mkdist)
   - Javascript and `.ts` files will be transformed to `.mjs` with extracted types on `.d.ts` file with same name
   - `.vue` files will be transformed with extracted `.d.ts` file
-  - Other files will be copied as as
-
-
+  - Other files will be copied as is
 
 ## 💻 Development
 

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import mri from 'mri';
 import { resolve } from 'pathe';
-import { b as buildModule } from './chunks/build.mjs';
+import { b as buildModule } from './shared/module-builder.4bb3ed8c.mjs';
 import 'fs';
 import 'url';
 import 'consola';
@@ -12,6 +12,7 @@ async function main() {
   const rootDir = resolve(args._[0] || ".");
   await buildModule({
     rootDir,
+    outDir: args.outDir,
     stub: args.stub
   });
 }

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 interface BuildModuleOptions {
     rootDir: string;
     stub?: boolean;
+    outDir?: string;
 }
 declare function buildModule(opts: BuildModuleOptions): Promise<void>;
 

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { b as buildModule } from './chunks/build.mjs';
+export { b as buildModule } from './shared/module-builder.4bb3ed8c.mjs';
 import 'fs';
 import 'url';
 import 'pathe';

package/dist/{chunks/build.mjs → shared/module-builder.4bb3ed8c.mjs}

@@ -6,12 +6,14 @@ import { findExports } from 'mlly';
 
 async function buildModule(opts) {
   const { build } = await import('unbuild');
+  const outDir = opts.outDir || "dist";
   await build(opts.rootDir, false, {
     declaration: true,
     stub: opts.stub,
+    outDir,
     entries: [
       "src/module",
-      { input: "src/runtime/", outDir: "dist/runtime", ext: "mjs" }
+      { input: "src/runtime/", outDir: `${outDir}/runtime`, ext: "mjs" }
     ],
     rollup: {
       emitCJS: false,
@@ -21,7 +23,12 @@ async function buildModule(opts) {
       "@nuxt/schema",
       "@nuxt/schema-edge",
       "@nuxt/kit",
-      "@nuxt/kit-edge"
+      "@nuxt/kit-edge",
+      "nuxt",
+      "nuxt-edge",
+      "nuxt3",
+      "vue",
+      "vue-demi"
     ],
     hooks: {
       async "rollup:done"(ctx) {
@@ -60,19 +67,26 @@ async function writeTypes(distDir, meta) {
   const moduleTypes = await promises.readFile(moduleTypesFile, "utf8").catch(() => "");
   const typeExports = findExports(moduleTypes);
   const isStub = moduleTypes.includes("export *");
-  const hasModuleOptions = isStub || typeExports.find((exp) => exp.names.includes("ModuleOptions"));
-  const hasModuleHooks = isStub || typeExports.find((exp) => exp.names.includes("ModuleHooks"));
   const schemaShims = [];
   const moduleImports = [];
-  if (meta.configKey && hasModuleOptions) {
+  const hasTypeExport = (name) => isStub || typeExports.find((exp) => exp.names.includes(name));
+  if (meta.configKey && hasTypeExport("ModuleOptions")) {
     moduleImports.push("ModuleOptions");
     schemaShims.push(`  interface NuxtConfig { ['${meta.configKey}']?: Partial<ModuleOptions> }`);
     schemaShims.push(`  interface NuxtOptions { ['${meta.configKey}']?: ModuleOptions }`);
   }
-  if (hasModuleHooks) {
+  if (hasTypeExport("ModuleHooks")) {
     moduleImports.push("ModuleHooks");
     schemaShims.push("  interface NuxtHooks extends ModuleHooks {}");
   }
+  if (hasTypeExport("ModuleRuntimeConfig")) {
+    moduleImports.push("ModuleRuntimeConfig");
+    schemaShims.push("  interface RuntimeConfig extends ModuleRuntimeConfig {}");
+  }
+  if (hasTypeExport("ModulePublicRuntimeConfig")) {
+    moduleImports.push("ModulePublicRuntimeConfig");
+    schemaShims.push("  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}");
+  }
   const dtsContents = `
 import { ${moduleImports.join(", ")} } from './module'
 
@@ -81,7 +95,7 @@ ${schemaShims.join("\n")}
 }
 ` : ""}
 
-export { default } from './module'
+export { ${typeExports[0].names.join(", ")} } from './module'
 `;
   await promises.writeFile(dtsFile, dtsContents, "utf8");
 }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Complete solution to build Nuxt Modules",
   "license": "MIT",
   "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.mjs"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "types": "./dist/index.d.ts",
   "bin": {
@@ -28,18 +29,19 @@
   },
   "dependencies": {
     "consola": "^2.15.3",
-    "mlly": "^0.3.19",
+    "mlly": "^0.5.16",
     "mri": "^1.2.0",
-    "pathe": "^0.2.0",
-    "unbuild": "^0.6.7"
+    "pathe": "^0.3.9",
+    "unbuild": "^0.9.4"
   },
   "devDependencies": {
-    "@nuxt/kit": "npm:@nuxt/kit-edge@latest",
-    "@nuxt/schema": "npm:@nuxt/schema-edge@latest",
-    "@nuxtjs/eslint-config-typescript": "latest",
-    "@types/mri": "latest",
-    "eslint": "latest",
-    "jiti": "^1.12.9",
-    "standard-version": "latest"
+    "@nuxt/kit": "^3.0.0-rc.11",
+    "@nuxt/schema": "^3.0.0-rc.11",
+    "@nuxtjs/eslint-config-typescript": "^11.0.0",
+    "@types/mri": "^1.1.1",
+    "@types/node": "^18.11.0",
+    "eslint": "^8.25.0",
+    "jiti": "^1.16.0",
+    "standard-version": "^9.5.0"
   }
 }