feat: add support for lazy plugin manager

Author: arsham

README.md

@@ -8,6 +8,8 @@ add more mappings by providing keys to the config.
 
 1. [Requirements](#requirements)
 2. [Installation](#installation)
+   - [Lazy](#lazy)
+   - [Packer](#packer)
 3. [Mappings](#mappings)
    - [Empty Lines](#empty-lines)
    - [End of Lines](#end-of-lines)
@@ -34,7 +36,21 @@ as dependencies in your package manager:
 
 ## Installation
 
-Use your favourite package manager to install this library. Packer example:
+Use your favourite package manager to install this library.
+
+### Lazy
+
+```lua
+{
+	"arsham/archer.nvim",
+	dependencies = { "arsham/arshlib.nvim" },
+	config = true,
+  -- or to provide configuration
+  -- config = { mapping = false, ..}
+}
+```
+
+### Packer
 
 ```lua
 use({

lua/archer/init.lua

@@ -49,26 +49,27 @@ local defaults = { --{{{1
   },
 } --}}}
 
-local function config(opts) --{{{
-  opts = vim.tbl_deep_extend("force", defaults, opts)
+local function setup(opts) --{{{
+  opts = vim.tbl_deep_extend("force", defaults, opts or {})
   -- Validations {{{
   vim.validate({
-    opts = { opts, { "table", "boolean", "nil" }, false },
+    opts = { opts, { "table", "boolean" }, false },
     mappings = { opts.mappings, { "table", "boolean", "nil" }, false },
     textobj = { opts.textobj, { "table", "boolean", "nil" }, false },
   })
   -- }}}
 
   if opts.mappings then
-    require("archer.mappings").config(opts.mappings)
+    require("archer.mappings").setup(opts.mappings)
   end
   if opts.textobj then
-    require("archer.textobj").config(opts.textobj)
+    require("archer.textobj").setup(opts.textobj)
   end
 end --}}}
 
 return {
-  config = config,
+  setup = setup,
+  config = setup,
 }
 
 -- vim: fdm=marker fdl=1

lua/archer/mappings.lua

@@ -46,6 +46,7 @@ local last_key = ""
 function _G.add_to_line_end()
   change_line_ends(last_key, false)
 end
+-- selene: allow(global_usage)
 function _G.remove_from_line_end()
   change_line_ends(last_key, true)
 end
@@ -70,6 +71,7 @@ end --}}}
 function _G.empty_line_below()
   insert_empty_lines(vim.v.count, 0)
 end
+-- selene: allow(global_usage)
 function _G.empty_line_above()
   insert_empty_lines(vim.v.count, -1)
 end
@@ -170,9 +172,8 @@ local function augment_vim(opts)
   end
 end
 
-
--- stylua: ignore start
 local function config(opts) --{{{
+  -- stylua: ignore
   vim.validate({
     space    = { opts.space,  { "table", "boolean", "nil" }, true },
     ending   = { opts.ending, { "table", "boolean", "nil" }, true },
@@ -195,11 +196,10 @@ local function config(opts) --{{{
   if opts.augment_vim then --{{{
     augment_vim(opts.augment_vim)
   end --}}}
-
 end --}}}
--- stylua: ignore end
 
 return {
+  setup = config,
   config = config,
 }
 

lua/archer/textobj.lua

@@ -47,7 +47,7 @@ local function visual_number(around)
 end ---}}}
 
 -- stylua: ignore start
-local function config(opts)
+local function setup(opts)
   vim.validate({--{{{
     next_obj  = { opts.next_obj,  { "table",  "boolean", "nil" }, true },
     in_chars  = { opts.in_chars,  { "table",  "boolean", "nil" }, true },
@@ -160,7 +160,8 @@ end
 -- stylua: ignore end
 
 return {
-  config = config,
+  setup = setup,
+  config = setup,
 }
 
 -- vim: fdm=marker fdl=0