@sentry/wizard 3.12.0 → 3.14.0

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

@@ -71,7 +71,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNewConfigFile = exports.showCopyPasteInstructions = exports.askForToolConfigPath = exports.getOrAskForProjectData = exports.isUsingTypeScript = exports.getPackageDotJson = exports.ensurePackageIsInstalled = exports.addDotEnvSentryBuildPluginFile = exports.addSentryCliConfig = exports.installPackage = exports.askForItemSelection = exports.askToInstallSentryCLI = exports.confirmContinueEvenThoughNoGitRepo = exports.printWelcome = exports.abortIfCancelled = exports.abort = exports.sourceMapsCliSetupConfig = exports.SENTRY_PROPERTIES_FILE = exports.SENTRY_CLI_RC_FILE = exports.SENTRY_DOT_ENV_FILE = void 0;
+exports.createNewConfigFile = exports.makeCodeSnippet = exports.showCopyPasteInstructions = exports.askForToolConfigPath = exports.getOrAskForProjectData = exports.isUsingTypeScript = exports.getPackageDotJson = exports.ensurePackageIsInstalled = exports.addDotEnvSentryBuildPluginFile = exports.addSentryCliConfig = exports.installPackage = exports.askForItemSelection = exports.askToInstallSentryCLI = exports.confirmContinueIfNoOrDirtyGitRepo = exports.printWelcome = exports.abortIfCancelled = exports.abort = exports.sourceMapsCliSetupConfig = exports.SENTRY_PROPERTIES_FILE = exports.SENTRY_CLI_RC_FILE = exports.SENTRY_DOT_ENV_FILE = void 0;
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 var clack = __importStar(require("@clack/prompts"));
 var axios_1 = __importDefault(require("axios"));
@@ -79,6 +79,7 @@ var chalk_1 = __importDefault(require("chalk"));
 var childProcess = __importStar(require("child_process"));
 var fs = __importStar(require("fs"));
 var path = __importStar(require("path"));
+var os = __importStar(require("os"));
 var timers_1 = require("timers");
 var url_1 = require("url");
 var Sentry = __importStar(require("@sentry/node"));
@@ -175,50 +176,90 @@ function printWelcome(options) {
     console.log('');
     clack.intro(chalk_1.default.inverse(" ".concat(options.wizardName, " ")));
     var welcomeText = options.message ||
-        'This Wizard will help you set up Sentry for your application.\nThank you for using Sentry :)';
+        "The ".concat(options.wizardName, " will help you set up Sentry for your application.\nThank you for using Sentry :)");
     if (options.promoCode) {
-        welcomeText += "\n\nUsing promo-code: ".concat(options.promoCode);
+        welcomeText = "".concat(welcomeText, "\n\nUsing promo-code: ").concat(options.promoCode);
     }
     if (wizardPackage.version) {
-        welcomeText += "\n\nVersion: ".concat(wizardPackage.version);
+        welcomeText = "".concat(welcomeText, "\n\nVersion: ").concat(wizardPackage.version);
     }
     if (options.telemetryEnabled) {
-        welcomeText += "\n\nYou are using the Sentry Wizard with telemetry enabled. This helps us improve the Wizard.\nYou can disable it at any time by running `sentry-wizard --disable-telemetry`.";
+        welcomeText = "".concat(welcomeText, "\n\nThis wizard sends telemetry data and crash reports to Sentry. This helps us improve the Wizard.\nYou can turn this off at any time by running ").concat(chalk_1.default.cyanBright('sentry-wizard --disable-telemetry'), ".");
     }
     clack.note(welcomeText);
 }
 exports.printWelcome = printWelcome;
