@sentry/wizard 3.12.0 → 3.14.0

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

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -22,10 +33,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasSentryContent = exports.findFile = void 0;
+exports.printJsonC = exports.parseJsonC = exports.setOrUpdateObjectProperty = exports.getOrSetObjectProperty = exports.getObjectProperty = exports.hasSentryContent = exports.findFile = void 0;
 var fs = __importStar(require("fs"));
 var recast = __importStar(require("recast"));
+var b = recast.types.builders;
 /**
  * Checks if a file where we don't know its concrete file type yet exists
  * and returns the full path to the file with the correct file type.
@@ -57,4 +78,134 @@ function hasSentryContent(program) {
     return !!foundSentry;
 }
 exports.hasSentryContent = hasSentryContent;
+/**
+ * Searches for a property of an ObjectExpression by name
+ *
+ * @param object the ObjectExpression to search in
+ * @param name the name of the property to search for
+ *
+ * @returns the property if it exists
+ */
+function getObjectProperty(object, name) {
+    return object.properties.find(function (p) {
+        var isObjectProp = p.type === 'Property' || p.type === 'ObjectProperty';
+        if (!isObjectProp) {
+            return false;
+        }
+        var hasMatchingLiteralKey = isObjectProp &&
+            (p.key.type === 'Literal' || p.key.type === 'StringLiteral') &&
+            p.key.value === name;
+        if (hasMatchingLiteralKey) {
+            return true;
+        }
+        // has matching identifier key
+        return isObjectProp && p.key.type === 'Identifier' && p.key.name === name;
+    });
+}
+exports.getObjectProperty = getObjectProperty;
+/**
+ * Attempts to find a property of an ObjectExpression by name. If it doesn't exist,
+ * the property will be added to the ObjectExpression with the provided default value.
+ *
+ * @param object the parent object expression to search in
+ * @param name the name of the property to search for
+ * @param defaultValue the default value to set if the property doesn't exist
+ *
+ * @returns the
+ */
+function getOrSetObjectProperty(object, name, defaultValue) {
+    var existingProperty = getObjectProperty(object, name);
+    if (existingProperty) {
+        return existingProperty;
+    }
+    var newProperty = b.property.from({
+        kind: 'init',
+        key: b.stringLiteral(name),
+        value: defaultValue,
+    });
+    object.properties.push(newProperty);
+    return newProperty;
+}
+exports.getOrSetObjectProperty = getOrSetObjectProperty;
+/**
+ * Sets a property of an ObjectExpression if it exists, otherwise adds it
+ * to the ObjectExpression. Optionally, a comment can be added to the
+ * property.
+ *
+ * @param object the ObjectExpression to set the property on
+ * @param name the name of the property to set
+ * @param value  the value of the property to set
+ * @param comment (optional) a comment to add to the property
+ */
+function setOrUpdateObjectProperty(object, name, value, comment) {
+    var newComments = comment &&
+        comment.split('\n').map(function (c) { return b.commentLine(" ".concat(c), true, false); });
+    var existingProperty = getObjectProperty(object, name);
+    if (existingProperty) {
+        existingProperty.value = value;
+        if (newComments) {
+            existingProperty.comments = __spreadArray(__spreadArray([], ((existingProperty === null || existingProperty === void 0 ? void 0 : existingProperty.comments) || []), true), newComments, true);
+        }
+    }
+    else {
+        object.properties.push(b.objectProperty.from(__assign({ key: b.stringLiteral(name), value: value }, (newComments && {
+            comments: newComments,
+        }))));
+    }
+}
+exports.setOrUpdateObjectProperty = setOrUpdateObjectProperty;
+/**
+ * Parses a JSON string with (potential) comments (JSON-C) and returns the JS AST
+ * that can be walked and modified with recast like a normal JS AST.
+ *
+ * This is done by wrapping the JSON-C string in parentheses, thereby making it
+ * a JS `Program` with an `ExpressionStatement` as its body. The expression is then
+ * extracted from the AST and returned alongside the AST.
+ *
+ * To preserve as much original formatting as possible, the returned `ast`
+ * property should be passed to {@link `printJsonC`} to get the JSON-C string back.
+ *
+ * If the input is not valid JSON-C, the result will be undefined.
+ *
+ * @see {@link JsonCParseResult}
+ *
+ * @param jsonString a JSON-C string
+ *
+ * @returns a {@link JsonCParseResult}, containing either the JSON-C object and the AST or undefined in both cases
+ */
+function parseJsonC(jsonString) {
+    try {
+        var jsTsConfig = "(".concat(jsonString, ")");
+        // no idea why recast returns any here, this is dumb :/
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        var ast = recast.parse(jsTsConfig.toString()).program;
+        var jsonObject = (ast.body[0].type === 'ExpressionStatement' &&
+            ast.body[0].expression.type === 'ObjectExpression' &&
+            ast.body[0].expression) ||
+            undefined;
+        if (jsonObject) {
+            return { jsonObject: jsonObject, ast: ast };
+        }
+    }
+    catch (_a) {
+        /* empty */
+    }
+    return { jsonObject: undefined, ast: undefined };
+}
+exports.parseJsonC = parseJsonC;
+/**
+ * Takes the AST of a parsed JSON-C "program" and returns the JSON-C string without
+ * any of the temporary JS wrapper code that was previously applied.
+ *
+ * Only use this in conjunction with {@link `parseJsonC`}
+ *
+ * @param ast the `ast` returned from {@link `parseJsonC`}
+ *
+ * @returns the JSON-C string
+ */
+function printJsonC(ast) {
+    var js = recast.print(ast).code;
+    return js.substring(1, js.length - 1);
+}
+exports.printJsonC = printJsonC;
 //# sourceMappingURL=ast-utils.js.map

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;AAEzB,6CAAiC;AAIjC;;;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","sourcesContent":["import * as fs from 'fs';\n\nimport * as recast from 'recast';\nimport x = recast.types;\nimport t = x.namedTypes;\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"]}
+{"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

@@ -20,7 +20,7 @@ export declare function printWelcome(options: {
     message?: string;
     telemetryEnabled?: boolean;
 }): void;
-export declare function confirmContinueEvenThoughNoGitRepo(): Promise<void>;
+export declare function confirmContinueIfNoOrDirtyGitRepo(): Promise<void>;
 export declare function askToInstallSentryCLI(): Promise<boolean>;
 export declare function askForItemSelection(items: string[], message: string): Promise<{
     value: string;
@@ -31,8 +31,18 @@ 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>;
+/**
+ * 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
+ */
 export declare function ensurePackageIsInstalled(packageJson: PackageDotJson, packageId: string, packageName: string): Promise<void>;
 export declare function getPackageDotJson(): Promise<PackageDotJson>;
 export declare function isUsingTypeScript(): boolean;
@@ -78,15 +88,46 @@ export declare function askForToolConfigPath(toolName: string, configFileName: s
  *
  * @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
  */
-export declare function showCopyPasteInstructions(filename: string, codeSnippet: string): Promise<void>;
+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.
  *
@@ -105,3 +146,4 @@ export declare function showCopyPasteInstructions(filename: string, codeSnippet:
  * @returns true on sucess, false otherwise
  */
 export declare function createNewConfigFile(filepath: string, codeSnippet: string, moreInformation?: string): Promise<boolean>;
+export {};