feat: Try running Prettier on exit

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - ref(nextjs): Adjust dev server command in verification message (#665)
 - feat(remix): Add feature selection (#646)
+- feat: Try running Prettier on exit (#644)
 - fix(remix): Don't create `.sentrclirc` if project uses Vite (#667)
 
 ## 3.28.0

src/nextjs/nextjs-wizard.ts

@@ -24,6 +24,7 @@ import {
   installPackage,
   isUsingTypeScript,
   printWelcome,
+  runPrettierIfInstalled,
   showCopyPasteInstructions,
 } from '../utils/clack-utils';
 import type { SentryProjectData, WizardOptions } from '../utils/types';
@@ -330,10 +331,10 @@ export async function runNextjsWizardWithTelemetry(
   }
 
   const pacMan = await getPackageManager();
+  await runPrettierIfInstalled();
 
-  clack.outro(`${chalk.green(
-    'Successfully installed the Sentry Next.js SDK!',
-  )}${
+  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`,

src/react-native/react-native-wizard.ts

@@ -16,6 +16,7 @@ import {
   installPackage,
   printWelcome,
   propertiesCliSetupConfig,
+  runPrettierIfInstalled,
 } from '../utils/clack-utils';
 import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
 import { podInstall } from '../apple/cocoapod';
@@ -212,11 +213,14 @@ Or setup using ${chalk.cyan(
     await traceStep('patch-android-files', () => patchAndroidFiles(cliConfig));
   }
 
+  await runPrettierIfInstalled();
+
   const confirmedFirstException = await confirmFirstSentryException(
     sentryUrl,
     orgSlug,
     projectId,
   );
+
   Sentry.setTag('user-confirmed-first-error', confirmedFirstException);
 
   if (confirmedFirstException) {

src/remix/remix-wizard.ts

@@ -14,6 +14,7 @@ import {
   isUsingTypeScript,
   printWelcome,
   rcCliSetupConfig,
+  runPrettierIfInstalled,
 } from '../utils/clack-utils';
 import { hasPackageInstalled } from '../utils/package-json';
 import type { WizardOptions } from '../utils/types';
@@ -239,6 +240,8 @@ async function runRemixWizardWithTelemetry(
     });
   }
 
+  await runPrettierIfInstalled();
+
   clack.outro(`
 ${chalk.green(
   'Sentry has been successfully configured for your Remix project.',

src/sveltekit/sveltekit-wizard.ts

@@ -15,6 +15,7 @@ import {
   getPackageDotJson,
   installPackage,
   printWelcome,
+  runPrettierIfInstalled,
 } from '../utils/clack-utils';
 import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
 import type { WizardOptions } from '../utils/types';
@@ -163,6 +164,8 @@ export async function runSvelteKitWizardWithTelemetry(
     }
   }
 
+  await runPrettierIfInstalled();
+
   clack.outro(buildOutroMessage(shouldCreateExamplePage));
 }
 

src/utils/clack-utils.ts

@@ -670,6 +670,52 @@ async function addCliConfigFileToGitIgnore(filename: string): Promise<void> {
   }
 }
 
+export async function runPrettierIfInstalled(): Promise<void> {
+  return traceStep('run-prettier', async () => {
+    const packageJson = await getPackageDotJson();
+    const prettierInstalled = hasPackageInstalled('prettier', packageJson);
+
+    if (prettierInstalled) {
+      // prompt the user if they want to run prettier
+      const shouldRunPrettier = await abortIfCancelled(
+        clack.confirm({
+          message:
+            'Looks like you have Prettier in your project. Do you want to run it on your files?',
+        }),
+      );
+
+      if (!shouldRunPrettier) {
+        return;
+      }
+    } else {
+      return;
+    }
+
+    const prettierSpinner = clack.spinner();
+    prettierSpinner.start('Running Prettier on your files.');
+
+    try {
+      await new Promise<void>((resolve, reject) => {
+        childProcess.exec('npx prettier --write .', (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve();
+          }
+        });
+      });
+    } catch {
+      prettierSpinner.stop('Prettier failed to run.');
+      clack.log.error(
+        'Prettier failed to run. There may be formatting issues in your updated files.',
+      );
+      return;
+    }
+
+    prettierSpinner.stop('Prettier has formatted your files.');
+  });
+}
+
 /**
  * Checks if @param packageId is listed as a dependency in @param packageJson.
  * If not, it will ask users if they want to continue without the package.