-function confirmContinueEvenThoughNoGitRepo() {
+function confirmContinueIfNoOrDirtyGitRepo() {
     return __awaiter(this, void 0, void 0, function () {
-        var _a, continueWithoutGit;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    _b.trys.push([0, 1, , 5]);
-                    childProcess.execSync('git rev-parse --is-inside-work-tree', {
-                        stdio: 'ignore',
+        var _this = this;
+        return __generator(this, function (_a) {
+            return [2 /*return*/, (0, telemetry_1.traceStep)('check-git-status', function () { return __awaiter(_this, void 0, void 0, function () {
+                    var continueWithoutGit, uncommittedOrUntrackedFiles, continueWithDirtyRepo;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!!isInGitRepo()) return [3 /*break*/, 3];
+                                return [4 /*yield*/, abortIfCancelled(clack.confirm({
+                                        message: 'You are not inside a git repository. The wizard will create and update files. Do you want to continue anyway?',
+                                    }))];
+                            case 1:
+                                continueWithoutGit = _a.sent();
+                                Sentry.setTag('continue-without-git', continueWithoutGit);
+                                if (!!continueWithoutGit) return [3 /*break*/, 3];
+                                return [4 /*yield*/, abort(undefined, 0)];
+                            case 2:
+                                _a.sent();
+                                _a.label = 3;
+                            case 3:
+                                uncommittedOrUntrackedFiles = getUncommittedOrUntrackedFiles();
+                                if (!uncommittedOrUntrackedFiles.length) return [3 /*break*/, 6];
+                                clack.log.warn("You have uncommitted or untracked files in your repo:\n\n".concat(uncommittedOrUntrackedFiles.join('\n'), "\n\nThe wizard will create and update files."));
+                                return [4 /*yield*/, abortIfCancelled(clack.confirm({
+                                        message: 'Do you want to continue anyway?',
+                                    }))];
+                            case 4:
+                                continueWithDirtyRepo = _a.sent();
+                                Sentry.setTag('continue-with-dirty-repo', continueWithDirtyRepo);
+                                if (!!continueWithDirtyRepo) return [3 /*break*/, 6];
+                                return [4 /*yield*/, abort(undefined, 0)];
+                            case 5:
+                                _a.sent();
+                                _a.label = 6;
+                            case 6: return [2 /*return*/];
+                        }
                     });
-                    return [3 /*break*/, 5];
-                case 1:
-                    _a = _b.sent();
-                    return [4 /*yield*/, abortIfCancelled(clack.confirm({
-                            message: 'You are not inside a git repository. The wizard will create and update files. Do you still want to continue?',
-                        }))];
-                case 2:
-                    continueWithoutGit = _b.sent();
-                    Sentry.setTag('continue-without-git', continueWithoutGit);
-                    if (!!continueWithoutGit) return [3 /*break*/, 4];
-                    return [4 /*yield*/, abort(undefined, 0)];
-                case 3:
-                    _b.sent();
-                    _b.label = 4;
-                case 4: return [3 /*break*/, 5];
-                case 5: return [2 /*return*/];
-            }
+                }); })];
         });
     });
 }
