@sentry/wizard 3.34.1 → 3.34.3

package/src/nextjs/nextjs-wizard.ts

@@ -44,6 +44,7 @@ import {
   getSentryExamplePageContents,
   getSimpleUnderscoreErrorCopyPasteSnippet,
   getWithSentryConfigOptionsTemplate,
+  getNextjsConfigMjsTemplate,
 } from './templates';
 import { traceStep, withTelemetry } from '../telemetry';
 import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
@@ -90,10 +91,11 @@ export async function runNextjsWizardWithTelemetry(
   );
   Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
 
-  await installPackage({
-    packageName: '@sentry/nextjs@^8',
-    alreadyInstalled: !!packageJson?.dependencies?.['@sentry/nextjs'],
-  });
+  const { packageManager: packageManagerFromInstallStep } =
+    await installPackage({
+      packageName: '@sentry/nextjs@^8',
+      alreadyInstalled: !!packageJson?.dependencies?.['@sentry/nextjs'],
+    });
 
   await traceStep('configure-sdk', async () => {
     const tunnelRoute = await askShouldSetTunnelRoute();
@@ -195,7 +197,7 @@ export async function runNextjsWizardWithTelemetry(
 
       const shouldContinue = await abortIfCancelled(
         clack.confirm({
-          message: `Did add the code to your ${chalk.cyan(
+          message: `Did you add the code to your ${chalk.cyan(
             path.join(...pagesLocation, underscoreErrorPageFile),
           )} file as described above?`,
           active: 'Yes',
@@ -277,7 +279,7 @@ export async function runNextjsWizardWithTelemetry(
 
       const shouldContinue = await abortIfCancelled(
         clack.confirm({
-          message: `Did add the code to your ${chalk.cyan(
+          message: `Did you add the code to your ${chalk.cyan(
             path.join(...appDirLocation, globalErrorPageFile),
           )} file as described above?`,
           active: 'Yes',
@@ -331,14 +333,15 @@ export async function runNextjsWizardWithTelemetry(
     await traceStep('configure-ci', () => configureCI('nextjs', authToken));
   }
 
-  const pacMan = await getPackageManager();
+  const packageManagerForOutro =
+    packageManagerFromInstallStep ?? (await getPackageManager());
   await runPrettierIfInstalled();
 
   clack.outro(`
 ${chalk.green('Successfully installed the Sentry Next.js SDK!')} ${
     shouldCreateExamplePage
       ? `\n\nYou can validate your setup by (re)starting your dev environment (e.g. ${chalk.cyan(
-          `${pacMan.runScriptCommand} dev`,
+          `${packageManagerForOutro.runScriptCommand} dev`,
         )}) and visiting ${chalk.cyan('"/sentry-example-page"')}`
       : ''
   }${
@@ -562,15 +565,39 @@ async function createOrMergeNextJsFiles(
     if (!foundNextConfigFile) {
       Sentry.setTag('next-config-strategy', 'create');
 
+      // Try to figure out whether the user prefers ESM
+      let isTypeModule = false;
+      try {
+        const packageJsonText = await fs.promises.readFile(
+          path.join(process.cwd(), 'package.json'),
+          'utf8',
+        );
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const packageJson = JSON.parse(packageJsonText);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        if (packageJson.type === 'module') {
+          isTypeModule = true;
+        }
+      } catch {
+        // noop
+      }
+
+      // We are creating `next.config.(m)js` files by default as they are supported by the most Next.js versions
+      const configFilename = isTypeModule
+        ? nextConfigPossibleFilesMap.mjs
+        : nextConfigPossibleFilesMap.js;
+      const configContent = isTypeModule
+        ? getNextjsConfigMjsTemplate(withSentryConfigOptionsTemplate)
+        : getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate);
+
       await fs.promises.writeFile(
-        // We are creating a `next.config.js` file by default as it is supported by the most Next.js versions
-        path.join(process.cwd(), nextConfigPossibleFilesMap.js),
-        getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate),
+        path.join(process.cwd(), configFilename),
+        configContent,
         { encoding: 'utf8', flag: 'w' },
       );
 
       clack.log.success(
-        `Created ${chalk.cyan('next.config.js')} with Sentry configuration.`,
+        `Created ${chalk.cyan(configFilename)} with Sentry configuration.`,
       );
 
       return;

package/src/nextjs/templates.ts

@@ -81,6 +81,21 @@ module.exports = withSentryConfig(
 `;
 }
 
+export function getNextjsConfigMjsTemplate(
+  withSentryConfigOptionsTemplate: string,
+): string {
+  return `import { withSentryConfig } from "@sentry/nextjs";
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default withSentryConfig(
+  nextConfig,
+  ${withSentryConfigOptionsTemplate}
+);
+`;
+}
+
 export function getNextjsConfigCjsAppendix(
   withSentryConfigOptionsTemplate: string,
 ): string {

package/src/utils/clack-utils.ts

@@ -358,7 +358,7 @@ export async function installPackage({
   packageName: string;
   alreadyInstalled: boolean;
   askBeforeUpdating?: boolean;
-}): Promise<void> {
+}): Promise<{ packageManager?: PackageManager }> {
   return traceStep('install-package', async () => {
     if (alreadyInstalled && askBeforeUpdating) {
       const shouldUpdatePackage = await abortIfCancelled(
@@ -370,7 +370,7 @@ export async function installPackage({
       );
 
       if (!shouldUpdatePackage) {
-        return;
+        return {};
       }
     }
 
@@ -428,6 +428,8 @@ export async function installPackage({
         packageName,
       )} with ${chalk.bold(packageManager.label)}.`,
     );
+
+    return { packageManager };
   });
 }