@clickview/ship-it 0.0.9 → 0.0.11

package/lib/src/utils/Csv.js

@@ -0,0 +1,54 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CsvFile = void 0;
+var format_1 = require("@fast-csv/format");
+var fs_extra_1 = __importDefault(require("fs-extra"));
+var CsvFile = /** @class */ (function () {
+    function CsvFile(opts) {
+        this.headers = opts.headers;
+        this.path = opts.path;
+        this.writeOpts = { headers: this.headers, includeEndRowDelimiter: true };
+    }
+    CsvFile.write = function (stream, rows, options) {
+        return new Promise(function (res, rej) {
+            (0, format_1.writeToStream)(stream, rows, options)
+                .on('error', function (err) { return rej(err); })
+                .on('finish', function () { return res(); });
+        });
+    };
+    CsvFile.prototype.create = function (rows) {
+        return CsvFile.write(fs_extra_1.default.createWriteStream(this.path), rows, __assign({}, this.writeOpts));
+    };
+    CsvFile.prototype.append = function (rows) {
+        return CsvFile.write(fs_extra_1.default.createWriteStream(this.path, { flags: 'a' }), rows, __assign(__assign({}, this.writeOpts), { 
+            // dont write the headers when appending
+            writeHeaders: false }));
+    };
+    CsvFile.prototype.read = function () {
+        var _this = this;
+        return new Promise(function (res, rej) {
+            fs_extra_1.default.readFile(_this.path, function (err, contents) {
+                if (err) {
+                    return rej(err);
+                }
+                return res(contents);
+            });
+        });
+    };
+    return CsvFile;
+}());
+exports.CsvFile = CsvFile;

package/lib/src/utils/Descriptions.js

@@ -1,67 +1,46 @@
 "use strict";