-exports.confirmContinueEvenThoughNoGitRepo = confirmContinueEvenThoughNoGitRepo;
+exports.confirmContinueIfNoOrDirtyGitRepo = confirmContinueIfNoOrDirtyGitRepo;
+function isInGitRepo() {
+    try {
+        childProcess.execSync('git rev-parse --is-inside-work-tree', {
+            stdio: 'ignore',
+        });
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+function getUncommittedOrUntrackedFiles() {
+    try {
+        var gitStatus = childProcess
+            .execSync('git status --porcelain=v1')
+            .toString();
+        var files = gitStatus
+            .split(os.EOL)
+            .map(function (line) { return line.trim(); })
+            .filter(Boolean)
+            .map(function (f) { return "- ".concat(f.split(/\s+/)[1]); });
+        return files;
+    }
+    catch (_a) {
+        return [];
+    }
+}
 function askToInstallSentryCLI() {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
@@ -258,121 +299,100 @@ exports.askForItemSelection = askForItemSelection;
 function installPackage(_a) {
     var packageName = _a.packageName, alreadyInstalled = _a.alreadyInstalled, _b = _a.askBeforeUpdating, askBeforeUpdating = _b === void 0 ? true : _b;
     return __awaiter(this, void 0, void 0, function () {
-        var shouldUpdatePackage, sdkInstallSpinner, packageManager, e_1;
+        var _this = this;
         return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    if (!(alreadyInstalled && askBeforeUpdating)) return [3 /*break*/, 2];
-                    return [4 /*yield*/, abortIfCancelled(clack.confirm({
-                            message: "The ".concat(chalk_1.default.bold.cyan(packageName), " package is already installed. Do you want to update it to the latest version?"),
-                        }))];
-                case 1:
-                    shouldUpdatePackage = _c.sent();
-                    if (!shouldUpdatePackage) {
-                        return [2 /*return*/];
-                    }
-                    _c.label = 2;
-                case 2:
-                    sdkInstallSpinner = clack.spinner();
-                    return [4 /*yield*/, getPackageManager()];
-                case 3:
-                    packageManager = _c.sent();
-                    sdkInstallSpinner.start("".concat(alreadyInstalled ? 'Updating' : 'Installing', " ").concat(chalk_1.default.bold.cyan(packageName), " with ").concat(chalk_1.default.bold(packageManager.label), "."));
-                    _c.label = 4;
-                case 4:
-                    _c.trys.push([4, 6, , 8]);
-                    return [4 /*yield*/, (0, package_manager_1.installPackageWithPackageManager)(packageManager, packageName)];
-                case 5:
-                    _c.sent();
-                    return [3 /*break*/, 8];
-                case 6:
-                    e_1 = _c.sent();
-                    sdkInstallSpinner.stop('Installation failed.');
-                    clack.log.error("".concat(chalk_1.default.red('Encountered the following error during installation:'), "\n\n").concat(e_1, "\n\n").concat(chalk_1.default.dim('If you think this issue is caused by the Sentry wizard, let us know here:\nhttps://github.com/getsentry/sentry-wizard/issues')));
-                    return [4 /*yield*/, abort()];
-                case 7:
-                    _c.sent();
-                    return [3 /*break*/, 8];
-                case 8:
-                    sdkInstallSpinner.stop("".concat(alreadyInstalled ? 'Updated' : 'Installed', " ").concat(chalk_1.default.bold.cyan(packageName), " with ").concat(chalk_1.default.bold(packageManager.label), "."));
-                    return [2 /*return*/];
-            }
+            return [2 /*return*/, (0, telemetry_1.traceStep)('install-package', function () { return __awaiter(_this, void 0, void 0, function () {
+                    var shouldUpdatePackage, sdkInstallSpinner, packageManager, e_1;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (!(alreadyInstalled && askBeforeUpdating)) return [3 /*break*/, 2];
+                                return [4 /*yield*/, abortIfCancelled(clack.confirm({
+                                        message: "The ".concat(chalk_1.default.bold.cyan(packageName), " package is already installed. Do you want to update it to the latest version?"),
+                                    }))];
+                            case 1:
+                                shouldUpdatePackage = _a.sent();
+                                if (!shouldUpdatePackage) {
+                                    return [2 /*return*/];
+                                }
+                                _a.label = 2;
+                            case 2:
+                                sdkInstallSpinner = clack.spinner();
+                                return [4 /*yield*/, getPackageManager()];
+                            case 3:
+                                packageManager = _a.sent();
+                                sdkInstallSpinner.start("".concat(alreadyInstalled ? 'Updating' : 'Installing', " ").concat(chalk_1.default.bold.cyan(packageName), " with ").concat(chalk_1.default.bold(packageManager.label), "."));
+                                _a.label = 4;
+                            case 4:
+                                _a.trys.push([4, 6, , 8]);
+                                return [4 /*yield*/, (0, package_manager_1.installPackageWithPackageManager)(packageManager, packageName)];
+                            case 5:
+                                _a.sent();
+                                return [3 /*break*/, 8];
+                            case 6:
+                                e_1 = _a.sent();
+                                sdkInstallSpinner.stop('Installation failed.');
+                                clack.log.error("".concat(chalk_1.default.red('Encountered the following error during installation:'), "\n\n").concat(e_1, "\n\n").concat(chalk_1.default.dim('If you think this issue is caused by the Sentry wizard, let us know here:\nhttps://github.com/getsentry/sentry-wizard/issues')));
+                                return [4 /*yield*/, abort()];
+                            case 7:
+                                _a.sent();
+                                return [3 /*break*/, 8];
+                            case 8:
+                                sdkInstallSpinner.stop("".concat(alreadyInstalled ? 'Updated' : 'Installed', " ").concat(chalk_1.default.bold.cyan(packageName), " with ").concat(chalk_1.default.bold(packageManager.label), "."));
+                                return [2 /*return*/];
+                        }
+                    });
+                }); })];
         });
     });
 }
 exports.installPackage = installPackage;
