@clickview/ship-it 0.0.40 → 0.0.42-dev.1

package/lib/src/utils/Csv.js

@@ -1,54 +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;
+"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,274 +1,274 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Descriptions = void 0;
-var Headings = {
-    BeforeRelease: 'Before release',
-    Dependencies: 'Dependencies',
-    CodeChanges: 'Code changes',
-    CustomerChanges: 'Customer changes',
-    Testing: 'Testing',
-    Notes: 'Notes'
-};
-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 = [
-    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';
-    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')
-            continue;
-        if (line.startsWith(headingPrefix + ' ')) {
-            // TODO: Potentially add heading transforms to capture multiple variants
-            currentHeading = headingTransformer(line.replace(headingPrefix, '').trim());
-            continue;
-        }
-        if (!obj[currentHeading])
-            obj[currentHeading] = '';
-        /**
-         * Our images need an extra line return so they don't get squished against our dot points
-         */
-        if (line.startsWith('!'))
-            obj[currentHeading] += '\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;
-}
-/**
- * I can't read this code but it came from here and it works: https://stackoverflow.com/a/63457487/14258157
- * - Josh
- */
-function orderDescriptionHeadings(headings) {
-    // 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 = 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 = {
-    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 errors = this.validateProject(obj, {
-            validSections: validHeadings,
-            requiredSections: PROJECT_REQUIRED_HEADINGS
-        });
-        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 = '#'; }
-        var descriptionObjs = mergeRequests
-            .filter(function (mr) { return mr.status === 'merged'; })
-            .map(function (mr) { return toObject(mr.description.split('\n'), headingPrefix); });
-        var obj = {};
-        var _loop_2 = function (descriptionObj) {
-            Object.keys(descriptionObj).forEach(function (key) {
-                if (!obj[key])
-                    obj[key] = '';
-                obj[key] += descriptionObj[key] + '\n';
-            });
-        };
-        for (var _i = 0, descriptionObjs_1 = descriptionObjs; _i < descriptionObjs_1.length; _i++) {
-            var descriptionObj = descriptionObjs_1[_i];
-            _loop_2(descriptionObj);
-        }
-        var description = '';
-        var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
-        orderedHeadings.forEach(function (key) {
-            if (key === Headings.Notes)
-                return;
-            if (!obj[key])
-                return;
-            description += '\n' + headingPrefix + ' ' + key + '\n';
-            description += obj[key];
-        });
-        return description;
-    },
-    getDescriptionSection: function (heading, mergeRequest) {
-        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
-        var obj = {};
-        Object.keys(descriptionObj).forEach(function (key) {
-            if (!obj[key])
-                obj[key] = '';
-            obj[key] += descriptionObj[key] + '\n';
-        });
-        return obj[Headings[heading]];
-    },
-    // TODO: This isn't readable, it needs to be refactored
-    getMonorepoCombinedDescription: function (mergeRequests) {
-        // Get an object where H1s are properties
-        var descriptionObjs = mergeRequests
-            .filter(function (mr) { return mr.status === 'merged'; })
-            .map(function (mr) { return toObject(mr.description.split('\n'), '#'); });
-        var combinedObj = {};
-        var _loop_3 = function (descriptionObj) {
-            Object.keys(descriptionObj).forEach(function (key) {
-                if (!combinedObj[key])
-                    combinedObj[key] = {};
-                var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
-                var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedSubObj));
-                orderedHeadings.forEach(function (subKey) {
-                    if (!combinedObj[key][subKey])
-                        combinedObj[key][subKey] = '';
-                    combinedObj[key][subKey] += combinedSubObj[subKey];
-                });
-            });
-        };
-        // 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_3(descriptionObj);
-        }
-        var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
-        // Build our description
-        var description = '';
-        orderedHeadings.forEach(function (key) {
-            if (key === Headings.Notes)
-                return;
-            description += '\n# ' + key + '\n';
-            Object.keys(combinedObj[key]).forEach(function (subKey) {
-                if (key !== Headings.Dependencies && key !== Headings.Testing)
-                    description += '\n## ' + subKey + '\n';
-                description += combinedObj[key][subKey];
-            });
-        });
-        return description;
-    },
-    getMonorepoDescriptionSection: function (subHeading, mergeRequest) {
-        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
-        var obj = {};
-        Object.keys(descriptionObj).forEach(function (key) {
-            if (!obj[key])
-                obj[key] = {};
-            var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
-            Object.keys(combinedSubObj).forEach(function (subKey) {
-                if (!obj[key][subKey])
-                    obj[key][subKey] = '';
-                obj[key][subKey] += combinedSubObj[subKey];
-            });
-        });
-        // Build our description
-        var description = '';
-        Object.keys(obj).forEach(function (key) {
-            if (key === Headings.Notes)
-                return;
-            Object.keys(obj[key]).forEach(function (subKey) {
-                if (subKey !== Headings[subHeading])
-                    return;
-                description += '\n# ' + key + '\n';
-                description += obj[key][subKey];
-            });
-        });
-        return description;
-    },
-    bumpHeadings: function (description) {
-        var lines = description.split('\n');
-        var bumpedDescription = '';
-        lines.forEach(function (line) {
-            if (line.startsWith('#'))
-                bumpedDescription += '#' + line + '\n';
-            else
-                bumpedDescription += line + '\n';
-        });
-        return bumpedDescription;
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Descriptions = void 0;
+var Headings = {
+    BeforeRelease: 'Before release',
+    Dependencies: 'Dependencies',
+    CodeChanges: 'Code changes',
+    CustomerChanges: 'Customer changes',
+    Testing: 'Testing',
+    Notes: 'Notes'
+};
+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 = [
+    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';
+    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')
+            continue;
+        if (line.startsWith(headingPrefix + ' ')) {
+            // TODO: Potentially add heading transforms to capture multiple variants
+            currentHeading = headingTransformer(line.replace(headingPrefix, '').trim());
+            continue;
+        }
+        if (!obj[currentHeading])
+            obj[currentHeading] = '';
+        /**
+         * Our images need an extra line return so they don't get squished against our dot points
+         */
+        if (line.startsWith('!'))
+            obj[currentHeading] += '\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;
+}
+/**
+ * I can't read this code but it came from here and it works: https://stackoverflow.com/a/63457487/14258157
+ * - Josh
+ */
+function orderDescriptionHeadings(headings) {
+    // 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 = 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 = {
+    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 errors = this.validateProject(obj, {
+            validSections: validHeadings,
+            requiredSections: PROJECT_REQUIRED_HEADINGS
+        });
+        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 = '#'; }
+        var descriptionObjs = mergeRequests
+            .filter(function (mr) { return mr.status === 'merged'; })
+            .map(function (mr) { return toObject(mr.description.split('\n'), headingPrefix); });
+        var obj = {};
+        var _loop_2 = function (descriptionObj) {
+            Object.keys(descriptionObj).forEach(function (key) {
+                if (!obj[key])
+                    obj[key] = '';
+                obj[key] += descriptionObj[key] + '\n';
+            });
+        };
+        for (var _i = 0, descriptionObjs_1 = descriptionObjs; _i < descriptionObjs_1.length; _i++) {
+            var descriptionObj = descriptionObjs_1[_i];
+            _loop_2(descriptionObj);
+        }
+        var description = '';
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
+        orderedHeadings.forEach(function (key) {
+            if (key === Headings.Notes)
+                return;
+            if (!obj[key])
+                return;
+            description += '\n' + headingPrefix + ' ' + key + '\n';
+            description += obj[key];
+        });
+        return description;
+    },
+    getDescriptionSection: function (heading, mergeRequest) {
+        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
+        var obj = {};
+        Object.keys(descriptionObj).forEach(function (key) {
+            if (!obj[key])
+                obj[key] = '';
+            obj[key] += descriptionObj[key] + '\n';
+        });
+        return obj[Headings[heading]];
+    },
+    // TODO: This isn't readable, it needs to be refactored
+    getMonorepoCombinedDescription: function (mergeRequests) {
+        // Get an object where H1s are properties
+        var descriptionObjs = mergeRequests
+            .filter(function (mr) { return mr.status === 'merged'; })
+            .map(function (mr) { return toObject(mr.description.split('\n'), '#'); });
+        var combinedObj = {};
+        var _loop_3 = function (descriptionObj) {
+            Object.keys(descriptionObj).forEach(function (key) {
+                if (!combinedObj[key])
+                    combinedObj[key] = {};
+                var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
+                var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedSubObj));
+                orderedHeadings.forEach(function (subKey) {
+                    if (!combinedObj[key][subKey])
+                        combinedObj[key][subKey] = '';
+                    combinedObj[key][subKey] += combinedSubObj[subKey];
+                });
+            });
+        };
+        // 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_3(descriptionObj);
+        }
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
+        // Build our description
+        var description = '';
+        orderedHeadings.forEach(function (key) {
+            if (key === Headings.Notes)
+                return;
+            description += '\n# ' + key + '\n';
+            Object.keys(combinedObj[key]).forEach(function (subKey) {
+                if (key !== Headings.Dependencies && key !== Headings.Testing)
+                    description += '\n## ' + subKey + '\n';
+                description += combinedObj[key][subKey];
+            });
+        });
+        return description;
+    },
+    getMonorepoDescriptionSection: function (subHeading, mergeRequest) {
+        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
+        var obj = {};
+        Object.keys(descriptionObj).forEach(function (key) {
+            if (!obj[key])
+                obj[key] = {};
+            var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
+            Object.keys(combinedSubObj).forEach(function (subKey) {
+                if (!obj[key][subKey])
+                    obj[key][subKey] = '';
+                obj[key][subKey] += combinedSubObj[subKey];
+            });
+        });
+        // Build our description
+        var description = '';
+        Object.keys(obj).forEach(function (key) {
+            if (key === Headings.Notes)
+                return;
+            Object.keys(obj[key]).forEach(function (subKey) {
+                if (subKey !== Headings[subHeading])
+                    return;
+                description += '\n# ' + key + '\n';
+                description += obj[key][subKey];
+            });
+        });
+        return description;
+    },
+    bumpHeadings: function (description) {
+        var lines = description.split('\n');
+        var bumpedDescription = '';
+        lines.forEach(function (line) {
+            if (line.startsWith('#'))
+                bumpedDescription += '#' + line + '\n';
+            else
+                bumpedDescription += line + '\n';
+        });
+        return bumpedDescription;
+    }
+};