@sentry/wizard 6.9.0 → 6.10.0

package/dist/src/utils/clack/index.d.ts

@@ -89,6 +89,15 @@ export declare function installPackage({ packageName, alreadyInstalled, askBefor
 }>;
 export declare function addSentryCliConfig({ authToken, org, project, url }: CliSetupConfigContent, setupConfig?: CliSetupConfig): Promise<void>;
 export declare function addDotEnvSentryBuildPluginFile(authToken: string): Promise<void>;
+/**
+ * Runs available formatters (Prettier and/or Biome) on the changed or untracked files in the project.
+ * This function provides a unified interface for running multiple formatters with a single user prompt.
+ *
+ * @param _opts The directory of the project. If undefined, the current process working directory will be used.
+ */
+export declare function runFormatters(_opts: {
+    cwd: string | undefined;
+}): Promise<void>;
 /**
  * Runs prettier on the changed or untracked files in the project.
  *
@@ -97,6 +106,14 @@ export declare function addDotEnvSentryBuildPluginFile(authToken: string): Promi
 export declare function runPrettierIfInstalled(opts: {
     cwd: string | undefined;
 }): Promise<void>;
+/**
+ * Runs Biome on the changed or untracked files in the project.
+ *
+ * @param options.cwd The directory of the project. If undefined, the current process working directory will be used.
+ */
+export declare function runBiomeIfInstalled(opts: {
+    cwd: string | undefined;
+}): Promise<void>;
 /**
  * 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.

package/dist/src/utils/clack/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askToRunBuildOrEnterPathOrProceed = exports.artifactsExist = exports.askShouldAddPackageOverride = exports.askShouldInstallPackage = exports.featureSelectionPrompt = exports.askShouldCreateExampleComponent = exports.askShouldCreateExamplePage = exports.createNewConfigFile = exports.makeCodeSnippet = exports.showCopyPasteInstructions = exports.askForToolConfigPath = exports.askForWizardLogin = exports.getOrAskForProjectData = exports.isUsingTypeScript = exports.getPackageManager = exports.updatePackageDotJson = exports.getPackageDotJson = exports.ensurePackageIsInstalled = exports.runPrettierIfInstalled = exports.addDotEnvSentryBuildPluginFile = exports.addSentryCliConfig = exports.installPackage = exports.confirmContinueIfPackageVersionNotSupported = exports.askForItemSelection = exports.askToInstallSentryCLI = exports.confirmContinueIfNoOrDirtyGitRepo = exports.printWelcome = exports.abortIfCancelled = exports.abort = exports.propertiesCliSetupConfig = exports.rcCliSetupConfig = exports.SENTRY_PROPERTIES_FILE = exports.SENTRY_CLI_RC_FILE = exports.SENTRY_DOT_ENV_FILE = void 0;
+exports.askToRunBuildOrEnterPathOrProceed = exports.artifactsExist = exports.askShouldAddPackageOverride = exports.askShouldInstallPackage = exports.featureSelectionPrompt = exports.askShouldCreateExampleComponent = exports.askShouldCreateExamplePage = exports.createNewConfigFile = exports.makeCodeSnippet = exports.showCopyPasteInstructions = exports.askForToolConfigPath = exports.askForWizardLogin = exports.getOrAskForProjectData = exports.isUsingTypeScript = exports.getPackageManager = exports.updatePackageDotJson = exports.getPackageDotJson = exports.ensurePackageIsInstalled = exports.runBiomeIfInstalled = exports.runPrettierIfInstalled = exports.runFormatters = exports.addDotEnvSentryBuildPluginFile = exports.addSentryCliConfig = exports.installPackage = exports.confirmContinueIfPackageVersionNotSupported = exports.askForItemSelection = exports.askToInstallSentryCLI = exports.confirmContinueIfNoOrDirtyGitRepo = exports.printWelcome = exports.abortIfCancelled = exports.abort = exports.propertiesCliSetupConfig = exports.rcCliSetupConfig = exports.SENTRY_PROPERTIES_FILE = exports.SENTRY_CLI_RC_FILE = exports.SENTRY_DOT_ENV_FILE = void 0;
 const childProcess = __importStar(require("node:child_process"));
 const fs = __importStar(require("node:fs"));
 const node_child_process_1 = require("node:child_process");
@@ -104,17 +104,22 @@ exports.propertiesCliSetupConfig = {
  */
 async function abort(message, status) {
     clack.outro(message ?? 'Wizard setup cancelled.');
-    const sentryHub = Sentry.getCurrentHub();
-    const sentryTransaction = sentryHub.getScope().getTransaction();
+    const activeSpan = Sentry.getActiveSpan();
+    const rootSpan = activeSpan ? Sentry.getRootSpan(activeSpan) : undefined;
     // 'cancelled' doesn't increase the `failureRate()` shown in the Sentry UI
     // 'aborted' increases the failure rate
     // see: https://docs.sentry.io/product/insights/overview/metrics/#failure-rate
-    sentryTransaction?.setStatus(status === 0 ? 'cancelled' : 'aborted');
-    sentryTransaction?.finish();
-    const sentrySession = sentryHub.getScope().getSession();
+    if (rootSpan) {
+        rootSpan.setStatus({
+            code: status === 0 ? 1 : 2,
+            message: status === 0 ? 'cancelled' : 'aborted',
+        });
+        rootSpan.end();
+    }
+    const sentrySession = Sentry.getCurrentScope().getSession();
     if (sentrySession) {
         sentrySession.status = status === 0 ? 'abnormal' : 'crashed';
-        sentryHub.captureSession(true);
+        Sentry.captureSession(true);
     }
     await Sentry.flush(3000).catch(() => {
         // Ignore flush errors during abort
@@ -125,11 +130,13 @@ exports.abort = abort;
 async function abortIfCancelled(input) {
     if (clack.isCancel(await input)) {
         clack.cancel('Wizard setup cancelled.');
-        const sentryHub = Sentry.getCurrentHub();
-        const sentryTransaction = sentryHub.getScope().getTransaction();
-        sentryTransaction?.setStatus('cancelled');
-        sentryTransaction?.finish();
-        sentryHub.captureSession(true);
+        const activeSpan = Sentry.getActiveSpan();
+        const rootSpan = activeSpan ? Sentry.getRootSpan(activeSpan) : undefined;
+        if (rootSpan) {
+            rootSpan.setStatus({ code: 1, message: 'cancelled' });
+            rootSpan.end();
+        }
+        Sentry.captureSession(true);
         await Sentry.flush(3000).catch(() => {
             // Ignore flush errors during abort
         });
@@ -450,6 +457,99 @@ async function addCliConfigFileToGitIgnore(filename) {
         clack.log.error(`Failed adding ${chalk_1.default.cyan(filename)} to ${chalk_1.default.cyan('.gitignore')}. Please add it manually!`);
     }
 }
+/**
+ * Helper function to get the list of changed or untracked files for formatting.
+ * @returns Space-separated string of file paths, or null if not in git repo or no files changed.
+ */
+function getFormatterTargetFiles() {
+    if (!(0, git_1.isInGitRepo)({ cwd: undefined })) {
+        return null;
+    }
+    const changedOrUntrackedFiles = (0, git_1.getUncommittedOrUntrackedFiles)()
+        .map((filename) => {
+        return filename.startsWith('- ') ? filename.slice(2) : filename;
+    })
+        .join(' ');
+    return changedOrUntrackedFiles.length ? changedOrUntrackedFiles : null;
+}
+/**
+ * Runs available formatters (Prettier and/or Biome) on the changed or untracked files in the project.
+ * This function provides a unified interface for running multiple formatters with a single user prompt.
+ *
+ * @param _opts The directory of the project. If undefined, the current process working directory will be used.
+ */
+async function runFormatters(_opts) {
+    return (0, telemetry_1.traceStep)('run-formatters', async () => {
+        const targetFiles = getFormatterTargetFiles();
+        if (!targetFiles) {
+            return;
+        }
+        const packageJson = await getPackageDotJson();
+        const prettierInstalled = (0, package_json_1.hasPackageInstalled)('prettier', packageJson);
+        const biomeInstalled = (0, package_json_1.hasPackageInstalled)('@biomejs/biome', packageJson);
+        Sentry.setTag('prettier-installed', prettierInstalled);
+        Sentry.setTag('biome-installed', biomeInstalled);
+        if (!prettierInstalled && !biomeInstalled) {
+            return;
+        }
+        // Determine prompt message based on what's installed
+        const formattersAvailable = [];
+        if (prettierInstalled)
+            formattersAvailable.push('Prettier');
+        if (biomeInstalled)
+            formattersAvailable.push('Biome');
+        const message = formattersAvailable.length === 1
+            ? `Looks like you have ${formattersAvailable[0]} in your project. Do you want to run it on your files?`
+            : `Looks like you have ${formattersAvailable.join(' and ')} in your project. Do you want to run them on your files?`;
+        const shouldRun = await abortIfCancelled(clack.confirm({ message }));
+        if (!shouldRun) {
+            return;
+        }
+        const spinner = clack.spinner();
+        spinner.start('Running formatters on your files.');
+        try {
+            // Run Prettier first if installed (handles general formatting)
+            if (prettierInstalled) {
+                await new Promise((resolve, reject) => {
+                    childProcess.exec(`npx prettier --ignore-unknown --write ${targetFiles}`, (err) => {
+                        if (err) {
+                            reject(err);
+                        }
+                        else {
+                            resolve();
+                        }
+                    });
+                });
+            }
+            // Run Biome if installed (handles linting + additional formatting)
+            if (biomeInstalled) {
+                // Format first
+                await new Promise((resolve) => {
+                    childProcess.exec(`npx @biomejs/biome format --write ${targetFiles}`, () => {
+                        // Ignore errors, just continue
+                        resolve();
+                    });
+                });
+                // Then lint with fixes (using --unsafe for auto-fixable issues)
+                // See: https://biomejs.dev/linter/#unsafe-fixes
+                // The --unsafe flag applies potentially behavior-changing fixes like removing unused imports.
+                // This is acceptable for wizard-generated code which may have fixable issues.
+                await new Promise((resolve) => {
+                    childProcess.exec(`npx @biomejs/biome check --write --unsafe ${targetFiles}`, () => {
+                        // Ignore errors, Biome exits non-zero if there are remaining issues
+                        resolve();
+                    });
+                });
+            }
+            spinner.stop('Formatters have processed your files.');
+        }
+        catch (e) {
+            spinner.stop('Formatting encountered an issue.');
+            clack.log.warn('Formatting encountered an issue. There may be formatting or linting issues in your updated files.');
+        }
+    });
+}
+exports.runFormatters = runFormatters;
 /**
  * Runs prettier on the changed or untracked files in the project.
  *
@@ -507,6 +607,68 @@ async function runPrettierIfInstalled(opts) {
     });
 }
 exports.runPrettierIfInstalled = runPrettierIfInstalled;
+/**
+ * Runs Biome on the changed or untracked files in the project.
+ *
+ * @param options.cwd The directory of the project. If undefined, the current process working directory will be used.
+ */
+async function runBiomeIfInstalled(opts) {
+    return (0, telemetry_1.traceStep)('run-biome', async () => {
+        if (!(0, git_1.isInGitRepo)({ cwd: opts.cwd })) {
+            // We only run formatting on changed files. If we're not in a git repo, we can't find
+            // changed files. So let's early-return without showing any formatting-related messages.
+            return;
+        }
+        const changedOrUntrackedFiles = (0, git_1.getUncommittedOrUntrackedFiles)()
+            .map((filename) => {
+            return filename.startsWith('- ') ? filename.slice(2) : filename;
+        })
+            .join(' ');
+        if (!changedOrUntrackedFiles.length) {
+            // Likewise, if we can't find changed or untracked files, there's no point in running Biome.
+            return;
+        }
+        const packageJson = await getPackageDotJson();
+        const biomeInstalled = (0, package_json_1.hasPackageInstalled)('@biomejs/biome', packageJson);
+        Sentry.setTag('biome-installed', biomeInstalled);
+        if (!biomeInstalled) {
+            return;
+        }
+        // prompt the user if they want to run biome
+        const shouldRunBiome = await abortIfCancelled(clack.confirm({
+            message: 'Looks like you have Biome in your project. Do you want to run it on your files?',
+        }));
+        if (!shouldRunBiome) {
+            return;
+        }
+        const biomeSpinner = clack.spinner();
+        biomeSpinner.start('Running Biome on your files.');
+        try {
+            // Use biome format --write for formatting (always succeeds if it can format)
+            // Then biome check --write for lint fixes
+            // We ignore exit codes because Biome exits non-zero if there are unfixable issues
+            await new Promise((resolve) => {
+                childProcess.exec(`npx @biomejs/biome format --write ${changedOrUntrackedFiles}`, () => {
+                    // Ignore errors, just continue
+                    resolve();
+                });
+            });
+            await new Promise((resolve) => {
+                childProcess.exec(`npx @biomejs/biome check --write --unsafe ${changedOrUntrackedFiles}`, () => {
+                    // Ignore errors, Biome exits non-zero if there are remaining issues
+                    resolve();
+                });
+            });
+        }
+        catch (e) {
+            biomeSpinner.stop('Biome encountered an issue.');
+            clack.log.warn('Biome encountered an issue. There may be formatting or linting issues in your updated files.');
+            return;
+        }
+        biomeSpinner.stop('Biome has formatted your files.');
+    });
+}
+exports.runBiomeIfInstalled = runBiomeIfInstalled;
 /**
  * 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.