@nuxt/module-builder 0.8.4 → 1.0.0-alpha.1

package/README.md

@@ -111,7 +111,7 @@ A minimum `package.json` should look like this:
     "dist"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build"
+    "prepack": "nuxt-module-build build"
   },
   "dependencies": {
     "@nuxt/kit": "npm:@nuxt/kit-edge@latest"
@@ -122,6 +122,20 @@ A minimum `package.json` should look like this:
 }
 ```
 
+### `build.config.ts` (optional)
+
+Module builder is essentially a preset for [unjs/unbuild](https://github.com/unjs/unbuild), check out the [build command](./src/commands/build.ts#L51) for reference.
+
+To customize/extend the unbuild configuration you can add a `build.config.ts` in the root of your project:
+
+```ts
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  // set additional configuration or customize using hooks
+})
+```
+
 ## Dist files
 
 Module builder generates dist files in `dist/` directory:
@@ -151,7 +165,7 @@ Module builder generates dist files in `dist/` directory:
 [npm-version-href]: https://npmjs.com/package/@nuxt/module-builder
 
 [npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-downloads-href]: https://npmjs.com/package/@nuxt/module-builder
+[npm-downloads-href]: https://npm.chart.dev/@nuxt/module-builder
 
 [license-src]: https://img.shields.io/github/license/nuxt/module-builder.svg?style=flat&colorA=18181B&colorB=28CF8D
 [license-href]: https://github.com/nuxt/module-builder/blob/main/LICENSE

package/dist/chunks/build.mjs

@@ -1,15 +1,17 @@
 import { promises, existsSync } from 'node:fs';
 import { pathToFileURL } from 'node:url';
-import { resolve, basename, join, dirname } from 'pathe';
+import { resolve, basename, normalize, join, dirname } from 'pathe';
 import { filename } from 'pathe/utils';
 import { readPackageJSON } from 'pkg-types';
 import { parse } from 'tsconfck';
 import { defu } from 'defu';
+import { createJiti } from 'jiti';
 import { createRegExp, anyOf } from 'magic-regexp';
 import { consola } from 'consola';
 import { resolvePath, findExports } from 'mlly';
 import { defineCommand } from 'citty';
-import { n as name, v as version } from '../shared/module-builder.617a9be8.mjs';
+import { convertCompilerOptionsFromJson } from 'typescript';
+import { n as name, v as version } from '../shared/module-builder.D3Pp640p.mjs';
 
 const build = defineCommand({
   meta: {
@@ -39,9 +41,10 @@ const build = defineCommand({
   async run(context) {
     const { build } = await import('unbuild');
     const cwd = resolve(context.args.cwd || context.args.rootDir || ".");
+    const jiti = createJiti(cwd);
     const outDir = context.args.outDir || "dist";
     await build(cwd, false, {
-      declaration: true,
+      declaration: "node16",
       sourcemap: context.args.sourcemap,
       stub: context.args.stub,
       outDir,
@@ -52,6 +55,13 @@ const build = defineCommand({
           outDir: `${outDir}/runtime`,
           addRelativeDeclarationExtensions: true,
           ext: "js",
+          pattern: [
+            "**",
+            "!**/*.stories.{js,cts,mts,ts,jsx,tsx}",
+            // ignore storybook files
+            "!**/*.{spec,test}.{js,cts,mts,ts,jsx,tsx}"
+            // ignore tests
+          ],
           esbuild: {
             jsxImportSource: "vue",
             jsx: "automatic",
@@ -64,16 +74,18 @@ const build = defineCommand({
           target: "esnext"
         },
         emitCJS: false,
-        cjsBridge: true
+        cjsBridge: false
       },
       externals: [
-        /dist\/runtime\//,
+        /dist[\\/]runtime[\\/]/,
         "@nuxt/schema",
         "@nuxt/schema-nightly",
         "@nuxt/schema-edge",
         "@nuxt/kit",
         "@nuxt/kit-nightly",
         "@nuxt/kit-edge",
+        "#app",
+        "#app/nuxt",
         "nuxt",
         "nuxt-nightly",
         "nuxt-edge",
@@ -88,12 +100,20 @@ const build = defineCommand({
           });
         },
         async "rollup:options"(ctx, options) {
-          options.plugins || (options.plugins = []);
+          const [entry] = ctx.buildEntries;
+          const mergedCompilerOptions = defu({
+            noEmit: false,
+            paths: {
+              "#app/nuxt": ["./node_modules/nuxt/dist/app/nuxt"]
+            }
+          }, ctx.options.rollup.dts.compilerOptions, await loadTSCompilerOptions(entry.path));
+          ctx.options.rollup.dts.compilerOptions = convertCompilerOptionsFromJson(mergedCompilerOptions, entry.path).options;
+          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("/"));
+          const runtimeEntries = ctx.options.entries.filter((entry2) => entry2.builder === "mkdist");
+          const runtimeDirs = runtimeEntries.map((entry2) => basename(entry2.input));
+          const RUNTIME_RE = createRegExp(anyOf(...runtimeDirs).and(anyOf("/", "\\")));
           options.plugins.unshift({
             name: "nuxt-module-builder:runtime-externals",
             async resolveId(id, importer) {
@@ -102,10 +122,11 @@ const build = defineCommand({
               const resolved = await this.resolve(id, importer, { skipSelf: true });
               if (!resolved)
                 return;
-              for (const entry of runtimeEntries) {
-                if (!resolved.id.includes(entry.input))
+              const normalizedId = normalize(resolved.id);
+              for (const entry2 of runtimeEntries) {
+                if (!normalizedId.includes(entry2.input))
                   continue;
-                const distFile = await resolvePath(join(dirname(resolved.id.replace(entry.input, entry.outDir)), filename(resolved.id)));
+                const distFile = await resolvePath(join(dirname(pathToFileURL(normalizedId).href.replace(entry2.input, entry2.outDir)), filename(normalizedId)));
                 if (distFile) {
                   return {
                     external: true,
@@ -117,9 +138,8 @@ const build = defineCommand({
           });
         },
         async "rollup:done"(ctx) {
-          await writeCJSStub(ctx.options.outDir);
           const moduleEntryPath = resolve(ctx.options.outDir, "module.mjs");
-          const moduleFn = await import(pathToFileURL(moduleEntryPath).toString()).then((r) => r.default || r).catch((err) => {
+          const moduleFn = await jiti.import(pathToFileURL(moduleEntryPath).toString(), { default: true }).catch((err) => {
             consola.error(err);
             consola.error("Cannot load module. Please check dist:", moduleEntryPath);
             return null;
@@ -143,20 +163,32 @@ 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, ctx.options.stub);
+        },
+        async "build:done"(ctx) {
+          const logs = [...ctx.warnings].filter((l) => l.startsWith("Potential missing package.json files:"));
+          if (logs.filter((l) => l.match(/\.d\.ts/)).length > 0) {
+            consola.warn(`\`@nuxt/module-builder\` no longer supports Node10 TypeScript module resolution and will no longer generate \`.d.ts\` declaration files. You can update these paths to use the \`.d.mts\` extension instead.`);
+          }
+          if (logs.filter((l) => l.match(/module\.cjs/)).length > 0) {
+            consola.warn(`\`@nuxt/module-builder\` will no longer generate \`module.cjs\` as this is not required for Nuxt v3+. You can safely remove replace this with \`module.mjs\` in your \`package.json\`.`);
+          }
+          const pkg = await readPackageJSON(cwd);
+          if (pkg?.types && !existsSync(resolve(cwd, pkg.types))) {
+            consola.warn(`Please remove the \`types\` field from package.json as it is no longer required for Bundler TypeScript module resolution.`);
+          }
         }
       }
     });
   }
 });
 async function writeTypes(distDir, isStub) {
-  const dtsFile = resolve(distDir, "types.d.ts");
-  const dtsFileMts = resolve(distDir, "types.d.mts");
+  const dtsFile = resolve(distDir, "types.d.mts");
   if (existsSync(dtsFile)) {
     return;
   }
   const moduleReExports = [];
   if (!isStub) {
-    const moduleTypesFile = resolve(distDir, "module.d.ts");
+    const moduleTypesFile = resolve(distDir, "module.d.mts");
     const moduleTypes = await promises.readFile(moduleTypesFile, "utf8").catch(() => "");
     const normalisedModuleTypes = moduleTypes.replace(/export\s*\{.*?\}/gs, (match) => match.replace(/\b(type|interface)\b/g, ""));
     for (const e of findExports(normalisedModuleTypes)) {
@@ -193,7 +225,7 @@ async function writeTypes(distDir, isStub) {
   const dtsContents = `
   ${schemaImports.length ? `import type { ${schemaImports.join(", ")} } from '@nuxt/schema'` : ""}
 
-${moduleImports.length ? `import type { ${moduleImports.join(", ")} } from './module'` : ""}
+${moduleImports.length ? `import type { ${moduleImports.join(", ")} } from './module.mjs'` : ""}
 
 ${appShims.length ? `declare module '#app' {
 ${appShims.join("\n")}
@@ -205,27 +237,11 @@ ${schemaShims.join("\n")}
 ` : ""}
 ${moduleExports.length ? `
 ${moduleExports.join("\n")}` : ""}
-${isStub ? 'export * from "./module"' : ""}
+${isStub ? 'export * from "./module.mjs"' : ""}
 ${moduleReExports[0] ? `
-export { ${moduleReExports[0].names.map((n) => (n === "default" ? "" : "type ") + n).join(", ")} } from './module'` : ""}
+export { ${moduleReExports[0].names.map((n) => (n === "default" ? "" : "type ") + n).join(", ")} } from './module.mjs'` : ""}
 `.trim().replace(/[\n\r]{3,}/g, "\n\n") + "\n";
   await promises.writeFile(dtsFile, dtsContents, "utf8");
-  if (!existsSync(dtsFileMts)) {
-    await promises.writeFile(dtsFileMts, dtsContents.replace(/\.\/module/g, "./module.js"), "utf8");
-  }
-}
-async function writeCJSStub(distDir) {
-  const cjsStubFile = resolve(distDir, "module.cjs");
-  if (existsSync(cjsStubFile)) {
-    return;
-  }
-  const cjsStub = `module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-const _meta = module.exports.meta = require('./module.json')
-module.exports.getMeta = () => Promise.resolve(_meta)
-`;
-  await promises.writeFile(cjsStubFile, cjsStub, "utf8");
 }
 async function loadTSCompilerOptions(path) {
   const config = await parse(path);
@@ -233,8 +249,7 @@ async function loadTSCompilerOptions(path) {
   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;
+        if (!/^\.{1,2}(?:\/|$)/.test(p)) return p;
         return resolve(dirname(tsconfigFile), p);
       });
     }

package/dist/cli.d.mts

@@ -1,2 +1 @@
 
-export {  }

package/dist/cli.d.ts

@@ -1,2 +1 @@
 
-export {  }

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

package/dist/index.mjs

@@ -7,8 +7,10 @@ import 'pathe/utils';
 import 'pkg-types';
 import 'tsconfck';
 import 'defu';
+import 'jiti';
 import 'magic-regexp';
 import 'consola';
 import 'mlly';
 import 'citty';
-import './shared/module-builder.617a9be8.mjs';
+import 'typescript';
+import './shared/module-builder.D3Pp640p.mjs';

package/dist/shared/{module-builder.617a9be8.mjs → module-builder.D3Pp640p.mjs}

@@ -1,5 +1,5 @@
 const name = "@nuxt/module-builder";
-const version = "0.8.4";
+const version = "1.0.0-alpha.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.8.4",
+  "version": "1.0.0-alpha.1",
   "repository": "nuxt/module-builder",
   "description": "Complete solution for building Nuxt modules",
   "license": "MIT",
@@ -21,39 +21,41 @@
   ],
   "dependencies": {
     "citty": "^0.1.6",
-    "consola": "^3.2.3",
+    "consola": "^3.3.3",
     "defu": "^6.1.4",
+    "jiti": "^2.4.2",
     "magic-regexp": "^0.8.0",
-    "mlly": "^1.7.1",
-    "pathe": "^1.1.2",
-    "pkg-types": "^1.2.0",
-    "tsconfck": "^3.1.3",
-    "unbuild": "^2.0.0"
+    "mlly": "^1.7.3",
+    "pathe": "^2.0.0",
+    "pkg-types": "^1.3.0",
+    "tsconfck": "^3.1.4",
+    "unbuild": "^3.2.0"
   },
   "peerDependencies": {
-    "@nuxt/kit": "^3.13.1",
-    "nuxi": "^3.13.1"
+    "nuxi": "^3.18.2",
+    "typescript": "^5.7.2"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.5.6",
-    "@nuxt/kit": "^3.13.1",
-    "@nuxt/schema": "^3.13.1",
-    "@types/node": "^20.16.5",
-    "@vitest/coverage-v8": "^2.0.5",
-    "changelogen": "^0.5.5",
-    "eslint": "^9.10.0",
-    "jiti": "^1.21.6",
-    "nuxi": "^3.13.1",
-    "nuxt": "^3.13.1",
-    "typescript": "^5.6.2",
-    "vitest": "^2.0.5",
-    "vue": "^3.5.4",
-    "vue-tsc": "^2.1.6"
+    "@nuxt/eslint-config": "^0.7.4",
+    "@nuxt/schema": "^3.15.1",
+    "@types/node": "^22.10.5",
+    "@vitest/coverage-v8": "^2.1.8",
+    "changelogen": "^0.5.7",
+    "eslint": "^9.17.0",
+    "nuxi": "^3.18.2",
+    "nuxt": "^3.15.1",
+    "tinyexec": "^0.3.2",
+    "typescript": "~5.7.2",
+    "vitest": "^2.1.8",
+    "vue": "^3.5.13",
+    "vue-tsc": "^2.2.0"
   },
   "resolutions": {
-    "@nuxt/kit": "^3.13.1",
-    "@nuxt/schema": "^3.13.1",
-    "vue": "^3.5.4"
+    "@nuxt/kit": "^3.15.1",
+    "@nuxt/schema": "^3.15.1",
+    "typescript": "^5.7.2",
+    "vue": "^3.5.13",
+    "vue-tsc": "^2.2.0"
   },
   "scripts": {
     "build": "unbuild",
@@ -62,7 +64,7 @@
     "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": "pnpm vitest --coverage",
     "test:types": "vue-tsc --noEmit && pnpm -r test:types"
   }
 }