Merge pull request #25 from fedepujol/feature/config

Feature/config

Author: fedepujol

README.md

@@ -20,39 +20,68 @@ Gain the power to move lines and blocks!
 
 ## :zap: Requirements
 
-This plugin works with NeoVim v0.5 or later.
+This plugin works with Neovim v0.5 or later.
 
 ## :package: Installation
 
-- [packer.nvim](https://github.com/wbthomason/packer.nvim)
+- [lazy](https://github.com/folke/lazy.nvim)
 
 ```lua
-use 'fedepujol/move.nvim'
+{ 
+    'fedepujol/move.nvim',
+    opts = {
+        --- Config
+    }
+}
 ```
 
-- [vim-plug](https://github.com/junegunn/vim-plug)
+- [paq](https://github.com/savq/paq-nvim)
 
-```vim
-Plug 'fedepujol/move.nvim'
+```lua
+'fedepujol/move.nvim';
 ```
 
-- [paq](https://github.com/savq/paq-nvim)
+## :cog: Configuration
+You can use the default's (leaving the setup function empty)
+```lua
+require('move').setup({})
 
+```
+
+or customizing it
 ```lua
-'fedepujol/move.nvim';
+require('move').setup({
+	line = {
+		enable = true, -- Enables line movement
+		indent = true  -- Toggles indentation
+	},
+	block = {
+		enable = true, -- Enables block movement
+		indent = true  -- Toggles indentation
+	},
+	word = {
+		enable = true, -- Enables word movement
+	},
+	char = {
+		enable = false -- Enables char movement
+	}
+})
+
 ```
+:information_source: By default, every option is enabled except char movement.
+:warning: Disabling line/block/word/char movements, will not generate the commands.
 
 ## :rocket: Usage
 
 The plugin provides the following commands:
 
-| Command    | Description                                           | Mode   |
-| ---------- | ----------------------------------------------------- | ------ |
-| MoveLine   | Moves a line up or down                               | Normal |
-| MoveHChar  | Moves the character under the cursor, left or right   | Normal |
-| MoveWord   | Moves the word under the cursor forwards or backwards | Normal |
-| MoveBlock  | Moves a selected block of text, up or down            | Visual |
-| MoveHBlock | Moves a visual area, left or right                    | Visual |
+| Command    | Description                                               | Mode   |
+| ---------- | --------------------------------------------------------- | ------ |
+| MoveLine   | Moves a line up or down                                   | Normal |
+| MoveHChar  | Moves the character under the cursor, left or right       | Normal |
+| MoveWord   | Transpose the word under the cursor forwards or backwards | Normal |
+| MoveBlock  | Moves a selected block of text, up or down                | Visual |
+| MoveHBlock | Moves a visual area, left or right                        | Visual |
 
 ## :keyboard: Mappings
 

lua/move.lua

@@ -0,0 +1,12 @@
+local Config = require('move.config')
+local commands = require('move.commands')
+
+local M = {}
+
+M.setup = function(config)
+	Config.apply(config)
+
+	commands.create_user_commands(Config.default_config)
+end
+
+return M

lua/move/commands.lua

@@ -0,0 +1,57 @@
+local move_vert = require('move.core.vert')
+local move_hor = require('move.core.horiz')
+
+local M = {}
+
+---Creates User defined commands
+---@param cfg MoveConfig
+M.create_user_commands = function(cfg)
+	-- Line Command
+	if cfg.line.enable then
+		vim.api.nvim_create_user_command("MoveLine",
+			function(args)
+				local dir = tonumber(args.args:gsub("[()]", ""), 10)
+				move_vert.moveLine(dir, cfg.line.indent)
+			end, { desc = "Move cursor line", force = true, nargs = 1 }
+		)
+	end
+
+	-- Block Command
+	if cfg.block.enable then
+		vim.api.nvim_create_user_command("MoveBlock",
+			function(args)
+				local dir = tonumber(args.args:gsub("[()]", ""), 10)
+				move_vert.moveBlock(dir, args.line1, args.line2, cfg.block.indent)
+			end, { desc = "Move visual block", force = true, nargs = 1, range = "%" }
+		)
+	end
+
+	-- Word Command
+	if cfg.word.enable then
+		vim.api.nvim_create_user_command('MoveWord',
+			function(args)
+				local dir = tonumber(args.args:gsub("[()]", ""), 10)
+				move_hor.horzWord(dir)
+			end, { desc = "Move word forwards or backwards", force = true, nargs = 1 }
+		)
+	end
+
+	-- Character Commands
+	if cfg.char.enable then
+		vim.api.nvim_create_user_command('MoveHChar',
+			function(args)
+				local dir = tonumber(args.args:gsub("[()]", ""), 10)
+				move_hor.horzChar(dir)
+			end, { desc = "Move the character under the cursor horizontally", force = true, nargs = 1 }
+		)
+
+		vim.api.nvim_create_user_command('MoveHBlock',
+			function(args)
+				local dir = tonumber(args.args:gsub("[()]", ""), 10)
+				move_hor.horzBlock(dir)
+			end, { desc = "Move visual block horizontally", force = true, nargs = 1, range = "%" }
+		)
+	end
+end
+
+return M

lua/move/config.lua

@@ -0,0 +1,53 @@
+---@class MWordConfig
+---@field enable boolean
+
+---@class MLineConfig
+---@field enable boolean
+---@field indent boolean
+
+---@class MBlockConfig
+---@field enable boolean
+---@field indent boolean
+
+---@class MCharConfig
+---@field enable boolean
+
+---@class MoveConfig
+---@field line MLineConfig
+---@field block MBlockConfig
+---@field word MWordConfig
+---@field char MCharConfig
+
+local M = {}
+
+---@class MoveConfig
+local default_config = {
+	line = {
+		enable = true,
+		indent = true
+	},
+	block = {
+		enable = true,
+		indent = true
+	},
+	word = {
+		enable = true,
+	},
+	char = {
+		enable = false
+	}
+}
+
+---@type MoveConfig
+M.default_config = setmetatable({}, {
+	__index = function(_, k)
+		return default_config[k]
+	end
+})
+
+---@param config MoveConfig
+M.apply = function(config)
+	default_config = vim.tbl_deep_extend('force', default_config, config or {})
+end
+
+return M

lua/move/core/vert.lua

@@ -7,7 +7,8 @@ M.foldLastLine = -1
 
 ---Moves up or down the current cursor-line, mantaining the cursor over the line.
 ---@param dir number Movement direction. One of -1, 1.
-M.moveLine = function(dir)
+---@param indent boolean Enable auto-indent
+M.moveLine = function(dir, indent)
 	-- Get the last line of current buffer
 	local last_line = vim.fn.line('$')
 
@@ -38,15 +39,19 @@ M.moveLine = function(dir)
 
 		local amount = utils.calc_indent(target + dir, dir)
 		utils.swap_line(line, target + dir)
-		utils.indent(amount, target + dir)
+
+		if indent then
+			utils.indent(amount, target + dir)
+		end
 	end
 end
 
 ---Moves up or down a visual area mantaining the selection.
 ---@param dir number Movement direction. One of -1, 1.
 ---@param line1 number Initial line of the selected area.
 ---@param line2 number End line of the selected area.
-M.moveBlock = function(dir, line1, line2)
+---@param indent boolean Enable auto-indent
+M.moveBlock = function(dir, line1, line2, indent)
 	local vSRow = line1 or vim.fn.line('v')
 	local vERow = line2 or vim.api.nvim_win_get_cursor(0)[1]
 	local last_line = vim.fn.line('$')
@@ -63,11 +68,11 @@ M.moveBlock = function(dir, line1, line2)
 
 	-- Edges
 	if vSRow == 0 and dir < 0 then
-		vim.api.nvim_exec(':normal! ' .. vSRow .. 'ggV' .. vERow .. 'gg', false)
+		vim.api.nvim_exec2(':normal! ' .. vSRow .. 'ggV' .. vERow .. 'gg', { output = false })
 		return
 	end
 	if vERow == last_line and dir > 0 then
-		vim.api.nvim_exec(':normal! ' .. (vSRow + 1) .. 'ggV' .. (vERow + dir) .. 'gg', false)
+		vim.api.nvim_exec2(':normal! ' .. (vSRow + 1) .. 'ggV' .. (vERow + dir) .. 'gg', { output = false })
 		return
 	end
 
@@ -90,7 +95,9 @@ M.moveBlock = function(dir, line1, line2)
 		vim.cmd(':normal! zx')
 	end
 
-	utils.indent_block(amount, (dir > 0 and vSRow + 2 or vSRow), vERow + dir)
+	if indent then
+		utils.indent_block(amount, (dir > 0 and vSRow + 2 or vSRow), vERow + dir)
+	end
 	utils.reselect_block(dir, vSRow, vERow)
 end
 

lua/move/init.lua

@@ -21,10 +21,10 @@ end
 ---@param vSRow number Start row of Visual area.
 ---@param vERow number End row of Visual area.
 M.reselect_block = function(dir, vSRow, vERow)
-	vim.api.nvim_exec(':normal! \\e\\e', false)
-	vim.api.nvim_exec(
+	vim.api.nvim_exec2(':normal! \\e\\e', { output = false })
+	vim.api.nvim_exec2(
 		':normal! ' .. (dir > 0 and vSRow + 2 or vSRow) .. 'ggV' .. (vERow + dir) .. 'gg',
-		false
+		{ output = false }
 	)
 end