-function addOrgAndProjectToSentryCliRc(org, project, setupConfig) {
-    return __awaiter(this, void 0, void 0, function () {
-        var configContents, e_2;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    configContents = fs.readFileSync(path.join(process.cwd(), setupConfig.filename), 'utf8');
-                    if (!setupConfig.likelyAlreadyHasOrgAndProject(configContents)) return [3 /*break*/, 1];
-                    clack.log.warn("".concat(chalk_1.default.bold(setupConfig.filename), " already has org and project. Will not add them."));
-                    return [3 /*break*/, 4];
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, fs.promises.appendFile(path.join(process.cwd(), setupConfig.filename), "\n".concat(setupConfig.orgAndProjContent(org, project), "\n"))];
-                case 2:
-                    _a.sent();
-                    return [3 /*break*/, 4];
-                case 3:
-                    e_2 = _a.sent();
-                    clack.log.warn("".concat(chalk_1.default.bold(setupConfig.filename), " could not be updated with org and project."));
-                    return [3 /*break*/, 4];
-                case 4: return [2 /*return*/];
-            }
-        });
-    });
-}
-function addSentryCliConfig(authToken, setupConfig, orgSlug, projectSlug) {
+function addSentryCliConfig(authToken, setupConfig) {
     if (setupConfig === void 0) { setupConfig = exports.sourceMapsCliSetupConfig; }
     return __awaiter(this, void 0, void 0, function () {
-        var configExists, configContents, _a, _b;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    configExists = fs.existsSync(path.join(process.cwd(), setupConfig.filename));
-                    if (!configExists) return [3 /*break*/, 5];
-                    configContents = fs.readFileSync(path.join(process.cwd(), setupConfig.filename), 'utf8');
-                    if (!setupConfig.likelyAlreadyHasAuthToken(configContents)) return [3 /*break*/, 1];
-                    clack.log.warn("".concat(chalk_1.default.bold(setupConfig.filename), " already has auth token. Will not add one."));
-                    return [3 /*break*/, 4];
-                case 1:
-                    _c.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), setupConfig.filename), "".concat(configContents, "\n").concat(setupConfig.tokenContent(authToken), "\n"), { encoding: 'utf8', flag: 'w' })];
-                case 2:
-                    _c.sent();
-                    clack.log.success(chalk_1.default.greenBright("Added auth token to ".concat(chalk_1.default.bold(setupConfig.filename), " for you to test uploading ").concat(setupConfig.name, " locally.")));
-                    return [3 /*break*/, 4];
-                case 3:
-                    _a = _c.sent();
-                    clack.log.warning("Failed to add auth token to ".concat(chalk_1.default.bold(setupConfig.filename), ". Uploading ").concat(setupConfig.name, " during build will likely not work locally."));
-                    return [3 /*break*/, 4];
-                case 4: return [3 /*break*/, 8];
-                case 5:
-                    _c.trys.push([5, 7, , 8]);
-                    return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), setupConfig.filename), "".concat(setupConfig.tokenContent(authToken), "\n"), { encoding: 'utf8', flag: 'w' })];
-                case 6:
-                    _c.sent();
-                    clack.log.success(chalk_1.default.greenBright("Created ".concat(chalk_1.default.bold(setupConfig.filename), " with auth token for you to test uploading ").concat(setupConfig.name, " locally.")));
-                    return [3 /*break*/, 8];
-                case 7:
-                    _b = _c.sent();
-                    clack.log.warning("Failed to create ".concat(chalk_1.default.bold(setupConfig.filename), " with auth token. Uploading ").concat(setupConfig.name, " during build will likely not work locally."));
-                    return [3 /*break*/, 8];
-                case 8:
-                    if (!(orgSlug && projectSlug)) return [3 /*break*/, 10];
-                    return [4 /*yield*/, addOrgAndProjectToSentryCliRc(orgSlug, projectSlug, setupConfig)];
-                case 9:
-                    _c.sent();
-                    _c.label = 10;
-                case 10: return [4 /*yield*/, addAuthTokenFileToGitIgnore(setupConfig.filename)];
-                case 11:
-                    _c.sent();
-                    return [2 /*return*/];
-            }
+        var _this = this;
+        return __generator(this, function (_a) {
+            return [2 /*return*/, (0, telemetry_1.traceStep)('add-sentry-cli-config', function () { return __awaiter(_this, void 0, void 0, function () {
+                    var configExists, configContents, _a, _b;
+                    return __generator(this, function (_c) {
+                        switch (_c.label) {
+                            case 0:
+                                configExists = fs.existsSync(path.join(process.cwd(), setupConfig.filename));
+                                if (!configExists) return [3 /*break*/, 5];
+                                configContents = fs.readFileSync(path.join(process.cwd(), setupConfig.filename), 'utf8');
+                                if (!setupConfig.likelyAlreadyHasAuthToken(configContents)) return [3 /*break*/, 1];
+                                clack.log.warn("".concat(chalk_1.default.bold(setupConfig.filename), " already has auth token. Will not add one."));
+                                return [3 /*break*/, 4];
+                            case 1:
+                                _c.trys.push([1, 3, , 4]);
+                                return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), setupConfig.filename), "".concat(configContents, "\n").concat(setupConfig.tokenContent(authToken), "\n"), { encoding: 'utf8', flag: 'w' })];
+                            case 2:
+                                _c.sent();
+                                clack.log.success(chalk_1.default.greenBright("Added auth token to ".concat(chalk_1.default.bold(setupConfig.filename), " for you to test uploading ").concat(setupConfig.name, " locally.")));
+                                return [3 /*break*/, 4];
+                            case 3:
+                                _a = _c.sent();
+                                clack.log.warning("Failed to add auth token to ".concat(chalk_1.default.bold(setupConfig.filename), ". Uploading ").concat(setupConfig.name, " during build will likely not work locally."));
+                                return [3 /*break*/, 4];
+                            case 4: return [3 /*break*/, 8];
+                            case 5:
+                                _c.trys.push([5, 7, , 8]);
+                                return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), setupConfig.filename), "".concat(setupConfig.tokenContent(authToken), "\n"), { encoding: 'utf8', flag: 'w' })];
+                            case 6:
+                                _c.sent();
+                                clack.log.success(chalk_1.default.greenBright("Created ".concat(chalk_1.default.bold(setupConfig.filename), " with auth token for you to test uploading ").concat(setupConfig.name, " locally.")));
+                                return [3 /*break*/, 8];
+                            case 7:
+                                _b = _c.sent();
+                                clack.log.warning("Failed to create ".concat(chalk_1.default.bold(setupConfig.filename), " with auth token. Uploading ").concat(setupConfig.name, " during build will likely not work locally."));
+                                return [3 /*break*/, 8];
+                            case 8: return [4 /*yield*/, addAuthTokenFileToGitIgnore(setupConfig.filename)];
+                            case 9:
+                                _c.sent();
+                                return [2 /*return*/];
+                        }
+                    });
+                }); })];
         });
     });
 }
