clubhouse-cli - npm Package Compare versions

Comparing version 2.3.1 to 2.4.0

build/bin/club-epics.js

@@ -51,2 +51,3 @@ #!/usr/bin/env node
     .option('-d, --detailed', 'List more details for each epic', '')
+    .option('-f, --format [template]', 'Format each epic output by template', '')
     .option('-M, --milestone [ID]', 'List epics in milestone matching id', '')
@@ -84,26 +85,33 @@ .option('-t, --title [query]', 'List epics with name/title containing query', '')
         return;
-    log(chalk_1.default.bold("#" + epic.id) + chalk_1.default.blue(" " + epic.name));
-    log(chalk_1.default.bold('Milestone:     ') + (" " + (epic.milestone_id || '_')));
-    log(chalk_1.default.bold('State:         ') + (" " + epic.state));
-    log(chalk_1.default.bold('Deadline:      ') + (" " + (epic.deadline || '_')));
-    log(chalk_1.default.bold('Points:        ') + (" " + epic.stats.num_points));
-    log(chalk_1.default.bold('Points Started:') + (" " + epic.stats.num_points_started));
-    log(chalk_1.default.bold('Points Done:   ') + (" " + epic.stats.num_points_done));
-    log(chalk_1.default.bold('Completion:    ') +
-        (" " + Math.round((epic.stats.num_points_done / (epic.stats.num_points || 1)) * 100) + "%"));
+    var defaultFormat = "#%id %t\nMilestone:\t%m\nState:\t\t%s\nDeadline:\t%dl\n";
+    defaultFormat += "Points:\t\t%p\nPoints Started: %ps\nPoints Done:\t%pd\nCompletion:\t%c\n";
     if (epic.archived) {
-        log(chalk_1.default.bold('Archived:      ') + (" " + epic.archived));
+        defaultFormat += "Archived:\t%ar\n";
     }
     if (epic.started) {
-        log(chalk_1.default.bold('Started:       ') + (" " + epic.started_at));
+        defaultFormat += "Started:\t%st\n";
     }
     if (epic.completed) {
-        log(chalk_1.default.bold('Completed:     ') + (" " + epic.completed_at));
+        defaultFormat += "Completed:\t%co\n";
     }
     if (program.detailed) {
-        log(chalk_1.default.bold('Description:    ') + (" " + epic.description));
+        defaultFormat += "Description:\t%d\n";
     }
