diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9bbbeea --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.luarc.json diff --git a/README.md b/README.md index 9484289..4b7b43a 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,13 @@ end) - `:OpenInGHFileLines` - Opens the current file page in GitHub. This command supports ranges. + +## Registers + +All of the commands above optionally take a register, e.g. `:OpenInGHFileLines+`. +In this case, the URL will not be opened in the browser, but put into the register given. +This is especially useful if you're running neovim on a remote machine, but want to open the URL locally. + ## Usage You can call the commands directly or define mappings them: diff --git a/lua/openingh/init.lua b/lua/openingh/init.lua index 4da7982..88e34f6 100644 --- a/lua/openingh/init.lua +++ b/lua/openingh/init.lua @@ -34,7 +34,7 @@ local function get_current_branch_or_commit_with_priority(priority) end end -function M.open_file( +function M.get_file_url( priority, --[[optional]] range_start, @@ -67,12 +67,10 @@ function M.open_file( file_page_url = file_page_url .. "#L" .. range_start .. "-L" .. range_end end - if not utils.open_url(file_page_url) then - utils.notify("Could not open the built URL " .. file_page_url, vim.log.levels.ERROR) - end + return file_page_url end -function M.open_repo(priority) +function M.get_repo_url(priority) -- make sure to update the current directory M.setup() if M.is_no_git_origin then @@ -80,8 +78,11 @@ function M.open_repo(priority) return end - local url = M.repo_url .. "/tree/" .. get_current_branch_or_commit_with_priority(priority) + return url +end + +function M.open_url(url) if not utils.open_url(url) then utils.notify("Could not open the built URL " .. url, vim.log.levels.ERROR) end diff --git a/plugin/openingh.lua b/plugin/openingh.lua index 531db6d..ffba143 100644 --- a/plugin/openingh.lua +++ b/plugin/openingh.lua @@ -13,32 +13,60 @@ local function complete_func(arg_lead, _, _) end vim.api.nvim_create_user_command("OpenInGHFile", function(opts) + local url + if opts.range == 0 then -- Nothing was selected - openingh.open_file(opts.args) - else -- Current line or block was selected - openingh.open_file(opts.args, opts.line1, opts.line2) + url = openingh.get_file_url(opts.args) + else -- Current line or block was selected + url = openingh.get_file_url(opts.args, opts.line1, opts.line2) + end + + if opts.reg == "" then + openingh.open_url(url) + else + vim.fn.setreg(opts.reg, url) + print("URL put into register " .. opts.reg) end end, { + register = true, range = true, nargs = '?', complete = complete_func, }) vim.api.nvim_create_user_command("OpenInGHFileLines", function(opts) + local url + if opts.range == 0 then -- Nothing was selected - openingh.open_file(opts.args, opts.line1) - else -- Current line or block was selected - openingh.open_file(opts.args, opts.line1, opts.line2) + url = openingh.get_file_url(opts.args, opts.line1) + else -- Current line or block was selected + url = openingh.get_file_url(opts.args, opts.line1, opts.line2) + end + + if opts.reg == "" then + openingh.open_url(url) + else + vim.fn.setreg(opts.reg, url) + print("URL put into register " .. opts.reg) end end, { + register = true, range = true, nargs = '?', complete = complete_func, }) vim.api.nvim_create_user_command("OpenInGHRepo", function(opts) - openingh.open_repo(opts.args) + local url = openingh.get_repo_url(opts.args) + + if opts.reg == "" then + openingh.open_url(url) + else + vim.fn.setreg(opts.reg, url) + print("URL put into register " .. opts.reg) + end end, { + register = true, nargs = '?', complete = complete_func, })