Github issue lookup in Vim
Vim script
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

github-issues.vim

Github issue integration in Vim. It's kind of awesome.

Looking for a new owner

If you're interested in taking over this project and giving it the love it deserves, send me an email or file a bug.

Omnicomplete

If you use Fugitive or edit gitcommit files in Vim, github-issues will automatically populate the omnicomplete menu with issues on Github. This is useful when you want to reference commits, close issues, etc., through Github's commit message parsing.

Here's how it works with Neocomplete:

If you use pure omnicomplete, use C-x C-o to pull up the menu.

No need to run commands, no need to configure. It just works. ;) (And if it doesn't, it should, so submit an issue) Not bad, huh?

Lookup menu

To show Github issues for the current repository:

:Gissues

Press enter to view more details.

Handling issues

You can open and close issues using co and cc in the issue view.

They're also totally editable buffers, and saving the file will sync with Github's servers. You can use this to write comments, too:

You can also open the current issue in your browser using cb.

Creating issues

You can even use :Giadd to create a blank issue. Saving the buffer will generate a new issue and update the buffer with an issue number and the ability to add comments.

How awesome is that!?

Milestones

New feature: Use :Gmiles to open a menu of milestones. Press return on one to select it and filter :Gissues by that milestone from then on.

Custom Issue Search

You have the ability to define your own issue search using Githubs search API. This allows you to view issues and pull requests across repos.

To use this feature, you can add a line like the following, with the search parameters that you wish to use.

let g:gh_issues_query = "state:open user:github label:\"feature\" sort:created-asc"

You can than get this list of issues using the command :Gisearch

Fugitive integration

Github will show any commits that reference the issue. That's what the omnicomplete helps with. But to make things even more awesome, github-issues.vim integrates with Fugitive.vim to make commit hashes clickable with the return key.

Requirements and Installation

Vim with Python 2.7, Python 2.7 installed and working with Vim.

I recommend using Pathogen and Git cloning into ~/.vim/bundle. You can also just download the plugin and paste it into your plugin directory.

Then read below about adding an access token.

Configuration

The omnicomplete and lookup features will work out of the box for public repos.

If you have private repos, or would like the ability to comment, open, close, and add issues, you will need to set an access token. Don't worry, this is super easy.

g:github_access_token

Grab an access token from here, then set this variable, preferably in a local vim file not included in any public repositories:

let g:github_access_token = "9jb19c1189f083d7013i24367lol"

Remember, you should treat your access token like a password!

Other options include:

g:github_issues_no_omni

When this is set to any value, github-issues will not set Neocomplete and Omnicomplete hooks.

g:github_upstream_issues

When this is set to 1, github-issues will use upstream issues (if repo is fork). This will require extra requests for the Github API, however.

g:github_api_url = "https://api.github.com/"

If you use Github Enterprise, where the Github server is hosted somewhere other than Github.com, set this parameter to your API path. This is specifically for Github Enterprise and will not work for Bitbucket, Gitlab, etc.

g:github_same_window = 1

When this is set to 1, github-issues will use the current window instead of splitting the screen via the :new command.

g:gissues_lazy_load = 0

When this is set to 1, omnicomplete will not be populated until it is triggered. This eliminates potential lag when opening gitcommit files.

g:gissues_async_omni = 0

Experimental: When set to 1, omnicomplete will be populated asynchronously, on another thread. This removes almost all lag from the UI when using Gissues, and can be combined with g:gissues_lazy_load to reduce network traffic while still receiving the same speed boost. However, this uses threads and needs a lot more testing to ensure it is stable.

Contributing

Pull requests, feature requests, and issues are always welcome!

Shameless plug

I hack around with Vim plugins, so follow me if you're into that kind of stuff (or just want to make my day) ;)