-    log();
+    var format = program.format || defaultFormat;
+    log(format
+        .replace(/%id/, chalk_1.default.bold("" + epic.id))
+        .replace(/%t/, chalk_1.default.blue("" + epic.name))
+        .replace(/%m/, "" + (epic.milestone_id || '_'))
+        .replace(/%s/, "" + epic.state)
+        .replace(/%dl/, "" + (epic.deadline || '_'))
+        .replace(/%d/, "" + epic.description)
+        .replace(/%p/, "" + epic.stats.num_points)
+        .replace(/%ps/, "" + epic.stats.num_points_started)
+        .replace(/%pd/, "" + epic.stats.num_points_done)
+        .replace(/%c/, Math.round((epic.stats.num_points_done / (epic.stats.num_points || 1)) * 100) + "%")
+        .replace(/%a/, "" + epic.archived)
+        .replace(/%st/, "" + epic.started_at)
+        .replace(/%co/, "" + epic.completed_at));
 };
 main();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2x1Yi1lcGljcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iaW4vY2x1Yi1lcGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFDQSx3Q0FBbUM7QUFDbkMscUNBQXVDO0FBQ3ZDLCtCQUEwQjtBQUcxQiwwQ0FBcUM7QUFFckMsSUFBTSxHQUFHLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQztBQUN4QixJQUFNLElBQUksR0FBRyxpQkFBTyxFQUFFLENBQUM7QUFFdkIsSUFBTSxPQUFPLEdBQUcsU0FBUztLQUNwQixXQUFXLENBQUMscUNBQXFDLENBQUM7S0FDbEQsTUFBTSxDQUFDLGdCQUFnQixFQUFFLG9DQUFvQyxFQUFFLEVBQUUsQ0FBQztLQUNsRSxNQUFNLENBQUMsaUJBQWlCLEVBQUUsMENBQTBDLEVBQUUsRUFBRSxDQUFDO0tBQ3pFLE1BQU0sQ0FBQyxnQkFBZ0IsRUFBRSxpQ0FBaUMsRUFBRSxFQUFFLENBQUM7S0FDL0QsTUFBTSxDQUFDLHNCQUFzQixFQUFFLHFDQUFxQyxFQUFFLEVBQUUsQ0FBQztLQUN6RSxNQUFNLENBQUMscUJBQXFCLEVBQUUsNkNBQTZDLEVBQUUsRUFBRSxDQUFDO0tBQ2hGLE1BQU0sQ0FBQyxlQUFlLEVBQUUsbUNBQW1DLEVBQUUsRUFBRSxDQUFDO0tBQ2hFLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7QUFFekIsSUFBTSxJQUFJLEdBQUc7Ozs7O2dCQUNULElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztnQkFDQyxXQUFNLGdCQUFNLENBQUMsU0FBUyxFQUFFLEVBQUE7O2dCQUFoQyxLQUFLLEdBQUcsU0FBd0I7Z0JBQ3RDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ1YsU0FBUyxHQUFHLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7Z0JBQ2pELEtBQUs7cUJBQ0EsTUFBTSxDQUFDLFVBQUMsSUFBVTtvQkFDZixPQUFPLENBQ0gsQ0FBQyxDQUFDLENBQUcsSUFBSSxDQUFDLElBQUksU0FBSSxJQUFJLENBQUMsSUFBTSxDQUFBLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQzt3QkFDOUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksSUFBSSxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FDeEUsQ0FBQztnQkFDTixDQUFDLENBQUM7cUJBQ0QsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDOzs7O0tBQ3ZCLENBQUM7QUFFRixJQUFNLFNBQVMsR0FBRyxVQUFDLElBQVU7SUFDekIsSUFBSSxJQUFJLENBQUMsUUFBUSxJQUFJLENBQUMsT0FBTyxDQUFDLFFBQVE7UUFBRSxPQUFPO0lBQy9DLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxJQUFJLE9BQU8sQ0FBQyxPQUFPO1FBQUUsT0FBTztJQUM3QyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsSUFBSSxPQUFPLENBQUMsU0FBUztRQUFFLE9BQU87SUFFakQsR0FBRyxDQUFDLGVBQUssQ0FBQyxJQUFJLENBQUMsTUFBSSxJQUFJLENBQUMsRUFBSSxDQUFDLEdBQUcsZUFBSyxDQUFDLElBQUksQ0FBQyxNQUFJLElBQUksQ0FBQyxJQUFNLENBQUMsQ0FBQyxDQUFDO0lBQzdELEdBQUcsQ0FBQyxlQUFLLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLElBQUcsT0FBSSxJQUFJLENBQUMsWUFBWSxJQUFJLEdBQUcsQ0FBRSxDQUFBLENBQUMsQ0FBQztJQUNwRSxHQUFHLENBQUMsZUFBSyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxJQUFHLE1BQUksSUFBSSxDQUFDLEtBQU8sQ0FBQSxDQUFDLENBQUM7SUFDdEQsR0FBRyxDQUFDLGVBQUssQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsSUFBRyxPQUFJLElBQUksQ0FBQyxRQUFRLElBQUksR0FBRyxDQUFFLENBQUEsQ0FBQyxDQUFDO0lBQ2hFLEdBQUcsQ0FBQyxlQUFLLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLElBQUcsTUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLFVBQVksQ0FBQSxDQUFDLENBQUM7SUFDakUsR0FBRyxDQUFDLGVBQUssQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsSUFBRyxNQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsa0JBQW9CLENBQUEsQ0FBQyxDQUFDO0lBQ3pFLEdBQUcsQ0FBQyxlQUFLLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLElBQUcsTUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLGVBQWlCLENBQUEsQ0FBQyxDQUFDO0lBQ3RFLEdBQUcsQ0FDQyxlQUFLLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDO1NBQ3pCLE1BQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsZUFBZSxHQUFHLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxHQUFHLENBQUMsTUFBRyxDQUFBLENBQzNGLENBQUM7SUFDRixJQUFJLElBQUksQ0FBQyxRQUFRLEVBQUU7UUFDZixHQUFHLENBQUMsZUFBSyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxJQUFHLE1BQUksSUFBSSxDQUFDLFFBQVUsQ0FBQSxDQUFDLENBQUM7S0FDNUQ7SUFDRCxJQUFJLElBQUksQ0FBQyxPQUFPLEVBQUU7UUFDZCxHQUFHLENBQUMsZUFBSyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxJQUFHLE1BQUksSUFBSSxDQUFDLFVBQVksQ0FBQSxDQUFDLENBQUM7S0FDOUQ7SUFDRCxJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUU7UUFDaEIsR0FBRyxDQUFDLGVBQUssQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsSUFBRyxNQUFJLElBQUksQ0FBQyxZQUFjLENBQUEsQ0FBQyxDQUFDO0tBQ2hFO0lBQ0QsSUFBSSxPQUFPLENBQUMsUUFBUSxFQUFFO1FBQ2xCLEdBQUcsQ0FBQyxlQUFLLENBQUMsSUFBSSxDQUFDLGtCQUFrQixDQUFDLElBQUcsTUFBSSxJQUFJLENBQUMsV0FBYSxDQUFBLENBQUMsQ0FBQztLQUNoRTtJQUNELEdBQUcsRUFBRSxDQUFDO0FBQ1YsQ0FBQyxDQUFDO0FBQ0YsSUFBSSxFQUFFLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2x1Yi1lcGljcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iaW4vY2x1Yi1lcGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFDQSx3Q0FBbUM7QUFDbkMscUNBQXVDO0FBQ3ZDLCtCQUEwQjtBQUcxQiwwQ0FBcUM7QUFFckMsSUFBTSxHQUFHLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQztBQUN4QixJQUFNLElBQUksR0FBRyxpQkFBTyxFQUFFLENBQUM7QUFFdkIsSUFBTSxPQUFPLEdBQUcsU0FBUztLQUNwQixXQUFXLENBQUMscUNBQXFDLENBQUM7S0FDbEQsTUFBTSxDQUFDLGdCQUFnQixFQUFFLG9DQUFvQyxFQUFFLEVBQUUsQ0FBQztLQUNsRSxNQUFNLENBQUMsaUJBQWlCLEVBQUUsMENBQTBDLEVBQUUsRUFBRSxDQUFDO0tBQ3pFLE1BQU0sQ0FBQyxnQkFBZ0IsRUFBRSxpQ0FBaUMsRUFBRSxFQUFFLENBQUM7S0FDL0QsTUFBTSxDQUFDLHlCQUF5QixFQUFFLHFDQUFxQyxFQUFFLEVBQUUsQ0FBQztLQUM1RSxNQUFNLENBQUMsc0JBQXNCLEVBQUUscUNBQXFDLEVBQUUsRUFBRSxDQUFDO0tBQ3pFLE1BQU0sQ0FBQyxxQkFBcUIsRUFBRSw2Q0FBNkMsRUFBRSxFQUFFLENBQUM7S0FDaEYsTUFBTSxDQUFDLGVBQWUsRUFBRSxtQ0FBbUMsRUFBRSxFQUFFLENBQUM7S0FDaEUsS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUV6QixJQUFNLElBQUksR0FBRzs7Ozs7Z0JBQ1QsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO2dCQUNDLFdBQU0sZ0JBQU0sQ0FBQyxTQUFTLEVBQUUsRUFBQTs7Z0JBQWhDLEtBQUssR0FBRyxTQUF3QjtnQkFDdEMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztnQkFDVixTQUFTLEdBQUcsSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQztnQkFDakQsS0FBSztxQkFDQSxNQUFNLENBQUMsVUFBQyxJQUFVO29CQUNmLE9BQU8sQ0FDSCxDQUFDLENBQUMsQ0FBRyxJQUFJLENBQUMsSUFBSSxTQUFJLElBQUksQ0FBQyxJQUFNLENBQUEsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDO3dCQUM5QyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUN4RSxDQUFDO2dCQUNOLENBQUMsQ0FBQztxQkFDRCxHQUFHLENBQUMsU0FBUyxDQUFDLENBQUM7Ozs7S0FDdkIsQ0FBQztBQUVGLElBQU0sU0FBUyxHQUFHLFVBQUMsSUFBVTtJQUN6QixJQUFJLElBQUksQ0FBQyxRQUFRLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUTtRQUFFLE9BQU87SUFDL0MsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLElBQUksT0FBTyxDQUFDLE9BQU87UUFBRSxPQUFPO0lBQzdDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxJQUFJLE9BQU8sQ0FBQyxTQUFTO1FBQUUsT0FBTztJQUVqRCxJQUFJLGFBQWEsR0FBRyx5REFBeUQsQ0FBQztJQUM5RSxhQUFhLElBQUksMEVBQTBFLENBQUM7SUFDNUYsSUFBSSxJQUFJLENBQUMsUUFBUSxFQUFFO1FBQ2YsYUFBYSxJQUFJLGtCQUFrQixDQUFDO0tBQ3ZDO0lBQ0QsSUFBSSxJQUFJLENBQUMsT0FBTyxFQUFFO1FBQ2QsYUFBYSxJQUFJLGlCQUFpQixDQUFDO0tBQ3RDO0lBQ0QsSUFBSSxJQUFJLENBQUMsU0FBUyxFQUFFO1FBQ2hCLGFBQWEsSUFBSSxtQkFBbUIsQ0FBQztLQUN4QztJQUNELElBQUksT0FBTyxDQUFDLFFBQVEsRUFBRTtRQUNsQixhQUFhLElBQUksb0JBQW9CLENBQUM7S0FDekM7SUFFRCxJQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxJQUFJLGFBQWEsQ0FBQztJQUMvQyxHQUFHLENBQ0MsTUFBTTtTQUNELE9BQU8sQ0FBQyxLQUFLLEVBQUUsZUFBSyxDQUFDLElBQUksQ0FBQyxLQUFHLElBQUksQ0FBQyxFQUFJLENBQUMsQ0FBQztTQUN4QyxPQUFPLENBQUMsSUFBSSxFQUFFLGVBQUssQ0FBQyxJQUFJLENBQUMsS0FBRyxJQUFJLENBQUMsSUFBTSxDQUFDLENBQUM7U0FDekMsT0FBTyxDQUFDLElBQUksRUFBRSxNQUFHLElBQUksQ0FBQyxZQUFZLElBQUksR0FBRyxDQUFFLENBQUM7U0FDNUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFHLElBQUksQ0FBQyxLQUFPLENBQUM7U0FDOUIsT0FBTyxDQUFDLEtBQUssRUFBRSxNQUFHLElBQUksQ0FBQyxRQUFRLElBQUksR0FBRyxDQUFFLENBQUM7U0FDekMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFHLElBQUksQ0FBQyxXQUFhLENBQUM7U0FDcEMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBWSxDQUFDO1NBQ3pDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsS0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGtCQUFvQixDQUFDO1NBQ2xELE9BQU8sQ0FBQyxLQUFLLEVBQUUsS0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGVBQWlCLENBQUM7U0FDL0MsT0FBTyxDQUNKLElBQUksRUFDRCxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxlQUFlLEdBQUcsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFVBQVUsSUFBSSxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxNQUFHLENBQ3RGO1NBQ0EsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFHLElBQUksQ0FBQyxRQUFVLENBQUM7U0FDakMsT0FBTyxDQUFDLEtBQUssRUFBRSxLQUFHLElBQUksQ0FBQyxVQUFZLENBQUM7U0FDcEMsT0FBTyxDQUFDLEtBQUssRUFBRSxLQUFHLElBQUksQ0FBQyxZQUFjLENBQUMsQ0FDOUMsQ0FBQztBQUNOLENBQUMsQ0FBQztBQUNGLElBQUksRUFBRSxDQUFDIn0=

