jira-term

<!DOCTYPE html> <html> <head> <title>jira.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="data-utils.html"> data-utils.coffee </a> <a class="source" href="format-options.html"> format-options.coffee </a> <a class="source" href="jira-cli.html"> jira-cli.coffee </a> <a class="source" href="jira.html"> jira.coffee </a> <a class="source" href="pretty-printer.html"> pretty-printer.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> jira.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <h1>Jira Command Line Client</h1> This client depends on you having a json file in your home directory named <code>.jiraclirc.json</code> it must contain: <pre><code>{ "user": "USERNAME", "password": "PASSWORD", "host": "xxxxxx.atlassian.net", "project": 10100 } </code></pre> For SSL this the <code>.jiraclirc.json</code> may look like: <pre><code>{ "user": "USERNAME", "password": "PASSWORD", "host": "xxxxxxx.atlassian.net", "project": "ACME", "protocol": "https:" } </code></pre> If not present, it will enter an interactive mode to create it with you jira-term is on <a href="https://github.com/bryangrimes/jira-term">github</a> and is a fork off of the work done by Chris Moultrie in the <a href="https://github.com/tebriel/jira-cli">jira-cli</a> project. Cheers. </td> <td class="code"> <div class="highlight"><pre>fs = require 'fs' path = require 'path'</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <a href="jira-cli.html">JiraHelper docs/source</a> </td> <td class="code"> <div class="highlight"><pre>JiraHelper = require('./jira-cli').JiraHelper</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <a href="data-utils.html">dutils docs/source</a> </td> <td class="code"> <div class="highlight"><pre>dutils = require('./data-utils')</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h2>Create Config File</h2> Creates a config file when one doesn't exist </td> <td class="code"> <div class="highlight"><pre>createConfigFile = (aConfigFile) -> console.log "No config file found, answer these questions to create one!" dutils.ask "Username", /.+/, (username) -> dutils.ask "Password", /.+/, (password) -> dutils.ask "Jira Host", /.+/, (host) -> dutils.ask "Jira Port", /.+/, (port) -> dutils.ask "Default Project", /.*/, (project) -> config = user:username password:password host:host port:port project:project fs.writeFileSync aConfigFile, JSON.stringify(config), 'utf8' console.log "File created and saved as #{aConfigFile}" process.exit()</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h2>Check for Text Parameter</h2> Optimist returns a <code>bool</code> if the param is given but with nothing following it </td> <td class="code"> <div class="highlight"><pre>paramIsText = (param)-> if typeof(param) is "boolean" argv.showHelp() return false true</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h2>Load the Config File</h2> </td> <td class="code"> <div class="highlight"><pre>loadConfigFile = (configFilePath) -> configFile = fs.readFileSync configFilePath JSON.parse configFile</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h2>Transition Item</h2> This takes the issueId, lists the transitions available for the item and then lets the user apply that transition to the item. Optionally the user can specify a comment which will then prompt for time spent. This adds a work log item to the item before the transition. </td> <td class="code"> <div class="highlight"><pre>transitionItem = (issueId) -> jiraCli.listTransitions issueId, (transitions) -> transitions.sort dutils.itemSorter for transition, index in transitions jiraCli.pp.prettyPrintTransition transition, index + 1 allowedTypes = [1..transitions.length] dutils.ask "Transtion Type ", allowedTypes, (type)-> dutils.ask "Comment for worklog (blank to skip)", /.*/, (comment)-> if comment.length is 0 jiraCli.transitionIssue issueId, transitions[type - 1].id return dutils.ask "Time Spent (for worklog)", /.+/, (timeSpent)-> jiraCli.addWorklog issueId, comment, timeSpent, false jiraCli.transitionIssue issueId, transitions[type - 1].id , allowedTypes</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>Add Work Log</h2> This will add a comment and time spent as a worklog item attached to the issue </td> <td class="code"> <div class="highlight"><pre>addWorklog = (issueId) -> dutils.ask "Comment for worklog", /.+/, (comment)-> dutils.ask "Time Spent (for worklog)", /.+/, (timeSpent)-> jiraCli.addWorklog issueId, comment, timeSpent, true</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>List Projects</h2> This will list all the projects available to you </td> <td class="code"> <div class="highlight"><pre>listProjects = -> projects = jiraCli.getMyProjects (projects)-> for project in projects jiraCli.pp.prettyPrintProject project</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h2>Get Project</h2> Here we ask the user for their project, giving them an option for the default, ? for a list, or they can type in a number directly It calls itself if we list the projects, so that it can still be used to for what it was called to do </td> <td class="code"> <div class="highlight"><pre>getProject = (callback, defaultProj)-> dutils.ask "Project (Enter for Default/? for list) [#{defaultProj}] ",/.*/, (project) -> unless project is '?' callback configFile.project return projects = jiraCli.getMyProjects (projects)-> for project in projects jiraCli.pp.prettyPrintProject project getProject callback, defaultProj</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h2>Add Item</h2> Adds an item to Jira. The project passed in comes from getProject currently. Takes a summary and a description then lists the issue types for the user to choose from </td> <td class="code"> <div class="highlight"><pre>addItem = (project)-></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> Gather the summary, description, an type </td> <td class="code"> <div class="highlight"><pre> dutils.ask "Summary", /.+/, (summary)-> dutils.ask "Description", /.+/, (description)-> dutils.ask "QA Aceptance Criteria", /.+/, (criteria)-> jiraCli.getIssueTypes (issueTypes)-> issueTypes.sort dutils.itemSorter for type, index in issueTypes jiraCli.pp.prettyPrintIssueTypes type, index + 1 allowedTypes = [1..issueTypes.length] addIssueCallback = (type)-> jiraCli.addIssue summary, description, issueTypes[type - 1].id, project, criteria dutils.ask "Type ", allowedTypes, addIssueCallback, allowedTypes</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <h2>Main entry point</h2> Parses the arguments and then calls a function above </td> <td class="code"> <div class="highlight"><pre>if require.main is module argv = (require 'optimist') .options('f', alias:'find' describe:'Finds the specified Jira ID' ).options('a', alias:'add' describe:'Allows you to add a new Jira Task' ).options('t', alias:'transition' describe:'Allows you to resolve a specific Jira ID' ).options('l', alias:'list' describe:'Lists all your open issues' ).options('c', alias:'list-all' describe:'Lists all your issues' ).options('d', alias:'details' describe:'Shows expanded details' ).options('p', alias:'projects' describe:'Lists all your viewable projects' ).options('o', describe:'Limits list to only this project' ).options('w', alias:'worklog' describe:'Adds work to your task' ).options('s', alias:'search' describe:'Pass a jql string to jira' ).options('h', alias:'help' describe:'Shows this help message' ).usage('Usage:\n\tjira -f EG-143\n\tjira -f EG-143 -d\n\tjira -l') .boolean('d') .string('s') .string('f') .string('t') .string('w') if argv.argv.help argv.showHelp() return args = argv.argv configFilePath = path.join process.env.HOME, '.jiraclirc.json' unless fs.existsSync configFilePath createConfigFile configFilePath return configFile = loadConfigFile(configFilePath) jiraCli = new JiraHelper configFile if args.o? if args.o instanceof Array args.o = args.o.join ',' args.o = " AND project in (#{args.o})" if args.l jiraCli.getMyIssues true, args.d, args.o else if args.c jiraCli.getMyIssues false, args.d, args.o else if args.s return unless paramIsText args.s if args.o? args.s += args.o jiraCli.searchJira args.s, args.d else if args.p listProjects() else if args.a getProject addItem, configFile.project else if args.f? return unless paramIsText args.f jiraCli.getIssue args.f, args.d else if args.w? return unless paramIsText args.w addWorklog args.w else if args.t? return unless paramIsText args.t transitionItem args.t else argv.showHelp() </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>