mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 21:25:11 +00:00
125 lines
3.4 KiB
Markdown
125 lines
3.4 KiB
Markdown
# 🍿 gitbrowse
|
|
|
|
Open the repo of the active file in the browser (e.g., GitHub)
|
|
|
|
<!-- docgen -->
|
|
|
|
## 📦 Setup
|
|
|
|
```lua
|
|
-- lazy.nvim
|
|
{
|
|
"folke/snacks.nvim",
|
|
---@type snacks.Config
|
|
opts = {
|
|
gitbrowse = {
|
|
-- your gitbrowse configuration comes here
|
|
-- or leave it empty to use the default settings
|
|
-- refer to the configuration section below
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## ⚙️ Config
|
|
|
|
```lua
|
|
---@class snacks.gitbrowse.Config
|
|
---@field url_patterns? table<string, table<string, string|fun(fields:snacks.gitbrowse.Fields):string>>
|
|
{
|
|
notify = true, -- show notification on open
|
|
-- Handler to open the url in a browser
|
|
---@param url string
|
|
open = function(url)
|
|
if vim.fn.has("nvim-0.10") == 0 then
|
|
require("lazy.util").open(url, { system = true })
|
|
return
|
|
end
|
|
vim.ui.open(url)
|
|
end,
|
|
---@type "repo" | "branch" | "file" | "commit" | "permalink"
|
|
what = "commit", -- what to open. not all remotes support all types
|
|
branch = nil, ---@type string?
|
|
line_start = nil, ---@type number?
|
|
line_end = nil, ---@type number?
|
|
-- patterns to transform remotes to an actual URL
|
|
remote_patterns = {
|
|
{ "^(https?://.*)%.git$" , "%1" },
|
|
{ "^git@(.+):(.+)%.git$" , "https://%1/%2" },
|
|
{ "^git@(.+):(.+)$" , "https://%1/%2" },
|
|
{ "^git@(.+)/(.+)$" , "https://%1/%2" },
|
|
{ "^org%-%d+@(.+):(.+)%.git$" , "https://%1/%2" },
|
|
{ "^ssh://git@(.*)$" , "https://%1" },
|
|
{ "^ssh://([^:/]+)(:%d+)/(.*)$" , "https://%1/%3" },
|
|
{ "^ssh://([^/]+)/(.*)$" , "https://%1/%2" },
|
|
{ "ssh%.dev%.azure%.com/v3/(.*)/(.*)$", "dev.azure.com/%1/_git/%2" },
|
|
{ "^https://%w*@(.*)" , "https://%1" },
|
|
{ "^git@(.*)" , "https://%1" },
|
|
{ ":%d+" , "" },
|
|
{ "%.git$" , "" },
|
|
},
|
|
url_patterns = {
|
|
["github%.com"] = {
|
|
branch = "/tree/{branch}",
|
|
file = "/blob/{branch}/{file}#L{line_start}-L{line_end}",
|
|
permalink = "/blob/{commit}/{file}#L{line_start}-L{line_end}",
|
|
commit = "/commit/{commit}",
|
|
},
|
|
["gitlab%.com"] = {
|
|
branch = "/-/tree/{branch}",
|
|
file = "/-/blob/{branch}/{file}#L{line_start}-L{line_end}",
|
|
permalink = "/-/blob/{commit}/{file}#L{line_start}-L{line_end}",
|
|
commit = "/-/commit/{commit}",
|
|
},
|
|
["bitbucket%.org"] = {
|
|
branch = "/src/{branch}",
|
|
file = "/src/{branch}/{file}#lines-{line_start}-L{line_end}",
|
|
permalink = "/src/{commit}/{file}#lines-{line_start}-L{line_end}",
|
|
commit = "/commits/{commit}",
|
|
},
|
|
["git.sr.ht"] = {
|
|
branch = "/tree/{branch}",
|
|
file = "/tree/{branch}/item/{file}",
|
|
permalink = "/tree/{commit}/item/{file}#L{line_start}",
|
|
commit = "/commit/{commit}",
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
## 📚 Types
|
|
|
|
```lua
|
|
---@class snacks.gitbrowse.Fields
|
|
---@field branch? string
|
|
---@field file? string
|
|
---@field line_start? number
|
|
---@field line_end? number
|
|
---@field commit? string
|
|
---@field line_count? number
|
|
```
|
|
|
|
## 📦 Module
|
|
|
|
### `Snacks.gitbrowse()`
|
|
|
|
```lua
|
|
---@type fun(opts?: snacks.gitbrowse.Config)
|
|
Snacks.gitbrowse()
|
|
```
|
|
|
|
### `Snacks.gitbrowse.get_url()`
|
|
|
|
```lua
|
|
---@param repo string
|
|
---@param fields snacks.gitbrowse.Fields
|
|
---@param opts? snacks.gitbrowse.Config
|
|
Snacks.gitbrowse.get_url(repo, fields, opts)
|
|
```
|
|
|
|
### `Snacks.gitbrowse.open()`
|
|
|
|
```lua
|
|
---@param opts? snacks.gitbrowse.Config
|
|
Snacks.gitbrowse.open(opts)
|
|
```
|