@@ -451,26 +471,44 @@ function addAuthTokenFileToGitIgnore(filename) {
         });
     });
 }
+/**
+ * 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.
+ *
+ * Use this function to check if e.g. a the framework of the SDK is installed
+ *
+ * @param packageJson the package.json object
+ * @param packageId the npm name of the package
+ * @param packageName a human readable name of the package
+ */
 function ensurePackageIsInstalled(packageJson, packageId, packageName) {
     return __awaiter(this, void 0, void 0, function () {
-        var continueWithoutPackage;
+        var _this = this;
         return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (!!(0, package_json_1.hasPackageInstalled)(packageId, packageJson)) return [3 /*break*/, 3];
-                    return [4 /*yield*/, abortIfCancelled(clack.confirm({
-                            message: "".concat(packageName, " does not seem to be installed. Do you still want to continue?"),
-                            initialValue: false,
-                        }))];
-                case 1:
-                    continueWithoutPackage = _a.sent();
-                    if (!!continueWithoutPackage) return [3 /*break*/, 3];
-                    return [4 /*yield*/, abort(undefined, 0)];
-                case 2:
-                    _a.sent();
-                    _a.label = 3;
-                case 3: return [2 /*return*/];
-            }
+            return [2 /*return*/, (0, telemetry_1.traceStep)('ensure-package-installed', function () { return __awaiter(_this, void 0, void 0, function () {
+                    var installed, continueWithoutPackage;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                installed = (0, package_json_1.hasPackageInstalled)(packageId, packageJson);
+                                Sentry.setTag("".concat(packageName.toLowerCase(), "-installed"), installed);
+                                if (!!installed) return [3 /*break*/, 3];
+                                Sentry.setTag("".concat(packageName.toLowerCase(), "-installed"), false);
+                                return [4 /*yield*/, abortIfCancelled(clack.confirm({
+                                        message: "".concat(packageName, " does not seem to be installed. Do you still want to continue?"),
+                                        initialValue: false,
+                                    }))];
+                            case 1:
+                                continueWithoutPackage = _a.sent();
+                                if (!!continueWithoutPackage) return [3 /*break*/, 3];
+                                return [4 /*yield*/, abort(undefined, 0)];
+                            case 2:
+                                _a.sent();
+                                _a.label = 3;
+                            case 3: return [2 /*return*/];
+                        }
+                    });
+                }); })];
         });
     });
 }
