@sentry/wizard 3.11.0 → 3.13.0

package/dist/src/utils/ast-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ast-utils.js","sourceRoot":"","sources":["../../../src/utils/ast-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAyB;AAIzB;;;GAGG;AACH,SAAgB,QAAQ,CACtB,QAAgB,EAChB,SAA4C;IAA5C,0BAAA,EAAA,aAAuB,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC;IAE5C,OAAO,SAAS;SACb,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,UAAG,QAAQ,SAAG,IAAI,CAAE,EAApB,CAAoB,CAAC;SACnC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAC;AACzC,CAAC;AAPD,4BAOC;AAED,kEAAkE;AAClE,SAAgB,gBAAgB,CAAC,GAA4B;IAC3D,IAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,IAAI,EAAN,CAAM,CAAC,CAAC;IACtD,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,EAAxB,CAAwB,CAAC,CAAC;AACzD,CAAC;AAHD,4CAGC","sourcesContent":["import * as fs from 'fs';\n// @ts-ignore - magicast is ESM and TS complains about that. It works though\nimport { ProxifiedModule } from 'magicast';\n\n/**\n * Checks if a file where we don't know its concrete file type yet exists\n * and returns the full path to the file with the correct file type.\n */\nexport function findFile(\n  filePath: string,\n  fileTypes: string[] = ['.js', '.ts', '.mjs'],\n): string | undefined {\n  return fileTypes\n    .map((type) => `${filePath}${type}`)\n    .find((file) => fs.existsSync(file));\n}\n\n/** Checks if a Sentry package is already mentioned in the file */\nexport function hasSentryContent(mod: ProxifiedModule<object>): boolean {\n  const imports = mod.imports.$items.map((i) => i.from);\n  return !!imports.find((i) => i.startsWith('@sentry/'));\n}\n"]}
+{"version":3,"file":"ast-utils.js","sourceRoot":"","sources":["../../../src/utils/ast-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAyB;AAEzB,6CAAiC;AAIjC,IAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;AAEhC;;;GAGG;AACH,SAAgB,QAAQ,CACtB,QAAgB,EAChB,SAAoD;IAApD,0BAAA,EAAA,aAAuB,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IAEpD,OAAO,SAAS;SACb,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,UAAG,QAAQ,SAAG,IAAI,CAAE,EAApB,CAAoB,CAAC;SACnC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAC;AACzC,CAAC;AAPD,4BAOC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,OAAkB;IACjD,IAAI,WAAW,GAAwB,KAAK,CAAC;IAC7C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;QACpB,kBAAkB,YAAC,IAAI;YACrB,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QACD,YAAY,YAAC,IAAI;;YACf,WAAW;gBACT,WAAW,KAAI,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,0CAAE,QAAQ,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,CAAC,WAAW,CAAC;AACvB,CAAC;AAfD,4CAeC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,MAA0B,EAC1B,IAAY;IAEZ,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAC,CAAC;QAC9B,IAAM,YAAY,GAAG,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC;QAE1E,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO,KAAK,CAAC;SACd;QAED,IAAM,qBAAqB,GACzB,YAAY;YACZ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC;YAC5D,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC;QAEvB,IAAI,qBAAqB,EAAE;YACzB,OAAO,IAAI,CAAC;SACb;QAED,8BAA8B;QAC9B,OAAO,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAvBD,8CAuBC;AAED;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CACpC,MAA0B,EAC1B,IAAY,EACZ,YAIsB;IAEtB,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,gBAAgB,EAAE;QACpB,OAAO,gBAAgB,CAAC;KACzB;IAED,IAAM,WAAW,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;QAC1B,KAAK,EAAE,YAAY;KACpB,CAAC,CAAC;IAEH,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEpC,OAAO,WAAW,CAAC;AACrB,CAAC;AAxBD,wDAwBC;AAED;;;;;;;;;GASG;AACH,SAAgB,yBAAyB,CACvC,MAA0B,EAC1B,IAAY,EACZ,KAA0E,EAC1E,OAAgB;IAEhB,IAAM,WAAW,GACf,OAAO;QACP,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,CAAC,WAAI,CAAC,CAAE,EAAE,IAAI,EAAE,KAAK,CAAC,EAAnC,CAAmC,CAAC,CAAC;IAEtE,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,gBAAgB,EAAE;QACpB,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/B,IAAI,WAAW,EAAE;YACf,gBAAgB,CAAC,QAAQ,mCACpB,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,KAAI,EAAE,CAAC,SAClC,WAAW,OACf,CAAC;SACH;KACF;SAAM;QACL,MAAM,CAAC,UAAU,CAAC,IAAI,CACpB,CAAC,CAAC,cAAc,CAAC,IAAI,YACnB,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAC1B,KAAK,OAAA,IACF,CAAC,WAAW,IAAI;YACjB,QAAQ,EAAE,WAAW;SACtB,CAAC,EACF,CACH,CAAC;KACH;AACH,CAAC;AA/BD,8DA+BC;AAYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CAAC,UAAkB;IAC3C,IAAI;QACF,IAAM,UAAU,GAAG,WAAI,UAAU,MAAG,CAAC;QACrC,uDAAuD;QACvD,sEAAsE;QACtE,IAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAoB,CAAC;QAErE,IAAM,UAAU,GACd,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,qBAAqB;YACzC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,KAAK,kBAAkB;YAClD,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YACzB,SAAS,CAAC;QAEZ,IAAI,UAAU,EAAE;YACd,OAAO,EAAE,UAAU,YAAA,EAAE,GAAG,KAAA,EAAE,CAAC;SAC5B;KACF;IAAC,WAAM;QACN,WAAW;KACZ;IACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AACnD,CAAC;AApBD,gCAoBC;AAED;;;;;;;;;GASG;AACH,SAAgB,UAAU,CAAC,GAAc;IACvC,IAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IAClC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC;AAHD,gCAGC","sourcesContent":["import * as fs from 'fs';\n\nimport * as recast from 'recast';\nimport x = recast.types;\nimport t = x.namedTypes;\n\nconst b = recast.types.builders;\n\n/**\n * Checks if a file where we don't know its concrete file type yet exists\n * and returns the full path to the file with the correct file type.\n */\nexport function findFile(\n  filePath: string,\n  fileTypes: string[] = ['.js', '.ts', '.mjs', '.cjs'],\n): string | undefined {\n  return fileTypes\n    .map((type) => `${filePath}${type}`)\n    .find((file) => fs.existsSync(file));\n}\n\n/**\n * checks for require('@sentry/*') syntax\n */\nexport function hasSentryContent(program: t.Program): boolean {\n  let foundSentry: boolean | undefined = false;\n  recast.visit(program, {\n    visitStringLiteral(path) {\n      foundSentry = foundSentry || path.node.value.startsWith('@sentry/');\n      this.traverse(path);\n    },\n    visitLiteral(path) {\n      foundSentry =\n        foundSentry || path.node.value?.toString().startsWith('@sentry/');\n      this.traverse(path);\n    },\n  });\n\n  return !!foundSentry;\n}\n\n/**\n * Searches for a property of an ObjectExpression by name\n *\n * @param object the ObjectExpression to search in\n * @param name the name of the property to search for\n *\n * @returns the property if it exists\n */\nexport function getObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n): t.Property | undefined {\n  return object.properties.find((p): p is t.Property => {\n    const isObjectProp = p.type === 'Property' || p.type === 'ObjectProperty';\n\n    if (!isObjectProp) {\n      return false;\n    }\n\n    const hasMatchingLiteralKey =\n      isObjectProp &&\n      (p.key.type === 'Literal' || p.key.type === 'StringLiteral') &&\n      p.key.value === name;\n\n    if (hasMatchingLiteralKey) {\n      return true;\n    }\n\n    // has matching identifier key\n    return isObjectProp && p.key.type === 'Identifier' && p.key.name === name;\n  });\n}\n\n/**\n * Attempts to find a property of an ObjectExpression by name. If it doesn't exist,\n * the property will be added to the ObjectExpression with the provided default value.\n *\n * @param object the parent object expression to search in\n * @param name the name of the property to search for\n * @param defaultValue the default value to set if the property doesn't exist\n *\n * @returns the\n */\nexport function getOrSetObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n  defaultValue:\n    | t.Literal\n    | t.BooleanLiteral\n    | t.StringLiteral\n    | t.ObjectExpression,\n): t.Property {\n  const existingProperty = getObjectProperty(object, name);\n\n  if (existingProperty) {\n    return existingProperty;\n  }\n\n  const newProperty = b.property.from({\n    kind: 'init',\n    key: b.stringLiteral(name),\n    value: defaultValue,\n  });\n\n  object.properties.push(newProperty);\n\n  return newProperty;\n}\n\n/**\n * Sets a property of an ObjectExpression if it exists, otherwise adds it\n * to the ObjectExpression. Optionally, a comment can be added to the\n * property.\n *\n * @param object the ObjectExpression to set the property on\n * @param name the name of the property to set\n * @param value  the value of the property to set\n * @param comment (optional) a comment to add to the property\n */\nexport function setOrUpdateObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n  value: t.Literal | t.BooleanLiteral | t.StringLiteral | t.ObjectExpression,\n  comment?: string,\n) {\n  const newComments =\n    comment &&\n    comment.split('\\n').map((c) => b.commentLine(` ${c}`, true, false));\n\n  const existingProperty = getObjectProperty(object, name);\n\n  if (existingProperty) {\n    existingProperty.value = value;\n    if (newComments) {\n      existingProperty.comments = [\n        ...(existingProperty?.comments || []),\n        ...newComments,\n      ];\n    }\n  } else {\n    object.properties.push(\n      b.objectProperty.from({\n        key: b.stringLiteral(name),\n        value,\n        ...(newComments && {\n          comments: newComments,\n        }),\n      }),\n    );\n  }\n}\n\ntype JsonCParseResult =\n  | {\n      jsonObject: t.ObjectExpression;\n      ast: t.Program;\n    }\n  | {\n      jsonObject: undefined;\n      ast: undefined;\n    };\n\n/**\n * Parses a JSON string with (potential) comments (JSON-C) and returns the JS AST\n * that can be walked and modified with recast like a normal JS AST.\n *\n * This is done by wrapping the JSON-C string in parentheses, thereby making it\n * a JS `Program` with an `ExpressionStatement` as its body. The expression is then\n * extracted from the AST and returned alongside the AST.\n *\n * To preserve as much original formatting as possible, the returned `ast`\n * property should be passed to {@link `printJsonC`} to get the JSON-C string back.\n *\n * If the input is not valid JSON-C, the result will be undefined.\n *\n * @see {@link JsonCParseResult}\n *\n * @param jsonString a JSON-C string\n *\n * @returns a {@link JsonCParseResult}, containing either the JSON-C object and the AST or undefined in both cases\n */\nexport function parseJsonC(jsonString: string): JsonCParseResult {\n  try {\n    const jsTsConfig = `(${jsonString})`;\n    // no idea why recast returns any here, this is dumb :/\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n    const ast = recast.parse(jsTsConfig.toString()).program as t.Program;\n\n    const jsonObject =\n      (ast.body[0].type === 'ExpressionStatement' &&\n        ast.body[0].expression.type === 'ObjectExpression' &&\n        ast.body[0].expression) ||\n      undefined;\n\n    if (jsonObject) {\n      return { jsonObject, ast };\n    }\n  } catch {\n    /* empty */\n  }\n  return { jsonObject: undefined, ast: undefined };\n}\n\n/**\n * Takes the AST of a parsed JSON-C \"program\" and returns the JSON-C string without\n * any of the temporary JS wrapper code that was previously applied.\n *\n * Only use this in conjunction with {@link `parseJsonC`}\n *\n * @param ast the `ast` returned from {@link `parseJsonC`}\n *\n * @returns the JSON-C string\n */\nexport function printJsonC(ast: t.Program): string {\n  const js = recast.print(ast).code;\n  return js.substring(1, js.length - 1);\n}\n"]}

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

@@ -31,7 +31,7 @@ export declare function installPackage({ packageName, alreadyInstalled, askBefor
     alreadyInstalled: boolean;
     askBeforeUpdating?: boolean;
 }): Promise<void>;
-export declare function addSentryCliConfig(authToken: string, setupConfig?: CliSetupConfig, orgSlug?: string, projectSlug?: string): Promise<void>;
+export declare function addSentryCliConfig(authToken: string, setupConfig?: CliSetupConfig): Promise<void>;
 export declare function addDotEnvSentryBuildPluginFile(authToken: string): Promise<void>;
 export declare function ensurePackageIsInstalled(packageJson: PackageDotJson, packageId: string, packageName: string): Promise<void>;
 export declare function getPackageDotJson(): Promise<PackageDotJson>;
@@ -53,3 +53,87 @@ export declare function getOrAskForProjectData(options: WizardOptions, platform?
     selectedProject: SentryProjectData;
     authToken: string;
 }>;
+/**
+ * Asks users if they have a config file for @param tool (e.g. Vite).
+ * If yes, asks users to specify the path to their config file.
+ *
+ * Use this helper function as a fallback mechanism if the lookup for
+ * a config file with its most usual location/name fails.
+ *
+ * @param toolName Name of the tool for which we're looking for the config file
+ * @param configFileName Name of the most common config file name (e.g. vite.config.js)
+ *
+ * @returns a user path to the config file or undefined if the user doesn't have a config file
+ */
+export declare function askForToolConfigPath(toolName: string, configFileName: string): Promise<string | undefined>;
+/**
+ * Prints copy/paste-able instructions to the console.
+ * Afterwards asks the user if they added the code snippet to their file.
+ *
+ * While there's no point in providing a "no" answer here, it gives users time to fulfill the
+ * task before the wizard continues with additional steps.
+ *
+ * Use this function if you want to show users instructions on how to add/modify
+ * code in their file. This is helpful if automatic insertion failed or is not possible/feasible.
+ *
+ * @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. 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
+ */
+export declare function showCopyPasteInstructions(filename: string, codeSnippet: string, hint?: string): Promise<void>;
+/**
+ * Callback that exposes formatting helpers for a code snippet.
+ * @param unchanged - Formats text as old code.
+ * @param plus - Formats text as new code.
+ * @param minus - Formats text as removed code.
+ */
+type CodeSnippetFormatter = (unchanged: (txt: string) => string, plus: (txt: string) => string, minus: (txt: string) => string) => string;
+/**
+ * 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.
+ */
+export declare function makeCodeSnippet(colors: boolean, callback: CodeSnippetFormatter): string;
+/**
+ * Creates a new config file with the given @param filepath and @param codeSnippet.
+ *
+ * Use this function to create a new config file for users. This is useful
+ * when users answered that they don't yet have a config file for a tool.
+ *
+ * (This doesn't mean that they don't yet have some other way of configuring
+ * their tool but we can leave it up to them to figure out how to merge configs
+ * here.)
+ *
+ * @param filepath absolute path to the new config file
+ * @param codeSnippet the snippet to be inserted into the file
+ * @param moreInformation (optional) the message to be printed after the file was created
+ * For example, this can be a link to more information about configuring the tool.
+ *
+ * @returns true on sucess, false otherwise
+ */
+export declare function createNewConfigFile(filepath: string, codeSnippet: string, moreInformation?: string): Promise<boolean>;
+export {};

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

@@ -58,11 +58,20 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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;
 // @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"));
@@ -76,6 +85,7 @@ var Sentry = __importStar(require("@sentry/node"));
 var package_json_1 = require("./package-json");
 var telemetry_1 = require("../telemetry");
 var package_manager_1 = require("./package-manager");
+var debug_1 = require("./debug");
 var opn = require('opn');
 exports.SENTRY_DOT_ENV_FILE = '.env.sentry-build-plugin';
 exports.SENTRY_CLI_RC_FILE = '.sentryclirc';
@@ -165,15 +175,15 @@ 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);
 }
