rework for better scaling

.github/workflows/install.yml

@@ -5,10 +5,10 @@ on:
     branches:
       - "main"
     paths:
-      - '.github/workflows/**'
-      - 'lua/**'
-      - 'snapshots/**'
-      - 'utils/**'
+      - ".github/workflows/**"
+      - "lua/**"
+      - "snapshots/**"
+      - "utils/**"
 
 jobs:
   unixish:
@@ -19,10 +19,10 @@ jobs:
         include:
           - runner: ubuntu-latest
             os: linux
-            neovim: v0.9.0
+            neovim: latest
           - runner: macos-latest
             os: osx
-            neovim: v0.9.0
+            neovim: latest
           - runner: ubuntu-22.04
             os: linux
             neovim: nightly
@@ -52,8 +52,8 @@ jobs:
 
           installer_url="https://raw.githubusercontent.com/${QV_REMOTE}/${QV_BRANCH}/utils/installer/install.sh"
           curl -LSsO "$installer_url"
-          bash ./install.sh
-      
+          bash ./install.sh --no-install-dependencies
+
       - name: Test QuantumVim startup
         env:
           QUANTUMVIM_DIR: "$HOME/.config/qvim"

.luacheckrc

@@ -23,11 +23,15 @@ stds.nvim = {
 		"path_sep",
 		"vim",
 		"join_paths",
+		"get_qvim_log_dir",
 		"get_qvim_cache_dir",
+		"get_qvim_state_dir",
 		"get_qvim_config_dir",
 		"get_qvim_data_dir",
-		"get_qvim_state_dir",
+		"get_qvim_rtp_dir",
 		"get_qvim_base_dir",
+		"get_qvim_pack_dir",
+		"get_qvim_structlog_dir",
 		"get_lazy_rtp_dir",
 		"require_clean",
 	},
@@ -44,6 +48,6 @@ self = false
 cache = true
 
 ignore = {
-	"631",  -- max_line_length
+	"631", -- max_line_length
 	"212/_.*", -- unused argument, for vars with "_" prefix
 }

Makefile

@@ -1,4 +1,5 @@
 SHELL := /usr/bin/env bash
+CURRENT_DIR := $(shell pwd)
 
 install:
 	@echo starting QuantumVim installer
@@ -42,4 +43,7 @@ style-sh:
 	shfmt -f . | grep -v jdtls | xargs shfmt -i 2 -ci -bn -l -d
 
 test:
-	bash ./utils/ci/run_test.sh "$(TEST)"
+	bash ./utils/ci/run_test.sh "$(TEST)"
+
+test-local:
+	export QUANTUMVIM_RTP_DIR="$(CURRENT_DIR)"; bash ./utils/scripts/test_local.sh "$(TEST)"

README.md

