@clickview/ship-it 0.0.35-dev.18 → 0.0.35-dev.2

package/lib/src/commands/BumpPackagesCommand.js

@@ -53,15 +53,22 @@ require("reflect-metadata");
 var inversify_1 = require("inversify");
 var types_1 = require("../types");
 var BumpPackagesCommand = /** @class */ (function () {
-    function BumpPackagesCommand(bumpPackagesTask) {
+    function BumpPackagesCommand(bumpPackagesTask, commitPackageVersionsTask) {
         this.bumpPackagesTask = bumpPackagesTask;
+        this.commitPackageVersionsTask = commitPackageVersionsTask;
     }
     BumpPackagesCommand.prototype.run = function (options) {
         return __awaiter(this, void 0, void 0, function () {
+            var cont;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.bumpPackagesTask.run(options)];
-                    case 1: return [2 /*return*/, _a.sent()];
+                    case 1:
+                        cont = _a.sent();
+                        if (!cont)
+                            return [2 /*return*/, false];
+                        return [4 /*yield*/, this.commitPackageVersionsTask.run(options)];
+                    case 2: return [2 /*return*/, _a.sent()];
                 }
             });
         });
@@ -69,7 +76,8 @@ var BumpPackagesCommand = /** @class */ (function () {
     BumpPackagesCommand = __decorate([
         (0, inversify_1.injectable)(),
         __param(0, (0, inversify_1.inject)(types_1.TASKS.BumpPackagesTask)),
-        __metadata("design:paramtypes", [Object])
+        __param(1, (0, inversify_1.inject)(types_1.TASKS.CommitPackageVersionsTask)),
+        __metadata("design:paramtypes", [Object, Object])
     ], BumpPackagesCommand);
     return BumpPackagesCommand;
 }());

package/lib/src/constants/MonorepoPackageJsonFiles.js

@@ -1,8 +1,6 @@
 "use strict";
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MONOREPO_PACKAGE_JSON_FILES_MAP = exports.MONOREPO_PACKAGE_JSON_FILES = void 0;
-var ProjectNames_1 = require("./ProjectNames");
+exports.MONOREPO_PACKAGE_JSON_FILES = void 0;
 exports.MONOREPO_PACKAGE_JSON_FILES = [
     'packages/libs/analytics/package.json',
     'packages/libs/styles/package.json',
@@ -17,14 +15,3 @@ exports.MONOREPO_PACKAGE_JSON_FILES = [
     'packages/projects/player/package.json',
     'packages/projects/streamable-learning/package.json'
 ];
-exports.MONOREPO_PACKAGE_JSON_FILES_MAP = (_a = {},
-    _a[ProjectNames_1.PROJECT_NAMES.backend.auth] = 'packages/projects/auth/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.curator] = 'packages/projects/curator/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.cloud] = 'packages/projects/library-editor/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.lite] = 'packages/projects/lite/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.online] = 'packages/projects/online/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.reports] = 'packages/projects/reports/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.exchange] = 'packages/projects/exchange/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.player] = 'packages/projects/player/package.json',
-    _a[ProjectNames_1.PROJECT_NAMES.frontend.streamable] = 'packages/projects/streamable-learning/package.json',
-    _a);

package/lib/src/inversify.config.js

