feat: Add option to NextJS for creating sentry rules LLM file

src/nextjs/nextjs-wizard.ts

@@ -51,6 +51,7 @@
   getSimpleUnderscoreErrorCopyPasteSnippet,
   getWithSentryConfigOptionsTemplate,
   getInstrumentationClientHookCopyPasteSnippet,
+  getAiRulesFileContent,
 } from './templates';
 import { getNextJsVersionBucket } from './utils';
 
@@ -122,12 +123,12 @@
 
     const pagesLocation =
       fs.existsSync(maybePagesDirPath) &&
-      fs.lstatSync(maybePagesDirPath).isDirectory()
+        fs.lstatSync(maybePagesDirPath).isDirectory()
         ? ['pages']
         : fs.existsSync(maybeSrcPagesDirPath) &&
           fs.lstatSync(maybeSrcPagesDirPath).isDirectory()
-        ? ['src', 'pages']
-        : undefined;
+          ? ['src', 'pages']
+          : undefined;
 
     if (!pagesLocation) {
       return;
@@ -138,12 +139,12 @@
     )
       ? '_error.tsx'
       : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.ts'))
-      ? '_error.ts'
-      : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.jsx'))
-      ? '_error.jsx'
-      : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.js'))
-      ? '_error.js'
-      : undefined;
+        ? '_error.ts'
+        : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.jsx'))
+          ? '_error.jsx'
+          : fs.existsSync(path.join(process.cwd(), ...pagesLocation, '_error.js'))
+            ? '_error.js'
+            : undefined;
 
     if (!underscoreErrorPageFile) {
       await fs.promises.writeFile(
@@ -198,7 +199,7 @@
       console.log(
         getFullUnderscoreErrorCopyPasteSnippet(
           underscoreErrorPageFile === '_error.ts' ||
-            underscoreErrorPageFile === '_error.tsx',
+          underscoreErrorPageFile === '_error.tsx',
         ),
       );
 
@@ -224,12 +225,12 @@
 
     const appDirLocation =
       fs.existsSync(maybeAppDirPath) &&
-      fs.lstatSync(maybeAppDirPath).isDirectory()
+        fs.lstatSync(maybeAppDirPath).isDirectory()
         ? ['app']
         : fs.existsSync(maybeSrcAppDirPath) &&
           fs.lstatSync(maybeSrcAppDirPath).isDirectory()
-        ? ['src', 'app']
-        : undefined;
+          ? ['src', 'app']
+          : undefined;
 
     if (!appDirLocation) {
       return;
@@ -240,23 +241,22 @@
     )
       ? 'global-error.tsx'
       : fs.existsSync(
-          path.join(process.cwd(), ...appDirLocation, 'global-error.ts'),
-        )
-      ? 'global-error.ts'
-      : fs.existsSync(
+        path.join(process.cwd(), ...appDirLocation, 'global-error.ts'),
+      )
+        ? 'global-error.ts'
+        : fs.existsSync(
           path.join(process.cwd(), ...appDirLocation, 'global-error.jsx'),
         )
-      ? 'global-error.jsx'
-      : fs.existsSync(
-          path.join(process.cwd(), ...appDirLocation, 'global-error.js'),
-        )
-      ? 'global-error.js'
-      : undefined;
+          ? 'global-error.jsx'
+          : fs.existsSync(
+            path.join(process.cwd(), ...appDirLocation, 'global-error.js'),
+          )
+            ? 'global-error.js'
+            : undefined;
 
     if (!globalErrorPageFile) {
-      const newGlobalErrorFileName = `global-error.${
-        typeScriptDetected ? 'tsx' : 'jsx'
-      }`;
+      const newGlobalErrorFileName = `global-error.${typeScriptDetected ? 'tsx' : 'jsx'
+        }`;
 
       await fs.promises.writeFile(
         path.join(process.cwd(), ...appDirLocation, newGlobalErrorFileName),
@@ -280,7 +280,7 @@
       console.log(
         getGlobalErrorCopyPasteSnippet(
           globalErrorPageFile === 'global-error.ts' ||
-            globalErrorPageFile === 'global-error.tsx',
+          globalErrorPageFile === 'global-error.tsx',
         ),
       );
 
@@ -344,24 +344,57 @@
   const packageManagerForOutro =
     packageManagerFromInstallStep ?? (await getPackageManager());
 
+  await traceStep('create-ai-rules-file', async () => {
+    const shouldCreateAiRulesFile = await askShouldCreateAiRulesFile();
+    if (shouldCreateAiRulesFile) {
+      try {
+        const rulesDir = path.join(process.cwd(), '.rules');
+        const rulesDirExists = fs.existsSync(rulesDir);
+
+        // Create .rules directory if it doesn't exist
+        if (!rulesDirExists) {
+          await fs.promises.mkdir(rulesDir, { recursive: true });
+        }
+
+        const aiRulesContent = getAiRulesFileContent();
+        await fs.promises.writeFile(
+          path.join(rulesDir, 'sentryrules.md'),
+          aiRulesContent,
+          { encoding: 'utf8', flag: 'w' },
+        );
+
+        clack.log.success(
+          `Created ${chalk.cyan('sentryrules.md')} in ${chalk.cyan('.rules')} directory.`,
+        );
+      } catch (error) {
+        clack.log.error(
+          `Failed to create ${chalk.cyan(
+            'sentryrules.md',
+          )} in ${chalk.cyan('.rules')} directory. Please create it manually.`,
+        );
+        Sentry.captureException(error);
+      }
+    } else {
+      clack.log.info('Skipped creating sentryrules.md.');
+    }
+  });
+
   await runPrettierIfInstalled({ cwd: undefined });
 
   clack.outro(`
-${chalk.green('Successfully installed the Sentry Next.js SDK!')} ${
-    shouldCreateExamplePage
+${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(
-          `${packageManagerForOutro.runScriptCommand} dev`,
-        )}) and visiting ${chalk.cyan('"/sentry-example-page"')}`
+        `${packageManagerForOutro.runScriptCommand} dev`,
+      )}) and visiting ${chalk.cyan('"/sentry-example-page"')}`
       : ''
-  }${
-    shouldCreateExamplePage && isLikelyUsingTurbopack
+    }${shouldCreateExamplePage && isLikelyUsingTurbopack
       ? `\nDon't forget to remove \`--turbo\` or \`--turbopack\` from your dev command until you have verified the SDK is working. You can safely add it back afterwards.`
       : ''
-  }
+    }
 
 ${chalk.dim(
-  'If you encounter any issues, let us know here: https://github.com/getsentry/sentry-javascript/issues',
-)}`);
+      'If you encounter any issues, let us know here: https://github.com/getsentry/sentry-javascript/issues',
+    )}`);
 }
 
 type SDKConfigOptions = {
@@ -503,9 +536,8 @@
       }
     }
 
