feat: add plugin manager for testing

s1n7ax · s1n7ax · commit 1feb82e5576b · 2023-11-10T12:22:40.000+05:30
diff --git a/Makefile b/Makefile
@@ -1,11 +1,11 @@
-TESTS_INIT=tests/minimal_init.lua
+PREPARE_CONFIG=tests/prepare-config.lua
+TEST_CONFIG=tests/test-config.lua
 TESTS_DIR=tests/
 
 .PHONY: test
 
 test:
 	@nvim \
 		--headless \
-		--noplugin \
-		-u ${TESTS_INIT} \
-		-c "PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TESTS_INIT}' }"
+		-u ${PREPARE_CONFIG} \
+		"+PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TEST_CONFIG}' }"
diff --git a/dev/init.lua b/dev/init.lua
@@ -0,0 +1,42 @@
+local cwd = vim.fn.getcwd()
+vim.opt.runtimepath:prepend(cwd)
+
+--[[
+-- plugin name will be used to reload the loaded modules
+--]]
+local package_name = 'plugin_name'
+
+-- add the escape character to special characters
+local escape_pattern = function(text)
+	return text:gsub('([^%w])', '%%%1')
+end
+
+-- unload loaded modules by the matching text
+local unload_packages = function()
+	local esc_package_name = escape_pattern(package_name)
+
+	for module_name, _ in pairs(package.loaded) do
+		if string.find(module_name, esc_package_name) then
+			package.loaded[module_name] = nil
+		end
+	end
+end
+
+-- executes the run method in the package
+local run_action = function()
+	vim.cmd.messages('clear')
+
+	require(package_name).hello()
+end
+
+-- unload and run the function from the package
+function _G.Reload_and_run()
+	unload_packages()
+	run_action()
+end
+
+---@diagnostic disable-next-line: undefined-global
+local set_keymap = vim.api.nvim_set_keymap
+
+set_keymap('n', '<leader><leader>r', '<cmd>luafile dev/init.lua<cr>', {})
+set_keymap('n', '<leader><leader>w', '<cmd>lua Reload_and_run()<cr>', {})
diff --git a/lua/plugin_name.lua b/lua/plugin_name.lua
@@ -1,10 +1,10 @@
 -- main module file
-local module = require("plugin_name.module")
+local module = require('plugin_name.module')
 
 ---@class Config
 ---@field opt string Your config option
 local config = {
-  opt = "Hello!",
+	opt = 'Hello!',
 }
 
 ---@class MyModule
@@ -17,11 +17,11 @@ M.config = config
 -- you can define your setup function here. Usually configurations can be merged, accepting outside params and
 -- you can also put some validation here for those.
 M.setup = function(args)
-  M.config = vim.tbl_deep_extend("force", M.config, args or {})
+	M.config = vim.tbl_deep_extend('force', M.config, args or {})
 end
 
 M.hello = function()
-  module.my_first_function()
+	print(module.my_first_function())
 end
 
 return M
diff --git a/plugin/plugin_name.lua b/plugin/plugin_name.lua
@@ -1 +1,5 @@
-vim.api.nvim_create_user_command("MyFirstFunction", require("plugin_name").hello, {})
+vim.api.nvim_create_user_command(
+	'MyFirstFunction',
+	require('plugin_name').hello,
+	{}
+)
diff --git a/tests/minimal_init.lua b/tests/minimal_init.lua
@@ -1,11 +1,16 @@
-local plenary_dir = os.getenv("PLENARY_DIR") or "/tmp/plenary.nvim"
+local plenary_dir = os.getenv('PLENARY_DIR') or '/tmp/plenary.nvim'
 local is_not_a_directory = vim.fn.isdirectory(plenary_dir) == 0
 if is_not_a_directory then
-  vim.fn.system({"git", "clone", "https://github.com/nvim-lua/plenary.nvim", plenary_dir})
+	vim.fn.system({
+		'git',
+		'clone',
+		'https://github.com/nvim-lua/plenary.nvim',
+		plenary_dir,
+	})
 end
 
-vim.opt.rtp:append(".")
+vim.opt.rtp:append('.')
 vim.opt.rtp:append(plenary_dir)
 
-vim.cmd("runtime plugin/plenary.vim")
-require("plenary.busted")
+vim.cmd('runtime plugin/plenary.vim')
+require('plenary.busted')
diff --git a/tests/plugin_name/plugin_name_spec.lua b/tests/plugin_name/plugin_name_spec.lua
@@ -1,12 +1,12 @@
-local plugin = require("plugin_name")
+local plugin = require('plugin_name')
 
-describe("setup", function()
-  it("works with default", function()
-    assert("my first function with param = Hello!", plugin.hello())
-  end)
+describe('setup', function()
+	it('works with default', function()
+		assert('my first function with param = Hello!', plugin.hello())
+	end)
 
-  it("works with custom var", function()
-    plugin.setup({ opt = "custom" })
-    assert("my first function with param = custom", plugin.hello())
-  end)
+	it('works with custom var', function()
+		plugin.setup({ opt = 'custom' })
+		assert('my first function with param = custom', plugin.hello())
+	end)
 end)
diff --git a/tests/prepare-config.lua b/tests/prepare-config.lua
@@ -0,0 +1,29 @@
+local lazypath = vim.fn.stdpath('data') .. '/lazy/lazy.nvim'
+
+if not vim.loop.fs_stat(lazypath) then
+	vim.fn.system({
+		'git',
+		'clone',
+		'--filter=blob:none',
+		'https://github.com/folke/lazy.nvim.git',
+		'--branch=stable',
+		lazypath,
+	})
+end
+
+vim.opt.rtp:prepend(lazypath)
+
+local temp_path = './.test_plugins'
+
+require('lazy').setup({
+	{
+		'nvim-lua/plenary.nvim',
+		lazy = false,
+	},
+}, {
+	root = temp_path,
+	lockfile = temp_path .. '/lazy-lock.json',
+	defaults = {
+		lazy = false,
+	},
+})
diff --git a/tests/test-config.lua b/tests/test-config.lua
@@ -0,0 +1,5 @@
+local temp_path = './.test_plugins'
+
+vim.opt.rtp:append(temp_path .. '/plenary.nvim')
+-- vim.opt.rtp:append(temp_path .. '/nvim-lspconfig')
+-- vim.opt.rtp:append(temp_path .. '/mason.nvim')
