jira-term

<!DOCTYPE html> <html> <head> <title>pretty-printer.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> pretty-printer.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> create wrap function for formatting </td> <td class="code"> <div class="highlight"><pre>wrap = require('wordwrap')(8, 80)</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> sometime you want to pad: here it is </td> <td class="code"> <div class="highlight"><pre>pad = require('wordwrap')(2, 100)</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> moment because we're not filthy animals </td> <td class="code"> <div class="highlight"><pre>moment = require('moment')</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> use colors it owns </td> <td class="code"> <div class="highlight"><pre>colors = require('colors')</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <a href="format-options.html">Printing Options docs/source</a> </td> <td class="code"> <div class="highlight"><pre>options = require('./format-options')</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h2>PrettyPrinter</h2> This creates the fancy output your eyes want to see. </td> <td class="code"> <div class="highlight"><pre>class PrettyPrinter</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Statuses that should be colored </td> <td class="code"> <div class="highlight"><pre> colors.setTheme success: "green" error: "red" log: "white" low:"green" medium:"yellow" high:"magenta" crit:"red"</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h2>Pretty Print List</h2> Prints a listing of items with the ability for a detailed print. Color logic is weak and will be addressed more cleanly. </td> <td class="code"> <div class="highlight"><pre> prettyPrintList: (issue, detail) -> process.stdout.write issue.key.log.bold issue.fields.summary = "None" unless issue.fields.summary? dash() process.stdout.write issue.fields.summary.log if detail if issue.fields.issuetype? process.stdout.write "Type:".log.bold if issue.fields.issuetype.name in options.bad_types process.stdout.write pad(issue.fields.issuetype.name).high else process.stdout.write pad(issue.fields.issuetype.name).low newline() process.stdout.write "Status:".log.bold if issue.fields.status.name in options.bad_statuses process.stdout.write pad(issue.fields.status.name).red else process.stdout.write pad(issue.fields.status.name).green newline() process.stdout.write "Assigned To:".log.bold process.stdout.write pad(issue.fields.assignee.name).log newline() newline()</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h2>Pretty Print Issue</h2> Prints an issue with Summary information, or with expanded detail. </td> <td class="code"> <div class="highlight"><pre> prettyPrintIssue: (issue, detail)-> newline() seperator().yellow newline() process.stdout.write "Issue:".log.bold process.stdout.write pad(issue.key).log.bold issue.fields.summary = "None" unless issue.fields.summary? dash() process.stdout.write issue.fields.summary.log newline() if detail if issue.fields.description? process.stdout.write "Description:".log.bold newline() txt = issue.fields.description.slice(0,300) process.stdout.write wrap(txt).log if txt.length > 300 newline() process.stdout.write pad("...") newline() if issue.fields.issuetype? process.stdout.write "Type:".log.bold if issue.fields.issuetype.name in options.bad_types process.stdout.write pad(issue.fields.issuetype.name).high else process.stdout.write pad(issue.fields.issuetype.name).low newline() process.stdout.write "Status:".log.bold if issue.fields.status.name in options.bad_statuses process.stdout.write pad(issue.fields.status.name).red else process.stdout.write pad(issue.fields.status.name).green newline() process.stdout.write "Priority:".log.bold if issue.fields.priority.name in options.med_priority process.stdout.write pad(issue.fields.priority.name).medium else if issue.fields.priority.name in options.high_priority process.stdout.write pad(issue.fields.priority.name).high else if issue.fields.priority.name in options.critical_priority process.stdout.write pad(issue.fields.priority.name).crit else process.stdout.write pad(issue.fields.priority.name).low newline() process.stdout.write "Assigned To:".log.bold process.stdout.write pad(issue.fields.assignee.name).log newline() process.stdout.write "Reporter:".log.bold process.stdout.write pad(issue.fields.reporter.name).log newline() process.stdout.write "Created On:".log.bold</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> this isn't localized I know. </td> <td class="code"> <div class="highlight"><pre> dt = moment(issue.fields.created).format("MM/D/YYYY h:mm:ss a") process.stdout.write pad(dt) newline() process.stdout.write "Updated On:".log.bold</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> this isn't localized I know. </td> <td class="code"> <div class="highlight"><pre> dt = moment(issue.fields.updated).format("MM/D/YYYY h:mm:ss a") process.stdout.write pad(dt) newline() newline()</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <h2>Do some fancy formatting on issue types</h2> Helper really, called when adding to not show certian issue types and to format </td> <td class="code"> <div class="highlight"><pre> prettyPrintIssueTypes: (issueType, index)-></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> ignore subtasks for now that's a monster (linking, etc) </td> <td class="code"> <div class="highlight"><pre> if issueType.subtask == false process.stdout.write issueType.id.log.bold dash() process.stdout.write issueType.name if issueType.description.length > 0 dash() process.stdout.write issueType.description newline()</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <h2>Pretty Print Transition</h2> Show a transition with the ID in bold followed by the name </td> <td class="code"> <div class="highlight"><pre> prettyPrintTransition: (transition, index) -> process.stdout.write transition.id dash() process.stdout.write transition.name newline()</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <h2>Pretty Print Projects</h2> Prints the project list in a non-awful format </td> <td class="code"> <div class="highlight"><pre> prettyPrintProject: (project) -> key = project.key while key.length < 12 key = ' ' + key process.stdout.write project.key dash() process.stdout.write project.name newline()</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <h2>Pretty Print Errors</h2> Prints errors red </td> <td class="code"> <div class="highlight"><pre> prettyPrintError: (message) -> process.stdout.write message.error newline()</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <h2>Pretty Print Successes</h2> Prints success notifications </td> <td class="code"> <div class="highlight"><pre> prettyPrintSuccess: (message) -> process.stdout.write message.success newline()</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> <h2>Pretty Print Logs</h2> Prints general log notifications </td> <td class="code"> <div class="highlight"><pre> prettyPrintLog: (message) -> process.stdout.write message.log newline()</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> Private helpers because copy and paste is OK, but make it clean(er) with functs </td> <td class="code"> <div class="highlight"><pre> newline = () -> process.stdout.write "\n" dash = () -> process.stdout.write " - " seperator = () -> txt="" for i in [1..80] txt += "*" process.stdout.write txt module.exports = { PrettyPrinter } </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>