bjira 0.0.11 → 0.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bjira",
-  "version": "0.0.11",
+  "version": "0.0.15",
   "description": "A simple jira CLI tool",
   "main": "src/index.js",
   "author": {
@@ -26,7 +26,9 @@
   "dependencies": {
     "commander": "^8.2.0",
     "execa": "^5.1.1",
+    "fuzzy": "^0.1.3",
     "inquirer": "^8.2.0",
+    "inquirer-autocomplete-prompt": "^1.4.0",
     "jira-client": "^6.22.0",
     "ora": "^6.0.1",
     "temp": "^0.9.4"

package/src/ask.js

@@ -3,6 +3,10 @@
 // SPDX-License-Identifier: MIT
 
 import inquirer from 'inquirer';
+import inquirerAutocompletePrompt from 'inquirer-autocomplete-prompt';
+import fuzzy from 'fuzzy';
+
+inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt);
 
 class Ask {
   static async askString(message, defaultValue = undefined) {
@@ -48,11 +52,12 @@ class Ask {
 
   static async askList(message, list) {
     const answer = await inquirer.prompt([{
-      type: 'list',
+      type: 'autocomplete',
       name: 'value',
       message,
-      choices: list,
-      filter: name => list.indexOf(name),
+      source: (answers, input) => fuzzy.filter(input || '', list, {
+        extract: el => el.name
+      }).map(el => el.original),
     }]);
     return answer.value;
   }

package/src/create.js

@@ -6,9 +6,11 @@ import color from 'chalk';
 
 import Ask from './ask.js';
 import Command from './command.js';
+import Field from './field.js';
 import Jira from './jira.js';
 import Issue from './issue.js';
 import Project from './project.js';
+import Query from './query.js';
 import Set from './set.js';
 import Sprint from './sprint.js';
 import User from './user.js';
@@ -22,9 +24,17 @@ class Create extends Command {
         const jira = new Jira(program);
 
         const project = await Project.pickProject(jira);
-        const issueTypePos = await Ask.askList('Issue type:', project.issueTypes.map(issueType => issueType.name));
+        const issueType = await Ask.askList('Issue type:',
+          project.issueTypes.map(issueType => ({
+            name: issueType.name,
+            value: {
+              name: issueType.name,
+              id: issueType.id
+            }
+          })));
 
-        // Create the issue object
+        const meta = await jira.spin('Retrieving issue metadata...',
+          jira.apiRequest(`/issue/createmeta?projectKeys=${project.key}&issuetypeNames=${issueType.name}&expand=projects.issuetypes.fields`));
         const newIssue = {
           fields: {
             project: {
@@ -32,7 +42,7 @@ class Create extends Command {
             },
             summary: await Ask.askString('Summary:', 'New Issue'),
             issuetype: {
-              id: project.issueTypes[issueTypePos].id
+              id: issueType.id
             }
           }
         };
@@ -44,11 +54,33 @@ class Create extends Command {
           }
         }
 
-        if (project.issueTypes[issueTypePos].name === 'Task') {
-          const parentIssue = await Ask.askString('Please provide the epic:');
-          if (parentIssue !== '') {
+        const issueFields = meta.projects.find(p => p.key === project.key)
+          .issuetypes.find(i => i.name === issueType.name).fields;
+        const requiredFields = Object.keys(issueFields).filter(
+          key => issueFields[key].required &&
+          Field.isSupported(issueFields[key].schema.type) &&
+          !["summary", "description", "project"].includes(key)).map(key => issueFields[key]);
+
+        for (const field of requiredFields) {
+          newIssue.fields[field.key] = await Ask.askString(`${field.name}:`);
+        }
+
+        if (issueType.name !== 'Epic' &&
+          await Ask.askBoolean('Do you want to set a parent epic?')) {
+          const result = await Query.runQuery(jira, `project = "${project.key}" and type = "epic"`, 999999);
+          if (!result.issues || result.issues.length === 0) {
+            console.log("No epics yet.");
+          } else {
+            const resultFields = await Field.listFields(jira);
+            result.issues.forEach(epic => Issue.replaceFields(epic, resultFields));
+
+            const parentKey = await Ask.askList('Choose the epic:',
+              result.issues.map(epic => ({
+                name: `${epic.key} - ${epic.fields['Summary']}`,
+                value: epic.key
+              })));
             newIssue.fields.parent = {
-              key: parentIssue
+              key: parentKey
             };
           }
         }

package/src/errorhandler.js

@@ -10,10 +10,23 @@ class ErrorHandler {
       head: ['Errors']
     });
 
-    e.error.errorMessages.forEach(error => table.addRow([{
-      color: "blue",
-      text: error
-    }]));
+    if (typeof e.error === "string") {
+      table.addRow([{
+        color: "blue",
+        text: e.error
+      }]);
+    } else if ("errorMessages" in e.error) {
+      e.error.errorMessages.forEach(error => table.addRow([{
+        color: "blue",
+        text: error
+      }]));
+    } else {
+      table.addRow([{
+        color: "blue",
+        text: e.error
+      }]);
+    }
+
     console.log(table.toString());
   }
 

package/src/field.js

@@ -125,7 +125,7 @@ class Field extends Command {
         };
       case 'string':
         return {
-          value: Ask.askString(`${fieldName}:`), key: fieldData.key
+          value: await Ask.askString(`${fieldName}:`), key: fieldData.key
         };
     }
 

package/src/issue.js

@@ -17,7 +17,7 @@ class Issue extends Command {
   addOptions(program) {
     const cmd = program.command('show')
       .description('Show an issue')
-      .option('-C, --comments')
+      .option('-C, --comments', 'Show the comments too')
       .argument('<id>', 'The issue ID')
       .action(async id => {
         const jira = new Jira(program);

package/src/project.js

@@ -35,23 +35,38 @@ class Project extends Command {
       jira.apiRequest('/issue/createmeta'));
 
     meta.projects.sort((a, b) => {
-      if (a.key === jira.latestProject) {
+      if (a.name < b.name) {
         return -1;
       }
 
-      if (b.key === jira.latestProject) {
+      if (a.name > b.name) {
         return 1;
       }
 
-      return a.name > b.name;
+      return 0;
     });
 
-    const projectPos = await Ask.askList('Project:', meta.projects.map(project => project.name));
-    const project = meta.projects[projectPos];
+    const projects = [];
+    if (jira.latestProject) {
+      const latestProject = meta.projects.find(project => project.key === jira.latestProject);
+      if (latestProject) {
+        projects.push({
+          name: `Latest: ${latestProject.name}`,
+          value: latestProject.key
+        });
+      }
+    }
+
+    meta.projects.forEach(project => projects.push({
+      name: project.name,
+      value: project.key
+    }));
 
-    jira.latestProject = project.key;
+    const projectKey = await Ask.askList('Project:', projects);
+    jira.latestProject = projectKey;
     jira.syncConfig();
 
+    const project = meta.projects.find(project => project.key === projectKey);
     return {
       name: project.name,
       key: project.key,

package/src/query.js

@@ -9,6 +9,8 @@ import Issue from './issue.js';
 import Jira from './jira.js';
 import Table from './table.js';
 
+import color from 'chalk';
+
 const DEFAULT_QUERY_LIMIT = 20;
 
 class Query extends Command {
@@ -24,31 +26,15 @@ class Query extends Command {
         const opts = cmd.opts();
 
         const resultFields = await Field.listFields(jira);
+        const result = await Query.runQuery(jira, query, opts.limit);
 
-        let expectedResult = opts.limit;
-        let issues = [];
-
-        while (issues.length < opts.limit) {
-          const result = await jira.spin('Running query...',
-            jira.api.searchJira(query, {
-              startAt: issues.lengh,
-              maxResults: opts.limit - issues.length
-            }));
-
-          if (result.warningMessages) {
-            ErrorHandler.showWarningMessages(result.warningMessages);
-            return;
-          }
-
-          issues = issues.concat(result.issues);
-          if (issues.length >= result.total) break;
-        }
-
-        Query.showIssues(jira, issues, resultFields);
+        Query.showIssues(jira, result.issues, result.total, resultFields);
       });
   }
 
-  static showIssues(jira, issues, fields) {
+  static showIssues(jira, issues, total, fields) {
+    console.log(`Showing ${color.bold(issues.length)} issues of ${color.bold(total)}`);
+
     const table = new Table({
       head: ['Key', 'Status', 'Type', 'Assignee', 'Summary']
     });
@@ -71,6 +57,33 @@ class Query extends Command {
 
     console.log(table.toString());
   }
+
+  static async runQuery(jira, query, expectedResult) {
+    let issues = [];
+    let total = 0;
+    while (issues.length < (expectedResult === undefined ? issues.length + 1 : expectedResult)) {
+      const result = await jira.spin('Running query...',
+        jira.api.searchJira(query, {
+          startAt: issues.lengh,
+          maxResults: expectedResult - issues.length
+        }));
+
+      if (result.warningMessages) {
+        ErrorHandler.showWarningMessages(result.warningMessages);
+        return;
+      }
+
+      total = result.total;
+      issues = issues.concat(result.issues);
+
+      if (issues.length >= total) break;
+    }
+
+    return {
+      total,
+      issues
+    };
+  }
 };
 
 export default Query;

package/src/run.js

@@ -44,27 +44,9 @@ class Run extends Command {
         }
 
         const resultFields = await Field.listFields(jira);
+        const result = await Query.runQuery(jira, query, opts.limit);
 
-        let expectedResult = opts.limit;
-        let issues = [];
-
-        while (issues.length < opts.limit) {
-          const result = await jira.spin('Running query...',
-            jira.api.searchJira(query, {
-              startAt: issues.lengh,
-              maxResults: opts.limit - issues.length
-            }));
-
-          if (result.warningMessages) {
-            ErrorHandler.showWarningMessages(result.warningMessages);
-            return;
-          }
-
-          issues = issues.concat(result.issues);
-          if (issues.length >= result.total) break;
-        }
-
-        Query.showIssues(jira, issues, resultFields);
+        Query.showIssues(jira, result.issues, result.total, resultFields);
       });
   }
 

package/src/set.js

@@ -58,12 +58,16 @@ class Set extends Command {
   static async assignIssue(jira, id) {
     const userList = await User.pickUser(jira);
     const activeUsers = userList.filter(user => user.active);
-    const assignee = await Ask.askList('Assignee:', activeUsers.map(user => user.displayName));
+    const assigneeId = await Ask.askList('Assignee:',
+      activeUsers.map(user => ({
+        name: user.displayName,
+        value: user.accountId
+      })));
 
     const issue = {
       fields: {
         assignee: {
-          accountId: activeUsers[assignee].accountId
+          accountId: assigneeId
         }
       }
     }
@@ -90,10 +94,14 @@ class Set extends Command {
 
   static async setStatus(jira, id) {
     const transitionList = await jira.spin('Retrieving transitions...', jira.api.listTransitions(id));
-    const transitionPos = await Ask.askList('Status:', transitionList.transitions.map(transition => transition.name));
+    const transitionId = await Ask.askList('Status:',
+      transitionList.transitions.map(transition => ({
+        name: transition.name,
+        value: transition.id
+      })));
     const transition = {
       transition: {
-        id: transitionList.transitions[transitionPos].id
+        id: transitionId
       }
     };
 

package/src/sprint.js

@@ -2,10 +2,16 @@
 //
 // SPDX-License-Identifier: MIT
 
+import color from 'chalk';
+
 import Ask from './ask.js';
 import Command from './command.js';
+import Field from './field.js';
+import Issue from './issue.js';
 import Jira from './jira.js';
 import Project from './project.js';
+import Table from './table.js';
+import User from './user.js';
 
 class Sprint extends Command {
   addOptions(program) {
@@ -34,6 +40,108 @@ class Sprint extends Command {
             }
           }));
       });
+
+    const showCmd = sprintCmd.command('show')
+      .description('Show the sprint')
+      .option('-a, --all', 'Show all the users')
+      .action(async () => {
+        const jira = new Jira(program);
+        const data = await Sprint.pickSprint(jira);
+        if (data === null) {
+          console.log("No active sprints");
+          return;
+        }
+
+        const resultFields = await Field.listFields(jira);
+
+        let issues = [];
+        while (true) {
+          const results = await jira.spin('Retrieving issues...',
+            jira.api.getBoardIssuesForSprint(data.boardId, data.sprintId, issues.length));
+          issues = issues.concat(results.issues);
+          if (issues.length >= results.total) break;
+        }
+
+        if (issues.length === 0) {
+          console.log("No issues");
+          return;
+        }
+
+        const statuses = [];
+
+        const users = [];
+        issues.forEach(issue => {
+          issue = Issue.replaceFields(issue, resultFields);
+
+          const accountId = issue.fields['Assignee'] ? issue.fields['Assignee'].accountId : null;
+          let user = users.find(user => user.accountId === accountId);
+          if (!user) {
+            user = {
+              accountId,
+              displayName: issue.fields['Assignee']?.displayName,
+              user: issue.fields['Assignee'],
+              statuses: []
+            };
+            users.push(user);
+          }
+
+          if (!statuses.includes(issue.fields['Status'].name)) {
+            statuses.push(issue.fields['Status'].name);
+          }
+
+          let status = user.statuses.find(status => issue.fields['Status'].name === status.name);
+          if (!status) {
+            status = {
+              name: issue.fields['Status'].name,
+              issues: []
+            };
+            user.statuses.push(status);
+          }
+
+          status.issues.push(issue);
+        });
+
+        const currentUser = await jira.spin('Retrieving current user...', jira.api.getCurrentUser());
+        const transitionList = await jira.spin('Retrieving transitions...', jira.api.listTransitions(issues[0].id));
+
+        console.log('\n' + color.blue(data.sprintName) + '\n');
+
+        let filteredUsers;
+        if (showCmd.opts().all) {
+          filteredUsers = User.sortUsers(currentUser, users);
+        } else {
+          filteredUsers = [users.find(user => user.accountId === currentUser.accountId)];
+        }
+
+        filteredUsers.forEach(user => {
+          console.log(color.yellow(Issue.showUser(user.user)));
+
+          const maxIssues = Math.max(...user.statuses.map(status => status.issues.length));
+
+          const statuses = user.statuses.sort((a, b) => {
+            const posA = transitionList.transitions.findIndex(transition => transition.name === a.name);
+            const posB = transitionList.transitions.findIndex(transition => transition.name === b.name);
+            return posA - posB;
+          });
+
+          const table = new Table({
+            head: statuses.map(status => status.name),
+          });
+
+          for (let i = 0; i < maxIssues; ++i) {
+            const line = statuses.map(status => {
+              if (status.issues.length > i) {
+                return `${status.issues[i].key} ${status.issues[i].fields['Summary'].trim()}`
+              }
+              return ""
+            });
+            table.addRow(line);
+          }
+
+          console.log(table.toString() + '\n');
+        });
+
+      });
   }
 
   static async pickSprint(jira) {
@@ -42,34 +150,53 @@ class Sprint extends Command {
       jira.api.getAllBoards(undefined, undefined, undefined, undefined,
         project.key));
 
-    const boardPos = await Ask.askList('Board:', boardList.values.map(board => board.name));
+    const boardId = await Ask.askList('Board:',
+      boardList.values.map(board => ({
+        name: board.name,
+        value: board.id
+      })));
 
     const sprintList = await jira.spin('Retrieving sprints...',
-      jira.api.getAllSprints(boardList.values[boardPos].id));
+      jira.api.getAllSprints(boardId));
 
     const sprints = sprintList.values.filter(sprint => sprint.state === 'active' || sprint.state === 'future');
 
     if (sprints.length === 0) {
-      return 0;
+      return null;
     }
 
     if (sprints.length > 1) {
-      const sprintPos = await Ask.askList('Sprint:', sprints.map(sprint => sprint.name));
-      return sprints[sprintPos].id;
+      const sprintData = await Ask.askList('Sprint:',
+        sprints.map(sprint => ({
+          name: sprint.name,
+          value: {
+            id: sprint.id,
+            name: sprint.name
+          }
+        })));
+      return {
+        boardId,
+        sprintId: sprintData.id,
+        sprintName: sprintData.name,
+      };
     }
 
-    return sprints[0].id;
+    return {
+      boardId,
+      sprintId: sprints[0].id,
+      sprintName: sprints[0].name,
+    };
   }
 
   static async add(jira, id) {
-    const sprintId = await Sprint.pickSprint(jira);
-    if (sprintId === 0) {
+    const data = await Sprint.pickSprint(jira);
+    if (data === null) {
       console.log("No active sprints");
       return;
     }
 
     await jira.spin('Adding the issue to the sprint...',
-      jira.apiAgileRequest(`/sprint/${sprintId}/issue`, {
+      jira.apiAgileRequest(`/sprint/${data.sprintId}/issue`, {
         method: 'POST',
         followAllRedirects: true,
         body: {

package/src/user.js

@@ -8,7 +8,10 @@ class User {
   static async pickUser(jira) {
     const currentUser = await jira.spin('Retrieving current user...', jira.api.getCurrentUser());
     const userList = await jira.spin('Retrieving users...', jira.api.getUsers(0, 1000));
+    return User.sortUsers(currentUser, userList);
+  }
 
+  static sortUsers(currentUser, userList) {
     userList.sort((a, b) => {
       if (a.accountId === currentUser.accountId) {
         return -1;
@@ -18,7 +21,15 @@ class User {
         return 1;
       }
 
-      return a.displayName > b.displayName;
+      if (a.displayName < b.displayName) {
+        return -1;
+      }
+
+      if (a.displayName > b.displayName) {
+        return 1;
+      }
+
+      return 0;
     });
 
     return userList;