@@ -497,7 +535,7 @@ function getPackageDotJson() {
                     return [3 /*break*/, 5];
                 case 3:
                     _a = _b.sent();
-                    clack.log.error('Unable to parse your package.json. Make sure it has a valid format!');
+                    clack.log.error("Unable to parse your ".concat(chalk_1.default.cyan('package.json'), ". Make sure it has a valid format!"));
                     return [4 /*yield*/, abort()];
                 case 4:
                     _b.sent();
@@ -815,7 +853,7 @@ function askForToolConfigPath(toolName, configFileName) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, abortIfCancelled(clack.confirm({
-                        message: "Do you have a ".concat(toolName, " config file (e.g. ").concat(chalk_1.default.cyan(configFileName), "?"),
+                        message: "Do you have a ".concat(toolName, " config file (e.g. ").concat(chalk_1.default.cyan(configFileName), ")?"),
                         initialValue: true,
                     }))];
                 case 1:
@@ -856,23 +894,30 @@ exports.askForToolConfigPath = askForToolConfigPath;
  *
  * @param filename the name of the file to which the code snippet should be applied.
  * If a path is provided, only the filename will be used.
- * @param codeSnippet the snippet to be printed.
- * Make sure to follow the diff-like format of highlighting lines that require changes
- * and showing unchanged lines in gray.
  *