@@ -291,32 +301,7 @@ function installPackage(_a) {
     });
 }
 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;
@@ -352,14 +337,8 @@ function addSentryCliConfig(authToken, setupConfig, orgSlug, projectSlug) {
                     _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 8: return [4 /*yield*/, addAuthTokenFileToGitIgnore(setupConfig.filename)];
                 case 9:
-                    _c.sent();
-                    _c.label = 10;
-                case 10: return [4 /*yield*/, addAuthTokenFileToGitIgnore(setupConfig.filename)];
-                case 11:
                     _c.sent();
                     return [2 /*return*/];
             }
@@ -447,7 +426,8 @@ function ensurePackageIsInstalled(packageJson, packageId, packageName) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    if (!!(0, package_json_1.hasPackageInstalled)(packageId, packageJson)) return [3 /*break*/, 3];
+                    if (!!(0, package_json_1.hasPackageInstalled)(packageId, packageJson)) return [3 /*break*/, 4];
+                    Sentry.setTag('package-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,
@@ -459,7 +439,11 @@ function ensurePackageIsInstalled(packageJson, packageId, packageName) {
                 case 2:
                     _a.sent();
                     _a.label = 3;
-                case 3: return [2 /*return*/];
+                case 3: return [3 /*break*/, 5];
+                case 4:
+                    Sentry.setTag('package-installed', true);
+                    _a.label = 5;
+                case 5: return [2 /*return*/];
             }
         });
     });
