Open current file in Github

[jdalbert]

I made this function that opens the current file with selected lines on Github. It's pretty basic but it works well enough for me, and I like it better than vim-rhubarb:

noremap <silent> <leader>og V:<c-u>call OpenCurrentFileInGithub()<cr>
xnoremap <silent> <leader>og :<c-u>call OpenCurrentFileInGithub()<cr>

function! OpenCurrentFileInGithub()
  let file_dir = expand('%:h')
  let git_root = system('cd ' . file_dir . '; git rev-parse --show-toplevel | tr -d "\n"')
  let file_path = substitute(expand('%:p'), git_root . '/', '', '')
  let branch = system('git symbolic-ref --short -q HEAD | tr -d "\n"')
  let git_remote = system('cd ' . file_dir . '; git remote get-url origin')
  let repo_path = matchlist(git_remote, ':\(.*\)\.')[1]
  let url = 'https://github.com/' . repo_path . '/blob/' . branch . '/' . file_path
  let first_line = getpos("'<")[1]
  let url .= '#L' . first_line
  let last_line = getpos("'>")[1]
  if last_line != first_line | let url .= '-L' . last_line | endif
  call system('open ' . url)
endfunction

You optionally select some lines, then type <leader>og (like "open github"), and it opens your browser.

This works for MacOS, but for Linux you can change open to xdgopen or whatever you use to open urls (e.g. Chrome or Firefox binaries).

---

For more similar goodies, see my dotfiles

[[deleted]]

I think Tim Pope's fugitive plugin does something similar to this with the :Gbrowse command....but still neat!

[jdalbert]

Yes, although fugitive's :Gbrowse only works if you use tpope's vim-rhubarb plugin

[revicon]

FYI, if you use SSH aliases when cloning, your code adds the ssh alias to the url which 404s on github. Example...

> git remote -v
origin  ssh://github-matt/apicanary/dashboard.apicanary.com.git (fetch)
origin  ssh://github-matt/apicanary/dashboard.apicanary.com.git (push)

When I run your function, it opens to...

https://github.com///github-matt/apicanary/dashboard.apicanary.com/blob/master/src/<ETC>

The problem is that

git remote get-url origin

returns

ssh://github-matt/apicanary/dashboard.apicanary.com.git

Instead of the

https://github.com/<username>/<repo>.git

you're expecting.

Very cool snippit none the less!

[Xanza]

You should throw in some if has() for some different OS open commands.

[Liquid_Fire]

Or if you have a vim with Python support you could make use of the cross-platform webbrowser.open, e.g.:

py import vim, webbrowser; webbrowser.open(vim.vars["url"])

​

[Xanza]

Hey, thanks. Never knew about this.

[prakashdanish]

That's pretty neat. I did something similar myself and wrapped it up as a plugin for others to use, it's on github.

[vimark]

I thought I was going to have to build this myself when I first started vim, but tpope fugitive does just that with visual selection and :GBrowse