Option to output as json

[jrschumacher]

Is there an option to output content as json rather than in an ascii table?

[germanrcuriel]

Hi @jrschumacher! No, there's no support for that yet sorry.

[tibu]

Hi @germanrcuriel ,

I'd be happy to add JSON as output format.

What do you think about adding an option --format which could be json and later others too live csv?

[germanrcuriel]

@tibu Sure! It would be a nice feature!

[palashkulsh]

this has been done with
jira jql -j 1 "reporter=currentUser() and project='MMA'"

but somehow piping it to jq doesn't work with error
parse error: Unfinished JSON term at EOF at line 1565, column 4

[RichardBronosky]

@palashkulsh I figured out the reason for the jq error. It's caused by a common issue with node cli scripts that make async network calls. If the script calls process.exit() before the output buffer is emptied, pipes get closed (usually at 64k). You can compare these 2 commands:

$ jira jql -j 1 "reporter=currentUser()" > /tmp/1.json
$ jira jql -j 1 "reporter=currentUser()" | cat > /tmp/2.json
$ ls -lh /tmp/[12].json
-rw-r--r--  1 bruno  wheel   240K Jul 12 01:44 /tmp/1.json
-rw-r--r--  1 bruno  wheel    64K Jul 12 01:45 /tmp/2.json

as a result, you can jq . < /tmp/1.json but not jq . < /tmp/2.json

commenting out line 37 in bin/jira.js resolves this. Afterward you can do a simple:

$ jira jql -j 1 "reporter=currentUser()" | jq . | head -n4
[
  {
    "expand": "operations,customfield_10028.properties,versionedRepresentations,editmeta,changelog,customfield_10029.properties,customfield_10047.properties,renderedFields",
    "id": "13490",

[palashkulsh]

Awesome !! thanks @RichardBronosky it works. Before pushing this change I am thinking what would be the downside of not doing process.exit(0) . any thought?

[RichardBronosky]

I'm not sure about downsides. Based on nodejs/node#3669 (comment) and nodejs/node#2972 (comment) (both comments by the same user, mind you) seems like the downsides are on using it.

I'm looking into nodejs/node#6456 to see what other option there is.

Also, I have a PR coming that adds the option to get json output from the ls command.

[palashkulsh]

will be removing the exit part.
Also just fyi you can jira jql ALIAS functionality to have jira ls on steroids.

[RichardBronosky]

My PR https://github.com/germanrcuriel/jira-cmd/pull/89 uses the nodejs/node#6456 method instead of the change you made (at my indication) in https://github.com/germanrcuriel/jira-cmd/pull/88 I don't care which way you address the buffer issue. I can modify my branch if you want to keep your change. Just let me know.

[palashkulsh]

Surething @RichardBronosky , will let you know. Due to some time crunch for next 4-5 hours, will test post that.