feat: add open_cmd options

README.md

@@ -30,30 +30,26 @@ that already exist in gitlinker! See [callbacks](#callbacks)
 
 ## Installation
 
-Install it like any other vim plugin, just make sure
-[plenary.nvim](https://github.com/nvim-lua/plenary.nvim) is also installed.
+Install it like any other vim plugin.
 
 - [packer.nvim](https://github.com/wbthomason/packer.nvim)
 
 ``` lua
 use {
     'ruifm/gitlinker.nvim',
-    requires = 'nvim-lua/plenary.nvim',
 }
 ```
 
 - [vim-plug](https://github.com/junegunn/vim-plug)
 
 ``` vim
-Plug 'nvim-lua/plenary.nvim'
 Plug 'ruifm/gitlinker.nvim'
 ```
 
 ### Requirements
 
 - git
-- neovim 0.5
-- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
+- neovim 0.8
 
 ## Usage
 
@@ -126,6 +122,8 @@ require"gitlinker".setup({
     action_callback = require"gitlinker.actions".copy_to_clipboard,
     -- print the url after performing the action
     print_url = true,
+    -- os-specific command to open url, default to Unix: `xdg-open`, Mac: `open`, Windows: `explorer`
+    open_cmd = '',
   },
   callbacks = {
         ["github.com"] = require"gitlinker.hosts".get_github_type_url,
@@ -140,7 +138,8 @@ require"gitlinker".setup({
         ["git.kernel.org"] = require"gitlinker.hosts".get_cgit_type_url,
         ["git.savannah.gnu.org"] = require"gitlinker.hosts".get_cgit_type_url
   },
--- default mapping to call url generation with action_callback
+  -- default mapping to call url generation with action_callback
+  -- to disable the default mappings, set it to empty string
   mappings = "<leader>gy"
 })
 ```
@@ -239,7 +238,11 @@ default set to `require"gitlinker.actions".copy_to_clipboard` which copies to
 generated url to your system clipboard.
 
 An alternative callback `require"gitlinker.actions".open_in_browser` is provided
-which opens the url in your preferred browser using `xdg-open` (linux only).
+which opens the url in your preferred browser using os-specific command:
+
+- Unix: `xdg-open`
+- Mac: `open`
+- Windows: `explorer`
 
 You can define your own action callback.
 

doc/gitlinker.txt

@@ -30,22 +30,19 @@ Supported git web hosts                                   *gitlinker-supported*
 ==============================================================================
 Installation                                           *gitlinker-installation*
 
-Install it like any other vim plugin, just make sure plenary.nvim is also
-installed.
+Install it like any other vim plugin.
 
 * packer.nvim
 
 >
   use {
       'ruifm/gitlinker.nvim',
-      requires = 'nvim-lua/plenary.nvim',
   }
 <
 
 * vim-plug
 
 >
-Plug 'nvim-lua/plenary.nvim'
 Plug 'ruifm/gitlinker.nvim'
 <
 
@@ -124,8 +121,8 @@ Here’s all the options with their defaults:
       action_callback = require"gitlinker.actions".copy_to_clipboard,
       -- print the url after performing the action
       print_url = true,
-      -- mapping to call url generation
-      mappings = "<leader>gy"
+      -- os-specific command to open url, default to Unix: `xdg-open`, Mac: `open`, Windows: `explorer`
+      open_cmd = '',
     },
     callbacks = {
           ["github.com"] = require"gitlinker.hosts".get_github_type_url,
@@ -140,6 +137,9 @@ Here’s all the options with their defaults:
           ["git.kernel.org"] = require"gitlinker.hosts"get_cgit_type_url,
           ["git.savannah.gnu.org"] = require"gitlinker.hosts"get_cgit_type_url
     }
+    -- default mapping to call url generation with action_callback
+    -- to disable the default mappings, set it to empty string
+    mappings = "<leader>gy"
   })
 <
 

lua/gitlinker.lua

@@ -71,15 +71,14 @@ local function get_buf_range_url_data(mode, user_opts)
     return nil
   end
 
-  local buf_path = buffer.get_relative_path()
   if
-    git.has_file_changed(buf_path, rev)
+    git.has_file_changed(buf_repo_path , rev)
     and (mode == "v" or user_opts.add_current_line_on_normal_mode)
   then
     vim.notify(
       string.format(
         "Computed Line numbers are probably wrong because '%s' has changes",
-        buf_path
+        buf_repo_path
       ),
       vim.log.levels.WARN
     )

lua/gitlinker/actions.lua

@@ -1,7 +1,7 @@
 local M = {}
 
 local api = vim.api
-local job = require("plenary.job")
+local fn = vim.fn
 
 --- copies the url to clipboard
 --
@@ -12,12 +12,12 @@ end
 
 --- opens the url in your default browser
 --
--- Uses xdg-open
 -- @param url the url string
 function M.open_in_browser(url)
-  local command = vim.loop.os_uname().sysname == "Darwin" and "open"
-    or "xdg-open"
-  job:new({ command = command, args = { url } }):start()
+  fn.jobstart(
+    { require("gitlinker.opts").get().open_cmd, url },
+    { detach = true }
+  )
 end
 
 return M

lua/gitlinker/buffer.lua

@@ -1,10 +1,12 @@
 local M = {}
 
 local api = vim.api
-local path = require("plenary.path")
 
 function M.get_relative_path(cwd)
-  return path:new(api.nvim_buf_get_name(0)):make_relative(cwd)
+  return vim.fn.fnamemodify(
+    vim.fs.normalize(api.nvim_buf_get_name(0)),
+    ":s?" .. cwd .. "/" .. "??"
+  )
 end
 
 function M.get_curr_line()

lua/gitlinker/git.lua

@@ -1,20 +1,19 @@
 local M = {}
-
-local job = require("plenary.job")
-local path = require("plenary.path")
+local fn = vim.fn
 
 -- wrap the git command to do the right thing always
 local function git(args, cwd)
   local output
-  local p = job:new({
-    command = "git",
-    args = args,
+  -- output = fn.systemlist(vim.list_extend({ "git" }, args))
+  fn.jobstart(vim.list_extend({ "git" }, args), {
     cwd = cwd or M.get_git_root(),
+    on_stdout = function(_, data, _)
+      output = data
+    end,
   })
-  p:after_success(function(j)
-    output = j:result()
-  end)
-  p:sync()
+  vim.wait(200, function()
+    return output ~= nil
+  end, 20)
   return output or {}
 end
 
@@ -43,7 +42,8 @@ function M.is_file_in_rev(file, revspec)
 end
 
 function M.has_file_changed(file, rev)
-  if git({ "diff", rev, "--", file })[1] then
+  local output = git({ "diff", rev, "--", file })[1]
+  if output and output ~= "" then
     return true
   end
   return false
@@ -229,7 +229,7 @@ end
 function M.get_git_root()
   return git(
     { "rev-parse", "--show-toplevel" },
-    tostring(path:new(vim.api.nvim_buf_get_name(0)):parent())
+    vim.fs.dirname(vim.api.nvim_buf_get_name(0))
   )[1]
 end
 
@@ -248,9 +248,8 @@ function M.get_branch_remote()
     return nil
   end
 
-  local remote_from_upstream_branch = upstream_branch:match(
-    "^(" .. allowed_chars .. ")%/"
-  )
+  local remote_from_upstream_branch =
+    upstream_branch:match("^(" .. allowed_chars .. ")%/")
   if not remote_from_upstream_branch then
     error(
       string.format(

lua/gitlinker/mappings.lua

@@ -18,6 +18,9 @@ end
 
 function M.set(mappings)
   mappings = mappings or "<leader>gy"
+  if mappings == '' then
+    return
+  end
   set_keymap("n", mappings)
   set_keymap("v", mappings, { silent = false })
 end

lua/gitlinker/opts.lua

@@ -1,10 +1,18 @@
 local M = {}
 
+local os, open_cmd = jit.os, "xdg-open"
+if os == "Darwin" then
+  open_cmd = "open"
+elseif os == "Windows" then
+  open_cmd = "explorer"
+end
+
 local defaults = {
   remote = "origin", -- force the use of a specific remote
   add_current_line_on_normal_mode = true, -- if true adds the line nr in the url for normal mode
   action_callback = require("gitlinker.actions").copy_to_clipboard, -- callback for what to do with the url
   print_url = true, -- print the url after action
+  open_cmd = open_cmd -- os-specific command to open url
 }
 
 local opts

test/minimal_init.lua

@@ -18,7 +18,6 @@ require("packer").startup(
       use 'wbthomason/packer.nvim'
       use {
           'ruifm/gitlinker.nvim',
-          requires = 'nvim-lua/plenary.nvim',
       }
     end,
     config = {package_root = '/tmp/nvim/site/pack'}