@basementuniverse/kanbn 1.1.1 → 2.1.0

package/src/controller/add.js

@@ -1,9 +1,13 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const inquirer = require('inquirer');
 const fuzzy = require('fuzzy');
 const chrono = require('chrono-node');
-const getGitUsername = require('git-user-name');
+const getGitUsername = require('../git-user-name');
+
+// The boards this command targets - set from --board before anything else runs
+let kanbn = workspace;
+let boardTargets = [];
 
 inquirer.registerPrompt('datepicker', require('inquirer-datepicker'));
 inquirer.registerPrompt('recursive', require('inquirer-recursive'));
@@ -235,15 +239,24 @@ async function interactiveAddUntrackedTasks(untrackedTasks, columnName, columnNa
  * @param {object} taskData
  * @param {string} columnName
  */
-function createTask(taskData, columnName) {
-  kanbn
-  .createTask(taskData, columnName)
-  .then(taskId => {
-    console.log(`Created task "${taskId}" in column "${columnName}"`);
-  })
-  .catch(error => {
+async function createTask(taskData, columnName) {
+  try {
+
+    // The task is created once, on the first target board, and then added to the others - one task
+    // file, referenced by however many boards were named
+    const [first, ...rest] = boardTargets;
+    const taskId = await first.kanbn.createTask(taskData, columnName);
+    console.log(
+      `Created task "${taskId}" in column "${columnName}"` +
+      (boardTargets.length > 1 || !first.main ? ` on board "${first.slug}"` : '')
+    );
+    for (const target of rest) {
+      await target.kanbn.addTaskToBoard(taskId, target.columnName);
+      console.log(`Added task "${taskId}" to column "${target.columnName}" on board "${target.slug}"`);
+    }
+  } catch (error) {
     utility.error(error);
-  });
+  }
 }
 
 /**
@@ -252,50 +265,44 @@ function createTask(taskData, columnName) {
  * @param {string} columnName
  */
 async function addUntrackedTasks(untrackedTasks, columnName) {
-  for (let untrackedTask of untrackedTasks) {
-    try {
-      await kanbn.addUntrackedTaskToIndex(untrackedTask, columnName);
-    } catch (error) {
-      utility.error(error);
-      return;
+  for (const target of boardTargets) {
+
+    // The column chosen interactively or on the command line applies to the first board; the others
+    // use whatever resolveBoardTargets() paired them with
+    const targetColumn = target === boardTargets[0] ? columnName : target.columnName;
+    for (let untrackedTask of untrackedTasks) {
+      try {
+        await target.kanbn.addUntrackedTaskToIndex(untrackedTask, targetColumn);
+      } catch (error) {
+        utility.error(error);
+        return;
+      }
     }
+    console.log(
+      `Added ${untrackedTasks.length} task${untrackedTasks.length !== 1 ? 's' : ''} ` +
+      `to column "${targetColumn}"` + (boardTargets.length > 1 || !target.main ? ` on board "${target.slug}"` : '')
+    );
   }
-  console.log(
-    `Added ${untrackedTasks.length} task${untrackedTasks.length !== 1 ? 's' : ''} to column "${columnName}"`
-  );
 }
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which boards this command targets, and which column to use on each. -b is repeatable,
+  // so one task can be created and placed on several boards at once
+  const targets = await utility.resolveBoardTargets(workspace, args);
+  if (targets === null) {
     return;
   }
-
-  // Get the index and make sure it has some columns
-  let index;
-  try {
-    index = await kanbn.getIndex();
-  } catch (error) {
-    utility.error(error);
-    return;
-  }
-  const columnNames = Object.keys(index.columns);
-  if (!columnNames.length) {
-    utility.error('No columns defined in the index\nTry running {b}kanbn init -c "column name"{b}');
-    return;
+  boardTargets = targets;
+  kanbn = targets[0].kanbn;
+  for (const target of boardTargets) {
+    target.main = await target.kanbn.isMainBoard();
   }
+  utility.showColumnFallbackNotices(boardTargets, kanbn.isVerbose(targets[0].index));
 
-  // Get column name if specified, otherwise default to the first available column
-  let columnName = columnNames[0];
-  if (args.column) {
-    columnName = utility.strArg(args.column);
-    if (columnNames.indexOf(columnName) === -1) {
-      utility.error(`Column "${columnName}" doesn't exist`);
-      return;
-    }
-  }
+  const index = targets[0].index;
+  const columnNames = Object.keys(index.columns);
+  const columnName = targets[0].columnName;
 
   // Add untracked file(s)
   if (args.untracked) {
@@ -534,8 +541,7 @@ module.exports = async args => {
           type: relation.type
         }));
       }
-      columnName = answers.column;
-      createTask(taskData, columnName);
+      createTask(taskData, answers.column);
     })
     .catch(error => {
       utility.error(error);

package/src/controller/archive.js

@@ -1,6 +1,9 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
+
 /**
  * Archive a task
  * @param {string} taskId
@@ -32,11 +35,12 @@ function listArchivedTasks() {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
 
   // Check if we're listing archived tasks
   if (args.list) {

package/src/controller/board.js

@@ -1,12 +1,12 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const board = require('../board');
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board we're showing
+  const kanbn = await utility.resolveBoard(workspace, args);
+  if (kanbn === null) {
     return;
   }
 
@@ -32,6 +32,11 @@ module.exports = async args => {
   // Show the board
   board
   .show(index, tasks, args.view, args.json)
+  .then(async () => {
+    const verbose = !args.json && kanbn.isVerbose(index);
+    utility.showDateDriftHint(kanbn.getDateDrift(index, tasks), verbose);
+    utility.showBoardCountHint(await workspace.listBoards(), verbose);
+  })
   .catch(error => {
     utility.error(error);
   });

package/src/controller/boards.js

@@ -0,0 +1,140 @@
+const kanbn = require('../main');
+const utility = require('../utility');
+
+/**
+ * Show the list of boards in this workspace
+ * @param {object[]} boards
+ * @param {boolean} json
+ */
+function showBoards(boards, json) {
+  if (json) {
+    console.log(JSON.stringify(boards, null, 2));
+    return;
+  }
+  console.log(`${boards.length} ${boards.length === 1 ? 'board' : 'boards'}:`);
+  for (const board of boards) {
+    console.log(utility.replaceTags(`\n{b}${board.slug}{b}${board.main ? ' (main board)' : ''}`));
+    console.log(`  ${board.name}`);
+    if (board.description) {
+      console.log(`  ${board.description.split('\n')[0]}`);
+    }
+    console.log(
+      `  ${board.columns} ${board.columns === 1 ? 'column' : 'columns'}, ` +
+      `${board.tasks} ${board.tasks === 1 ? 'task' : 'tasks'}, ` +
+      `${board.completedPercentage}% complete` +
+      (board.modified ? `, last modified ${board.modified.toISOString()}` : '')
+    );
+  }
+}
+
+/**
+ * Show which boards each task appears on
+ * @param {object[]} tasks
+ * @param {boolean} all True if single-board tasks are included
+ * @param {boolean} json
+ */
+function showCrossBoardTasks(tasks, all, json) {
+  if (json) {
+    console.log(JSON.stringify(tasks, null, 2));
+    return;
+  }
+  if (!tasks.length) {
+    console.log(all ? 'No tracked tasks found' : 'No tasks appear on more than one board');
+    return;
+  }
+  console.log(
+    `${tasks.length} ${tasks.length === 1 ? 'task' : 'tasks'}` +
+    (all ? ':' : ' on more than one board:')
+  );
+  for (const task of tasks) {
+    console.log(utility.replaceTags(`\n{b}${task.id}{b}`));
+    for (const [slug, columnName] of Object.entries(task.boards)) {
+      console.log(`  ${slug}: ${columnName}`);
+    }
+  }
+}
+
+module.exports = async args => {
+
+  // Make sure kanbn has been initialised
+  if (!await kanbn.workspaceInitialised()) {
+    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+    return;
+  }
+
+  // Delete a board
+  if (args.delete) {
+    const slug = utility.strArg(args.delete);
+    let orphaned;
+    try {
+      orphaned = await kanbn.findOrphanedTasks(slug);
+    } catch (error) {
+      utility.error(error);
+      return;
+    }
+
+    // Deleting a board never deletes task files, but it can leave tasks with no board at all
+    if (orphaned.length && !args.force) {
+      utility.error(
+        `Deleting board "${slug}" would leave ${orphaned.length} ` +
+        `${orphaned.length === 1 ? 'task' : 'tasks'} untracked:\n` +
+        orphaned.map(taskId => `  ${taskId}`).join('\n') +
+        '\nUse {b}-f{b} to delete the board anyway'
+      );
+      return;
+    }
+    try {
+      await kanbn.deleteBoard(slug);
+    } catch (error) {
+      utility.error(error);
+      return;
+    }
+    console.log(
+      `Deleted board "${slug}"` +
+      (orphaned.length
+        ? `\n${orphaned.length} ${orphaned.length === 1 ? 'task is' : 'tasks are'} now untracked:\n` +
+          orphaned.map(taskId => `  ${taskId}`).join('\n')
+        : '')
+    );
+    return;
+  }
+
+  // Rename a board, i.e. kanbn boards --rename design ux --name "UX Pipeline"
+  if (args.rename) {
+    const slug = utility.strArg(args.rename);
+    const newSlug = args._[1] || slug;
+    const newName = args.name ? utility.strArg(args.name) : null;
+    if (newSlug === slug && newName === null) {
+      utility.error('No new board slug or name specified\nTry running {b}kanbn boards --rename "board-slug" "new-slug"{b}');
+      return;
+    }
+    try {
+      const renamedSlug = await kanbn.renameBoard(slug, newSlug, newName);
+      console.log(
+        renamedSlug === slug
+          ? `Renamed board "${slug}" to "${newName}"`
+          : `Renamed board "${slug}" to "${renamedSlug}"`
+      );
+    } catch (error) {
+      utility.error(error);
+    }
+    return;
+  }
+
+  // Show which boards each task appears on
+  if (args.tasks) {
+    try {
+      showCrossBoardTasks(await kanbn.getCrossBoardTasks(args.all), args.all, args.json);
+    } catch (error) {
+      utility.error(error);
+    }
+    return;
+  }
+
+  // List boards
+  try {
+    showBoards(await kanbn.getBoardsSummary(), args.json);
+  } catch (error) {
+    utility.error(error);
+  }
+};

package/src/controller/burndown.js

@@ -1,10 +1,13 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const asciichart = require('asciichart');
 const term = require('terminal-kit').terminal;
 const chrono = require('chrono-node');
 const formatDate = require('dateformat');
 
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
+
 const getLabelPlacements = (from, to, width, dateFormat, maxLabels) => {
   for (let count = maxLabels; count >= 1; count--) {
     const placements = [];
@@ -62,11 +65,12 @@ const renderXAxisLabels = (from, to, width, dateFormat, leftPadding) => {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
   const index = await kanbn.getIndex();
 
   // Get sprint numbers or names
@@ -127,7 +131,7 @@ module.exports = async args => {
 
       // Render chart
       const PADDING = '     ';
-      const width = Math.max(1, term.width - (PADDING.length + 1));
+      const width = Math.max(1, utility.terminalWidth(term.width) - (PADDING.length + 1));
 
       const plots = [];
       for (const s of data.series) {

package/src/controller/comment.js

@@ -1,7 +1,10 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const inquirer = require('inquirer');
-const getGitUsername = require('git-user-name');
+const getGitUsername = require('../git-user-name');
+
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
 
 /**
  * Add a comment interactively
@@ -51,11 +54,12 @@ function addComment(taskId, text, author) {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
 
   // Get the task that we're add a comment to
   const taskId = args._[1];

package/src/controller/edit.js

@@ -1,9 +1,12 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const inquirer = require('inquirer');
 const fuzzy = require('fuzzy');
 const chrono = require('chrono-node');
-const getGitUsername = require('git-user-name');
+const getGitUsername = require('../git-user-name');
+
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
 
 inquirer.registerPrompt('datepicker', require('inquirer-datepicker'));
 inquirer.registerPrompt('recursive', require('inquirer-recursive'));
@@ -412,7 +415,7 @@ async function interactive(taskData, taskIds, columnName, columnNames) {
           type: 'input',
           name: 'type',
           message: 'Relation type:',
-          default: answers => taskData.relations.find(relation => relation.task === answers.selectRelation).task,
+          default: answers => taskData.relations.find(relation => relation.task === answers.selectRelation).type,
           when: answers => answers.editRelation === 'edit'
         }
       ]
@@ -420,15 +423,31 @@ async function interactive(taskData, taskIds, columnName, columnNames) {
   ]);
 }
 
+/**
+ * Metadata fields that can be cleared with --unset, in addition to any custom fields defined in
+ * the index options
+ */
+const UNSETTABLE_FIELDS = [
+  'started',
+  'completed',
+  'due',
+  'plannedStart',
+  'plannedFinish',
+  'assigned',
+  'progress',
+  'tags'
+];
+
 /**
  * Update a task
  * @param {string} taskId
  * @param {object} taskData
  * @param {?string} columnName
+ * @param {string[]} [unsetFields=[]]
  */
-function updateTask(taskId, taskData, columnName) {
+function updateTask(taskId, taskData, columnName, unsetFields = []) {
   kanbn
-  .updateTask(taskId, taskData, columnName)
+  .updateTask(taskId, taskData, columnName, unsetFields)
   .then(taskId => {
     console.log(`Updated task "${taskId}"`);
   })
@@ -439,11 +458,12 @@ function updateTask(taskId, taskData, columnName) {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
 
   // Get the task that we're editing
   const taskId = args._[1];
@@ -578,8 +598,8 @@ module.exports = async args => {
 
     // Check that the sub-tasks being removed currently exist
     for (let removedSubTask of removedSubTasks) {
-      if (taskData.subTasks.find(subTask => subTask.text === removedSubTask.text) === undefined) {
-        utility.error(`Sub-task "${removedSubTask.text}" doesn't exist`);
+      if (taskData.subTasks.find(subTask => subTask.text === removedSubTask) === undefined) {
+        utility.error(`Sub-task "${removedSubTask}" doesn't exist`);
         return;
       }
     }
@@ -633,7 +653,7 @@ module.exports = async args => {
     // Check that the tags being removed currently exist
     for (let removedTag of removedTags) {
       if (taskData.metadata.tags.indexOf(removedTag) === -1) {
-        utility.error(`Tag "${removedSubTask.text}" doesn't exist`);
+        utility.error(`Tag "${removedTag}" doesn't exist`);
         return;
       }
     }
@@ -652,8 +672,8 @@ module.exports = async args => {
 
     // Check that the relations being removed currently exist
     for (let removedRelation of removedRelations) {
-      if (taskData.relations.find(relation => relation.task === removedRelation.task) === undefined) {
-        utility.error(`Relation "${removedRelation.task}" doesn't exist`);
+      if (taskData.relations.find(relation => relation.task === removedRelation) === undefined) {
+        utility.error(`Relation "${removedRelation}" doesn't exist`);
         return;
       }
     }
@@ -754,6 +774,43 @@ module.exports = async args => {
     }
   }
 
+  // Unset metadata fields
+  const unsetFields = [];
+  if (args.unset) {
+    const customFieldNames = 'customFields' in index.options
+      ? index.options.customFields.map(customField => customField.name)
+      : [];
+    const unsettableFields = [...UNSETTABLE_FIELDS, ...customFieldNames];
+
+    // Arguments that set the value of a metadata field, so that setting and unsetting the same
+    // field in one command can be rejected instead of silently resolving one way or the other
+    const settingArgs = {
+      due: args.due,
+      plannedStart: args.plannedStart,
+      plannedFinish: args.plannedFinish,
+      progress: args.progress,
+      assigned: args.assigned,
+      tags: args.tag,
+      ...Object.fromEntries(customFieldNames.map(name => [name, args[name]]))
+    };
+
+    for (let field of utility.arrayArg(args.unset)) {
+      if (unsettableFields.indexOf(field) === -1) {
+        utility.error(
+          `Cannot unset "${field}"\nAvailable fields: ${unsettableFields.join(', ')}`
+        );
+        return;
+      }
+      if (settingArgs[field] !== undefined) {
+        utility.error(`Cannot set and unset "${field}" in the same command`);
+        return;
+      }
+      if (unsetFields.indexOf(field) === -1) {
+        unsetFields.push(field);
+      }
+    }
+  }
+
   // Update task interactively
   if (args.interactive) {
     interactive(taskData, taskIds, columnName, columnNames)
@@ -810,7 +867,7 @@ module.exports = async args => {
       // Edit or remove sub-tasks
       if ('editSubTasks' in answers) {
         for (editSubTask of answers.editSubTasks) {
-          const i = taskData.subTasks.findIndex(subTask => subTask.task === editSubTask.selectSubTask);
+          const i = taskData.subTasks.findIndex(subTask => subTask.text === editSubTask.selectSubTask);
           if (i !== -1) {
             switch (editSubTask.editSubTask) {
               case 'remove':
@@ -837,7 +894,7 @@ module.exports = async args => {
       // Remove tags
       if ('removeTags' in answers && 'metadata' in taskData && 'tags' in taskData.metadata) {
         for (removeTag of answers.removeTags) {
-          const i = taskData.metadata.tags.indexOf(removeTag.name);
+          const i = taskData.metadata.tags.indexOf(removeTag.selectTag);
           if (i !== -1) {
             taskData.metadata.tags.splice(i, 1);
           }
@@ -878,7 +935,7 @@ module.exports = async args => {
 
       // Update task
       columnName = answers.column !== currentColumnName ? answers.column : null;
-      updateTask(taskId, taskData, columnName);
+      updateTask(taskId, taskData, columnName, unsetFields);
     })
     .catch(error => {
       utility.error(error);
@@ -887,6 +944,6 @@ module.exports = async args => {
   // Otherwise edit task non-interactively
   } else {
     columnName = columnName !== currentColumnName ? columnName : null;
-    updateTask(taskId, taskData, columnName);
+    updateTask(taskId, taskData, columnName, unsetFields);
   }
 };

package/src/controller/find.js

@@ -1,9 +1,12 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const inquirer = require('inquirer');
 const chrono = require('chrono-node');
 const yaml = require('yamljs');
 
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
+
 inquirer.registerPrompt('recursive', require('inquirer-recursive'));
 
 const searchFields = [
@@ -213,12 +216,11 @@ async function interactive() {
  * @param {boolean} quiet
  * @param {boolean} json
  */
-function findTasks(filters, quiet, json) {
+function findTasks(filters, quiet, json, allBoards = false) {
   const removeEmptyProperties = o => Object.fromEntries(Object.entries(o).filter(
     ([k, v]) => !(Array.isArray(v) && v.length == 0) && !!v
   ));
-  kanbn
-  .search(filters, quiet)
+  (allBoards ? kanbn.searchAllBoards(filters, quiet) : kanbn.search(filters, quiet))
   .then(results => {
     if (quiet) {
       console.log(json ? JSON.stringify(results, null, 2) : results.join('\n'));
@@ -309,11 +311,12 @@ function convertDateFilters(filters, filterName) {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
 
   // Get the index and make sure it has some columns
   let index;
@@ -487,7 +490,7 @@ module.exports = async args => {
             filter.value
           );
         }
-        findTasks(filters, !otherAnswers.nonquiet, otherAnswers.json);
+        findTasks(filters, !otherAnswers.nonquiet, otherAnswers.json, !!args['all-boards']);
       })
       .catch(error => {
         utility.error(error);
@@ -499,6 +502,6 @@ module.exports = async args => {
 
   // Otherwise create task non-interactively
   } else {
-    findTasks(filters, args.quiet, args.json);
+    findTasks(filters, args.quiet, args.json, !!args['all-boards']);
   }
 };

package/src/controller/gantt.js

@@ -1,8 +1,11 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const formatDate = require('dateformat');
 const chrono = require('chrono-node');
 
+// The board this command targets - set from --board before anything else runs
+let kanbn = workspace;
+
 const NOW_MARKER = '┆';
 const ANSI_RESET = '\x1b[0m';
 const ANSI_FG_LINE = '\x1b[97m';
@@ -313,11 +316,12 @@ function truncateName(name, maxWidth) {
 
 module.exports = async args => {
 
-  // Make sure kanbn has been initialised
-  if (!await kanbn.initialised()) {
-    utility.error('Kanbn has not been initialised in this folder\nTry running: {b}kanbn init{b}');
+  // Work out which board this command targets
+  const scoped = await utility.resolveBoard(workspace, args);
+  if (scoped === null) {
     return;
   }
+  kanbn = scoped;
   const index = await kanbn.getIndex();
 
   // Get assigned