@@ -44,6 +44,7 @@ function createContainer(config) {
     container.bind(types_1.TASKS.CreateNotesAuditTask).to(tasks_1.CreateNotesAuditTask);
     container.bind(types_1.TASKS.InstallPackagesTask).to(tasks_1.InstallPackagesTask);
     container.bind(types_1.TASKS.BumpPackagesTask).to(tasks_1.BumpPackagesTask);
+    container.bind(types_1.TASKS.CommitPackageVersionsTask).to(tasks_1.CommitPackageVersionsTask);
     container.bind(types_1.TASKS.ValidateMergeRequestTask).to(tasks_1.ValidateMergeRequestTask);
     container.bind(types_1.TASKS.StartMonorepoBuildTask).to(tasks_1.StartMonorepoBuildTask);
     container.bind(types_1.TASKS.TagMasterTask).to(tasks_1.TagMasterTask);

package/lib/src/startup/SetupCommands.js

@@ -115,7 +115,6 @@ function setupCommands(program, container) {
         .description('Bump clickview npm package versions in monorepo to their next version')
         .requiredOption('-b, --branchName <branchName>')
         .option('-p, --preId <preId>')
-        .option('--projectIds <projectIds...>')
         .action(getAction('bump-packages'));
     program.command('install-packages')
         .description('Install the latest clickview npm packages in all consuming projects that are part of a milestone')

package/lib/src/tasks/BumpPackagesTask.js

@@ -50,8 +50,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BumpPackagesTask = void 0;
 require("reflect-metadata");
-var fs_1 = require("fs");
 var inversify_1 = require("inversify");
+var child_process_1 = require("child_process");
 var types_1 = require("../types");
 var services_1 = require("../services");
 var MonorepoPackageJsonFiles_1 = require("../constants/MonorepoPackageJsonFiles");
@@ -60,31 +60,25 @@ var RELEASE_BRANCH_REGEX = /^release\/(\d|\.)+$/;
 var HOTFIX_BRANCH_REGEX = /^hotfix\/(\d|\.)+$/;
 var DEV_VERSION_REGEX = /-dev\.\d+$/;
 var RC_VERSION_REGEX = /-rc\.\d+$/;
+var SHARED_LERNA_OPTIONS = '--exact --no-git-tag-version --no-push --yes';
 var BumpPackagesTask = /** @class */ (function () {
     function BumpPackagesTask(service) {
         this.isReleaseBranch = false;
         this.isHotfixBranch = false;
-        this.isInPreRelease = false;
         this.service = service;
     }
     BumpPackagesTask.prototype.run = function (options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var _b, branch, isValid, packageJsonFiles, commitFiles, _i, commitFiles_1, file;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var branch, isValid, lernaVersionCmd;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         utils_1.Logger.logTask('Bumping clickview npm package versions');
                         this.isReleaseBranch = RELEASE_BRANCH_REGEX.test(options.branchName);
                         this.isHotfixBranch = HOTFIX_BRANCH_REGEX.test(options.branchName);
-                        utils_1.Logger.logTask('Detected that monorepo is currently in a pre-release state');
-                        _b = this;
-                        return [4 /*yield*/, this.getIsInPrerelease(options.branchName)];
-                    case 1:
-                        _b.isInPreRelease = _c.sent();
                         return [4 /*yield*/, this.service.getBranch(utils_1.ProjectIds.MONOREPO_PROJECT_ID, options.branchName)];
-                    case 2:
-                        branch = _c.sent();
+                    case 1:
+                        branch = _a.sent();
                         if (!branch) {
                             utils_1.Logger.logError("Branch with name ".concat(options.branchName, " was not be found."));
                             return [2 /*return*/, false];
@@ -92,23 +86,15 @@ var BumpPackagesTask = /** @class */ (function () {
                         isValid = this.validateOptions(options);
                         if (!isValid)
                             return [2 /*return*/, false];
-                        utils_1.Logger.logInfo('Options are valid!');
-                        packageJsonFiles = MonorepoPackageJsonFiles_1.MONOREPO_PACKAGE_JSON_FILES;
-                        if ((_a = options.projectIds) === null || _a === void 0 ? void 0 : _a.length) {
-                            utils_1.Logger.logInfo('Project IDs list detected. Filtering out unspecified package.json files...');
-                            packageJsonFiles = options.projectIds.map(function (projectId) { return MonorepoPackageJsonFiles_1.MONOREPO_PACKAGE_JSON_FILES_MAP[projectId]; });
-                        }
-                        commitFiles = this.getCommitFiles(options, packageJsonFiles);
-                        utils_1.Logger.logInfo('Writing new versions to package.json files...');
-                        for (_i = 0, commitFiles_1 = commitFiles; _i < commitFiles_1.length; _i++) {
-                            file = commitFiles_1[_i];
-                            (0, fs_1.writeFileSync)(file.filePath, file.content);
+                        return [4 /*yield*/, this.getLernaCommand(options)];
+                    case 2:
+                        lernaVersionCmd = _a.sent();
+                        if (!lernaVersionCmd) {
+                            utils_1.Logger.logError('Something went wrong while trying to detect which versioning script to run with Lerna.');
+                            return [2 /*return*/, false];
                         }
-                        utils_1.Logger.logInfo('Committing new versions...');
-                        return [4 /*yield*/, this.service.commit(utils_1.ProjectIds.MONOREPO_PROJECT_ID, options.branchName, 'Bump package versions', commitFiles)];
-                    case 3:
-                        _c.sent();
-                        utils_1.Logger.logSuccess('Successfully committed updated version numbers.');
+                        (0, child_process_1.execSync)(lernaVersionCmd, { stdio: 'inherit' });
+                        utils_1.Logger.logSuccess('Successfully executed Lerna versioning command.');
                         return [2 /*return*/, true];
                 }
             });
@@ -150,51 +136,62 @@ var BumpPackagesTask = /** @class */ (function () {
             });
         });
     };
-    BumpPackagesTask.prototype.getCommitFiles = function (options, packageJsonFiles) {
-        var commitFiles = [];
-        for (var _i = 0, packageJsonFiles_1 = packageJsonFiles; _i < packageJsonFiles_1.length; _i++) {
-            var filePath = packageJsonFiles_1[_i];
-            var content = '';
-            try {
-                content = (0, fs_1.readFileSync)(filePath, { encoding: 'utf8' });
-            }
-            catch (_a) {
-                /**
-                 * If the file doesn't exist, ignore the error.
-                 * This will occur when TC Docker runs this script as it doesn't copy over @clickview/tooling
-                 */
-                continue;
-            }
-            var json = JSON.parse(content);
-            json.version = this.getNextVersion(json.version, options);
-            commitFiles.push({
-                filePath: filePath,
-                content: JSON.stringify(json, null, 2)
+    BumpPackagesTask.prototype.getLernaCommand = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var isInPrerelease;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.isInPrerelease(options.branchName)];
+                    case 1:
+                        isInPrerelease = _a.sent();
+                        /**
+                         * The `lerna version prerelease` script only cares about incrementing the preId part
+                         * of the version number. That's why we run this if `isInPrerelease` is true.
+                         *
+                         * E.g. this would change 0.0.1-dev.0 to 0.0.0-dev.1
+                         */
+                        if (isInPrerelease && options.preId) {
+                            utils_1.Logger.logMessage("Incrementing \"".concat(options.preId, "\" preId for each package."));
+                            return [2 /*return*/, "lerna version prerelease --preid ".concat(options.preId, " ").concat(SHARED_LERNA_OPTIONS)];
+                        }
+                        // Bump the patch with the preId "dev". We currently only support dev prereleases on patch versions
+                        if (options.preId === 'dev') {
+                            utils_1.Logger.logMessage("Incrementing the patch version for each package and appending preId: \"dev\".");
+                            return [2 /*return*/, "lerna version prepatch --preid dev ".concat(SHARED_LERNA_OPTIONS)];
+                        }
+                        if (options.preId === 'rc') {
+                            // Bump the minor number with the preId "rc". Release branches always bump the minor number.
+                            if (this.isReleaseBranch) {
+                                utils_1.Logger.logMessage("Incrementing the minor version for each package and appending preId: \"rc\".");
+                                return [2 /*return*/, "lerna version preminor --preid rc ".concat(SHARED_LERNA_OPTIONS)];
+                            }
+                            // Bump the patch with the preId "rc". Hotfix branches always bump the patch number.
+                            if (this.isHotfixBranch) {
+                                utils_1.Logger.logMessage("Incrementing the patch version for each package and appending preId: \"rc\".");
+                                return [2 /*return*/, "lerna version prepatch --preid rc ".concat(SHARED_LERNA_OPTIONS)];
+                            }
+                        }
+                        /**
+                         * If no preId is provided, we bump the version number to a production version.
+                         *
+                         * Release branch = minor bump
+                         * Hotfix branch = patch bump
+                         */
+                        if (this.isReleaseBranch) {
+                            utils_1.Logger.logMessage('Updating each package to production release version.');
+                            return [2 /*return*/, "lerna version minor ".concat(SHARED_LERNA_OPTIONS)];
+                        }
+                        if (this.isHotfixBranch) {
+                            utils_1.Logger.logMessage('Updating each package to production hotfix version.');
+                            return [2 /*return*/, "lerna version patch ".concat(SHARED_LERNA_OPTIONS)];
+                        }
+                        // Should never be reached
+                        return [2 /*return*/, ''];
+                }
             });
-        }
-        return commitFiles;
-    };
-    BumpPackagesTask.prototype.getNextVersion = function (version, options) {
-        // If we're in a prerelease, we only want to increment the preId part of the version number
-        if (this.isInPreRelease && options.preId) {
-            var currentPreId = Number(version[version.length - 1]);
-            return "".concat(version.substring(0, version.length - 1)).concat(currentPreId + 1);
-        }
-        if (options.preId === 'dev')
-            return "".concat(utils_1.Versions.getNextVersion(version, 'patch'), "-dev.0");
-        if (options.preId === 'rc') {
-            if (this.isReleaseBranch)
-                return "".concat(utils_1.Versions.getNextVersion(version, 'minor'), "-rc.0");
-            if (this.isHotfixBranch)
-                return "".concat(utils_1.Versions.getNextVersion(version, 'patch'), "-rc.0");
-        }
-        if (this.isReleaseBranch)
-            utils_1.Versions.getNextVersion(version, 'minor');
-        if (this.isHotfixBranch)
-            utils_1.Versions.getNextVersion(version, 'patch');
-        return version;
+        });
     };