-    const newInstrumentationFileName = `instrumentation.${
-      typeScriptDetected ? 'ts' : 'js'
-    }`;
+    const newInstrumentationFileName = `instrumentation.${typeScriptDetected ? 'ts' : 'js'
+      }`;
 
     if (instrumentationHookLocation === 'does-not-exist') {
       let newInstrumentationHookLocation: 'root' | 'src';
@@ -542,8 +574,8 @@
           srcInstrumentationTsExists || instrumentationTsExists
             ? 'instrumentation.ts'
             : srcInstrumentationJsExists || instrumentationJsExists
-            ? 'instrumentation.js'
-            : newInstrumentationFileName,
+              ? 'instrumentation.js'
+              : newInstrumentationFileName,
         codeSnippet: getInstrumentationHookCopyPasteSnippet(
           instrumentationHookLocation,
         ),
@@ -595,9 +627,8 @@
       }
     }
 
-    const newInstrumentationClientFileName = `instrumentation-client.${
-      typeScriptDetected ? 'ts' : 'js'
-    }`;
+    const newInstrumentationClientFileName = `instrumentation-client.${typeScriptDetected ? 'ts' : 'js'
+      }`;
 
     if (instrumentationClientHookLocation === 'does-not-exist') {
       let newInstrumentationClientHookLocation: 'root' | 'src';
@@ -638,8 +669,8 @@
           srcInstrumentationClientTsExists || instrumentationClientTsExists
             ? 'instrumentation-client.ts'
             : srcInstrumentationClientJsExists || instrumentationClientJsExists
-            ? 'instrumentation-client.js'
-            : newInstrumentationClientFileName,
+              ? 'instrumentation-client.js'
+              : newInstrumentationClientFileName,
         codeSnippet: getInstrumentationClientHookCopyPasteSnippet(
           selectedProject.keys[0].dsn.public,
           selectedFeatures,
@@ -887,14 +918,14 @@
   const appFolderLocation = hasRootAppDirectory
     ? ['app']
     : hasSrcAppDirectory
-    ? ['src', 'app']
-    : undefined;
+      ? ['src', 'app']
+      : undefined;
 
   let pagesFolderLocation = hasRootPagesDirectory
     ? ['pages']
     : hasSrcPagesDirectory
-    ? ['src', 'pages']
-    : undefined;
+      ? ['src', 'pages']
+      : undefined;
 
   // If the user has neither pages nor app directory we create a pages folder for them
   if (!appFolderLocation && !pagesFolderLocation) {
@@ -918,9 +949,8 @@
     if (!hasRootLayout) {
       // In case no root layout file exists, we create a simple one so that
       // the example page can be rendered correctly.
-      const newRootLayoutFilename = `layout.${
-        typeScriptDetected ? 'tsx' : 'jsx'
-      }`;
+      const newRootLayoutFilename = `layout.${typeScriptDetected ? 'tsx' : 'jsx'
+        }`;
 
       await fs.promises.writeFile(
         path.join(appFolderPath, newRootLayoutFilename),
@@ -1071,6 +1101,39 @@
   });
 }
 
+/**
+ * Ask users if they want to create a .sentryrules file with AI rule examples for Sentry.
+ * This is useful for giving the LLM context on common actions in Sentry like custom spans,
+ * logging, and error / exception handling. 
+ */
+
+async function askShouldCreateAiRulesFile(): Promise<boolean> {
+  return await traceStep('ask-create-ai-rules-file', async (span) => {
+    const shouldCreateAiRulesFile = await abortIfCancelled(
+      clack.select({
+        message: 'Do you want to create a .sentryrules file with AI rule examples for Sentry?',
+        options: [
+          {
+            label: 'Yes',
+            value: true,
+            hint: 'Creates .sentryrules in your project root',
+          },
+          {
+            label: 'No',
+            value: false,
+          },
+        ],
+        initialValue: true,
+      }),
+    );
+
+    span?.setAttribute('shouldCreateAiRulesFile', shouldCreateAiRulesFile);
+    Sentry.setTag('shouldCreateAiRulesFile', shouldCreateAiRulesFile);
+
+    return shouldCreateAiRulesFile;
+  });
+}
+
 /**
  * Returns true or false depending on whether we think the user is using Turbopack. May return null in case we aren't sure.
  */