From 02e6036f39bf766a608b92aa1800acd85112d983 Mon Sep 17 00:00:00 2001 From: Sathvik Birudavolu <8377116+BSathvik@users.noreply.github.com> Date: Fri, 29 Dec 2023 18:11:14 -0600 Subject: [PATCH 1/2] add override branch option --- doc/openingh.txt | 9 +++++++-- lua/openingh/init.lua | 10 ++++++++-- plugin/openingh.lua | 22 +++++++++++++--------- tests/utils_spec.lua | 7 +++++-- 4 files changed, 33 insertions(+), 15 deletions(-) diff --git a/doc/openingh.txt b/doc/openingh.txt index 21e781f..09fbebb 100644 --- a/doc/openingh.txt +++ b/doc/openingh.txt @@ -33,8 +33,9 @@ CONTENTS *openingh* :OpenInGHRepo - Opens the project's git repository page in GitHub. - :OpenInGHFile - - Opens the current file page in GitHub. + :OpenInGHFile [git-rev] + - Opens the current file page in GitHub. Providing an optional [git-rev] will override the + current branch/rev. ============================================================================== 4. USAGE *openingh-usage* @@ -47,6 +48,10 @@ CONTENTS *openingh* -- for current file page vim.api.nvim_set_keymap("n", "gf", ":OpenInGHFile ", { expr = true, noremap = true }) + To copy the URL into a register set + `vim.g.openingh_copy_to_register = true` + `OpenInGHFile a` should place the URL into register `a` + ============================================================================== 5. LICENSE *openingh-license* diff --git a/lua/openingh/init.lua b/lua/openingh/init.lua index c8b0253..6ba2b70 100644 --- a/lua/openingh/init.lua +++ b/lua/openingh/init.lua @@ -22,7 +22,7 @@ function M.setup() M.repo_url = string.format("http://%s/%s/%s", gh.host, gh.user_or_org, gh.reponame) end -M.priority = { BRANCH = 1, COMMIT = 2, } +M.priority = { BRANCH = 1, COMMIT = 2 } local function get_current_branch_or_commit_with_priority(priority) if priority == M.priority.BRANCH then @@ -37,6 +37,8 @@ end function M.get_file_url( priority, --[[optional]] + branch, + --[[optional]] range_start, --[[optional]] range_end @@ -56,8 +58,12 @@ function M.get_file_url( return end + local rev = get_current_branch_or_commit_with_priority(priority) + if branch ~= nil then + rev = branch + end - local file_page_url = M.repo_url .. "/blob/" .. get_current_branch_or_commit_with_priority(priority) .. file_path + local file_page_url = M.repo_url .. "/blob/" .. rev .. file_path if range_start and not range_end then file_page_url = file_page_url .. "#L" .. range_start diff --git a/plugin/openingh.lua b/plugin/openingh.lua index 783d64b..d5978ac 100644 --- a/plugin/openingh.lua +++ b/plugin/openingh.lua @@ -17,10 +17,11 @@ end vim.api.nvim_create_user_command("OpenInGHFile", function(opts) local url + local branch = opts.fargs[1] if opts.range == 0 then -- Nothing was selected - url = openingh.get_file_url(judge_priority(opts.bang)) - else -- Current line or block was selected - url = openingh.get_file_url(judge_priority(opts.bang), opts.line1, opts.line2) + url = openingh.get_file_url(judge_priority(opts.bang), branch) + else -- Current line or block was selected + url = openingh.get_file_url(judge_priority(opts.bang), branch, opts.line1, opts.line2) end if opts.reg == "" then @@ -30,18 +31,20 @@ vim.api.nvim_create_user_command("OpenInGHFile", function(opts) print("URL put into register " .. opts.reg) end end, { - register = true, + register = vim.g.openingh_copy_to_register, range = true, bang = true, + nargs = "*", }) vim.api.nvim_create_user_command("OpenInGHFileLines", function(opts) local url + local branch = opts.fargs[1] if opts.range == 0 then -- Nothing was selected - url = openingh.get_file_url(judge_priority(opts.bang), opts.line1) - else -- Current line or block was selected - url = openingh.get_file_url(judge_priority(opts.bang), opts.line1, opts.line2) + url = openingh.get_file_url(judge_priority(opts.bang), branch, opts.line1) + else -- Current line or block was selected + url = openingh.get_file_url(judge_priority(opts.bang), branch, opts.line1, opts.line2) end if opts.reg == "" then @@ -51,9 +54,10 @@ vim.api.nvim_create_user_command("OpenInGHFileLines", function(opts) print("URL put into register " .. opts.reg) end end, { - register = true, + register = vim.g.openingh_copy_to_register, range = true, bang = true, + nargs = "*", }) vim.api.nvim_create_user_command("OpenInGHRepo", function(opts) @@ -66,6 +70,6 @@ vim.api.nvim_create_user_command("OpenInGHRepo", function(opts) print("URL put into register " .. opts.reg) end end, { - register = true, + register = vim.g.openingh_copy_to_register, bang = true, }) diff --git a/tests/utils_spec.lua b/tests/utils_spec.lua index b3377b9..acb1acc 100644 --- a/tests/utils_spec.lua +++ b/tests/utils_spec.lua @@ -40,11 +40,14 @@ describe("encode_uri_component", function() input = input .. string.char(i) end local output = utils.encode_uri_component(input) - assert.is.Equal("%00%01%02%03%04%05%06%07%08%09%0A%0B%0C%0D%0E%0F%10%11%12%13%14%15%16%17%18%19%1A%1B%1C%1D%1E%1F%20%21%22%23%24%25%26%27%28%29%2A%2B%2C-.%2F0123456789%3A%3B%3C%3D%3E%3F%40ABCDEFGHIJKLMNOPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D~%7F", output) + assert.is.Equal( + "%00%01%02%03%04%05%06%07%08%09%0A%0B%0C%0D%0E%0F%10%11%12%13%14%15%16%17%18%19%1A%1B%1C%1D%1E%1F%20%21%22%23%24%25%26%27%28%29%2A%2B%2C-.%2F0123456789%3A%3B%3C%3D%3E%3F%40ABCDEFGHIJKLMNOPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D~%7F", + output + ) end) it("returns encoded string for a non-ascii string input (UTF-8)", function() - local input = "ほげ" -- UTF-8 bytewise representation is "e3 81 bb e3 81 92" + local input = "ほげ" -- UTF-8 bytewise representation is "e3 81 bb e3 81 92" local output = utils.encode_uri_component(input) assert.is.Equal("%E3%81%BB%E3%81%92", output) end) From 935009f81b3190d7b1baf4905f249019e7419553 Mon Sep 17 00:00:00 2001 From: Sathvik Birudavolu <8377116+BSathvik@users.noreply.github.com> Date: Fri, 29 Dec 2023 18:13:07 -0600 Subject: [PATCH 2/2] rm format --- tests/utils_spec.lua | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/tests/utils_spec.lua b/tests/utils_spec.lua index acb1acc..b3377b9 100644 --- a/tests/utils_spec.lua +++ b/tests/utils_spec.lua @@ -40,14 +40,11 @@ describe("encode_uri_component", function() input = input .. string.char(i) end local output = utils.encode_uri_component(input) - assert.is.Equal( - "%00%01%02%03%04%05%06%07%08%09%0A%0B%0C%0D%0E%0F%10%11%12%13%14%15%16%17%18%19%1A%1B%1C%1D%1E%1F%20%21%22%23%24%25%26%27%28%29%2A%2B%2C-.%2F0123456789%3A%3B%3C%3D%3E%3F%40ABCDEFGHIJKLMNOPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D~%7F", - output - ) + assert.is.Equal("%00%01%02%03%04%05%06%07%08%09%0A%0B%0C%0D%0E%0F%10%11%12%13%14%15%16%17%18%19%1A%1B%1C%1D%1E%1F%20%21%22%23%24%25%26%27%28%29%2A%2B%2C-.%2F0123456789%3A%3B%3C%3D%3E%3F%40ABCDEFGHIJKLMNOPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D~%7F", output) end) it("returns encoded string for a non-ascii string input (UTF-8)", function() - local input = "ほげ" -- UTF-8 bytewise representation is "e3 81 bb e3 81 92" + local input = "ほげ" -- UTF-8 bytewise representation is "e3 81 bb e3 81 92" local output = utils.encode_uri_component(input) assert.is.Equal("%E3%81%BB%E3%81%92", output) end)