@basementuniverse/kanbn 0.9.0 → 1.0.0

package/routes/gantt.json

@@ -0,0 +1,27 @@
+{
+  "name": "View Gantt Chart",
+  "commands": [
+    "gantt",
+    "gt"
+  ],
+  "args": {
+    "boolean": [
+      "json"
+    ],
+    "string": [
+      "assigned",
+      "column",
+      "date",
+      "now"
+    ],
+    "alias": {
+      "json": ["j"],
+      "assigned": ["a"],
+      "column": ["c"],
+      "date": ["d"],
+      "now": ["n"]
+    }
+  },
+  "controller": "./src/controller/gantt",
+  "help": "./docs/commands/gantt.txt"
+}

package/src/board.js

@@ -1,6 +1,7 @@
 const kanbn = require('./main');
 const term = require('terminal-kit').terminal;
 const formatDate = require('dateformat');
+const utility = require('./utility');
 
 module.exports = (() => {
   const TASK_SEPARATOR = '\n\n';
@@ -14,6 +15,18 @@ module.exports = (() => {
   function getTaskString(index, task) {
     const taskTemplate = kanbn.getTaskTemplate(index);
     const dateFormat = kanbn.getDateFormat(index);
+
+    // Get an object containing custom fields from the task
+    let customFields = {};
+    if ('customFields' in index.options) {
+      const customFieldNames = index.options.customFields.map(customField => customField.name);
+      customFields = Object.fromEntries(utility.zip(
+        customFieldNames,
+        customFieldNames.map(customFieldName => task.metadata[customFieldName] || '')
+      ));
+    }
+
+    // Prepare task data for interpolation
     const taskData = {
       name: task.name,
       description: task.name,
@@ -30,9 +43,15 @@ module.exports = (() => {
       dueMessage: 'dueData' in task && 'dueMessage' in task.dueData ? task.dueData.dueMessage : '',
       column: task.column,
       workload: task.workload,
-      progress: task.progress
+      progress: task.progress,
+      ...customFields
     };
-    return new Function(...Object.keys(taskData), 'return `^:' + taskTemplate + '`;')(...Object.values(taskData));
+    try {
+      return new Function(...Object.keys(taskData), 'return `^:' + taskTemplate + '`;')(...Object.values(taskData));
+    } catch (e) {
+      utility.error(`Unable to build task template: ${e.message}`);
+      return;
+    }
   }
 
   /**

package/src/controller/add.js

@@ -23,6 +23,11 @@ async function interactiveCreateTask(taskData, taskIds, columnName, columnNames)
     'due' in taskData.metadata &&
     taskData.metadata.due != null
   );
+  const postponedDateExists = (
+    'metadata' in taskData &&
+    'postponed' in taskData.metadata &&
+    taskData.metadata.postponed != null
+  );
   const assignedExists = (
     'metadata' in taskData &&
     'assigned' in taskData.metadata &&
@@ -76,6 +81,21 @@ async function interactiveCreateTask(taskData, taskIds, columnName, columnNames)
       format: ['Y', '/', 'MM', '/', 'DD'],
       when: answers => answers.setDue,
     },
+    {
+      type: 'confirm',
+      name: 'setPostponed',
+      message: 'Set a postponed date?',
+      default: false,
+      when: answers => !postponedDateExists
+    },
+    {
+      type: 'datepicker',
+      name: 'postponed',
+      message: 'Postponed date:',
+      default: postponedDateExists ? taskData.metadata.postponed : new Date(),
+      format: ['Y', '/', 'MM', '/', 'DD'],
+      when: answers => answers.setPostponed,
+    },
     {
       type: 'confirm',
       name: 'setAssigned',
@@ -323,6 +343,15 @@ module.exports = async args => {
     }
   }
 
+  // Postponed date
+  if (args.postponed) {
+    taskData.metadata.postponed = chrono.parseDate(utility.strArg(args.postponed));
+    if (taskData.metadata.postponed === null) {
+      utility.error('Unable to parse postponed date');
+      return;
+    }
+  }
+
   // Progress
   if (args.progress) {
     const progressValue = parseFloat(utility.strArg(args.progress));
@@ -450,7 +479,10 @@ module.exports = async args => {
         taskData.description = answers.description;
       }
       if ('due' in answers) {
-        taskData.metadata.due = answers.due.toISOString();
+        taskData.metadata.due = answers.due;
+      }
+      if ('postponed' in answers) {
+        taskData.metadata.postponed = answers.postponed;
       }
       if ('assigned' in answers) {
         taskData.metadata.assigned = answers.assigned;

package/src/controller/burndown.js

@@ -5,6 +5,61 @@ const term = require('terminal-kit').terminal;
 const chrono = require('chrono-node');
 const formatDate = require('dateformat');
 
+const getLabelPlacements = (from, to, width, dateFormat, maxLabels) => {
+  for (let count = maxLabels; count >= 1; count--) {
+    const placements = [];
+    let previousEnd = -1;
+
+    for (let i = 0; i < count; i++) {
+      const ratio = count === 1 ? 0 : i / (count - 1);
+      const position = Math.round(ratio * (width - 1));
+      const value = new Date(from.getTime() + Math.round((to.getTime() - from.getTime()) * ratio));
+      const label = formatDate(value, dateFormat);
+
+      let start = position - Math.floor(label.length / 2);
+      if (start < 0) {
+        start = 0;
+      }
+      if (start + label.length > width) {
+        start = Math.max(0, width - label.length);
+      }
+
+      const end = start + label.length - 1;
+      if (i > 0 && start <= previousEnd + 1) {
+        placements.length = 0;
+        break;
+      }
+
+      placements.push({ position, start, label, end });
+      previousEnd = end;
+    }
+
+    if (placements.length) {
+      return placements;
+    }
+  }
+
+  return [];
+};
+
+const renderXAxisLabels = (from, to, width, dateFormat, leftPadding) => {
+  const sampleLabel = formatDate(from, dateFormat);
+  const maxLabels = Math.max(1, Math.floor((width + 2) / (sampleLabel.length + 2)));
+  const placements = getLabelPlacements(from, to, width, dateFormat, maxLabels);
+
+  const ticks = Array(width).fill(' ');
+  const labels = Array(width).fill(' ');
+
+  for (const placement of placements) {
+    ticks[placement.position] = '|';
+    for (let i = 0; i < placement.label.length; i++) {
+      labels[placement.start + i] = placement.label[i];
+    }
+  }
+
+  return `${leftPadding}${ticks.join('')}\n${leftPadding}${labels.join('')}`;
+};
+
 module.exports = async args => {
 
   // Make sure kanbn has been initialised
@@ -72,18 +127,23 @@ module.exports = async args => {
 
       // Render chart
       const PADDING = '     ';
-      const width = term.width - (PADDING.length + 1);
+      const width = Math.max(1, term.width - (PADDING.length + 1));
 
       const plots = [];
-      for (s of data.series) {
-        const plot = [], delta = Math.floor((s.to.getTime() - s.from.getTime()) / width);
+      for (const s of data.series) {
+        const plot = [];
+        const span = Math.max(1, s.to.getTime() - s.from.getTime());
+        const delta = width > 1 ? span / (width - 1) : 0;
         for (let i = 0; i < width; i++) {
-          plot.push((s.dataPoints.find(d => d.x >= new Date(s.from.getTime() + i * delta)) || s.dataPoints[0]).y);
+          const x = new Date(s.from.getTime() + Math.round(i * delta));
+          plot.push((s.dataPoints.find(d => d.x >= x) || s.dataPoints[0]).y);
         }
         plots.push(plot);
       }
+
+      const referenceSeries = data.series[0];
       const dateFormat = kanbn.getDateFormat(index);
-      console.log(`${formatDate(s.from, dateFormat)} to ${formatDate(s.to, dateFormat)}:`);
+      console.log(`${formatDate(referenceSeries.from, dateFormat)} to ${formatDate(referenceSeries.to, dateFormat)}:`);
       console.log(asciichart.plot(
         plots,
         {
@@ -99,6 +159,13 @@ module.exports = async args => {
           ]
         }
       ));
+      console.log(renderXAxisLabels(
+        referenceSeries.from,
+        referenceSeries.to,
+        width,
+        dateFormat,
+        ' '.repeat(PADDING.length + 1)
+      ));
     }
   })
   .catch(error => {

package/src/controller/edit.js

@@ -23,6 +23,11 @@ async function interactive(taskData, taskIds, columnName, columnNames) {
     'due' in taskData.metadata &&
     taskData.metadata.due != null
   );
+  const postponedDateExists = (
+    'metadata' in taskData &&
+    'postponed' in taskData.metadata &&
+    taskData.metadata.postponed != null
+  );
   const assignedExists = (
     'metadata' in taskData &&
     'assigned' in taskData.metadata &&
@@ -101,6 +106,46 @@ async function interactive(taskData, taskIds, columnName, columnNames) {
       format: ['Y', '/', 'MM', '/', 'DD'],
       when: answers => answers.setDue || answers.editDue === 'edit'
     },
+    {
+      type: 'expand',
+      name: 'editPostponed',
+      message: 'Edit or remove postponed date?',
+      default: 'none',
+      when: answers => postponedDateExists,
+      choices: [
+        {
+          key: 'e',
+          name: 'Edit',
+          value: 'edit'
+        },
+        {
+          key: 'r',
+          name: 'Remove',
+          value: 'remove'
+        },
+        new inquirer.Separator(),
+        {
+          key: 'n',
+          name: 'Do nothing',
+          value: 'none'
+        }
+      ]
+    },
+    {
+      type: 'confirm',
+      name: 'setPostponed',
+      message: 'Set a postponed date?',
+      default: false,
+      when: answers => !postponedDateExists
+    },
+    {
+      type: 'datepicker',
+      name: 'postponed',
+      message: 'Postponed date:',
+      default: postponedDateExists ? taskData.metadata.postponed : new Date(),
+      format: ['Y', '/', 'MM', '/', 'DD'],
+      when: answers => answers.setPostponed || answers.editPostponed === 'edit'
+    },
     {
       type: 'expand',
       name: 'editAssigned',
@@ -430,6 +475,18 @@ module.exports = async args => {
     }
   }
 
+  // Postponed date
+  if (args.postponed) {
+    if (!('metadata' in taskData)) {
+      taskData.metadata = {};
+    }
+    taskData.metadata.postponed = chrono.parseDate(utility.strArg(args.postponed));
+    if (taskData.metadata.postponed === null) {
+      utility.error('Unable to parse postponed date');
+      return;
+    }
+  }
+
   // Progress
   if (args.progress) {
     if (!('metadata' in taskData)) {
@@ -660,7 +717,17 @@ module.exports = async args => {
 
       // Due date
       if ('due' in answers) {
-        taskData.metadata.due = answers.due.toISOString();
+        taskData.metadata.due = answers.due;
+      }
+
+      // Remove postponed date
+      if ('editPostponed' in answers && answers.editPostponed === 'remove') {
+        delete taskData.metadata.postponed;
+      }
+
+      // Postponed date
+      if ('postponed' in answers) {
+        taskData.metadata.postponed = answers.postponed;
       }
 
       // Remove assigned

package/src/controller/find.js

@@ -52,6 +52,11 @@ const searchFields = [
     field: 'due',
     type: 'date'
   },
+  {
+    name: 'Postponed',
+    field: 'postponed',
+    type: 'date'
+  },
   {
     name: 'Progress',
     field: 'progress',