@@ -6,8 +6,6 @@
 
 Heavily inspired by [LunarVim](https://github.com/LunarVim/LunarVim)!
 
-**[QuantumVim](https://github.com/quantumfate/qvim) was never meant to be a neovim distribution nor will it ever be.** This configuration is just my overkill take on how to setup a strong core by finding the righ mix of maintainability, stability and performance. Some things that I've implemented already exist as plugins, or could have been done differently with less runtime but the idea is that it would always allow me to migrate to a different plugin, with little effort, once something breaks.
-
 ## Dependencies
 
 - [ripgrep](https://github.com/BurntSushi/ripgrep)
@@ -23,6 +21,10 @@ Heavily inspired by [LunarVim](https://github.com/LunarVim/LunarVim)!
 
 Checkout the [Languages section](./lua/qvim/lang/README.md)
 
+## Testing
+
+Run `make test-local` in the root directory of the project.
+
 ## Install
 
 ### HTTPS

init.lua

@@ -1,8 +1,18 @@
+local base_dir = vim.env.QUANTUMVIM_RTP_DIR
+	or (function()
+		local init_path = debug.getinfo(1, "S").source
+		return init_path:sub(2):match("(.*[/\\])"):sub(1, -2)
+	end)()
+
+if not vim.tbl_contains(vim.opt.rtp:get(), base_dir) then
+	vim.opt.rtp:prepend(base_dir)
+end
+
 vim.loader.enable()
 
 require("qvim.bootstrap"):init()
 
 require("qvim.bootstrap"):setup()
 
-local log = require("qvim.log")
-log:debug("Starting QuantumVim")
+local log = require("qvim.log").qvim
+log.debug("Starting QuantumVim")

lua/qvim/bootstrap.lua

@@ -1,3 +1,4 @@
+---@diagnostic disable: param-type-mismatch, return-type-mismatch
 local M = {}
 M.__index = M
 
@@ -42,6 +43,16 @@ function _G.get_qvim_config_dir()
 	return qvim_config_dir
 end
 
+---Get the full path to `$QUANTUMVIM_LOG_DIR`
+---@return string
+function _G.get_qvim_log_dir()
+	local qvim_log_dir = os.getenv("QUANTUMVIM_LOG_DIR")
+	if not qvim_log_dir then
+		return vim.call("stdpath", "log")
+	end
+	return qvim_log_dir
+end
+
 ---Get the full path to `$QUANTUMVIM_STATE_DIR`
 ---@return string
 function _G.get_qvim_state_dir()
@@ -52,6 +63,12 @@ function _G.get_qvim_state_dir()
 	return qvim_state_dir
 end
 
+---Get the full path to `$QUANTUMVIM_RTP_DIR`
+---@return string
+function _G.get_qvim_rtp_dir()
+	return os.getenv("QUANTUMVIM_RTP_DIR")
+end
+
 ---Get the full path to `$QUANTUMVIM_DATA_DIR`
 ---@return string
 function _G.get_qvim_data_dir()
@@ -72,70 +89,136 @@ function _G.get_qvim_cache_dir()
 	return qvim_cache_dir
 end
 
+---Get the full path to `$QUANTUMVIM_PACK_DIR`
+---@return string
+function _G.get_qvim_pack_dir()
+	return os.getenv("QUANTUMVIM_PACK_DIR")
+end
+
+---Get the full path to `$QUANTUMVIM_STRUCTLAG_DIR`
+---@return string
+function _G.get_qvim_structlog_dir()
+	return os.getenv("QUANTUMVIM_STRUCTLOG_DIR")
+end
+
 M.qvim_config_dir = get_qvim_config_dir()
+M.qvim_state_dir = get_qvim_state_dir()
+M.qvim_rtp_dir = get_qvim_rtp_dir()
 M.qvim_cache_dir = get_qvim_cache_dir()
-M.opt_dir = join_paths(get_qvim_data_dir(), "after", "pack", "lazy", "opt")
-M.lazy_install_dir = join_paths(M.opt_dir, "lazy.nvim")
+M.qvim_data_dir = get_qvim_data_dir()
+M.qvim_log_dir = get_qvim_log_dir()
+M.qvim_pack_dir = get_qvim_pack_dir()
+M.lazy_install_dir = join_paths(M.qvim_pack_dir, "lazy.nvim")
 
 function _G.get_lazy_rtp_dir()
-	return M.opt_dir
+	return M.qvim_pack_dir
 end
 
 ---Initialize the `&runtimepath` variables, load the globals and prepare for startup
 ---@return table
 function M:init()
-	local utils = require("qvim.utils")
-
 	---@meta overridden
 	---@param what any
 	---@return string
 	vim.fn.stdpath = function(what)
 		if what == "cache" then
 			return get_qvim_cache_dir()
+		elseif what == "rtp" then
+			return get_qvim_rtp_dir()
 		elseif what == "state" then
 			return get_qvim_state_dir()
 		elseif what == "data" then
 			return get_qvim_data_dir()
 		elseif what == "config" then
 			return get_qvim_config_dir()
+		elseif what == "log" then
+			return get_qvim_log_dir()
+		elseif what == "pack" then
+			return get_qvim_pack_dir()
+		elseif what == "structlog" then
+			return get_qvim_structlog_dir()
 		else
 			return vim.call("stdpath", what)
 		end
 	end
 
-	local structlog_path = join_paths(self.opt_dir, "structlog")
-	if
-		not os.getenv("QV_FIRST_TIME_SETUP")
-		and utils.is_directory(structlog_path)
-	then
-		vim.opt.rtp:append(structlog_path)
-		require("qvim.log"):init_pre_setup()
-	end
+	local log_path = join_paths(self.qvim_pack_dir, "structlog")
+	vim.opt.rtp:prepend(log_path)
+
+	local log = require("qvim.log")
+	log.setup()
+
+	require("qvim.log")
 
 	require("qvim.core.manager"):init({
-		package_root = self.opt_dir,
+		package_root = self.qvim_pack_dir,
 		install_path = self.lazy_install_dir,
 	})
 
+	vim.opt.rtp = self:bootstrap()
+
 	require("qvim.config"):init()
 
 	return self
 end
 
 function M:setup()
-	local utils = require("qvim.utils")
-
-	local structlog_path = join_paths(self.opt_dir, "structlog")
-
 	local manager = require("qvim.core.manager")
 	manager:load()
-	if utils.is_directory(structlog_path) then
-		require("qvim.log"):init_post_setup()
-	end
-
 	require("qvim.core.plugins.mason").bootstrap()
 end
 
+--Modifies the runtimepath by removing standard paths from `vim.call("stdpath", what)` with `vim.fn.stdpath(what)`
+---@param stds string[]|nil @default: { "config", "data" }
+---@param expands string[][]|nil @default: { {}, { "site", "after" }, { "site" }, { "after" } }
+---@return vim.opt.runtimepath
+function M:bootstrap(stds, expands)
+	stds = stds or { "config", "data" }
+	expands = expands or { {}, { "site", "after" }, { "site" }, { "after" } }
+	---@type vim.opt.runtimepath
+	local rtp_paths = vim.opt.rtp:get()
+	local rtp = vim.opt.rtp
+
+	for _, what in ipairs(stds) do
+		for _, expand in ipairs(expands) do
+			if #expand == 0 then
+				if vim.tbl_contains(rtp_paths, vim.call("stdpath", what)) then
+					-- remove
+					rtp:remove(vim.call("stdpath", what))
+				end
+				if not vim.tbl_contains(rtp_paths, vim.fn.stdpath(what)) then
+					-- add
+					rtp:prepend(vim.fn.stdpath(what))
+				end
+			else
+				if
+					-- remove
+					vim.tbl_contains(
+						rtp_paths,
+						_G.join_paths(vim.call("stdpath", what), unpack(expand))
+					)
+				then
+					rtp:remove(
+						_G.join_paths(vim.call("stdpath", what), unpack(expand))
+					)
+				end
+				if
+					not vim.tbl_contains(
+						rtp_paths,
+						_G.join_paths(vim.fn.stdpath(what), unpack(expand))
+					)
+				then
+					-- add
+					rtp:prepend(
+						_G.join_paths(vim.fn.stdpath(what), unpack(expand))
+					)
+				end
+			end
+		end
+	end
+	return rtp
+end
+
 ---Update qvimVim
 ---pulls the latest changes from github and, resets the startup cache
 function M:update()

lua/qvim/config/config.lua

@@ -81,26 +81,6 @@ return {
 	icons = require("qvim.icons"),
 	---@class autocommands
 	autocommands = {},
-	---@class log
-	---@field level string
-	---@field viewer table
-	log = {
-		---@usage can be { "trace", "debug", "info", "warn", "error", "fatal" }
-		level = "error",
-		viewer = {
-			---@usage this will fallback on "less +F" if not found
-			cmd = "qnav",
-			layout_config = {
-				---@usage direction = 'vertical' | 'horizontal' | 'window' | 'float',
-				direction = "horizontal",
-				open_mapping = "",
-				size = 40,
-				float_opts = {},
-			},
-		},
-		-- currently disabled due to instabilities
-		override_notify = false,
-	},
 
 	---@alias Plugins table<string, AbstractPlugin>|table<string, AbstractParent>
 	---@type Plugins

lua/qvim/config/init.lua

@@ -1,4 +1,4 @@
-local Log = require("qvim.log")
+local log = require("qvim.log").qvim
 
 local M = {}
 
@@ -14,7 +14,6 @@ function M:init()
 	---@field icons icons
 	---@field lsp table
 	---@field autocommands autocommands
-	---@field log log
 	_G.qvim = setmetatable(
 		{},
 		{ __index = vim.deepcopy(require("qvim.config.config")) }
@@ -38,8 +37,7 @@ function M:init()
 		vim.cmd.colorscheme(qvim.config.colorscheme)
 	end
 
-	Log:set_level(qvim.log.level)
-	Log:info("Configs were loaded.")
+	log.info("Configs were loaded.")
 end
 
 --[[

lua/qvim/config/settings.lua

@@ -10,6 +10,8 @@ M.load_default_options = function()
 		vim.fn.mkdir(undodir, "p")
 	end
 
+	---@type vim.opt
+	--- https://neovim.io/doc/user/quickref.html#option-list
 	local default_options = {
 		backup = false, -- creates a backup file
 		clipboard = "unnamedplus", -- allows neovim to access the system clipboard
@@ -53,6 +55,7 @@ M.load_default_options = function()
 		showcmd = false,
 		ruler = false,
 		laststatus = 3,
+		relativenumber = true,
 	}
 
 	---  SETTINGS  ---