rush-archive-project-plugin
Version:
Rush plugin to archive project
200 lines • 13.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.archive = void 0;
var node_core_library_1 = require("@rushstack/node-core-library");
var path = __importStar(require("path"));
var tar = __importStar(require("tar"));
var git_1 = require("../logic/git");
var graveyard_1 = require("../logic/graveyard");
var projectMetadata_1 = require("../logic/projectMetadata");
var ora_1 = __importDefault(require("ora"));
var inquirer_1 = __importDefault(require("inquirer"));
var fs_1 = __importDefault(require("fs"));
var rushConfiguration_1 = require("../logic/rushConfiguration");
var generateMD_1 = require("../logic/generateMD");
function archive(_a) {
var packageName = _a.packageName, gitCheckpoint = _a.gitCheckpoint, shouldPushGitCheckpoint = _a.shouldPushGitCheckpoint;
return __awaiter(this, void 0, void 0, function () {
var spinner, rushConfiguration, monoRoot, project, consumingProjectNames, projectFolder, projectRelativeFolder, _b, graveyardRelativeFolder, tarballRelativeFolder, tarballFolder, tarballName, branchName, shouldPushBranch, pushBranch, archivedProjectMetadataFilePath, archivedProjectMetadataMdFilePath, archivedProjectMetadataObject, description, projectJson, packageJson, rawRushJson, rawProjectConfig, projectMetadata, projectMetadataFilepath, finalTarballPath, checkIgnored;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
rushConfiguration = (0, rushConfiguration_1.loadRushConfiguration)();
monoRoot = rushConfiguration.rushJsonFolder;
project = rushConfiguration.getProjectByName(packageName);
if (!project) {
throw new Error("Could not find project with package name ".concat(packageName));
}
consumingProjectNames = Array.from(project.consumingProjects).map(function (x) { return x.packageName; });
if (consumingProjectNames.length) {
throw new Error("Target project ".concat(packageName, " is depended by other ").concat(consumingProjectNames.length, " project(s):\n").concat(consumingProjectNames.join(", ")));
}
projectFolder = project.projectFolder, projectRelativeFolder = project.projectRelativeFolder;
// git clean -xdf
spinner = (0, ora_1.default)("Cleaning ".concat(projectRelativeFolder)).start();
(0, git_1.gitFullClean)(projectFolder);
spinner.succeed("Clean ".concat(projectRelativeFolder, " complete"));
_b = (0, graveyard_1.getGraveyardInfo)({
monoRoot: monoRoot,
packageName: packageName,
}), graveyardRelativeFolder = _b.graveyardRelativeFolder, tarballRelativeFolder = _b.tarballRelativeFolder, tarballFolder = _b.tarballFolder, tarballName = _b.tarballName;
node_core_library_1.FileSystem.ensureFolder(tarballFolder);
if (!gitCheckpoint) return [3 /*break*/, 4];
spinner = (0, ora_1.default)('Attempting to create a git checkpoint branch');
branchName = (0, git_1.getCheckpointBranch)(rushConfiguration.rushJsonFolder, packageName);
spinner.succeed("Git Checkpoint created at branch: ".concat(branchName));
shouldPushBranch = void 0;
if (!(shouldPushGitCheckpoint === undefined)) return [3 /*break*/, 2];
return [4 /*yield*/, inquirer_1.default.prompt([
{ type: 'confirm', name: 'pushBranch', message: 'Push checkpoint branch to remote?' }
])];
case 1:
pushBranch = (_c.sent()).pushBranch;
shouldPushBranch = pushBranch;
return [3 /*break*/, 3];
case 2:
shouldPushBranch = shouldPushGitCheckpoint;
_c.label = 3;
case 3:
if (shouldPushBranch) {
(0, git_1.pushGitBranch)(rushConfiguration.rushJsonFolder, branchName);
}
archivedProjectMetadataFilePath = path.join(monoRoot, graveyardRelativeFolder, 'projectCheckpoints.json');
archivedProjectMetadataMdFilePath = path.join(monoRoot, graveyardRelativeFolder, 'projectCheckpoints.md');
archivedProjectMetadataObject = {};
if (node_core_library_1.FileSystem.exists(archivedProjectMetadataFilePath)) {
archivedProjectMetadataObject = node_core_library_1.JsonFile.load(archivedProjectMetadataFilePath);
}
description = "";
projectJson = "".concat(project.projectFolder, "/package.json");
if (node_core_library_1.FileSystem.exists(projectJson)) {
packageJson = node_core_library_1.JsonFile.load("".concat(project.projectFolder, "/package.json"));
description = packageJson.description || "";
}
archivedProjectMetadataObject[packageName] = {
checkpointBranch: branchName,
archivedOn: new Date().toISOString(),
description: description
};
node_core_library_1.JsonFile.save(archivedProjectMetadataObject, archivedProjectMetadataFilePath);
fs_1.default.writeFileSync(archivedProjectMetadataMdFilePath, (0, generateMD_1.convertProjectMetadataToMD)(archivedProjectMetadataObject));
_c.label = 4;
case 4:
// create a metadata.json file
spinner = (0, ora_1.default)("Creating metadata.json for ".concat(projectRelativeFolder)).start();
rawRushJson = node_core_library_1.JsonFile.load(rushConfiguration.rushJsonFile);
rawProjectConfig = rawRushJson.projects.find(function (x) { return x.packageName === packageName; });
projectMetadata = new projectMetadata_1.ProjectMetadata(rawProjectConfig);
projectMetadataFilepath = path.join(projectFolder, projectMetadata_1.ProjectMetadata.FILENAME);
projectMetadata.save(projectMetadataFilepath);
spinner.succeed("Created metadata.json for ".concat(projectRelativeFolder));
// create archive tarball
spinner = (0, ora_1.default)("Creating tarball for ".concat(projectRelativeFolder)).start();
try {
//tar -czf test.tar.gz -C project_relative_folder .
tar.create({
gzip: true,
file: tarballName,
sync: true,
cwd: projectFolder,
}, ["."]);
}
catch (e) {
throw new Error("Failed to create tarball: ".concat(e.message));
}
spinner.succeed("Created tarball for ".concat(projectRelativeFolder));
// move the tarball to the graveyard folder
spinner = (0, ora_1.default)("Moving tarball to ".concat(tarballRelativeFolder)).start();
finalTarballPath = path.join(tarballFolder, tarballName);
node_core_library_1.FileSystem.move({
sourcePath: tarballName,
destinationPath: finalTarballPath,
});
spinner.succeed("Moved tarball to ".concat(tarballRelativeFolder));
// check if the tarball is ignored by git
spinner = (0, ora_1.default)("Checking if tarball is ignored by git").start();
checkIgnored = (0, git_1.gitCheckIgnored)(rushConfiguration.rushJsonFolder, finalTarballPath);
if (checkIgnored) {
throw new Error("Tarball is ignored by git: ".concat(checkIgnored));
}
spinner.succeed("Tarball is not ignored by git");
// remove project config in rush.json
spinner = (0, ora_1.default)("Removing project config from rush.json").start();
rawRushJson.projects = rawRushJson.projects.filter(function (x) { return x.packageName !== packageName; });
node_core_library_1.JsonFile.save(rawRushJson, rushConfiguration.rushJsonFile, {
updateExistingFile: true,
});
spinner.succeed("Removed project config from rush.json");
// delete project folder
spinner = (0, ora_1.default)("Deleting project folder ".concat(projectRelativeFolder)).start();
node_core_library_1.FileSystem.deleteFolder(projectFolder);
spinner.succeed("Deleted project folder ".concat(projectRelativeFolder));
return [2 /*return*/];
}
});
});
}
exports.archive = archive;
//# sourceMappingURL=archive.js.map