jirify

Gem Version Build Status Coverage Status

A simple ruby gem that helps me work with jira

Installation

  1. Run gem install jirify.
  2. Execute jira setup and go through the setup process.
  3. Optionally source $HOME/.jirify/jirify.bash_completion.sh to have autocomplete in bash.
  4. Execute jira and jira <command> help to learn about available commands.

Config Explained

Currently, the config structure of jirify is:

  • $HOME/.jirify folder that contains:
    • .jirify - yaml file generated by jira setup
    • jirify.bash_completion.sh - bash completion script you can source. This is placed here by jira setup, so if you don't see it or you want to refresh it, run jira setup again.
    • .cache - cache for completion script

Config file: $HOME/.jirify/.jirify

options:
  username: <atlassian username (email)>
  token: <token generated from https://id.atlassian.com>
  site: <JIRA url>
  projects:
    - <JIRA project key>
  filter_by_labels:
    - <label to filter by when displaying sprint>
  verbose: <force jirify to always be verbose>

To Do

  • Tests:
    • [ ] Test CLI classes.
    • [ ] Test UI classes.
    • [ ] Test Models::Issue.
    • [ ] Test Models::Transition, Models::BaseList (?).
    • [ ] Test Config::copy_bash_completion!.
  • [ ] Refactor Models - BaseList doesn't make much sense.
  • [x] ~~Refactor SprintCell:~~
    • [x] ~~It should be a more general IssueRenderer.~~
    • [x] ~~Use it for jira issues describe with additional option to draw border.~~
  • [ ] Adjust jira issues mine to terminal width.
  • [ ] Add ability to define mapping between custom statuses and custom transitions in config.
  • [ ] Add ability to specify custom filters when listing issues (both jira sprint and jira issues)