-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.Descriptions = void 0;
-var VALID_HEADINGS = {
-    'dependencies': true,
-    'before release': true,
-    'customer changes': true,
-    'code changes': true,
-    'testing': true,
-    'notes': true,
-    'other': true
-};
-var VALID_MONOREPO_HEADINGS = {
-    'common': true,
-    'curator': true,
-    'library editor': true,
-    'lite': true,
-    'online': true,
-    'shared': true,
-    'styles': true,
-    'player': true,
-    'reports': true,
-    'analytics': true,
-    'tooling': true,
-    'testing': true,
-    'dependencies': true,
-    'notes': true,
-    'monorepo': true,
-    'before release': true
+var Headings = {
+    BeforeRelease: 'Before release',
+    Dependencies: 'Dependencies',
+    CodeChanges: 'Code changes',
+    CustomerChanges: 'Customer changes',
+    Testing: 'Testing',
+    Notes: 'Notes'
 };
-/**
- * Most of the ordering here doesn't matter, BUT "before release" and "dependencies" should always be
- * at the top so that they're more visible to whoever is managing the release.
- */
+var BASE_VALID_HEADINGS = [
+    Headings.BeforeRelease,
+    Headings.Dependencies,
+    Headings.Testing,
+    Headings.Notes
+];
+var PROJECT_VALID_HEADINGS = BASE_VALID_HEADINGS.concat([
+    Headings.CustomerChanges,
+    Headings.CodeChanges
+]);
+var PROJECT_REQUIRED_HEADINGS = [
+    Headings.Testing
+];
 var HEADING_ORDER = [
-    'before release',
-    'dependencies',
-    'notes',
-    'other',
-    'customer changes',
-    'code changes',
-    'lite',
-    'library editor',
-    'online',
-    'reports',
-    'curator',
-    'player',
-    'shared',
-    'analytics',
-    'styles',
-    'common',
-    'monorepo',
-    'tooling',
-    'testing'
+    Headings.BeforeRelease,
+    Headings.Dependencies,
+    Headings.CustomerChanges,
+    Headings.CodeChanges,
+    '*',
+    Headings.Testing,
+    Headings.Notes,
 ];
+function headingTransformer(heading) {
+    // Fix casing of known headings
+    var lowerHeading = heading.toLowerCase();
+    for (var i = 0; i < PROJECT_VALID_HEADINGS.length; i++) {
+        if (PROJECT_VALID_HEADINGS[i].toLowerCase() === lowerHeading)
+            return PROJECT_VALID_HEADINGS[i];
+    }
+    // No transform
+    return heading;
+}
 function toObject(lines, headingPrefix) {
     var obj = {};
     var currentHeading = 'other';
@@ -72,7 +51,7 @@ function toObject(lines, headingPrefix) {
             continue;
         if (line.startsWith(headingPrefix + ' ')) {
             // TODO: Potentially add heading transforms to capture multiple variants
-            currentHeading = line.toLowerCase().replace(headingPrefix, '').trim();
+            currentHeading = headingTransformer(line.replace(headingPrefix, '').trim());
             continue;
         }
         if (!obj[currentHeading])
@@ -95,47 +74,85 @@ function toObject(lines, headingPrefix) {
  * - Josh
  */
 function orderDescriptionHeadings(headings) {
-    var orderForIndexVals = __spreadArray([], HEADING_ORDER, true).reverse();
+    // Get the index of our wildcard where we put all the other headings into
+    var starIndex = HEADING_ORDER.indexOf('*');
+    if (starIndex === -1)
+        starIndex = HEADING_ORDER.length;
     return headings.sort(function (a, b) {
-        var aIndex = -orderForIndexVals.indexOf(a);
-        var bIndex = -orderForIndexVals.indexOf(b);
+        var aIndex = HEADING_ORDER.indexOf(a);
+        var bIndex = HEADING_ORDER.indexOf(b);
+        // Do normal sort logic if both are missing from heading order
+        if (aIndex === -1 && bIndex === -1) {
+            if (a < b)
+                return -1;
+            if (a > b)
+                return 1;
+            return 0;
+        }
+        if (aIndex === -1)
+            aIndex = starIndex;
+        if (bIndex === -1)
+            bIndex = starIndex;
         return aIndex - bIndex;
     });
 }
 exports.Descriptions = {
-    isDescriptionValid: function (description, headingPrefix, checkForTesting) {
-        if (headingPrefix === void 0) { headingPrefix = '#'; }
-        if (checkForTesting === void 0) { checkForTesting = true; }
-        if (!description.trim())
-            return false;
-        var obj = toObject(description.split('\n'), headingPrefix);
-        var keys = Object.keys(obj);
-        if (!(keys === null || keys === void 0 ? void 0 : keys.length))
-            return false;
-        if (keys.some(function (k) { return !VALID_HEADINGS[k]; }))
-            return false;
-        if (checkForTesting && obj['testing'] === undefined)
-            return false;
-        return true;
-    },
-    isMonorepoDescriptionValid: function (description) {
-        if (!description.trim())
-            return false;
+    validate: function (description, projectConfig) {
+        var validHeadings;
+        // If we are a monorepo, add in the valid sub project headings
+        if (projectConfig.monorepo.enabled) {
+            var subProjects = projectConfig.monorepo.validSubProjects;
+            validHeadings = BASE_VALID_HEADINGS.concat(subProjects);
+        }
+        else {
+            validHeadings = PROJECT_VALID_HEADINGS;
+        }
+        // Parse description
         var obj = toObject(description.split('\n'), '#');
-        var keys = Object.keys(obj);
-        if (!(keys === null || keys === void 0 ? void 0 : keys.length))
-            return false;
-        if (keys.some(function (k) { return !VALID_MONOREPO_HEADINGS[k]; }))
-            return false;
-        if (obj['testing'] === undefined)
-            return false;
-        var isValid = Object.keys(obj).every(function (key) {
-            if (key === 'dependencies' || key === 'testing')
-                return true;
-            var subValid = exports.Descriptions.isDescriptionValid(obj[key], '##', false);
-            return subValid;
+        var errors = this.validateProject(obj, {
+            validSections: validHeadings,
+            requiredSections: PROJECT_REQUIRED_HEADINGS
         });
-        return isValid;
+        if (!projectConfig.monorepo.enabled)
+            return errors;
+        var _loop_1 = function (subProject) {
+            // Ignore known headings
+            if (PROJECT_VALID_HEADINGS.indexOf(subProject) !== -1)
+                return "continue";
+            var subObj = toObject(obj[subProject].split('\n'), '##');
+            var subErrors = this_1.validateProject(subObj, {
+                validSections: PROJECT_VALID_HEADINGS,
+                requiredSections: []
+            });
+            errors = errors.concat(subErrors.map(function (x) { return "[".concat(subProject, "] ") + x; }));
+        };
+        var this_1 = this;
+        // If monorepo we need to check the sub projects are valid
+        for (var subProject in obj) {
+            _loop_1(subProject);
+        }
+        return errors;
+    },
+    validateProject: function (parsedDescription, options) {
+        // Parse description
+        var headings = Object.keys(parsedDescription);
+        // Must have at least one heading
+        if (headings.length < 1)
+            return ['Must have at least one section'];
+        var errors = [];
+        // Ensure all the headings are valid
+        for (var _i = 0, headings_1 = headings; _i < headings_1.length; _i++) {
+            var heading = headings_1[_i];
+            if (options.validSections.indexOf(heading) === -1)
+                errors.push("Invalid section: ".concat(heading));
+        }
+        // Ensure we have all required headings
+        for (var _a = 0, _b = options.requiredSections; _a < _b.length; _a++) {
+            var requiredSection = _b[_a];
+            if (parsedDescription[requiredSection] === undefined)
+                errors.push("Missing section: ".concat(requiredSection));
+        }
+        return errors;
     },
     getCombinedDescription: function (mergeRequests, headingPrefix) {
         if (headingPrefix === void 0) { headingPrefix = '#'; }
@@ -143,7 +160,7 @@ exports.Descriptions = {
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), headingPrefix); });
         var obj = {};
-        var _loop_1 = function (descriptionObj) {
+        var _loop_2 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!obj[key])
                     obj[key] = '';
@@ -152,16 +169,16 @@ exports.Descriptions = {
         };
         for (var _i = 0, descriptionObjs_1 = descriptionObjs; _i < descriptionObjs_1.length; _i++) {
             var descriptionObj = descriptionObjs_1[_i];
-            _loop_1(descriptionObj);
+            _loop_2(descriptionObj);
         }
         var description = '';
         var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
         orderedHeadings.forEach(function (key) {
-            if (key === 'notes')
+            if (key === Headings.Notes)
                 return;
             if (!obj[key])
                 return;
-            description += '\n' + headingPrefix + ' ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';
+            description += '\n' + headingPrefix + ' ' + key + '\n';
             description += obj[key];
         });
         return description;
@@ -173,7 +190,7 @@ exports.Descriptions = {
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), '#'); });
         var combinedObj = {};
-        var _loop_2 = function (descriptionObj) {
+        var _loop_3 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!combinedObj[key])
                     combinedObj[key] = {};
@@ -189,18 +206,18 @@ exports.Descriptions = {
         // For each property in each MR object, calculate it's H2 heading objects
         for (var _i = 0, descriptionObjs_2 = descriptionObjs; _i < descriptionObjs_2.length; _i++) {
             var descriptionObj = descriptionObjs_2[_i];
-            _loop_2(descriptionObj);
+            _loop_3(descriptionObj);
         }
         var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
         // Build our description
         var description = '';
         orderedHeadings.forEach(function (key) {
-            if (key === 'notes')
+            if (key === Headings.Notes)
                 return;
-            description += '\n# ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';
+            description += '\n# ' + key + '\n';
             Object.keys(combinedObj[key]).forEach(function (subKey) {
-                if (key !== 'dependencies' && key !== 'testing')
-                    description += '\n## ' + subKey.charAt(0).toUpperCase() + subKey.slice(1) + '\n';
+                if (key !== Headings.Dependencies && key !== Headings.Testing)
+                    description += '\n## ' + subKey + '\n';
                 description += combinedObj[key][subKey];
             });
         });

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@clickview/ship-it",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Release Manager",
   "main": "./lib/index.js",
   "bin": {
     "ship-it": "./lib/src/index.js"
   },
   "scripts": {
-    "start": "npm run lint && ts-node --files 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"
   },
@@ -21,6 +21,7 @@
     "@gitbeaker/node": "35.6.0",
     "chalk": "4.1.2",
     "commander": "9.1.0",
+    "fast-csv": "4.3.6",
     "fs-extra": "10.0.1",
     "inversify": "6.0.1",
     "lodash": "4.17.21",