- * TODO: Link to wizard spec (develop) once it is live
+ * @param codeSnippet the snippet to be printed. Use {@link makeCodeSnippet}  to create the
+ * diff-like format for visually highlighting unchanged or modified lines of code.
+ *
+ * @param hint (optional) a hint to be printed after the main instruction to add
+ * the code from @param codeSnippet to their @param filename.
+ *
+ * More guidelines on copy/paste instructions:
+ * @see {@link https://develop.sentry.dev/sdk/setup-wizards/#copy--paste-snippets}
+ *
  * TODO: refactor copy paste instructions across different wizards to use this function.
  *       this might require adding a custom message parameter to the function
  */
-function showCopyPasteInstructions(filename, codeSnippet) {
+function showCopyPasteInstructions(filename, codeSnippet, hint) {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    clack.log.step("Add the following code to your ".concat(chalk_1.default.cyan(path.basename(filename)), " file:"));
+                    clack.log.step("Add the following code to your ".concat(chalk_1.default.cyan(path.basename(filename)), " file:").concat(hint ? chalk_1.default.dim(" (".concat(chalk_1.default.dim(hint), ")")) : ''));
+                    // Padding the code snippet to be printed with a \n at the beginning and end
+                    // This makes it easier to distinguish the snippet from the rest of the output
                     // Intentionally logging directly to console here so that the code can be copied/pasted directly
                     // eslint-disable-next-line no-console
-                    console.log("\n".concat(codeSnippet));
+                    console.log("\n".concat(codeSnippet, "\n"));
                     return [4 /*yield*/, abortIfCancelled(clack.select({
                             message: 'Did you apply the snippet above?',
                             options: [{ label: 'Yes, continue!', value: true }],
@@ -886,6 +931,31 @@ function showCopyPasteInstructions(filename, codeSnippet) {
     });
 }
 exports.showCopyPasteInstructions = showCopyPasteInstructions;
+/**
+ * Crafts a code snippet that can be used to e.g.
+ * - print copy/paste instructions to the console
+ * - create a new config file.
+ *
+ * @param colors set this to true if you want the final snippet to be colored.
+ * This is useful for printing the snippet to the console as part of copy/paste instructions.
+ *
+ * @param callback the callback that returns the formatted code snippet.
+ * It exposes takes the helper functions for marking code as unchaned, new or removed.
+ * These functions no-op if no special formatting should be applied
+ * and otherwise apply the appropriate formatting/coloring.
+ * (@see {@link CodeSnippetFormatter})
+ *
+ * @see {@link showCopyPasteInstructions} for the helper with which to display the snippet in the console.
+ *
+ * @returns a string containing the final, formatted code snippet.
+ */
+function makeCodeSnippet(colors, callback) {
+    var unchanged = function (txt) { return (colors ? chalk_1.default.grey(txt) : txt); };
+    var plus = function (txt) { return (colors ? chalk_1.default.greenBright(txt) : txt); };
+    var minus = function (txt) { return (colors ? chalk_1.default.redBright(txt) : txt); };
+    return callback(unchanged, plus, minus);
+}
+exports.makeCodeSnippet = makeCodeSnippet;
 /**
  * Creates a new config file with the given @param filepath and @param codeSnippet.
  *
@@ -905,7 +975,7 @@ exports.showCopyPasteInstructions = showCopyPasteInstructions;
  */
 function createNewConfigFile(filepath, codeSnippet, moreInformation) {
     return __awaiter(this, void 0, void 0, function () {
-        var prettyFilename, e_3;
+        var prettyFilename, e_2;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -926,8 +996,8 @@ function createNewConfigFile(filepath, codeSnippet, moreInformation) {
                     }
                     return [2 /*return*/, true];
                 case 3:
-                    e_3 = _a.sent();
-                    (0, debug_1.debug)(e_3);
+                    e_2 = _a.sent();
+                    (0, debug_1.debug)(e_2);
                     clack.log.warn("Could not create a new ".concat(prettyFilename, " file. Please create one manually and follow the instructions below."));
                     return [3 /*break*/, 4];
                 case 4: return [2 /*return*/, false];