@clickview/ship-it 0.0.2 → 0.0.4-dev.0

package/lib/src/utils/Descriptions.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Descriptions = void 0;
-// const VALID_HEADINGS: any = {
-//   'dependencies': true,
-//   'before release': true,
-//   'customer changes': true,
-//   'code changes': true,
-//   'testing': true,
-//   'notes': true
-// };
+var VALID_HEADINGS = {
+    'dependencies': true,
+    'before release': true,
+    'customer changes': true,
+    'code changes': true,
+    'testing': true,
+    'notes': true
+};
 var VALID_MONOREPO_HEADINGS = {
     'common': true,
     'curator': true,
@@ -19,19 +19,20 @@ var VALID_MONOREPO_HEADINGS = {
     'styles': true,
     'player': true,
     'reports': true,
-    'analytis': true,
+    'analytics': true,
     'tooling': true,
     'testing': true,
     'dependencies': true,
-    'notes': true
+    'notes': true,
+    'monorepo': true
 };
 function toObject(lines, headingPrefix) {
-    var obj = [];
+    var obj = {};
     var currentHeading = 'Other';
     for (var _i = 0, lines_1 = lines; _i < lines_1.length; _i++) {
         var line = lines_1[_i];
         // Skip empty lines
-        if (!line.trim() || line === '/n' || line.toLowerCase().trim() === 'n/a')
+        if (!line.trim() || line === '/n')
             continue;
         if (line.startsWith(headingPrefix + ' ')) {
             // TODO: Potentially add heading transforms to capture multiple variants
@@ -45,7 +46,11 @@ function toObject(lines, headingPrefix) {
          */
         if (line.startsWith('!'))
             obj[currentHeading] += '\n';
-        obj[currentHeading] += line + '\n';
+        /**
+         * Skip the line if the dev is opting out by adding n/a
+         */
+        if (line.toLowerCase().trim() !== 'n/a')
+            obj[currentHeading] += line + '\n';
     }
     return obj;
 }
@@ -58,11 +63,10 @@ exports.Descriptions = {
         var keys = Object.keys(obj);
         if (!(keys === null || keys === void 0 ? void 0 : keys.length))
             return false;
-        // TODO: Uncomment below once the team is writing good MR descriptions
-        // if (keys.some(k => !VALID_HEADINGS[k]))
-        //   return false;
-        // if (!obj['testing'])
-        //   return false;
+        if (keys.some(function (k) { return !VALID_HEADINGS[k]; }))
+            return false;
+        if (obj['testing'] === undefined)
+            return false;
         return true;
     },
     isMonorepoDescriptionValid: function (description) {
@@ -74,9 +78,8 @@ exports.Descriptions = {
             return false;
         if (keys.some(function (k) { return !VALID_MONOREPO_HEADINGS[k]; }))
             return false;
-        // TODO: Uncomment below once the team is writing good MR descriptions
-        // if (!obj['testing'])
-        //   return false;
+        if (!obj['testing'])
+            return false;
         var isValid = Object.keys(obj).every(function (key) {
             if (key !== 'dependencies' && key !== 'testing')
                 return true;
@@ -89,7 +92,7 @@ exports.Descriptions = {
         var descriptionObjs = mergeRequests
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), headingPrefix); });
-        var obj = [];
+        var obj = {};
         var _loop_1 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!obj[key])
@@ -105,6 +108,8 @@ exports.Descriptions = {
         Object.keys(obj).forEach(function (key) {
             if (key === 'notes')
                 return;
+            if (!obj[key])
+                return;
             description += '\n' + headingPrefix + ' ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';
             description += obj[key];
         });
@@ -116,7 +121,7 @@ exports.Descriptions = {
         var descriptionObjs = mergeRequests
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), '#'); });
-        var combinedObj = [];
+        var combinedObj = {};
         var _loop_2 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!combinedObj[key])

package/lib/src/utils/ProjectIds.js

@@ -1,13 +1,13 @@
 "use strict";
