@basementuniverse/kanbn 2.0.0 → 2.5.0

package/src/board.js

@@ -55,6 +55,23 @@ module.exports = (() => {
     }
   }
 
+  /**
+   * Render the simple tasks in a column - lines in the board file that aren't task links. They have
+   * no fields to interpolate and take no part in filtering or sorting, so they're shown dimmed at
+   * the end of the column, and only in the default layout where the columns on screen are the
+   * columns in the file
+   * @param {object} index
+   * @param {string} columnName
+   * @return {string[]} The rendered simple tasks
+   */
+  function getSimpleTaskStrings(index, columnName) {
+    return ((index.columnContent || {})[columnName] || [])
+      .filter(entry => !entry.block && !!entry.text && entry.text.indexOf('\n') === -1)
+
+      // A caret starts a markup sequence in terminal-kit, so any in the user's own text are escaped
+      .map(entry => `^-${entry.text.replace(/\^/g, '^^')}^:`);
+  }
+
   /**
    * Get a column heading with icons
    * @param {object} index
@@ -166,7 +183,13 @@ module.exports = (() => {
       table.push(board.headings.map(heading => heading.heading));
       board.lanes.forEach(lane => table.push(
         [lane.name],
-        lane.columns.map(column => column.map(task => getTaskString(index, task)).join(TASK_SEPARATOR))
+        lane.columns.map((column, i) => {
+          const cell = column.map(task => getTaskString(index, task));
+          if (view === null) {
+            cell.push(...getSimpleTaskStrings(index, board.headings[i].name));
+          }
+          return cell.join(TASK_SEPARATOR);
+        })
       ));
 
       // Display as a table
@@ -178,7 +201,7 @@ module.exports = (() => {
           borderChars: 'lightRounded',
           borderAttr: { color: 'grey' },
           textAttr: { color: 'white', bgColor: 'default' },
-          width: term.width,
+          width: utility.terminalWidth(term.width),
           fit: true
         }
       );

package/src/controller/add.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');
+
+// 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'));
@@ -15,9 +18,11 @@ inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'))
  * @param {string[]} taskIds
  * @param {string} columnName
  * @param {string[]} columnNames
+ * @param {?string} currentUser
+ * @param {object[]} contributors
  * @return {Promise<any>}
  */
-async function interactiveCreateTask(taskData, taskIds, columnName, columnNames) {
+async function interactiveCreateTask(taskData, taskIds, columnName, columnNames, currentUser, contributors) {
   const dueDateExists = (
     'metadata' in taskData &&
     'due' in taskData.metadata &&
@@ -123,13 +128,12 @@ async function interactiveCreateTask(taskData, taskIds, columnName, columnNames)
       default: false,
       when: answers => !assignedExists
     },
-    {
-      type: 'input',
+    utility.assignedPrompt({
       name: 'assigned',
       message: 'Assigned to:',
-      default: assignedExists ? taskData.metadata.assigned : getGitUsername(),
+      default: assignedExists ? taskData.metadata.assigned : (currentUser || ''),
       when: answers => answers.setAssigned || assignedExists
-    },
+    }, contributors),
     {
       type: 'recursive',
       name: 'subTasks',
@@ -235,15 +239,26 @@ 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}"` : '')
+    );
+    utility.showActionWarnings(first.kanbn);
+    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}"`);
+      utility.showActionWarnings(target.kanbn);
+    }
+  } catch (error) {
     utility.error(error);
-  });
+  }
 }
 
 /**
@@ -252,50 +267,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) {
@@ -393,10 +402,12 @@ module.exports = async args => {
 
   // Assigned
   if (args.assigned) {
-    const gitUsername = getGitUsername();
     if (args.assigned === true) {
-      if (gitUsername) {
-        taskData.metadata.assigned = gitUsername;
+
+      // A bare --assigned means "me", canonicalised against the contributors list if there is one
+      const currentUser = await kanbn.currentUser();
+      if (currentUser) {
+        taskData.metadata.assigned = currentUser;
       }
     } else {
       taskData.metadata.assigned = utility.strArg(args.assigned);
@@ -501,7 +512,14 @@ module.exports = async args => {
 
   // Create task interactively
   if (args.interactive) {
-    interactiveCreateTask(taskData, taskIds, columnName, columnNames)
+    interactiveCreateTask(
+      taskData,
+      taskIds,
+      columnName,
+      columnNames,
+      await kanbn.currentUser(),
+      await kanbn.getContributors()
+    )
     .then(answers => {
       taskData.name = answers.name;
       if ('description' in answers) {
@@ -534,8 +552,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
@@ -10,6 +13,7 @@ function archiveTask(taskId) {
   .archiveTask(taskId)
   .then(taskId => {
     console.log(`Archived task "${taskId}"`);
+    utility.showActionWarnings(kanbn);
   })
   .catch(error => {
     utility.error(error);
@@ -32,11 +36,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;
   }
 
@@ -24,19 +24,27 @@ module.exports = async args => {
     return;
   }
 
-  // Load and hydrate all tracked tasks
-  const tasks = (await kanbn.loadAllTrackedTasks(index)).map(
-    task => kanbn.hydrateTask(index, task)
-  );
+  // Load and hydrate all tracked tasks. A task the board references but which has no task file is
+  // skipped rather than fatal, and reported by the hint below
+  let tasks, missingTaskFiles;
+  try {
+    tasks = (await kanbn.loadAllTrackedTasks(index)).map(
+      task => kanbn.hydrateTask(index, task)
+    );
+    missingTaskFiles = await kanbn.findMissingTaskFiles(index);
+  } catch (error) {
+    utility.error(error);
+    return;
+  }
 
   // Show the board
   board
   .show(index, tasks, args.view, args.json)
-  .then(() => {
-    utility.showDateDriftHint(
-      kanbn.getDateDrift(index, tasks),
-      !args.json && kanbn.isVerbose(index)
-    );
+  .then(async () => {
+    const verbose = !args.json && kanbn.isVerbose(index);
+    utility.showMissingTaskFilesHint(missingTaskFiles, verbose);
+    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
@@ -94,10 +98,13 @@ module.exports = async args => {
     }
   }
 
-  // Get assigned
+  // Get assigned, expanding "@me" to the current user
   let assigned = null;
   if (args.assigned) {
-    assigned = utility.strArg(args.assigned);
+    assigned = await utility.expandCurrentUser(kanbn, utility.strArg(args.assigned));
+    if (assigned === null) {
+      return;
+    }
   }
 
   // Get columns
@@ -127,7 +134,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,9 @@
-const kanbn = require('../main');
+const workspace = require('../main');
 const utility = require('../utility');
 const inquirer = require('inquirer');
-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
@@ -43,6 +45,7 @@ function addComment(taskId, text, author) {
   .comment(taskId, text, author)
   .then(taskId => {
     console.log(`Added comment to task "${taskId}"`);
+    utility.showActionWarnings(kanbn);
   })
   .catch(error => {
     utility.error(error);
@@ -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];
@@ -84,7 +88,10 @@ module.exports = async args => {
   if (args.author && typeof args.author === 'string') {
     commentAuthor = utility.strArg(args.author);
   } else {
-    commentAuthor = getGitUsername();
+
+    // Nobody at all is a legitimate answer on a machine with no git identity, and an empty author is
+    // what a comment without one looks like
+    commentAuthor = (await kanbn.currentUser()) || '';
   }
 
   // Add comment interactively