@nuxt/module-builder 0.6.0 → 0.7.1

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"
     }
@@ -130,7 +131,7 @@ Module builder generates dist files in `dist/` directory:
 - `module.cjs`: ESM proxy to allow require module in CommonJS context
 - `types.d.ts`: Exported types in addition to shims for `nuxt.config` auto completion.
 - `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
+  - Javascript and `.ts` files will be transformed to `.js` 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 is
 

package/dist/chunks/build.mjs

@@ -1,12 +1,17 @@
 import { promises, existsSync } from 'node:fs';
 import { pathToFileURL } from 'node:url';
-import { resolve, dirname } from 'pathe';
-import { readPackageJSON, readTSConfig } from 'pkg-types';
+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 { n as name, v as version } from '../shared/module-builder.342fba3e.mjs';
+import { loadNuxt } from '@nuxt/kit';
+import { n as name, v as version } from '../shared/module-builder.832f08b1.mjs';
 
 const build = defineCommand({
   meta: {
@@ -47,7 +52,8 @@ const build = defineCommand({
         {
           input: "src/runtime/",
           outDir: `${outDir}/runtime`,
-          ext: "mjs",
+          addRelativeDeclarationExtensions: true,
+          ext: "js",
           esbuild: {
             jsxImportSource: "vue",
             jsx: "automatic",
@@ -63,7 +69,7 @@ const build = defineCommand({
         cjsBridge: true
       },
       externals: [
-        /src\/runtime/,
+        /dist\/runtime\//,
         "@nuxt/schema",
         "@nuxt/schema-nightly",
         "@nuxt/schema-edge",
@@ -78,9 +84,38 @@ const build = defineCommand({
         "vue-demi"
       ],
       hooks: {
-        async "mkdist:entry:options"(_ctx, _entry, options) {
+        async "mkdist:entry:options"(_ctx, entry, options) {
           options.typescript = defu(options.typescript, {
-            compilerOptions: await loadTSCompilerOptions(cwd)
+            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) {
@@ -109,13 +144,23 @@ const build = defineCommand({
           };
           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)) {
@@ -126,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, "")
     )
   );
@@ -134,11 +179,16 @@ async function writeTypes(distDir, meta) {
   const appShims = [];
   const schemaShims = [];
   const moduleImports = [];
+  const moduleDeclarations = [];
   const hasTypeExport = (name2) => isStub || typeExports.find((exp) => exp.names.includes(name2));
-  if (meta.configKey && hasTypeExport("ModuleOptions")) {
-    moduleImports.push("ModuleOptions");
+  if (meta.configKey) {
     schemaShims.push(`  interface NuxtConfig { ['${meta.configKey}']?: Partial<ModuleOptions> }`);
     schemaShims.push(`  interface NuxtOptions { ['${meta.configKey}']?: ModuleOptions }`);
+    if (hasTypeExport("ModuleOptions")) {
+      moduleImports.push("ModuleOptions");
+    } else {
+      moduleDeclarations.push(`  ${generateTypes(await resolveSchema(await getOptions()), { interfaceName: "ModuleOptions" })}`);
+    }
   }
   if (hasTypeExport("ModuleHooks")) {
     moduleImports.push("ModuleHooks");
@@ -163,6 +213,7 @@ async function writeTypes(distDir, meta) {
   const dtsContents = `
 import type { ${moduleImports.join(", ")} } from './module'
 