-// TODO: Eventually this should allow us to map project names to project ids
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectIds = void 0;
+exports.ProjectIds = exports.PROJECT_NAMES = void 0;
 var lodash_1 = __importDefault(require("lodash"));
-var PROJECT_NAMES = {
-    monorepo: '789',
+var errors_1 = require("../errors");
+exports.PROJECT_NAMES = {
+    monorepo: '798',
     online: '109',
     curator: '62',
     cloud: '534',
@@ -16,6 +16,10 @@ var PROJECT_NAMES = {
 };
 exports.ProjectIds = {
     MONOREPO_PROJECT_ID: '798',
+    /**
+     * This allows project names to be passed into the CLI.
+     * For example `ship-it release -m S2 -p lite`
+     */
     getProjectIds: function (projects) {
         var projectIds = [];
         for (var _i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
@@ -24,9 +28,9 @@ exports.ProjectIds = {
                 projectIds.push(project);
                 continue;
             }
-            var mappedId = PROJECT_NAMES[project.toLowerCase()];
+            var mappedId = exports.PROJECT_NAMES[project.toLowerCase()];
             if (!mappedId)
-                throw new Error("Could not find project id mapping for ".concat(project));
+                throw new errors_1.ShipItError("Could not find project id mapping for ".concat(project));
             projectIds.push(mappedId);
         }
         return projectIds;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@clickview/ship-it",
-  "version": "0.0.2",
+  "version": "0.0.4-dev.0",
   "description": "Release Manager",
   "main": "./lib/index.js",
   "bin": {
     "ship-it": "./lib/src/index.js"
   },
   "scripts": {
-    "start": "npm run lint && ts-node src/index.ts",
+    "start": "npm run lint && ts-node --files src/index.ts",
     "build": "npm run lint && tsc -p . && tsc-alias -p tsconfig.json",
     "lint": "eslint . --ext .ts"
   },
@@ -18,28 +18,29 @@
   "author": "Joshua Taylor, Shale Kuzmanovski",
   "license": "ISC",
   "dependencies": {
-    "@gitbeaker/node": "^35.6.0",
-    "chalk": "^4.1.2",
-    "commander": "^9.1.0",
-    "fs-extra": "^10.0.1",
-    "inversify": "^6.0.1",
-    "lodash": "^4.17.21",
-    "reflect-metadata": "^0.1.13",
-    "semver": "^7.3.5"
+    "@gitbeaker/node": "35.6.0",
+    "chalk": "4.1.2",
+    "commander": "9.1.0",
+    "fs-extra": "10.0.1",
+    "inversify": "6.0.1",
+    "lodash": "4.17.21",
+    "reflect-metadata": "0.1.13",
+    "semver": "7.3.5",
+    "teamcity-rest-api": "0.0.8"
   },
   "devDependencies": {
-    "@clickview/eslint-config": "^1.0.3",
-    "@types/fs-extra": "^9.0.13",
-    "@types/lodash": "^4.14.181",
-    "@types/node": "^17.0.23",
-    "@types/semver": "^7.3.9",
-    "@typescript-eslint/eslint-plugin": "^5.17.0",
-    "@typescript-eslint/parser": "^5.17.0",
-    "eslint": "^8.12.0",
-    "eslint-plugin-react-hooks": "^4.4.0",
-    "ts-node": "^10.7.0",
-    "tsc-alias": "^1.6.6",
-    "tsconfig-paths": "^3.14.1",
-    "typescript": "^4.6.3"
+    "@clickview/eslint-config": "1.0.3",
+    "@types/fs-extra": "9.0.13",
+    "@types/lodash": "4.14.181",
+    "@types/node": "17.0.23",
+    "@types/semver": "7.3.9",
+    "@typescript-eslint/eslint-plugin": "5.17.0",
+    "@typescript-eslint/parser": "5.17.0",
+    "eslint": "8.12.0",
+    "eslint-plugin-react-hooks": "4.4.0",
+    "ts-node": "10.7.0",
+    "tsc-alias": "1.6.6",
+    "tsconfig-paths": "3.14.1",
+    "typescript": "4.6.3"
   }
 }