@basementuniverse/kanbn 1.1.0 → 2.0.0

package/src/parse-index.js

@@ -24,6 +24,9 @@ function validateOptions(options) {
         type: 'array',
         items: { type: 'string' }
       },
+      'startedField': { type: 'string' },
+      'completedField': { type: 'string' },
+      'verbose': { type: 'boolean' },
       'sprints': {
         type: 'array',
         items: {

package/src/parse-markdown.js

@@ -26,7 +26,9 @@ module.exports = function parseMarkdown(markdown) {
     parsed[headings[i].title] = {
       heading: headings[i].heading,
       content: markdown.slice(
-        headings[i].index + headings[i].heading.length + 1,
+        // The + 1 skips the newline that ends the heading line; the synthetic 'raw' entry for
+        // content before the first heading has no heading line, so it starts at index 0
+        headings[i].index + headings[i].heading.length + (headings[i].heading ? 1 : 0),
         i < headings.length - 1
           ? headings[i + 1].index
           : undefined

package/src/parse-task.js

@@ -239,6 +239,11 @@ function validateHistoryFromJSON(history) {
 
 /**
  * Validate required fields in a history event
+ *
+ * An event with an unrecognised type is left alone rather than rejected: a task file written by a
+ * newer version of kanbn may contain event types this version doesn't know about, and refusing to
+ * parse the whole task would make the file unreadable. Unknown events are preserved on write and
+ * ignored when history is replayed.
  * @param {object} historyEvent
  */
 function validateHistoryEvent(historyEvent) {
@@ -275,10 +280,24 @@ function validateHistoryEvent(historyEvent) {
       }
       break;
     default:
-      throw new Error(`unsupported history event type "${historyEvent.type}"`);
+      break;
   }
 }
 
+/**
+ * History event keys that this version understands, in the order they should be written
+ */
+const KNOWN_HISTORY_EVENT_KEYS = [
+  'type',
+  'date',
+  'column',
+  'fromColumn',
+  'toColumn',
+  'fromProgress',
+  'toProgress',
+  'author'
+];
+
 module.exports = {
 
   /**
@@ -660,6 +679,14 @@ module.exports = {
               if ('author' in historyEvent && historyEvent.author) {
                 historyEventOutput.push(`author: ${historyEvent.author}`);
               }
+
+              // Write back any keys this version doesn't recognise, so that a file written by a
+              // newer version of kanbn survives a read/write cycle here without losing data
+              for (const key of Object.keys(historyEvent)) {
+                if (KNOWN_HISTORY_EVENT_KEYS.indexOf(key) === -1 && historyEvent[key] !== undefined) {
+                  historyEventOutput.push(`${key}: ${historyEvent[key]}`);
+                }
+              }
               return `- ${historyEventOutput.map((v, i) => i > 0 ? `  ${v}` : v).join('\n')}`;
             }).join('\n')
           );

package/src/utility.js

@@ -19,6 +19,26 @@ module.exports = (() => {
       !dontExit && process.env.KANBN_ENV !== 'test' && process.exit(1);
     },
 
+    /**
+     * Show a hint about tasks whose dates don't match the column they're in. Hints are suppressed
+     * for machine-readable output and when the board sets verbose to false
+     * @param {object[]} drift Drift entries from kanbn.getDateDrift()
+     * @param {boolean} show False to suppress the hint
+     */
+    showDateDriftHint(drift, show = true) {
+      if (!show || !drift.length) {
+        return;
+      }
+      const fixable = drift.filter(d => d.fixable).length;
+      const summary =
+        `${drift.length} ${drift.length === 1 ? 'task has' : 'tasks have'} dates that don't match ` +
+        `${drift.length === 1 ? 'its' : 'their'} column`;
+      console.log(this.replaceTags(
+        `\n{d}${summary}${fixable ? ' - run{d} {b}kanbn validate --fix{b}' : '{d}'}` +
+        (fixable ? ` {d}to fill in the missing ${fixable === 1 ? 'date' : 'dates'}{d}` : '')
+      ));
+    },
+
     /**
      * Convert a string to simplified paramcase, e.g:
      *  PascalCase -> pascalcase
@@ -34,7 +54,12 @@ module.exports = (() => {
         )
         .split(/[\s!?.,@:;|\\/"'`£$%\^&*{}[\]()<>~#+\-=_¬]+/g)
         .join('-')
-        .replace(/(^-|-$)/g, '');
+        .replace(/(^-|-$)/g, '')
+        // The word-boundary replacement above only matches an uppercase run that is followed by
+        // another character, so a trailing capital ("Task A" -> "task-A") and any non-ASCII capital
+        // ("Ünïcodé" -> "Ünïcodé") would otherwise survive. Board slugs use this function, so ids
+        // must be lowercase throughout.
+        .toLowerCase();
     },
 
     /**