Merge pull request #13 from LintaoAmons/dev

Refactor utils and enhance error msg

Author: LintaoAmons

lua/easy-commands/_types.lua

@@ -8,9 +8,6 @@ local M = {}
 ---@field allow_visual_mode? boolean
 ---@field errorInfo? string
 
----@type EasyCommand.Command
-M.Command = {}
-
 ---@param t table
 ---@return boolean
 function M.isCommand(t)

lua/easy-commands/config.lua

@@ -1,160 +1,167 @@
 local default_config = {
-	disabledCommands = {},
-	["RunCurrentLineAndOutputWithPrePostFix"] = {
-		prefix = "```bash",
-		postfix = "```",
-	},
-	---@type EasyCommand.Command[]
-	myCommands = { {
-		name = "EasyCommand",
-		callback = 'lua vim.print("easy command user command")',
-	} },
-	aliases = {
-		{
-			from = "GitListCommits",
-			to = "GitLog",
-		},
-	},
-	-- TODO: commandSpecificConfig
-	commandSpecificConfig = {
-		["CommandName"] = {},
-	},
+  disabledCommands = {},
+  ["RunCurrentLineAndOutputWithPrePostFix"] = {
+    prefix = "```bash",
+    postfix = "```",
+  },
+  ---@type EasyCommand.Command[]
+  myCommands = {
+    {
+      name = "EasyCommand",
+      callback = 'lua vim.print("easy command user command")',
+    },
+  },
+  aliases = {
+    {
+      from = "GitListCommits",
+      to = "GitLog",
+    },
+  },
+  -- TODO: commandSpecificConfig
+  commandSpecificConfig = {
+    ["CommandName"] = {},
+  },
 }
 
 local Config = {}
 Config.config = default_config
 
 ---@param msg string
 local function notifyErr(msg)
-	vim.notify("easy-comands: \n" .. msg, vim.log.levels.ERROR, { title = "easy-commands.nvim" })
+  vim.notify("easy-comands.nvim: \n" .. msg, vim.log.levels.ERROR, { title = "easy-commands.nvim" })
 end
 
 ---@param cmd EasyCommand.Command
+---@param err any | nil
 ---@return string
-local function formErrorMsg(cmd)
-	local msg = "Something went wrong when calling [" .. cmd.name .. "]\n"
-	if cmd.dependencies then
-		msg = msg .. "Please check dependencies firstly" .. "\n"
-		for _, d in ipairs(cmd.dependencies) do
-			msg = msg .. "    - " .. d .. "\n"
-		end
-	end
-	msg = msg .. "Run [InspectCommand " .. cmd.name .. "] to find the path of implemented and investgate more\n"
-	msg = msg .. "Or raise a issue in https://github.com/LintaoAmons/easy-commands.nvim/issues"
-	if cmd.errorInfo then
-		msg = msg + "Here more info you can check: \n" .. "    " .. "cmd.errorInfo"
-	end
-	return msg
+local function formErrorMsg(cmd, err)
+  local msg = "Something went wrong when calling [" .. cmd.name .. "]\n"
+  if cmd.dependencies then
+    msg = msg .. "\nPlease check dependencies firstly" .. "\n"
+    for _, d in ipairs(cmd.dependencies) do
+      msg = msg .. "    - " .. d .. "\n"
+    end
+  end
+  msg = msg .. "\nRun `:InspectCommand " .. cmd.name .. "` to investgate the implementation \n"
+  msg = msg .. "Or raise a issue in https://github.com/LintaoAmons/easy-commands.nvim/issues\n"
+  msg = msg .. "\nError: \n" .. err
+
+  if cmd.errorInfo then
+    msg = msg + "Here more info you can check: \n" .. "    " .. cmd.errorInfo
+  end
+  msg = string.gsub(msg, "^I", "  ")
+  return msg
 end
 
 ---@param cmd EasyCommand.Command
 local function safeCallWithErrMsg(cmd)
-	return function()
-		local ok
-		local callback = cmd.callback
-		if type(callback) == "string" then
-			---@cast callback string
-			ok, _ = pcall(function()
-				vim.cmd(callback)
-			end)
-		else
-			---@cast callback fun():nil
-			ok, _ = pcall(callback)
-		end
-
-		if not ok then
-			notifyErr(formErrorMsg(cmd))
-		end
-	end
+  return function()
+    local ok
+    local err
+    local callback = cmd.callback
+    if type(callback) == "string" then
+      ---@cast callback string
+      ok, err = pcall(function()
+        vim.cmd(callback)
+      end)
+    else
+      ---@cast callback fun():nil
+      ok, err = pcall(callback)
+    end
+
+    if not ok then
+      notifyErr(formErrorMsg(cmd, err))
+    end
+  end
 end
 
 ---@param implementation? EasyCommand.Command  -- The implementation of the user command.
 ---@param commandName string  -- The name of the user command to be registered.
 local function registerUserCommand(implementation, commandName)