-    BumpPackagesTask.prototype.getIsInPrerelease = function (branchName) {
+    BumpPackagesTask.prototype.isInPrerelease = function (branchName) {
         return __awaiter(this, void 0, void 0, function () {
             var _i, MONOREPO_PACKAGE_JSON_FILES_1, file, text, json;
             return __generator(this, function (_a) {

package/lib/src/tasks/CommitPackageVersionsTask.js

@@ -0,0 +1,116 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+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 (_) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitPackageVersionsTask = void 0;
+require("reflect-metadata");
+var fs_1 = require("fs");
+var inversify_1 = require("inversify");
+var types_1 = require("../types");
+var services_1 = require("../services");
+var MonorepoPackageJsonFiles_1 = require("../constants/MonorepoPackageJsonFiles");
+var utils_1 = require("../utils");
+var CommitPackageVersionsTask = /** @class */ (function () {
+    function CommitPackageVersionsTask(service) {
+        this.service = service;
+    }
+    CommitPackageVersionsTask.prototype.run = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var branch, commitFiles;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        utils_1.Logger.logTask('Committing clickview npm package versions');
+                        return [4 /*yield*/, this.service.getBranch(utils_1.ProjectIds.MONOREPO_PROJECT_ID, options.branchName)];
+                    case 1:
+                        branch = _a.sent();
+                        if (!branch) {
+                            utils_1.Logger.logError("Branch with name ".concat(options.branchName, " was not be found."));
+                            return [2 /*return*/, false];
+                        }
+                        commitFiles = this.getCommitFiles();
+                        return [4 /*yield*/, this.service.commit(utils_1.ProjectIds.MONOREPO_PROJECT_ID, options.branchName, 'Bump package versions', commitFiles)];
+                    case 2:
+                        _a.sent();
+                        utils_1.Logger.logSuccess('Successfully committed package versions.');
+                        return [2 /*return*/, true];
+                }
+            });
+        });
+    };
+    CommitPackageVersionsTask.prototype.getCommitFiles = function () {
+        var commitFiles = [];
+        for (var _i = 0, MONOREPO_PACKAGE_JSON_FILES_1 = MonorepoPackageJsonFiles_1.MONOREPO_PACKAGE_JSON_FILES; _i < MONOREPO_PACKAGE_JSON_FILES_1.length; _i++) {
+            var filePath = MONOREPO_PACKAGE_JSON_FILES_1[_i];
+            var content = '';
+            try {
+                content = (0, fs_1.readFileSync)(filePath, { encoding: 'utf8' });
+            }
+            catch (_a) {
+                /**
+                 * If the file doesn't exist, ignore the error.
+                 * This will occur when TC Docker runs this script as it doesn't copy over @clickview/tooling
+                 */
+                continue;
+            }
+            commitFiles.push({
+                filePath: filePath,
+                content: content
+            });
+        }
+        return commitFiles;
+    };
+    CommitPackageVersionsTask = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.SERVICES.GitLabService)),
+        __metadata("design:paramtypes", [services_1.GitLabService])
+    ], CommitPackageVersionsTask);
+    return CommitPackageVersionsTask;
+}());
+exports.CommitPackageVersionsTask = CommitPackageVersionsTask;

