@nuxt/module-builder 0.5.5 → 0.7.0

package/README.md

@@ -100,6 +100,7 @@ A minimum `package.json` should look like this:
   "version": "1.0.0",
   "exports": {
     ".": {
+      "types": "./dist/types.d.ts",
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
     }

package/dist/chunks/build.mjs

@@ -1,9 +1,17 @@
-import { promises, existsSync } from 'fs';
-import { pathToFileURL } from 'url';
-import { resolve } from 'pathe';
+import { promises, existsSync } from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { resolve, basename, join, dirname } from 'pathe';
+import { filename } from 'pathe/utils';
+import { readPackageJSON } from 'pkg-types';
+import { parse } from 'tsconfck';
+import { defu } from 'defu';
+import { createRegExp, anyOf } from 'magic-regexp';
 import { consola } from 'consola';
-import { findExports } from 'mlly';
+import { resolvePath, findExports } from 'mlly';
+import { generateTypes, resolveSchema } from 'untyped';
 import { defineCommand } from 'citty';
+import { loadNuxt } from '@nuxt/kit';
+import { n as name, v as version } from '../shared/module-builder.4be2741e.mjs';
 
 const build = defineCommand({
   meta: {
@@ -41,7 +49,17 @@ const build = defineCommand({
       outDir,
       entries: [
         "src/module",
-        { input: "src/runtime/", outDir: `${outDir}/runtime`, ext: "mjs" }
+        {
+          input: "src/runtime/",
+          outDir: `${outDir}/runtime`,
+          addRelativeDeclarationExtensions: true,
+          ext: "js",
+          esbuild: {
+            jsxImportSource: "vue",
+            jsx: "automatic",
+            jsxFactory: "h"
+          }
+        }
       ],
       rollup: {
         esbuild: {
@@ -51,17 +69,55 @@ const build = defineCommand({
         cjsBridge: true
       },
       externals: [
+        /dist\/runtime\//,
         "@nuxt/schema",
+        "@nuxt/schema-nightly",
         "@nuxt/schema-edge",
         "@nuxt/kit",
+        "@nuxt/kit-nightly",
         "@nuxt/kit-edge",
         "nuxt",
+        "nuxt-nightly",
         "nuxt-edge",
         "nuxt3",
         "vue",
         "vue-demi"
       ],
       hooks: {
+        async "mkdist:entry:options"(_ctx, entry, options) {
+          options.typescript = defu(options.typescript, {
+            compilerOptions: await loadTSCompilerOptions(entry.input)
+          });
+        },
+        async "rollup:options"(ctx, options) {
+          options.plugins || (options.plugins = []);
+          if (!Array.isArray(options.plugins))
+            options.plugins = [options.plugins];
+          const runtimeEntries = ctx.options.entries.filter((entry) => entry.builder === "mkdist");
+          const runtimeDirs = runtimeEntries.map((entry) => basename(entry.input));
+          const RUNTIME_RE = createRegExp(anyOf(...runtimeDirs).and("/"));
+          options.plugins.unshift({
+            name: "nuxt-module-builder:runtime-externals",
+            async resolveId(id, importer) {
+              if (!RUNTIME_RE.test(id))
+                return;
+              const resolved = await this.resolve(id, importer, { skipSelf: true });
+              if (!resolved)
+                return;
+              for (const entry of runtimeEntries) {
+                if (!resolved.id.includes(entry.input))
+                  continue;
+                const distFile = await resolvePath(join(dirname(resolved.id.replace(entry.input, entry.outDir)), filename(resolved.id)));
+                if (distFile) {
+                  return {
+                    external: true,
+                    id: distFile
+                  };
+                }
+              }
+            }
+          });
+        },
         async "rollup:done"(ctx) {
           await writeCJSStub(ctx.options.outDir);
           const moduleEntryPath = resolve(ctx.options.outDir, "module.mjs");
@@ -82,15 +138,29 @@ const build = defineCommand({
               moduleMeta.version = ctx.pkg.version;
             }
           }
+          moduleMeta.builder = {
+            [name]: version,
+            unbuild: await readPackageJSON("unbuild").then((r) => r.version).catch(() => "unknown")
+          };
           const metaFile = resolve(ctx.options.outDir, "module.json");
           await promises.writeFile(metaFile, JSON.stringify(moduleMeta, null, 2), "utf8");
-          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, meta) {
+async function writeTypes(distDir, meta, getOptions) {
   const dtsFile = resolve(distDir, "types.d.ts");
   const dtsFileMts = resolve(distDir, "types.d.mts");
   if (existsSync(dtsFile)) {
@@ -101,7 +171,7 @@ async function writeTypes(distDir, meta) {
   const typeExports = findExports(
     // Replace `export { type Foo }` with `export { Foo }`
     moduleTypes.replace(
-      /export\s*{.*?}/sg,
+      /export\s*\{.*?\}/gs,
       (match) => match.replace(/\btype\b/g, "")
     )
   );
@@ -109,22 +179,20 @@ async function writeTypes(distDir, meta) {
   const appShims = [];
   const schemaShims = [];
   const moduleImports = [];
-  const hasTypeExport = (name) => isStub || typeExports.find((exp) => exp.names.includes(name));
+  const hasTypeExport = (name2) => isStub || typeExports.find((exp) => exp.names.includes(name2));
   if (meta.configKey && hasTypeExport("ModuleOptions")) {
     moduleImports.push("ModuleOptions");
     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()), { interfaceName: "ModuleOptions" })}`);
   }
   if (hasTypeExport("ModuleHooks")) {
     moduleImports.push("ModuleHooks");
     schemaShims.push("  interface NuxtHooks extends ModuleHooks {}");
   }
-  if (hasTypeExport("RuntimeModuleHooks") || hasTypeExport("ModuleRuntimeHooks")) {
+  if (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");
     }
@@ -154,12 +222,12 @@ ${schemaShims.length ? `declare module 'nuxt/schema' {
 ${schemaShims.join("\n")}
 }
 ` : ""}
-
-export type { ${typeExports[0].names.join(", ")} } from './module'
+${typeExports[0] ? `
+export type { ${typeExports[0].names.join(", ")} } from './module'` : ""}
 `;
   await promises.writeFile(dtsFile, dtsContents, "utf8");
   if (!existsSync(dtsFileMts)) {
-    await promises.writeFile(dtsFileMts, dtsContents.replaceAll("./module", "./module.js"), "utf8");
+    await promises.writeFile(dtsFileMts, dtsContents.replace(/\.\/module/g, "./module.js"), "utf8");
   }
 }
 async function writeCJSStub(distDir) {
@@ -175,5 +243,19 @@ module.exports.getMeta = () => Promise.resolve(_meta)
 `;
   await promises.writeFile(cjsStubFile, cjsStub, "utf8");
 }
+async function loadTSCompilerOptions(path) {
+  const config = await parse(path);
+  const resolvedCompilerOptions = config?.tsconfig.compilerOptions || {};
+  for (const { tsconfig, tsconfigFile } of config.extended || []) {
+    for (const alias in tsconfig.compilerOptions?.paths || {}) {
+      resolvedCompilerOptions.paths[alias] = resolvedCompilerOptions.paths[alias].map((p) => {
+        if (!/^\.{1,2}(?:\/|$)/.test(p))
+          return p;
+        return resolve(dirname(tsconfigFile), p);
+      });
+    }
+  }
+  return resolvedCompilerOptions;
+}
 
 export { build as default };

package/dist/cli.mjs

@@ -1,12 +1,9 @@
 #!/usr/bin/env node
 import { defineCommand, runMain } from 'citty';
 import { consola } from 'consola';
+import { n as name, d as description, v as version } from './shared/module-builder.4be2741e.mjs';
 
-const name = "@nuxt/module-builder";
-const version = "0.5.5";
-const description = "Complete solution for building Nuxt modules";
-
-const _rDefault = (r) => r.default || r;
+const _rDefault = (r) => r && typeof r === "object" && "default" in r ? r.default : r;
 const main = defineCommand({
   meta: {
     name,
@@ -19,7 +16,7 @@ const main = defineCommand({
   },
   setup(context) {
     const firstArg = context.rawArgs[0];
-    if (context.cmd.subCommands && !(firstArg in context.cmd.subCommands)) {
+    if (context.cmd.subCommands && !(firstArg && 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/dist/index.mjs

@@ -1,8 +1,16 @@
 export { default as build } from './chunks/build.mjs';
 export { default as prepare } from './chunks/prepare.mjs';
-import 'fs';
-import 'url';
+import 'node:fs';
+import 'node:url';
 import 'pathe';
+import 'pathe/utils';
+import 'pkg-types';
+import 'tsconfck';
+import 'defu';
+import 'magic-regexp';
 import 'consola';
 import 'mlly';
+import 'untyped';
 import 'citty';
+import '@nuxt/kit';
+import './shared/module-builder.4be2741e.mjs';

package/dist/shared/module-builder.4be2741e.mjs

@@ -0,0 +1,5 @@
+const name = "@nuxt/module-builder";
+const version = "0.7.0";
+const description = "Complete solution for building Nuxt modules";
+
+export { description as d, name as n, version as v };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/module-builder",
-  "version": "0.5.5",
+  "version": "0.7.0",
   "repository": "nuxt/module-builder",
   "description": "Complete solution for building Nuxt modules",
   "license": "MIT",
@@ -19,38 +19,51 @@
   "files": [
     "dist"
   ],
-  "packageManager": "pnpm@8.12.1",
   "dependencies": {
-    "citty": "^0.1.5",
+    "citty": "^0.1.6",
     "consola": "^3.2.3",
-    "mlly": "^1.4.2",
-    "pathe": "^1.1.1",
-    "unbuild": "^2.0.0"
+    "defu": "^6.1.4",
+    "magic-regexp": "^0.8.0",
+    "mlly": "^1.7.0",
+    "pathe": "^1.1.2",
+    "pkg-types": "^1.1.1",
+    "tsconfck": "^3.0.3",
+    "unbuild": "^2.0.0",
+    "untyped": "^1.4.2"
   },
   "peerDependencies": {
-    "@nuxt/kit": "^3.8.2",
-    "nuxi": "^3.10.0"
+    "@nuxt/kit": "^3.11.2",
+    "nuxi": "^3.11.1"
   },
   "devDependencies": {
-    "@nuxt/kit": "^3.8.2",
-    "@nuxt/schema": "^3.8.2",
-    "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@types/node": "^20.10.5",
-    "@vitest/coverage-v8": "^1.1.0",
+    "@nuxt/eslint-config": "^0.3.13",
+    "@nuxt/kit": "^3.11.2",
+    "@nuxt/schema": "^3.11.2",
+    "@types/node": "^20.12.12",
+    "@vitest/coverage-v8": "^1.6.0",
     "changelogen": "^0.5.5",
-    "eslint": "^8.56.0",
+    "eslint": "^9.3.0",
     "jiti": "^1.21.0",
-    "nuxi": "^3.10.0",
-    "nuxt": "^3.8.2",
-    "vitest": "^1.1.0"
+    "nuxi": "^3.11.1",
+    "nuxt": "^3.11.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0",
+    "vue": "^3.4.27",
+    "vue-tsc": "^2.0.19"
+  },
+  "resolutions": {
+    "@nuxt/kit": "^3.11.2",
+    "@nuxt/schema": "^3.11.2",
+    "vue": "^3.4.27"
   },
   "scripts": {
     "build": "unbuild",
+    "dev:prepare": "pnpm -r dev:prepare",
     "example:build": "pnpm nuxt-module-build build ./example",
-    "lint": "eslint --ext .ts,.js,.mjs .",
+    "lint": "eslint .",
     "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:types": "tsc --noEmit && pnpm -r test:types"
+    "test:types": "vue-tsc --noEmit && pnpm -r test:types"
   }
 }