ref(nuxt): Build the Nuxt module in-house instead of @nuxt/module-builder (#22190)

Replaces `@nuxt/module-builder` with a plain rollup + tsc setup for the
`build/module` output. Rollup bundles the module entry and emits the
runtime files one-to-one (preserveModules), tsc emits the declarations,
and a small script writes `module.cjs`, `module.json` and `types.d.ts`.

The point is to drop a build tool that consumes the TypeScript compiler
API, so the package no longer pins us to a specific TS compiler, also
streamlines nuxt SDK build step for future changes like rolldown.

We still have E2E tests ensuring the module output is consumable by Nuxt
apps, so that's not something I would worry about drifting in the
future.

Stacked on #22186.

Author: logaretm

packages/nuxt/build.config.ts

@@ -33,8 +33,7 @@
     },
     "./module": {
       "types": "./build/module/types.d.ts",
-      "import": "./build/module/module.mjs",
-      "require": "./build/module/module.cjs"
+      "import": "./build/module/module.mjs"
     },
     "./module/plugins": {
       "types": "./build/module/runtime/plugins/index.d.ts",
@@ -66,7 +65,6 @@
     "local-pkg": "^1.1.2"
   },
   "devDependencies": {
-    "@nuxt/module-builder": "^0.8.4",
     "@nuxt/nitro-server": "^3.21.6",
     "nitro": "^3.0.260311-beta",
     "nuxi": "^3.25.1",
@@ -76,7 +74,7 @@
   "scripts": {
     "build": "run-s build:types build:transpile",
     "build:dev": "yarn build",
-    "build:nuxt-module": "bash ./generate-build-stubs.bash && nuxt-module-build build --outDir build/module",
+    "build:nuxt-module": "rollup -c rollup.module.config.mjs && tsc -p tsconfig.module.json && node scripts/build-module-meta.mjs",
     "build:transpile": "rollup -c rollup.npm.config.mjs && yarn build:nuxt-module",
     "build:types": "tsc -p tsconfig.types.json",
     "build:watch": "run-p build:transpile:watch",
@@ -87,7 +85,7 @@
     "clean": "rimraf build coverage sentry-nuxt-*.tgz",
     "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
     "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
-    "lint:es-compatibility": "es-check es2020 ./build/cjs/*.js && es-check es2020 ./build/esm/*.js --module && es-check es2020 ./build/module/*.cjs && es-check es2020 ./build/module/*.mjs --module",
+    "lint:es-compatibility": "es-check es2020 ./build/cjs/*.js && es-check es2020 ./build/esm/*.js --module && es-check es2020 ./build/module/*.mjs --module",
     "test": "yarn test:unit",
     "test:unit": "vitest run",
     "test:watch": "vitest --watch",

packages/nuxt/generate-build-stubs.bash

@@ -0,0 +1,56 @@
+import { readdirSync } from 'node:fs';
+import { join } from 'node:path';
+import esbuild from 'rollup-plugin-esbuild';
+
+// The Nuxt module ships two kinds of output that live side by side in `build/module`:
+//   - `module.mjs`: the module entry, bundled from `src/module.ts`.
+//   - `runtime/**`: the files Nuxt injects into the consuming app, emitted one-to-one
+//     (never bundled) because the app's own build re-processes them.
+// This config replaces `@nuxt/module-builder` so the package builds with plain rollup + tsc
+// and doesn't couple us to a build tool that consumes the TypeScript compiler API.
+
+// Anything that isn't a relative path is provided by the consuming app or Node at runtime
+// (this covers `@sentry/*`, `nuxt/app`, `#imports`, node builtins), so it stays external.
+const isExternal = id => !id.startsWith('.') && !id.startsWith('/') && !id.startsWith('\0');
+
+const transpile = esbuild({
+  target: 'es2020',
+  // Don't read a per-package tsconfig; pin only what affects codegen.
+  tsconfig: false,
+  tsconfigRaw: { compilerOptions: { useDefineForClassFields: false } },
+  sourceMap: false,
+});
+
+function runtimeEntrypoints(dir = 'src/runtime', acc = []) {
+  for (const entry of readdirSync(dir, { withFileTypes: true })) {
+    const full = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      runtimeEntrypoints(full, acc);
+    } else if (entry.name.endsWith('.ts') && !entry.name.endsWith('.d.ts')) {
+      acc.push(full);
+    }
+  }
+
+  return acc;
+}
+
+export default [
+  {
+    input: 'src/module.ts',
+    output: { file: 'build/module/module.mjs', format: 'esm' },
+    external: isExternal,
+    plugins: [transpile],
+  },
+  {
+    input: runtimeEntrypoints(),
+    output: {
+      dir: 'build/module/runtime',
+      format: 'esm',
+      preserveModules: true,
+      preserveModulesRoot: 'src/runtime',
+      entryFileNames: '[name].js',
+    },
+    external: isExternal,
+    plugins: [transpile],
+  },
+];

packages/nuxt/package.json

@@ -0,0 +1,27 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+// Emits the two non-compiled artifacts a Nuxt module needs alongside `module.mjs`,
+// replacing what `@nuxt/module-builder` used to generate:
+//   - `module.json`: module metadata Nuxt reads. Keep the `meta` fields in sync with
+//     `defineNuxtModule({ meta })` in `src/module.ts`.
+//   - `types.d.ts`: the type entry referenced by the `./module` export.
+
+const outDir = 'build/module';
+const { version } = JSON.parse(readFileSync('package.json', 'utf-8'));
+
+writeFileSync(
+  join(outDir, 'module.json'),
+  `${JSON.stringify(
+    {
+      name: '@sentry/nuxt/module',
+      configKey: 'sentry',
+      compatibility: { nuxt: '>=3.7.0' },
+      version,
+    },
+    null,
+    2,
+  )}\n`,
+);
+
+writeFileSync(join(outDir, 'types.d.ts'), "export { type ModuleOptions, default } from './module'\n");

packages/nuxt/rollup.module.config.mjs

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.json",
 
-  "include": ["src/**/*", "build.config.ts"],
+  "include": ["src/**/*"],
 
   "compilerOptions": {
     // package-specific options

packages/nuxt/scripts/build-module-meta.mjs

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/module.ts", "src/runtime/**/*"],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": false,
+    "emitDeclarationOnly": true,
+    "outDir": "build/module",
+    "rootDir": "src"
+  }
+}

packages/nuxt/tsconfig.json

@@ -1,6 +1,5 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["build.config.ts"],
   "compilerOptions": {
     "declaration": true,
     "declarationMap": true,