package/lib/src/tasks/InstallPackagesTask.js

@@ -128,7 +128,7 @@ var InstallPackagesTask = /** @class */ (function () {
                         /**
                          * Run npm i to update our package log file
                         */
-                        utils_1.Logger.logInfo("[".concat(project.title, "]: Running npm i"));
+                        utils_1.Logger.logInfo("[".concat(project.title, "]: Running npm i --package-lock-only"));
                         this.npmInstall(project, folderName);
                         utils_1.Logger.logInfo('\n');
                         /**
@@ -221,7 +221,7 @@ var InstallPackagesTask = /** @class */ (function () {
                         /**
                          * Run npm i to update our package log file
                          */
-                        utils_1.Logger.logInfo("[".concat(project.title, "]: Running npm i"));
+                        utils_1.Logger.logInfo("[".concat(project.title, "]: Running npm i --package-lock-only"));
                         this.npmInstall(project, options.milestone);
                         utils_1.Logger.logInfo('\n');
                         /**
@@ -280,7 +280,7 @@ var InstallPackagesTask = /** @class */ (function () {
     };
     InstallPackagesTask.prototype.npmInstall = function (project, folderName) {
         var outputPath = this.getOutputPath(project, folderName);
-        child_process_1.default.execSync('npm i', {
+        child_process_1.default.execSync('npm i --package-lock-only', {
             cwd: outputPath,
             // Uncomment if we want to silence
             // stdio: 'pipe'

package/lib/src/tasks/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BumpPackagesTask"), exports);
 __exportStar(require("./BumpVersionTxtTask"), exports);
+__exportStar(require("./CommitPackageVersionsTask"), exports);
 __exportStar(require("./CreateBranchTask"), exports);
 __exportStar(require("./CreateMergeRequestTask"), exports);
 __exportStar(require("./CreateReleaseNotesTask"), exports);

package/lib/src/types.js

@@ -31,6 +31,7 @@ exports.TASKS = {
     CreateNotesAuditTask: Symbol.for('CreateNotesAuditTask'),
     InstallPackagesTask: Symbol.for('InstallPackagesTask'),
     BumpPackagesTask: Symbol.for('BumpPackagesTask'),
+    CommitPackageVersionsTask: Symbol.for('CommitPackageVersionsTask'),
     ValidateMergeRequestTask: Symbol.for('ValidateMergeRequestTask'),
     StartMonorepoBuildTask: Symbol.for('StartMonorepoBuildTask'),
     StartProjectBuildsTask: Symbol.for('StartProjectBuildsTask'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clickview/ship-it",
-  "version": "0.0.35-dev.18",
+  "version": "0.0.35-dev.2",
   "description": "Release Manager",
   "main": "./lib/index.js",
   "bin": {