bjira 0.0.3 → 0.0.7

package/README.md

@@ -1,4 +1,72 @@
 # Jira cli
 
-This is a simple Jira CLI tool. Vaguely inspired by [jira-cl](https://jiracli.com/).
-License: MIT
+This is a simple Jira CLI tool. License: MIT
+
+## How to install it
+
+```
+$ npm install -g bjira
+```
+
+## How to configure it
+
+Run `bjira init` to set up the tool. You can optain the API token from your
+jira settings.
+
+```
+$ bjira init
+? Provide your jira host: your-config.atlassian.net
+? Please provide your jira username: username
+? API token: [hidden]
+? Enable HTTPS Protocol? Yes
+Config file succesfully created in: /home/baku/.bjira.json
+```
+
+## How to use it
+
+Run `bjira help` to see the main help menu. Each command is well documented.
+
+There are 2 main concepts to know:
+- presets
+- custom fields.
+
+### Presets
+
+Let's say you want to retrieve all the open issues assigned to you for project
+FOO.  The query is something like this:
+
+```
+bjira query 'project = "FOO" AND status != "Done" AND status != "Cancelled" AND assignee = currentUser()'
+```
+
+You can save this query as a preset:
+```
+bjira create mine 'project = "FOO" AND status != "Done" AND status != "Cancelled" AND assignee = currentUser()'
+```
+
+Then, you can run it using its query name:
+```
+bjira run mine
+```
+
+If you want to have parameters in your query, use `$$$` as placeholder. For instance:
+```
+bjira preset create search 'project = "FOO" AND text ~ "$$$" ORDER BY created DESC'
+bjira run search "hello world"
+```
+
+
+### Custom fields
+Jira is strongly configurable via custom fields. You can retrieve the list of custom fields using:
+
+```
+bjira field listall
+```
+
+If you want to see some of them in the issue report, add them:
+
+```
+bjira field add "Story Points"
+```
+
+Any custom fields added to the list will be shown in the issue report (See `bjira issue`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bjira",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "description": "A simple jira CLI tool",
   "main": "src/index.js",
   "author": {
@@ -12,19 +12,18 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/bakulf/jira.git"
+    "url": "git://github.com/bakulf/bjira.git"
   },
   "bugs": {
-    "url": "https://github.com/bakulf/jira/issues"
+    "url": "https://github.com/bakulf/bjira/issues"
   },
   "license": "MIT",
   "type": "module",
-  "engines" : {
-    "node" : ">=13.2.0"
+  "engines": {
+    "node": ">=13.2.0"
   },
   "engineStrict": true,
   "dependencies": {
-    "cli-table3": "^0.6.0",
     "commander": "^8.2.0",
     "execa": "^5.1.1",
     "inquirer": "^8.2.0",

package/src/ask.js

@@ -0,0 +1,57 @@
+import inquirer from 'inquirer';
+
+class Ask {
+  static async askString(message, defaultValue = undefined) {
+    const question = {
+      type: 'input',
+      name: 'value',
+      message,
+    };
+
+    if (defaultValue !== undefined) question.default = defaultValue;
+    const answer = await inquirer.prompt([question]);
+    return answer.value;
+  }
+
+  static async askPassword(message) {
+    const answer = await inquirer.prompt([{
+      type: 'password',
+      name: 'value',
+      message,
+    }]);
+    return answer.value;
+  }
+
+  static async askBoolean(message) {
+    const answer = await inquirer.prompt([{
+      type: 'confirm',
+      name: 'value',
+      message,
+    }]);
+    return answer.value;
+  }
+
+  static async askNumber(message) {
+    const question = {
+      type: 'number',
+      name: 'value',
+      message,
+    };
+
+    const answer = await inquirer.prompt([question]);
+    return answer.value;
+  }
+
+  static async askList(message, list) {
+    const answer = await inquirer.prompt([{
+      type: 'list',
+      name: 'value',
+      message,
+      choices: list,
+      filter: name => list.indexOf(name),
+    }]);
+    return answer.value;
+  }
+};
+
+export default Ask;

package/src/comment.js

@@ -1,11 +1,9 @@
 import execa from 'execa';
-import inquirer from 'inquirer';
 import fs from 'fs';
 import temp from 'temp';
 
 import Command from './command.js';
 import Jira from './jira.js';
-import ErrorHandler from './errorhandler.js';
 
 class Comment extends Command {
   addOptions(program) {
@@ -47,7 +45,7 @@ class Comment extends Command {
 
         const jira = new Jira(program);
 
-        const data = await jira.spin('Adding the comment...', jira.api.addComment(id, comment));
+        await jira.spin('Adding the comment...', jira.api.addComment(id, comment));
       });
   }
 };

package/src/create.js

@@ -1,11 +1,11 @@
 import color from 'chalk';
-import inquirer from 'inquirer';
-import Table from 'cli-table3';
 
+import Ask from './ask.js';
 import Command from './command.js';
 import Jira from './jira.js';
 import Issue from './issue.js';
 import Project from './project.js';
+import Set from './set.js';
 import User from './user.js';
 
 class Create extends Command {
@@ -16,30 +16,7 @@ class Create extends Command {
         const jira = new Jira(program);
 
         const project = await Project.pickProject(jira);
-
-        const issueQuestions = [{
-          type: 'list',
-          name: 'issueType',
-          message: 'Issue type:',
-          choices: project.issueTypes,
-          filter: name => project.issueTypes.find(obj => obj.name === name)
-        }, {
-          type: 'input',
-          name: 'summary',
-          message: 'Summary:',
-          default: 'New Issue'
-        }, {
-          type: 'input',
-          name: 'description',
-          message: 'Description:'
-        }, {
-          type: 'confirm',
-          name: 'assign',
-          message: 'Do you want to assign it?'
-        }, ];
-
-        // Ask for the issue name and type
-        const issueAnswers = await inquirer.prompt(issueQuestions);
+        const issueTypePos = await Ask.askList('Issue type:', project.issueTypes.map(issueType => issueType.name));
 
         // Create the issue object
         const newIssue = {
@@ -47,61 +24,23 @@ class Create extends Command {
             project: {
               key: project.key
             },
-            summary: issueAnswers.summary,
+            summary: await Ask.askString('Summary:', 'New Issue'),
             issuetype: {
-              id: issueAnswers.issueType.id
+              id: project.issueTypes[issueTypePos].id
             }
           }
         };
 
-        if (issueAnswers.description) {
-          newIssue.fields.description = issueAnswers.description;
-        }
-
-        if (issueAnswers.assign) {
-          const userList = await User.pickUser(jira);
-
-          const userNames = [];
-          const userIds = [];
-          userList.forEach(user => {
-            if (user.active) {
-              userNames.push(user.displayName);
-              userIds.push(user.accountId);
-            }
-          });
-
-          const assigneeQuestion = [{
-            type: 'list',
-            name: 'assignee',
-            message: 'Assignee:',
-            choices: userNames,
-            filter: name => {
-              const pos = userNames.indexOf(name);
-              return {
-                pos,
-                name,
-                id: userIds[pos]
-              };
-            }
-          }];
-
-          const assigneeAnswer = await inquirer.prompt(assigneeQuestion);
-          newIssue.fields.assignee = {
-            accountId: assigneeAnswer.assignee.id
-          };
+        const description = await Ask.askString('Description:');
+        if (description) {
+          newIssue.fields.description = description;
         }
 
-        if (issueAnswers.issueType.name === 'Task') {
-          const parentIssueQuestion = [{
-            type: 'input',
-            name: 'issueParentName',
-            message: 'Please provide the epic:'
-          }];
-
-          const parentIssueAnswer = await inquirer.prompt(parentIssueQuestion);
-          if (parentIssueAnswer.issueParentName !== '') {
+        if (project.issueTypes[issueTypePos].name === 'Task') {
+          const parentIssue = await Ask.askString('Please provide the epic:');
+          if (parentIssue !== '') {
             newIssue.fields.parent = {
-              key: parentIssueAnswer.issueParentName
+              key: parentIssue
             };
           }
         }
@@ -112,6 +51,21 @@ class Create extends Command {
         console.log('New issue: ' + color.bold.red(issue.key));
         console.log(color.blue(Issue.url(jira, issue.key)));
         console.log('');
+
+        if (await Ask.askBoolean('Do you want to assign it?')) {
+          await Set.assignIssue(jira, issue.key);
+        }
+
+        if (jira.fields && jira.fields.length > 0 &&
+          await Ask.askBoolean('Do you want to set custom fields?')) {
+          for (let fealdName of jira.fields) {
+            await Set.setCustomField(jira, filedName, issue.key);
+          }
+        }
+
+        if (await Ask.askBoolean('Do you want to set a status?')) {
+          await Set.setStatus(jira, issue.key);
+        }
       });
   }
 };

package/src/errorhandler.js

@@ -1,24 +1,27 @@
-import color from 'chalk';
-import Table from 'cli-table3';
+import Table from './table.js';
 
 class ErrorHandler {
   static showError(jira, e) {
     const table = new Table({
-      chars: jira.tableChars,
       head: ['Errors']
     });
 
-    e.error.errorMessages.forEach(error => table.push([color.blue(error)]));
+    e.error.errorMessages.forEach(error => table.addRow([{
+      color: "blue",
+      text: error
+    }]));
     console.log(table.toString());
   }
 
   static showWarningMessages(jira, messages) {
     const table = new Table({
-      chars: jira.tableChars,
       head: ['Warnings']
     });
 
-    messages.forEach(warning => table.push([color.blue(warning)]));
+    messages.forEach(warning => table.addRow([{
+      color: "blue",
+      text: warning
+    }]));
     console.log(table.toString());
   }
 };

package/src/field.js

@@ -1,9 +1,7 @@
-import color from 'chalk';
-import Table from 'cli-table3';
-
+import Ask from './ask.js';
 import Command from './command.js';
-import ErrorHandler from './errorhandler.js';
 import Jira from './jira.js';
+import Table from './table.js';
 
 class Field extends Command {
   addOptions(program) {
@@ -14,22 +12,18 @@ class Field extends Command {
       .action(async () => {
         const jira = new Jira(program);
 
-        let resultFields;
-        try {
-          resultFields = await Field.listFields(jira);
-        } catch (e) {
-          ErrorHandler.showError(jira, e);
-          return;
-        }
+        const resultFields = await Field.listFields(jira);
 
         const table = new Table({
-          chars: jira.tableChars,
           head: ['Name', 'Supported', 'Type']
         });
 
         resultFields.forEach(field => {
           const supported = Field.isSupported(field.schema?.type);
-          table.push([color.blue(field.name), supported, supported ? field.schema?.type : ""]);
+          table.addRow([{
+            color: "blue",
+            text: field.name
+          }, supported, supported ? field.schema?.type : ""]);
         });
         console.log(table.toString());
       });
@@ -40,13 +34,7 @@ class Field extends Command {
       .action(async fieldName => {
         const jira = new Jira(program);
 
-        let resultFields;
-        try {
-          resultFields = await Field.listFields(jira);
-        } catch (e) {
-          ErrorHandler.showError(jira, e);
-          return;
-        }
+        const resultFields = await Field.listFields(jira);
 
         const fieldData = resultFields.find(field => field.name === fieldName);
         if (!fieldData) {
@@ -88,11 +76,13 @@ class Field extends Command {
         const jira = new Jira(program);
 
         const table = new Table({
-          chars: jira.tableChars,
           head: ['Name']
         });
 
-        jira.fields.forEach(fieldName => table.push([color.blue(fieldName)]));
+        jira.fields.forEach(fieldName => table.addRow([{
+          color: "blue",
+          text: fieldName
+        }]));
         console.log(table.toString());
       });
   }
@@ -105,14 +95,8 @@ class Field extends Command {
     return ["string", "number"].includes(fieldType);
   }
 
-  static async getFieldDataIfSupported(jira, fieldName) {
-    let resultFields;
-    try {
-      resultFields = await Field.listFields(jira);
-    } catch (e) {
-      ErrorHandler.showError(jira, e);
-      return null;
-    }
+  static async askFieldIfSupported(jira, fieldName) {
+    const resultFields = await Field.listFields(jira);
 
     let fieldData;
     resultFields.forEach(field => {
@@ -132,17 +116,16 @@ class Field extends Command {
     let type;
     switch (fieldData.schema.type) {
       case 'number':
-        type = 'number';
-        break;
+        return {
+          value: await Ask.askNumber(`${fieldName}:`), key: fieldData.key
+        };
       case 'string':
-        type = 'input';
-        break;
+        return {
+          value: Ask.askString(`${fieldName}:`), key: fieldData.key
+        };
     }
 
-    return {
-      type,
-      key: fieldData.key
-    };
+    return null;
   }
 };
 

package/src/index.js

@@ -17,7 +17,7 @@ import Run from './run.js';
 import Set from './set.js';
 import Sprint from './sprint.js';
 
-const DEFAULT_CONFIG_FILE = path.join(os.homedir(), ".jira.json")
+const DEFAULT_CONFIG_FILE = path.join(os.homedir(), ".bjira.json")
 
 const commands = [
   new Comment(),

package/src/init.js

@@ -1,7 +1,7 @@
 import color from 'chalk';
-import inquirer from 'inquirer';
 import fs from 'fs';
 
+import Ask from './ask.js';
 import Command from './command.js';
 
 class Init extends Command {
@@ -10,33 +10,13 @@ class Init extends Command {
       .description('Create the initial config file')
       .action(async () => {
         const opts = program.opts();
-        const questions = [{
-          type: ' input',
-          name: 'host',
-          message: 'Provide your jira host:',
-          default: 'example.atlassian.net'
-        }, {
-          type: 'input',
-          name: 'username',
-          message: 'Please provide your jira username:'
-        }, {
-          type: 'password',
-          name: 'password',
-          message: 'API token:'
-        }, {
-          type: 'confirm',
-          name: 'protocol',
-          message: 'Enable HTTPS Protocol?'
-        }];
-
-        const answers = await inquirer.prompt(questions);
 
         const config = {
           jira: {
-            protocol: answers.protocol ? 'https' : 'http',
-            host: answers.host.trim(),
-            username: answers.username.trim(),
-            password: answers.password.trim(),
+            host: (await Ask.askString('Provide your jira host:', 'example.atlassian.net')).trim(),
+            protocol: await Ask.askBoolean('Enable HTTPS Protocol?') ? 'https' : 'http',
+            username: (await Ask.askString('Please provide your jira username:')).trim(),
+            password: (await Ask.askPassword('API token:')).trim(),
             apiVersion: '2',
             strictSSL: true,
           },