https://github.com/juacker/git-link.nvim
Neovim plugin to quickly jump from a line of code in Neovim to the same line of code in Github. Useful when you need to share a link to a line of code to your colleagues.
https://github.com/juacker/git-link.nvim
git neovim neovim-plugin
Last synced: 3 months ago
JSON representation
Neovim plugin to quickly jump from a line of code in Neovim to the same line of code in Github. Useful when you need to share a link to a line of code to your colleagues.
- Host: GitHub
- URL: https://github.com/juacker/git-link.nvim
- Owner: juacker
- License: apache-2.0
- Created: 2023-12-11T23:14:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-09T15:21:21.000Z (over 1 year ago)
- Last Synced: 2025-03-09T16:27:22.994Z (over 1 year ago)
- Topics: git, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 38.1 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git-Link for NeoVim
**Git-Link for NeoVim** allows you to quickly navigate from a line of code in Neovim to the corresponding line in a browser, assuming your repository's remote is hosted on platforms like GitHub, GitLab, etc. This plugin is especially useful when you need to share a link to a specific line of code (or line range) with your colleagues.
## Features
- **Get a sharable URL**: Easily generate a link to the line of code under your cursor, ready to share. You can also share a link to a line range, if you select a visual block.
- **Open in Browser**: Instantly open the browser and navigate to the specific line of code under your cursor.
- **Configurable URL Rules**: Support for custom Git hosting platforms through configurable URL rewriting rules.
## Installation and Configuration
This plugin does not set any default keymaps, however, in the following examples we set these:
- `gu`: Copies the URL of the line of code under your cursor to your clipboard.
- `go`: Opens the browser and navigates directly to the line of code under your cursor.
Below are examples for different setups:
### With LazyVim
```lua
{
"juacker/git-link.nvim",
keys = {
{
"gu",
function() require("git-link.main").copy_line_url() end,
desc = "Copy code link to clipboard",
mode = { "n", "x" }
},
{
"go",
function() require("git-link.main").open_line_url() end,
desc = "Open code link in browser",
mode = { "n", "x" }
},
},
}
```
### With Packer
```lua
use {
'juacker/git-link.nvim',
config = function()
-- Set up your keymaps
vim.keymap.set('n', 'gu', function() require("git-link.main").copy_line_url() end)
vim.keymap.set('n', 'go', function() require("git-link.main").open_line_url() end)
vim.keymap.set('x', 'gu', function() require("git-link.main").copy_line_url() end)
vim.keymap.set('x', 'go', function() require("git-link.main").open_line_url() end)
end
}
```
### Manual Setup
```lua
-- In your init.lua
vim.keymap.set('n', 'gu', function() require("git-link.main").copy_line_url() end)
vim.keymap.set('n', 'go', function() require("git-link.main").open_line_url() end)
vim.keymap.set('x', 'gu', function() require("git-link.main").copy_line_url() end)
vim.keymap.set('x', 'go', function() require("git-link.main").open_line_url() end)
```
### Default URL Rules
The plugin comes with built-in support for the following Git remote URL formats:
- HTTPS URLs (e.g., `https://github.com/user/repo`)
- Git SSH URLs (e.g., `git@github.com:user/repo`)
- SSH protocol URLs (e.g., `ssh://git@github.com/user/repo`)
These URLs are automatically converted to browser-friendly formats for GitHub, GitLab, and similar platforms.
### Custom URL Rules
You can add custom URL rules to support different Git hosting platforms. Each rule consists of:
- `pattern`: A Lua pattern to match your Git remote URL format
- `replace`: A template to convert the URL to HTTPS format
- `format_url`: A function that generates the final browser URL using:
- `base_url`: The resulting URL after replacing the pattern
- `params`: A table containing:
- `branch`: Current git branch
- `file_path`: Path to the file
- `start_line`: Starting line number
- `end_line`: Ending line number (same as start_line for single line links)
Custom rules are processed before default rules, allowing you to override the default behavior for specific repositories.
Here is an example of configuration with a custom URL rule:
```lua
{
"juacker/git-link.nvim",
opts = {
-- Optional: Add custom URL rules for your Git hosting platform
url_rules = {
-- Example rule for Gerrit (might need adjustment for your Gerrit instance)
{
pattern = "^ssh://([^:]+):29418/(.+)$",
replace = "https://%1/plugins/gitiles/%2",
format_url = function(base_url, params)
-- For single line
if params.start_line == params.end_line then
-- Generates Gerrit Gitiles URLs: https://host/plugins/gitiles/project/+/refs/heads/branch/path#number
return string.format("%s/+/refs/heads/%s/%s#%d", base_url, params.branch, params.file_path, params.start_line)
else
-- For line ranges - Gerrit uses comma to separate line ranges
return string.format("%s/+/refs/heads/%s/%s#%d,%d", base_url, params.branch, params.file_path, params.start_line, params.end_line)
end
end,
},
},
},
keys = {
{
"gu",
function() require("git-link.main").copy_line_url() end,
desc = "Copy code link to clipboard",
mode = { "n", "x" }
},
{
"go",
function() require("git-link.main").open_line_url() end,
desc = "Open code link in browser",
mode = { "n", "x" }
},
},
}
```
## Usage
1. Place the cursor on the desired line of code or select the visual block you want to share.
2. Use your configured keybinding to copy the link URL to your clipboard.
3. Alternatively, use your configured keybinding to open the link directly in your browser.
## Demo
[Git-Link Demo](https://github.com/user-attachments/assets/276635a4-77d7-4fb9-a2f3-9e1af423e99d)