-	if not implementation then
-		vim.api.nvim_create_user_command(commandName, function()
-			notifyErr(commandName .. " not implemented yet")
-		end, {})
-		return
-	end
-
-	if not require("easy-commands._types").isCommand(implementation) then
-		vim.api.nvim_create_user_command(commandName, function()
-			notifyErr(commandName .. " not properly implemented")
-		end, {})
-		return
-	end
-
-	---@cast implementation EasyCommand.Command
-	-- TODO: check dependencies and show alart or show dependency when user call command failed
-	if implementation.allow_visual_mode then
-		-- https://github.com/ray-x/go.nvim/blob/711b3b84cf59d3c43a9d1b02fdf12152b397e7b1/lua/go/commands.lua#LL443C7-L443C20
-		vim.api.nvim_create_user_command(
-			commandName,
-			safeCallWithErrMsg(implementation),
-			{ range = true, desc = implementation.description }
-		)
-		return
-	end
-
-	vim.api.nvim_create_user_command(
-		commandName,
-		safeCallWithErrMsg(implementation),
-		{ desc = implementation.description }
-	)
+  if not implementation then
+    vim.api.nvim_create_user_command(commandName, function()
+      notifyErr(commandName .. " not implemented yet")
+    end, {})
+    return
+  end
+
+  if not require("easy-commands._types").isCommand(implementation) then
+    vim.api.nvim_create_user_command(commandName, function()
+      notifyErr(commandName .. " not properly implemented")
+    end, {})
+    return
+  end
+
+  ---@cast implementation EasyCommand.Command
+  -- TODO: check dependencies and show alart or show dependency when user call command failed
+  if implementation.allow_visual_mode then
+    -- https://github.com/ray-x/go.nvim/blob/711b3b84cf59d3c43a9d1b02fdf12152b397e7b1/lua/go/commands.lua#LL443C7-L443C20
+    vim.api.nvim_create_user_command(
+      commandName,
+      safeCallWithErrMsg(implementation),
+      { range = true, desc = implementation.description }
+    )
+    return
+  end
+
+  vim.api.nvim_create_user_command(
+    commandName,
+    safeCallWithErrMsg(implementation),
+    { desc = implementation.description }
+  )
 end
 
 local function registerUserCustomCommand()
-	for _, c in pairs(Config.getConfig().myCommands) do
-		registerUserCommand(c, c.name)
-	end
+  for _, c in pairs(Config.getConfig().myCommands) do
+    registerUserCommand(c, c.name)
+  end
 end
 
 ---@return {[string]: EasyCommand.Command}
 local function buildCommandMap()
-	---@type EasyCommand.Command[]
-	local commands = require("easy-commands.impl")
-	local map = {}
-	for _, c in ipairs(commands) do
-		map[c.name] = c
-	end
-	return map
+  ---@type EasyCommand.Command[]
+  local commands = require("easy-commands.impl")
+  local map = {}
+  for _, c in ipairs(commands) do
+    map[c.name] = c
+  end
+  return map
 end
 
 local function registerUserCommands(commandNames)
-	local commandsMap = buildCommandMap()
-	for _, command in pairs(commandNames) do
-		local implementation = commandsMap[command]
-		registerUserCommand(implementation, command)
-	end
+  local commandsMap = buildCommandMap()
+  for _, command in pairs(commandNames) do
+    local implementation = commandsMap[command]
+    registerUserCommand(implementation, command)
+  end
 end
 
 ---@param aliases {from: "string", to: "string"}[]
 local function registerAliases(aliases)
-	for _, alias in ipairs(aliases) do
-		vim.api.nvim_create_user_command(alias.to, alias.from, {})
-	end
+  for _, alias in ipairs(aliases) do
+    vim.api.nvim_create_user_command(alias.to, alias.from, {})
+  end
 end
 
 ---@param user_config? table
 Config.setup = function(user_config)
-	Config.config = vim.tbl_deep_extend("force", default_config, user_config or {})
+  Config.config = vim.tbl_deep_extend("force", default_config, user_config or {})
 
-	local commands_name = require("easy-commands.names")
-	local inuse_commands = require("easy-commands.impl.util.base.table").getDifferenceSet(
-		commands_name,
-		Config.getConfig().disabledCommands
-	)
+  local commands_name = require("easy-commands.names")
+  local inuse_commands = require("easy-commands.impl.util.base.table").getDifferenceSet(
+    commands_name,
+    Config.getConfig().disabledCommands
+  )
 
-	registerUserCommands(inuse_commands)
+  registerUserCommands(inuse_commands)
 
-	registerUserCustomCommand()
+  registerUserCustomCommand()
 
-	registerAliases(Config.config.aliases)
+  registerAliases(Config.config.aliases)
 end
 
 Config.getConfig = function()
-	return Config.config
+  return Config.config
 end
 
 return Config

lua/easy-commands/impl/lang/go.lua

@@ -13,7 +13,7 @@ M.GoToTestFile = function()
 	end
 
 	if vim.fn.filereadable(jump_to_file) == 0 then
-		require("easy-commands.impl.util.base.fs").createFile(jump_to_file)
+		require("easy-commands.impl.util.base.fs").create_file(jump_to_file)
 	end
 
 	vim.cmd("e " .. jump_to_file)

lua/easy-commands/impl/navigation.lua

@@ -108,7 +108,12 @@ local M = {
 
   {
     name = "MaximiseWindow",
-    callback = require("easy-commands.impl.util.editor").close_all_other_windows,
+    callback = function()
+      require("easy-commands.impl.util.editor").window.close_all_other_windows({
+        "filesystem", -- neo-tree
+        "Trouble",
+      })
+    end,
   },
   {
     name = "MaximiseWindowAsPopup",