@@ -756,19 +740,27 @@ function askForWizardLogin(options) {
 }
 function askForProjectSelection(projects) {
     return __awaiter(this, void 0, void 0, function () {
-        var selection;
+        var label, sortedProjects, selection;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, abortIfCancelled(clack.select({
-                        maxItems: 12,
-                        message: 'Select your Sentry project.',
-                        options: projects.map(function (project) {
-                            return {
-                                value: project,
-                                label: "".concat(project.organization.slug, "/").concat(project.slug),
-                            };
-                        }),
-                    }))];
+                case 0:
+                    label = function (project) {
+                        return "".concat(project.organization.slug, "/").concat(project.slug);
+                    };
+                    sortedProjects = __spreadArray([], projects, true);
+                    sortedProjects.sort(function (a, b) {
+                        return label(a).localeCompare(label(b));
+                    });
+                    return [4 /*yield*/, abortIfCancelled(clack.select({
+                            maxItems: 12,
+                            message: 'Select your Sentry project.',
+                            options: sortedProjects.map(function (project) {
+                                return {
+                                    value: project,
+                                    label: label(project),
+                                };
+                            }),
+                        }))];
                 case 1:
                     selection = _a.sent();
                     Sentry.setTag('project', selection.slug);
@@ -779,4 +771,175 @@ function askForProjectSelection(projects) {
         });
     });
 }
