bjira 0.0.3 → 0.0.4

package/README.md

@@ -1,4 +1,65 @@
 # 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
+```
+
+## 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.4",
   "description": "A simple jira CLI tool",
   "main": "src/index.js",
   "author": {
@@ -12,15 +12,15 @@
   },
   "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": {

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/.babelrc

@@ -1,13 +0,0 @@
-{
-  "presets": [
-    ["@babel/env", {
-      "targets": {
-        "node": "current"
-      }
-    }]
-  ],
-  "plugins": [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-object-rest-spread"
-  ]
-}

package/dist/command.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-class Command {
-  addOptions(program) {}
-
-}
-
-;
-var _default = Command;
-exports.default = _default;

package/dist/comment.js

@@ -1,70 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _execa = _interopRequireDefault(require("execa"));
-
-var _inquirer = _interopRequireDefault(require("inquirer"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _temp = _interopRequireDefault(require("temp"));
-
-var _command = _interopRequireDefault(require("./command.js"));
-
-var _jira = _interopRequireDefault(require("./jira.js"));
-
-var _errorhandler = _interopRequireDefault(require("./errorhandler.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class Comment extends _command.default {
-  addOptions(program) {
-    const commentCmd = program.command('comment').description('Add a comment to an issue').argument('<id>', 'The issue ID').action(async id => {
-      _temp.default.track();
-
-      let file;
-
-      try {
-        file = _temp.default.openSync('jira');
-      } catch (e) {
-        console.log("Failed to open a temporary file");
-        return;
-      }
-
-      const code = await new Promise(resolve => {
-        const subprocess = (0, _execa.default)(process.env.EDITOR, [file.path], {
-          detached: true,
-          stdio: 'inherit'
-        });
-        subprocess.on('error', () => resolve(-1));
-        subprocess.on('close', resolve);
-      });
-
-      if (code !== 0) {
-        console.log("Failed to run the app");
-        return;
-      }
-
-      let comment = _fs.default.readFileSync(file.path);
-
-      comment = comment.toString().trim();
-
-      if (comment === "") {
-        console.log("No comment message");
-        return;
-      }
-
-      const jira = new _jira.default(program);
-      const data = await jira.spin('Adding the comment...', jira.api.addComment(id, comment));
-    });
-  }
-
-}
-
-;
-var _default = Comment;
-exports.default = _default;

package/dist/create.js

@@ -1,127 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _inquirer = _interopRequireDefault(require("inquirer"));
-
-var _cliTable = _interopRequireDefault(require("cli-table3"));
-
-var _command = _interopRequireDefault(require("./command.js"));
-
-var _jira = _interopRequireDefault(require("./jira.js"));
-
-var _issue = _interopRequireDefault(require("./issue.js"));
-
-var _project = _interopRequireDefault(require("./project.js"));
-
-var _user = _interopRequireDefault(require("./user.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class Create extends _command.default {
-  addOptions(program) {
-    const cmd = program.command('create').description('Create a new issue').action(async () => {
-      const jira = new _jira.default(program);
-      const project = await _project.default.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.default.prompt(issueQuestions); // Create the issue object
-
-      const newIssue = {
-        fields: {
-          project: {
-            key: project.key
-          },
-          summary: issueAnswers.summary,
-          issuetype: {
-            id: issueAnswers.issueType.id
-          }
-        }
-      };
-
-      if (issueAnswers.description) {
-        newIssue.fields.description = issueAnswers.description;
-      }
-
-      if (issueAnswers.assign) {
-        const userList = await _user.default.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.default.prompt(assigneeQuestion);
-        newIssue.fields.assignee = {
-          accountId: assigneeAnswer.assignee.id
-        };
-      }
-
-      if (issueAnswers.issueType.name === 'Task') {
-        const parentIssueQuestion = [{
-          type: 'input',
-          name: 'issueParentName',
-          message: 'Please provide the epic:'
-        }];
-        const parentIssueAnswer = await _inquirer.default.prompt(parentIssueQuestion);
-
-        if (parentIssueAnswer.issueParentName !== '') {
-          newIssue.fields.parent = {
-            key: parentIssueAnswer.issueParentName
-          };
-        }
-      }
-
-      const issue = await jira.spin('Creating the issue...', jira.api.addNewIssue(newIssue));
-      console.log('');
-      console.log('New issue: ' + _chalk.default.bold.red(issue.key));
-      console.log(_chalk.default.blue(_issue.default.url(jira, issue.key)));
-      console.log('');
-    });
-  }
-
-}
-
-;
-var _default = Create;
-exports.default = _default;

package/dist/errorhandler.js

@@ -1,37 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _cliTable = _interopRequireDefault(require("cli-table3"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class ErrorHandler {
-  static showError(jira, e) {
-    const table = new _cliTable.default({
-      chars: jira.tableChars,
-      head: ['Errors']
-    });
-    e.error.errorMessages.forEach(error => table.push([_chalk.default.blue(error)]));
-    console.log(table.toString());
-  }
-
-  static showWarningMessages(jira, messages) {
-    const table = new _cliTable.default({
-      chars: jira.tableChars,
-      head: ['Warnings']
-    });
-    messages.forEach(warning => table.push([_chalk.default.blue(warning)]));
-    console.log(table.toString());
-  }
-
-}
-
-;
-var _default = ErrorHandler;
-exports.default = _default;

package/dist/field.js

@@ -1,158 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _cliTable = _interopRequireDefault(require("cli-table3"));
-
-var _command = _interopRequireDefault(require("./command.js"));
-
-var _errorhandler = _interopRequireDefault(require("./errorhandler.js"));
-
-var _jira = _interopRequireDefault(require("./jira.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class Field extends _command.default {
-  addOptions(program) {
-    const cmd = program.command("field").description("Do things related to issue fields");
-    cmd.command("listall").description("Show the list of fields").action(async () => {
-      const jira = new _jira.default(program);
-      let resultFields;
-
-      try {
-        resultFields = await Field.listFields(jira);
-      } catch (e) {
-        _errorhandler.default.showError(jira, e);
-
-        return;
-      }
-
-      const table = new _cliTable.default({
-        chars: jira.tableChars,
-        head: ['Name', 'Supported', 'Type']
-      });
-      resultFields.forEach(field => {
-        var _field$schema, _field$schema2;
-
-        const supported = Field.isSupported((_field$schema = field.schema) === null || _field$schema === void 0 ? void 0 : _field$schema.type);
-        table.push([_chalk.default.blue(field.name), supported, supported ? (_field$schema2 = field.schema) === null || _field$schema2 === void 0 ? void 0 : _field$schema2.type : ""]);
-      });
-      console.log(table.toString());
-    });
-    cmd.command("add").description("Add a custom field to be shown").argument('<field>', 'The field name').action(async fieldName => {
-      var _fieldData$schema;
-
-      const jira = new _jira.default(program);
-      let resultFields;
-
-      try {
-        resultFields = await Field.listFields(jira);
-      } catch (e) {
-        _errorhandler.default.showError(jira, e);
-
-        return;
-      }
-
-      const fieldData = resultFields.find(field => field.name === fieldName);
-
-      if (!fieldData) {
-        console.log("Unknown field.");
-        return;
-      }
-
-      if (!Field.isSupported((_fieldData$schema = fieldData.schema) === null || _fieldData$schema === void 0 ? void 0 : _fieldData$schema.type)) {
-        console.log("Unsupported field.");
-        return;
-      }
-
-      jira.addField(fieldName);
-      jira.syncConfig();
-      console.log('Config file succesfully updated');
-    });
-    cmd.command("remove").description("Remove a custom field").argument('<field>', 'The field name').action(async fieldName => {
-      const jira = new _jira.default(program);
-
-      if (!jira.fields.includes(fieldName)) {
-        console.log("Unknown field.");
-        return;
-      }
-
-      jira.removeField(fieldName);
-      jira.syncConfig();
-      console.log('Config file succesfully updated');
-    });
-    cmd.command("list").description("List the supported custom field").action(async () => {
-      const jira = new _jira.default(program);
-      const table = new _cliTable.default({
-        chars: jira.tableChars,
-        head: ['Name']
-      });
-      jira.fields.forEach(fieldName => table.push([_chalk.default.blue(fieldName)]));
-      console.log(table.toString());
-    });
-  }
-
-  static async listFields(jira) {
-    return await jira.spin('Retrieving the fields...', jira.api.listFields());
-  }
-
-  static isSupported(fieldType) {
-    return ["string", "number"].includes(fieldType);
-  }
-
-  static async getFieldDataIfSupported(jira, fieldName) {
-    var _fieldData$schema2;
-
-    let resultFields;
-
-    try {
-      resultFields = await Field.listFields(jira);
-    } catch (e) {
-      _errorhandler.default.showError(jira, e);
-
-      return null;
-    }
-
-    let fieldData;
-    resultFields.forEach(field => {
-      if (field.name === fieldName) fieldData = field;
-    });
-
-    if (!fieldData) {
-      console.log(`Unable to find the field "${fieldName}"`);
-      return null;
-    }
-
-    if (!Field.isSupported((_fieldData$schema2 = fieldData.schema) === null || _fieldData$schema2 === void 0 ? void 0 : _fieldData$schema2.type)) {
-      console.log("Unsupported field");
-      return null;
-    }
-
-    let type;
-
-    switch (fieldData.schema.type) {
-      case 'number':
-        type = 'number';
-        break;
-
-      case 'string':
-        type = 'input';
-        break;
-    }
-
-    return {
-      type,
-      key: fieldData.key
-    };
-  }
-
-}
-
-;
-var _default = Field;
-exports.default = _default;

package/dist/index.js

@@ -1,49 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-var _commander = _interopRequireDefault(require("commander"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _os = _interopRequireDefault(require("os"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _comment = _interopRequireDefault(require("./comment.js"));
-
-var _create = _interopRequireDefault(require("./create.js"));
-
-var _field = _interopRequireDefault(require("./field.js"));
-
-var _init = _interopRequireDefault(require("./init.js"));
-
-var _issue = _interopRequireDefault(require("./issue.js"));
-
-var _preset = _interopRequireDefault(require("./preset.js"));
-
-var _project = _interopRequireDefault(require("./project.js"));
-
-var _query = _interopRequireDefault(require("./query.js"));
-
-var _run = _interopRequireDefault(require("./run.js"));
-
-var _set = _interopRequireDefault(require("./set.js"));
-
-var _sprint = _interopRequireDefault(require("./sprint.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const DEFAULT_CONFIG_FILE = _path.default.join(_os.default.homedir(), ".jira.json");
-
-const commands = [new _comment.default(), new _create.default(), new _field.default(), new _init.default(), new _issue.default(), new _preset.default(), new _project.default(), new _query.default(), new _run.default(), new _set.default(), new _sprint.default()];
-/*
-const pjson = JSON.parse(fs.readFileSync(new URL("../package.json",
-  import.meta.url)));
-program.version(pjson.version);
-*/
-
-_commander.default.option('-c, --config <file>', `config file`, DEFAULT_CONFIG_FILE);
-
-commands.forEach(command => command.addOptions(_commander.default));
-
-_commander.default.parseAsync(process.argv);

package/dist/init.js

@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _inquirer = _interopRequireDefault(require("inquirer"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _command = _interopRequireDefault(require("./command.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-class Init extends _command.default {
-  addOptions(program) {
-    program.command('init').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.default.prompt(questions);
-      const config = {
-        jira: {
-          protocol: answers.protocol ? 'https' : 'http',
-          host: answers.host.trim(),
-          username: answers.username.trim(),
-          password: answers.password.trim(),
-          apiVersion: '2',
-          strictSSL: true
-        },
-        presets: {}
-      };
-
-      _fs.default.writeFileSync(opts.config, JSON.stringify(config, null, 2), 'utf8');
-
-      console.log(`Config file succesfully created in: ${_chalk.default.green(opts.config)}`);
-    });
-  }
-
-}
-
-;
-var _default = Init;
-exports.default = _default;