openingh.nvim/README.md

openingh.nvim

Opens the current file or project page in GitHub.

• Features
  • Supports MacOS, Linux, and maybe Windows 🤷‍♂️
  • Works with detaches HEAD and support checked out branches or forks
  • Automatically selects the correct line number in the file page

Requirements

• Neovim 0.7.2+

Installation

Example with Packer

wbthomason/packer.nvim

  -- init.lua
  require("packer").startup(function()
    use "almo7aya/openingh.nvim"
  end)

Commands

• :OpenInGHRepo

  • Opens the project's git repository page in GitHub.

• :OpenInGHFile

  • Opens the current file page in GitHub.

Usage

You can call the commands directly or define mappings them:

-- for repository page
vim.api.nvim_set_keymap("n", "<Leader>gr", ":OpenInGHRepo <CR>", { expr = true, noremap = true })

-- for current file page
vim.api.nvim_set_keymap("n", "<Leader>gf", ":OpenInGHFile <CR>", { expr = true, noremap = true })

TODO

• Support the current file cursor position
• Support visual mode to open a file in range selection
• Support support other version control websites

Contribution

Feel free to open an issue or a pull request if you have any suggestion or improvements

License

MIT