+/**
+ * Asks users if they have a config file for @param tool (e.g. Vite).
+ * If yes, asks users to specify the path to their config file.
+ *
+ * Use this helper function as a fallback mechanism if the lookup for
+ * a config file with its most usual location/name fails.
+ *
+ * @param toolName Name of the tool for which we're looking for the config file
+ * @param configFileName Name of the most common config file name (e.g. vite.config.js)
+ *
+ * @returns a user path to the config file or undefined if the user doesn't have a config file
+ */
+function askForToolConfigPath(toolName, configFileName) {
+    return __awaiter(this, void 0, void 0, function () {
+        var hasConfig;
+        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), ")?"),
+                        initialValue: true,
+                    }))];
+                case 1:
+                    hasConfig = _a.sent();
+                    if (!hasConfig) {
+                        return [2 /*return*/, undefined];
+                    }
+                    return [4 /*yield*/, abortIfCancelled(clack.text({
+                            message: "Please enter the path to your ".concat(toolName, " config file:"),
+                            placeholder: path.join('.', configFileName),
+                            validate: function (value) {
+                                if (!value) {
+                                    return 'Please enter a path.';
+                                }
+                                try {
+                                    fs.accessSync(value);
+                                }
+                                catch (_a) {
+                                    return 'Could not access the file at this path.';
+                                }
+                            },
+                        }))];
+                case 2: return [2 /*return*/, _a.sent()];
+            }
+        });
+    });
+}
+exports.askForToolConfigPath = askForToolConfigPath;
+/**
+ * Prints copy/paste-able instructions to the console.
+ * Afterwards asks the user if they added the code snippet to their file.
+ *
+ * While there's no point in providing a "no" answer here, it gives users time to fulfill the
+ * task before the wizard continues with additional steps.
+ *
+ * Use this function if you want to show users instructions on how to add/modify
+ * code in their file. This is helpful if automatic insertion failed or is not possible/feasible.
+ *
+ * @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. 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, 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:").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, "\n"));
+                    return [4 /*yield*/, abortIfCancelled(clack.select({
+                            message: 'Did you apply the snippet above?',
+                            options: [{ label: 'Yes, continue!', value: true }],
+                            initialValue: true,
+                        }))];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+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.
+ *
+ * Use this function to create a new config file for users. This is useful
+ * when users answered that they don't yet have a config file for a tool.
+ *
+ * (This doesn't mean that they don't yet have some other way of configuring
+ * their tool but we can leave it up to them to figure out how to merge configs
+ * here.)
+ *
+ * @param filepath absolute path to the new config file
+ * @param codeSnippet the snippet to be inserted into the file
+ * @param moreInformation (optional) the message to be printed after the file was created
+ * For example, this can be a link to more information about configuring the tool.
+ *
+ * @returns true on sucess, false otherwise
+ */
+function createNewConfigFile(filepath, codeSnippet, moreInformation) {
+    return __awaiter(this, void 0, void 0, function () {
+        var prettyFilename, e_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!path.isAbsolute(filepath)) {
+                        (0, debug_1.debug)("createNewConfigFile: filepath is not absolute: ".concat(filepath));
+                        return [2 /*return*/, false];
+                    }
+                    prettyFilename = chalk_1.default.cyan(path.relative(process.cwd(), filepath));
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, fs.promises.writeFile(filepath, codeSnippet)];
+                case 2:
+                    _a.sent();
+                    clack.log.success("Added new ".concat(prettyFilename, " file."));
+                    if (moreInformation) {
+                        clack.log.info(chalk_1.default.gray(moreInformation));
+                    }
+                    return [2 /*return*/, true];
+                case 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];
+            }
+        });
+    });
+}
+exports.createNewConfigFile = createNewConfigFile;
 //# sourceMappingURL=clack-utils.js.map