+${moduleDeclarations.join("\n")}
 ${appShims.length ? `declare module '#app' {
 ${appShims.join("\n")}
 }
@@ -197,20 +248,18 @@ module.exports.getMeta = () => Promise.resolve(_meta)
   await promises.writeFile(cjsStubFile, cjsStub, "utf8");
 }
 async function loadTSCompilerOptions(path) {
-  const config = await readTSConfig(path).catch(() => {
-  });
-  if (!config)
-    return [];
-  config.compilerOptions || (config.compilerOptions = {});
-  for (const alias in config.compilerOptions.paths || {}) {
-    config.compilerOptions.paths[alias] = config.compilerOptions.paths[alias].map((p) => {
-      if (!/^\.{1,2}(\/|$)/.test(p))
-        return p;
-      return resolve(path, p);
-    });
+  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);
+      });
+    }
   }
-  const files = Array.isArray(config.extends) ? config.extends : config.extends ? [config.extends] : [];
-  return defu(config.compilerOptions, ...await Promise.all(files.map((file) => loadTSCompilerOptions(dirname(resolve(path, file))))));
+  return resolvedCompilerOptions;
 }
 
 export { build as default };

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/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.342fba3e.mjs';
+import { n as name, d as description, v as version } from './shared/module-builder.832f08b1.mjs';
 
 const _rDefault = (r) => r && typeof r === "object" && "default" in r ? r.default : r;
 const main = defineCommand({

package/dist/index.mjs

@@ -3,9 +3,14 @@ export { default as prepare } from './chunks/prepare.mjs';
 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 './shared/module-builder.342fba3e.mjs';
+import '@nuxt/kit';
+import './shared/module-builder.832f08b1.mjs';

package/dist/shared/{module-builder.342fba3e.mjs → module-builder.832f08b1.mjs}

@@ -1,5 +1,5 @@
 const name = "@nuxt/module-builder";
-const version = "0.6.0";
+const version = "0.7.1";
 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.6.0",
+  "version": "0.7.1",
   "repository": "nuxt/module-builder",
   "description": "Complete solution for building Nuxt modules",
   "license": "MIT",
@@ -19,50 +19,51 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "dev:prepare": "pnpm -r dev:prepare",
-    "example:build": "pnpm nuxt-module-build build ./example",
-    "lint": "eslint .",
-    "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:types": "vue-tsc --noEmit && pnpm -r test:types"
-  },
-  "packageManager": "pnpm@9.0.6",
   "dependencies": {
     "citty": "^0.1.6",
     "consola": "^3.2.3",
     "defu": "^6.1.4",
-    "mlly": "^1.6.1",
+    "magic-regexp": "^0.8.0",
+    "mlly": "^1.7.1",
     "pathe": "^1.1.2",
-    "pkg-types": "^1.1.0",
-    "unbuild": "^2.0.0"
+    "pkg-types": "^1.1.1",
+    "tsconfck": "^3.1.0",
+    "unbuild": "^2.0.0",
+    "untyped": "^1.4.2"
   },
   "peerDependencies": {
-    "@nuxt/kit": "^3.11.2",
-    "nuxi": "^3.11.1"
+    "@nuxt/kit": "^3.12.1",
+    "nuxi": "^3.12.0"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.3.10",
-    "@nuxt/kit": "^3.11.2",
-    "@nuxt/schema": "^3.11.2",
-    "@types/node": "^20.12.7",
-    "@vitest/coverage-v8": "^1.5.2",
+    "@nuxt/eslint-config": "^0.3.13",
+    "@nuxt/kit": "^3.12.1",
+    "@nuxt/schema": "^3.12.1",
+    "@types/node": "^20.14.2",
+    "@vitest/coverage-v8": "^1.6.0",
     "changelogen": "^0.5.5",
-    "eslint": "^9.1.1",
-    "jiti": "^1.21.0",
-    "nuxi": "^3.11.1",
-    "nuxt": "^3.11.2",
+    "eslint": "^9.4.0",
+    "jiti": "^1.21.6",
+    "nuxi": "^3.12.0",
+    "nuxt": "^3.12.1",
     "typescript": "^5.4.5",
-    "vitest": "^1.5.2",
-    "vue": "^3.4.25",
-    "vue-tsc": "^2.0.14"
+    "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.25"
+    "@nuxt/kit": "^3.12.1",
+    "@nuxt/schema": "^3.12.1",
+    "vue": "^3.4.27"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev:prepare": "pnpm -r dev:prepare",
+    "example:build": "pnpm nuxt-module-build build ./example",
+    "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": "vue-tsc --noEmit && pnpm -r test:types"
   }
-}
+}