Breaking change: Dont provide custom keybinding anymore, allow user to define own keybindings (#39)

Author: chrishrb

README.md

@@ -2,12 +2,14 @@
 
 ![ci](https://github.com/chrishrb/gx.nvim/actions/workflows/ci.yml/badge.svg)
 
+> ATTENTION: There was a breaking change in version v0.5.0. The keybinding `gx` must now be configured manually. See [Installation](#-installation)
+
 ## ✨ Features
 
 * open links without `netrw`
 * normal and visual mode support
 * links with/without an explicit protocol (e.g. `google.com` will open `https://google.com`)
-* open plugins in the browser with a single command (e.g. in lazy, packer you can hover over a plugin name, simply press `gx` and you get to the github page of the plugin)
+* open plugins in the browser with a single command (e.g. in lazy, packer you can hover over a plugin name, simply press `gx` or execute command `Browse` and you get to the github page of the plugin)
 * open github issues directly in the browser (e.g. `Fixes #22` opens `https://github.com/chrishrb/gx.nvim/issues/22`)
 * dependencies from `package.json` (e.g. line `"express": "^4.18.2",` in the `package.json` opens `https://www.npmjs.com/package/express`)
 * formulae and casks from `Brewfile` (e.g. line `brew "neovim"` in the `Brewfile` opens `https://formulae.brew.sh/formula/neovim`)
@@ -29,7 +31,7 @@
 require("lazy").setup({
   {
     "chrishrb/gx.nvim",
-    keys = { {"gx", mode = { "n", "x" }} },
+    keys = { { "gx", "<cmd>Browse<cr>", mode = { "n", "x" }} },
     cmd = { "Browse" },
     init = function ()
       vim.g.netrw_nogx = 1 -- disable netrw gx
@@ -57,10 +59,10 @@ require("lazy").setup({
 })
 ```
 
-## ⌨️ Mappings and Commands
+## 📡 Commands
 
-* `gx` is overridden by default
 * `Browse <URL or WORDS>`, e.g. `Browse http://google.de`, `Browse example`
+* OR hover/select words, links and more and execute command `Browse`
 
 ## 🚀 Usage
 

lua/gx/handlers/search.lua

@@ -10,7 +10,7 @@ local M = {
 function M.handle(mode, line, handler_options)
   local search_pattern
 
-  if mode == "v" then
+  if mode == "v" or mode == "c" then
     search_pattern = line
   else
     search_pattern = vim.fn.expand("<cword>")

lua/gx/init.lua

@@ -4,8 +4,16 @@ local sysname = vim.loop.os_uname().sysname
 
 local M = {}
 
-function M.browse(mode, line)
-  -- search for url
+-- search for url with handler
+function M.open(mode, line)
+  if not line then
+    line = vim.api.nvim_get_current_line()
+    mode = vim.api.nvim_get_mode().mode
+  end
+
+  -- cut if in visual mode
+  line = helper.cut_with_visual_mode(mode, line)
+
   local url =
     require("gx.handler").get_url(mode, line, M.options.handlers, M.options.handler_options)
 
@@ -20,17 +28,6 @@ function M.browse(mode, line)
   )
 end
 
--- search for url with handler
-local function open()
-  local line = vim.api.nvim_get_current_line()
-  local mode = vim.api.nvim_get_mode().mode
-
-  -- cut if in visual mode
-  line = helper.cut_with_visual_mode(mode, line)
-
-  return M.browse(mode, line)
-end
-
 -- get the app for opening the webbrowser
 local function get_open_browser_app()
   local app
@@ -78,19 +75,28 @@ local function with_defaults(options)
   }
 end
 
-local function bind_keys()
-  vim.g.netrw_nogx = 1 -- disable netrw gx
-  local opts = { noremap = true, silent = true }
-  vim.keymap.set({ "n", "x" }, "gx", open, opts)
+local function bind_command()
+  vim.api.nvim_create_user_command("Browse", function(opts)
+    local fargs = opts.fargs[1]
+    if fargs then
+      M.open("c", fargs)
+      return
+    end
+
+    if opts.range == 2 then
+      local range = vim.fn.getline(opts.line1)
+      M.open("v", range)
+      return
+    end
+
+    M.open()
+  end, { nargs = "?", range = 1 })
 end
 
 -- setup function
 function M.setup(options)
   M.options = with_defaults(options)
-  bind_keys()
-  vim.api.nvim_create_user_command("Browse", function(opts)
-    M.browse("v", opts.fargs[1])
-  end, { nargs = 1 })
+  bind_command()
 end
 
 M.options = nil