feat!: Make setup optional. (#296)

In this feature/version upgrade, we make `setup` optional by decoupling
initialization and configuration of `nvim-surround`. We leverage
(Neo)Vim's built-in runtimepath lazy loading to initialize the plugin,
defining the public API in the form of `<Plug>` maps. Configuration is
still done via `setup`. Please see `:h nvim-surround.migrating.v3_to_v4`
for details on how to update your configurations.

Author: kylechui

.github/workflows/integration.yml

@@ -37,4 +37,4 @@ jobs:
           git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ~/.local/share/nvim/site/pack/vendor/start/plenary.nvim
           ln -s $(pwd) ~/.local/share/nvim/site/pack/vendor/start
       - name: Run tests
-        run: nvim --headless --noplugin -c 'packadd plenary.nvim' -c "PlenaryBustedDirectory tests/ { minimal_init = 'tests/minimal_init.lua' }"
+        run: nvim --headless --noplugin -c 'packadd plenary.nvim' -c "PlenaryBustedDirectory tests/ { init = 'tests/minimal_init.lua' }"

README.md

@@ -31,38 +31,25 @@ Surround selections, stylishly :sunglasses:
 
 ## :package: Installation
 
-Install this plugin using your favorite plugin manager, and then call
-`require("nvim-surround").setup()`.
+Install this plugin using your favorite plugin manager, and that's it! See
+`:h nvim-surround.configuration` for how to configure the plugin.
 
 ### [lazy.nvim](https://github.com/folke/lazy.nvim)
 
 ```lua
 {
     "kylechui/nvim-surround",
-    version = "^3.0.0", -- Use for stability; omit to use `main` branch for the latest features
+    version = "^4.0.0", -- Use for stability; omit to use `main` branch for the latest features
     event = "VeryLazy",
-    config = function()
-        require("nvim-surround").setup({
-            -- Configuration here, or leave empty to use defaults
-        })
-    end
+    -- Optional: See `:h nvim-surround.configuration` and `:h nvim-surround.setup` for details
+    -- config = function()
+    --     require("nvim-surround").setup({
+    --         -- Put your configuration here
+    --     })
+    -- end
 }
 ```
 
-### [packer.nvim](https://github.com/wbthomason/packer.nvim)
-
-```lua
-use({
-    "kylechui/nvim-surround",
-    tag = "*", -- Use for stability; omit to use `main` branch for the latest features
-    config = function()
-        require("nvim-surround").setup({
-            -- Configuration here, or leave empty to use defaults
-        })
-    end
-})
-```
-
 ## :rocket: Usage
 
 The three "core" operations of `add`/`delete`/`change` can be done with the
@@ -82,9 +69,10 @@ respectively. For the following examples, `*` will denote the cursor position:
     delete(functi*on calls)     dsf             function calls
 ```
 
-Note that surrounding with an opening delimiter (e.g. `(`) will add a space before/after
-the selection, while surrounding with the closing delimiter (e.g. `)`) will not include
-the spaces. Detailed information on how to use this plugin can be found in
+Note that surrounding with an opening delimiter (e.g. `(`) will add a space
+before/after the selection, while surrounding with the closing delimiter (e.g.
+`)`) will not include the spaces. Detailed information on how to use this plugin
+can be found in
 [`:h nvim-surround.usage`](https://github.com/kylechui/nvim-surround/blob/main/doc/nvim-surround.txt).
 
 ## :gear: Configuration

doc/nvim-surround.txt

@@ -31,7 +31,6 @@
 ---@field change change_table
 
 ---@class options
----@field keymaps table<string, string>
 ---@field surrounds table<string, surround>
 ---@field aliases table<string, string|string[]>
 ---@field highlight { duration: integer }
@@ -54,7 +53,6 @@
 ---@field change? user_change
 
 ---@class user_options
----@field keymaps? table<string, false|string>
 ---@field surrounds? table<string, false|user_surround>
 ---@field aliases? table<string, false|string|string[]>
 ---@field highlight? { duration: false|integer }