CHANGELOG.md

@@ -17,2 +17,8 @@ # Changelog
 
+## [2.4.0] - 2020-06-16
+### Added
+- Allow custom formatting of epics via `club epics --format` (thanks [@gowabash](https://github.com/gowabash)!)
+### Security
+- Upgrade dependencies.
+
 ## [2.3.1] - 2020-03-30
@@ -19,0 +25,0 @@ ### Fixed

package.json

 {
   "name": "clubhouse-cli",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "A command line tool for viewing, creating and updating clubhouse.io stories",
@@ -15,2 +15,3 @@ "main": "index.js",
     "build:watch": "tsc --watch",
+    "start": "node -r source-map-support/register build/bin/club.js",
     "test": "npm run test:format",
@@ -50,9 +51,9 @@ "test:format": "prettier --list-different src/**/*.ts",
     "@types/debug": "4.1.5",
-    "@types/node": "12.12.32",
-    "@types/node-fetch": "2.5.5",
+    "@types/node": "12.12.47",
+    "@types/node-fetch": "2.5.7",
     "babel-eslint": "10.1.0",
-    "eslint": "6.8.0",
+    "eslint": "7.2.0",
     "eslint-config-standard": "14.1.1",
     "eslint-plugin-babel": "5.3.0",
-    "eslint-plugin-import": "2.20.2",
+    "eslint-plugin-import": "2.21.2",
     "eslint-plugin-node": "11.1.0",
@@ -62,5 +63,5 @@ "eslint-plugin-promise": "4.2.1",
     "prettier": "1.19.1",
-    "source-map-support": "0.5.16",
+    "source-map-support": "0.5.19",
     "typescript": "3.8.3"
   }
 }

README.md

@@ -262,2 +262,3 @@ # clubhouse-cli
     -d, --detailed            List more details for each epic
+    -f, --format [template]   Format epic output by template
     -M, --milestone [ID]      List only epics with the given milestone ID
@@ -269,2 +270,22 @@ -t, --title [query]       List epics with name/title containing query
 
+#### Epic Output Formatting
+
+Templating variables:
+
+~~~
+%id      Print ID of epic
+%t       Print title/name of epic
+%m       Print milestone of epic
+%s       Print epic state
+%dl      Print epic deadline
+%d       Print epic description
+%p       Print epic total points
+%ps      Print epic total points started
+%pd      Print epic total points done
+%c       Print epic total completion percentage
+%a       Print archived status of epic
+%st      Print started status of epic
+%co      Print completed status of epic
+~~~
+
 ### Workflows
@@ -271,0 +292,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

273282

increased by2.38%

Lines of code

1845

increased by0.44%

Number of lines in readme file

370

increased by6.02%

No dependency changes