@sentry/wizard
Version:
Sentry wizard helping you to configure your project
174 lines • 10.1 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.enableSourcemaps = exports.configureTscSourcemapGenerationFlow = void 0;
var fs = __importStar(require("fs"));
var path = __importStar(require("path"));
var recast = __importStar(require("recast"));
var Sentry = __importStar(require("@sentry/node"));
// @ts-ignore - clack is ESM and TS complains about that. It works though
var clack = __importStar(require("@clack/prompts"));
var chalk_1 = __importDefault(require("chalk"));
var clack_utils_1 = require("../../utils/clack-utils");
var ast_utils_1 = require("../../utils/ast-utils");
var debug_1 = require("../../utils/debug");
var b = recast.types.builders;
var getCodeSnippet = function (colors) {
return (0, clack_utils_1.makeCodeSnippet)(colors, function (unchanged, plus, _) {
return unchanged("{\n \"compilerOptions\": {\n ".concat(plus('"sourceMap": true,'), "\n ").concat(plus('"inlineSources": true,'), "\n\n // Set `sourceRoot` to \"/\" to strip the build path prefix from\n // generated source code references. This will improve issue grouping in Sentry.\n ").concat(plus('"sourceRoot": "/"'), "\n }\n}"));
});
};
function configureTscSourcemapGenerationFlow() {
var _a;
return __awaiter(this, void 0, void 0, function () {
var tsConfigPath, _b, successfullyAdded;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
if (!((_a = (0, ast_utils_1.findFile)(path.join(process.cwd(), 'tsconfig'), ['.json'])) !== null && _a !== void 0)) return [3 /*break*/, 1];
_b = _a;
return [3 /*break*/, 3];
case 1: return [4 /*yield*/, (0, clack_utils_1.askForToolConfigPath)('TypeScript', 'tsconfig.json')];
case 2:
_b = (_c.sent());
_c.label = 3;
case 3:
tsConfigPath = _b;
successfullyAdded = false;
if (!tsConfigPath) return [3 /*break*/, 5];
return [4 /*yield*/, enableSourcemaps(tsConfigPath)];
case 4:
successfullyAdded = _c.sent();
return [3 /*break*/, 7];
case 5: return [4 /*yield*/, (0, clack_utils_1.createNewConfigFile)(path.join(process.cwd(), 'tsconfig.json'), getCodeSnippet(false))];
case 6:
successfullyAdded = _c.sent();
Sentry.setTag('created-new-config', successfullyAdded ? 'success' : 'fail');
_c.label = 7;
case 7:
if (!successfullyAdded) return [3 /*break*/, 8];
Sentry.setTag('ast-mod', 'success');
clack.log.info("We recommend checking the ".concat(tsConfigPath ? 'modified' : 'added', " file after the wizard finished to ensure it works with your build setup."));
return [3 /*break*/, 10];
case 8:
Sentry.setTag('ast-mod', 'fail');
return [4 /*yield*/, (0, clack_utils_1.showCopyPasteInstructions)('tsconfig.json', getCodeSnippet(true), 'This ensures that source maps are generated correctly')];
case 9:
_c.sent();
_c.label = 10;
case 10: return [2 /*return*/];
}
});
});
}
exports.configureTscSourcemapGenerationFlow = configureTscSourcemapGenerationFlow;
/**
* Modifies tsconfig.json (@param tsConfigPath) to enable source maps generation.
*
* Exported only for testing
*/
function enableSourcemaps(tsConfigPath) {
return __awaiter(this, void 0, void 0, function () {
var tsConfig, _a, ast, jsonObject, compilerOptionsProp, compilerOptionsObj, code, e_1;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 3, , 4]);
return [4 /*yield*/, fs.promises.readFile(tsConfigPath, 'utf-8')];
case 1:
tsConfig = _b.sent();
_a = (0, ast_utils_1.parseJsonC)(tsConfig.toString()), ast = _a.ast, jsonObject = _a.jsonObject;
if (!jsonObject || !ast) {
// this will only happen if the input file isn't valid JSON-C
Sentry.setTag('ast-mod-fail-reason', 'original-file-invalid');
return [2 /*return*/, false];
}
compilerOptionsProp = (0, ast_utils_1.getOrSetObjectProperty)(jsonObject, 'compilerOptions', b.objectExpression([]));
compilerOptionsObj = compilerOptionsProp.value;
if (!compilerOptionsObj || compilerOptionsObj.type !== 'ObjectExpression') {
// a valid compilerOptions prop should always be an object expression
Sentry.setTag('ast-mod-fail-reason', 'original-file-invalid');
return [2 /*return*/, false];
}
(0, ast_utils_1.setOrUpdateObjectProperty)(compilerOptionsObj, 'sourceMap', b.booleanLiteral(true));
(0, ast_utils_1.setOrUpdateObjectProperty)(compilerOptionsObj, 'inlineSources', b.booleanLiteral(true));
(0, ast_utils_1.setOrUpdateObjectProperty)(compilerOptionsObj, 'sourceRoot', b.stringLiteral('/'), 'Set `sourceRoot` to "/" to strip the build path prefix\nfrom generated source code references.\nThis improves issue grouping in Sentry.');
code = (0, ast_utils_1.printJsonC)(ast);
return [4 /*yield*/, fs.promises.writeFile(tsConfigPath, code)];
case 2:
_b.sent();
clack.log.success("Enabled source maps generation in ".concat(chalk_1.default.cyan(path.basename(tsConfigPath || 'tsconfig.json')), "."));
return [2 /*return*/, true];
case 3:
e_1 = _b.sent();
(0, debug_1.debug)(e_1);
Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
return [2 /*return*/, false];
case 4: return [2 /*return*/];
}
});
});
}
exports.enableSourcemaps = enableSourcemaps;
//# sourceMappingURL=tsc.js.map