feat!: nvim v0.10 support

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,7 +7,7 @@ body:
       value: |
         _Before reporting:_ Search [existing issues](https://github.com/ayamir/nvimdots/issues) and check the [FAQ](https://github.com/ayamir/nvimdots/wiki/Issues). Thank you for helping us improve!
         > [!IMPORTANT]
-        > The `0.10` branch is intended for nightly neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
+        > The `0.11` branch is intended for nightly Neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
   - type: checkboxes
     id: is-latest-commit
     attributes:
@@ -38,7 +38,7 @@ body:
     attributes:
       label: "Neovim version"
       description: "Paste the output of `nvim --version` here"
-      placeholder: "NVIM v0.10.0-dev-873+g71ad771ea"
+      placeholder: "NVIM v0.11.0-dev-194+g6c7677e5d"
     validations:
       required: true
   - type: input
@@ -69,16 +69,16 @@ body:
       description: "Which branch are you currently on? If you are not sure, check the output of `git rev-parse --abbrev-ref HEAD`"
       options:
         - main (Default/Latest)
-        - 0.8 (Legacy)
-        - 0.7 (Deprecated)
-        - 0.10 (Nightly)
+        - 0.9 (Legacy)
+        - 0.8 (Deprecated)
+        - 0.11 (Nightly)
     validations:
       required: true
   - type: dropdown
     id: fetch-pref
     attributes:
       label: "Fetch Preferences"
-      description: "In what way do you fetch resources? If you are not sure, check the value of `use_ssh` in `lua/core/settings.lua`"
+      description: "In what way do you fetch resources? If you are not sure, check the value of `use_ssh` in `lua/user/settings.lua`"
       options:
         - SSH (use_ssh = true)
         - HTTPS (use_ssh = false)

.github/ISSUE_TEMPLATE/custom_config.yml

@@ -7,7 +7,7 @@ body:
       value: |
         _Before requesting:_ Make sure you've read through our [Wiki: Usage](https://github.com/ayamir/nvimdots/wiki/Usage) before you start to add things to nvimdots!
         > [!IMPORTANT]
-        > The `0.10` branch is intended for nightly neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
+        > The `0.11` branch is intended for nightly Neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
   - type: checkboxes
     id: is-latest-commit
     attributes:
@@ -30,7 +30,7 @@ body:
     attributes:
       label: "Neovim version"
       description: "Paste the output of `nvim --version` here"
-      placeholder: "NVIM v0.10.0-dev-873+g71ad771ea"
+      placeholder: "NVIM v0.11.0-dev-194+g6c7677e5d"
     validations:
       required: true
   - type: dropdown
@@ -40,9 +40,9 @@ body:
       description: "This issue template mainly targets `main` branch. Check the output of `git rev-parse --abbrev-ref HEAD` if you're not sure."
       options:
         - main (Default/Latest)
-        - 0.8 (Legacy)
-        - 0.7 (Deprecated)
-        - 0.10 (Nightly)
+        - 0.9 (Legacy)
+        - 0.8 (Deprecated)
+        - 0.11 (Nightly)
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/lsp_issue_report.yml

@@ -7,7 +7,7 @@ body:
       value: |
         _Before reporting:_ Search [existing issues](https://github.com/ayamir/nvimdots/issues) and check the [FAQ](https://github.com/ayamir/nvimdots/wiki/Issues). Thank you for helping us improve!
         > [!IMPORTANT]
-        > The `0.10` branch is intended for nightly neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
+        > The `0.11` branch is intended for nightly Neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
   - type: checkboxes
     id: is-latest-commit
     attributes:
@@ -38,7 +38,7 @@ body:
     attributes:
       label: "Neovim version"
       description: "Paste the output of `nvim --version` here"
-      placeholder: "NVIM v0.10.0-dev-873+g71ad771ea"
+      placeholder: "NVIM v0.11.0-dev-194+g6c7677e5d"
     validations:
       required: true
   - type: input
@@ -69,16 +69,16 @@ body:
       description: "Which branch are you currently on? If you are not sure, check the output of `git rev-parse --abbrev-ref HEAD`"
       options:
         - main (Default/Latest)
-        - 0.8 (Legacy)
-        - 0.7 (Deprecated)
-        - 0.10 (Nightly)
+        - 0.9 (Legacy)
+        - 0.8 (Deprecated)
+        - 0.11 (Nightly)
     validations:
       required: true
   - type: dropdown
     id: fetch-pref
     attributes:
       label: "Fetch Preferences"
-      description: "In what way do you fetch resources? If you are not sure, check the value of `use_ssh` in `lua/core/settings.lua`"
+      description: "In what way do you fetch resources? If you are not sure, check the value of `use_ssh` in `lua/user/settings.lua`"
       options:
         - SSH (use_ssh = true)
         - HTTPS (use_ssh = false)

.github/workflows/lint_code.yml

@@ -8,4 +8,4 @@ jobs:
       - uses: actions/checkout@v4
       - uses: lunarmodules/luacheck@v1
         with:
-          args: . --std luajit --globals vim _toggle_lazygit _buf_vtext _command_panel _flash_esc_or_noh _debugging --max-line-length 150 --no-config
+          args: . --std luajit --globals vim _debugging _command_panel _flash_esc_or_noh _telescope_collections _toggle_lazygit --max-line-length 150 --no-config

LICENSE

@@ -1,21 +1,30 @@
-MIT License
+BSD 3-Clause License
 
 Copyright (c) 2021 ayamir
+Copyright (c) 2022 Jint-lzxy, CharlesChiuGit
+Copyright (c) 2023 aarnphm, misumisumi
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -3,8 +3,8 @@
     <br>
     <a href="https://github.com/neovim/neovim/releases/tag/stable">
     <img
-        alt="NeoVim Version Capability"
-        src="https://img.shields.io/badge/Supports%20Nvim-v0.9-A6D895?style=for-the-badge&colorA=363A4F&logo=neovim&logoColor=D9E0EE">
+        alt="Neovim Version Capability"
+        src="https://img.shields.io/badge/Supports%20Nvim-v0.10-A6D895?style=for-the-badge&colorA=363A4F&logo=neovim&logoColor=D9E0EE">
     </a>
     <a href="https://github.com/ayamir/nvimdots/releases">
     <img
@@ -36,23 +36,23 @@
 
 ## 🪷 Introduction
 
-This repo hosts our [NeoVim](https://neovim.io/) configuration for Linux [(with NixOS support)](#nixos-support), macOS, and Windows. `init.lua` is the config entry point.
+This repo hosts our [Neovim](https://neovim.io/) configuration for Linux [(with NixOS support)](#nixos-support), macOS, and Windows. `init.lua` is the config entry point.
 
 Branch info:
 
 <div align="center">
 
-| Branch | Supported neovim version |
+| Branch | Supported Neovim version |
 | :----: | :----------------------: |
-|  main  |     nvim 0.9 stable      |
-|  0.10  |    nvim 0.10 nightly     |
+|  main  |     nvim 0.10 stable     |
+|  0.11  |    nvim 0.11 nightly     |
+|  0.9   |         nvim 0.9         |
 |  0.8   |         nvim 0.8         |
-|  0.7   |         nvim 0.7         |
 
 </div>
 
 > [!IMPORTANT]
-> The `0.10` branch is intended for nightly neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
+> The `0.11` branch is intended for nightly Neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included.
 
 We currently manage plugins using [lazy.nvim](https://github.com/folke/lazy.nvim).
 
@@ -61,14 +61,14 @@ Chinese introduction is [here](https://zhuanlan.zhihu.com/p/382092667).
 ### 🎐 Features
 
 - **Fast.** Less than **30ms** to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
-- **Simple.** Run out of the box.
+- **Simple.** Runs out of the box.
 - **Modern.** Pure `lua` config.
 - **Modular.** Easy to customize.
 - **Powerful.** Full functionality to code.
 
 ## 🏗 How to Install
 
-Just run the following interactive bootstrap command, and you're good to go 👍
+Simply run the following interactive bootstrap command, and you should be all set 👍
 
 - **Windows** _(Note: This script REQUIRES `pwsh` > `v7.1`)_
 
@@ -197,14 +197,16 @@ It's strongly recommended to read [Wiki: Prerequisites](https://github.com/ayami
 - [ayamir](https://github.com/ayamir)
 - [Jint-lzxy](https://github.com/Jint-lzxy)
 - [CharlesChiuGit](https://github.com/CharlesChiuGit)
+- [aarnphm](https://github.com/aarnphm)
+- [misumisumi](https://github.com/misumisumi)
 
 ## 🎉 Acknowledgement
 
 - [glepnir/nvim](https://github.com/glepnir/nvim)
 
 ## 📜 License
 
-This NeoVim configuration is released under the MIT license, which grants the following permissions:
+This Neovim configuration is released under the BSD 3-Clause license, which grants the following permissions:
 
 - Commercial use
 - Distribution

lazy-lock.json

@@ -93,4 +93,4 @@
   "vim-sleuth": { "branch": "master", "commit": "1cc4557420f215d02c4d2645a748a816c220e99b" },
   "which-key.nvim": { "branch": "main", "commit": "4b7167f8fb2dba3d01980735e3509e172c024c29" },
   "wilder.nvim": { "branch": "master", "commit": "679f348dc90d80ff9ba0e7c470c40a4d038dcecf" }
-}
+}

lua/core/event.lua

@@ -3,23 +3,32 @@ local autocmd = {}
 
 function autocmd.nvim_create_augroups(definitions)
 	for group_name, definition in pairs(definitions) do
-		vim.api.nvim_command("augroup " .. group_name)
+		-- Prepend an underscore to avoid name clashes
+		vim.api.nvim_command("augroup _" .. group_name)
 		vim.api.nvim_command("autocmd!")
 		for _, def in ipairs(definition) do
-			local command = table.concat(vim.tbl_flatten({ "autocmd", def }), " ")
+			local command = table.concat(vim.iter({ "autocmd", def }):flatten(math.huge):totable(), " ")
 			vim.api.nvim_command(command)
 		end
 		vim.api.nvim_command("augroup END")
 	end
 end
 
--- defer setting LSP-related keymaps till LspAttach
+-- Hold off on configuring anything related to the LSP until LspAttach
 local mapping = require("keymap.completion")
 vim.api.nvim_create_autocmd("LspAttach", {
 	group = vim.api.nvim_create_augroup("LspKeymapLoader", { clear = true }),
 	callback = function(event)
 		if not _G._debugging then
+			-- LSP Keymaps
 			mapping.lsp(event.buf)
+
+			-- LSP Inlay Hints
+			local inlayhints_enabled = require("core.settings").lsp_inlayhints
+			local client = vim.lsp.get_client_by_id(event.data.client_id)
+			if client and client.server_capabilities.inlayHintProvider ~= nil then
+				vim.lsp.inlay_hint.enable(inlayhints_enabled == true, { bufnr = event.buf })
+			end
 		end
 	end,
 })
@@ -32,7 +41,7 @@ vim.api.nvim_create_autocmd("BufEnter", {
 		local layout = vim.api.nvim_call_function("winlayout", {})
 		if
 			layout[1] == "leaf"
-			and vim.api.nvim_get_option_value("filetype", { buf = vim.api.nvim_win_get_buf(layout[2]) }) == "NvimTree"
+			and vim.bo[vim.api.nvim_win_get_buf(layout[2])].filetype == "NvimTree"
 			and layout[3] == nil
 		then
 			vim.api.nvim_command([[confirm quit]])
@@ -59,7 +68,7 @@ vim.api.nvim_create_autocmd("FileType", {
 	},
 	callback = function(event)
 		vim.bo[event.buf].buflisted = false
-		vim.api.nvim_buf_set_keymap(event.buf, "n", "q", "<CMD>close<CR>", { silent = true })
+		vim.api.nvim_buf_set_keymap(event.buf, "n", "q", "<Cmd>close<CR>", { silent = true })
 	end,
 })
 

lua/core/global.lua

@@ -1,18 +1,16 @@
 local global = {}
-local os_name = vim.loop.os_uname().sysname
+local os_name = vim.uv.os_uname().sysname
 
 function global:load_variables()
 	self.is_mac = os_name == "Darwin"
 	self.is_linux = os_name == "Linux"
 	self.is_windows = os_name == "Windows_NT"
 	self.is_wsl = vim.fn.has("wsl") == 1
 	self.vim_path = vim.fn.stdpath("config")
-	local path_sep = self.is_windows and "\\" or "/"
-	local home = self.is_windows and os.getenv("USERPROFILE") or os.getenv("HOME")
-	self.cache_dir = home .. path_sep .. ".cache" .. path_sep .. "nvim" .. path_sep
-	self.modules_dir = self.vim_path .. path_sep .. "modules"
-	self.home = home
+	self.cache_dir = vim.fn.stdpath("cache")
 	self.data_dir = string.format("%s/site/", vim.fn.stdpath("data"))
+	self.modules_dir = self.vim_path .. "/modules"
+	self.home = self.is_windows and os.getenv("USERPROFILE") or os.getenv("HOME")
 end
 
 global:load_variables()

lua/core/init.lua

@@ -3,19 +3,20 @@ local global = require("core.global")
 
 -- Create cache dir and data dirs
 local createdir = function()
-	local data_dir = {
-		global.cache_dir .. "backup",
-		global.cache_dir .. "session",
-		global.cache_dir .. "swap",
-		global.cache_dir .. "tags",
-		global.cache_dir .. "undo",
+	local data_dirs = {
+		global.cache_dir .. "/backup",
+		global.cache_dir .. "/session",
+		global.cache_dir .. "/swap",
+		global.cache_dir .. "/tags",
+		global.cache_dir .. "/undo",
 	}
 	-- Only check whether cache_dir exists, this would be enough.
 	if vim.fn.isdirectory(global.cache_dir) == 0 then
-		os.execute("mkdir -p " .. global.cache_dir)
-		for _, v in pairs(data_dir) do
-			if vim.fn.isdirectory(v) == 0 then
-				os.execute("mkdir -p " .. v)
+		---@diagnostic disable-next-line: param-type-mismatch
+		vim.fn.mkdir(global.cache_dir, "p")
+		for _, dir in pairs(data_dirs) do
+			if vim.fn.isdirectory(dir) == 0 then
+				vim.fn.mkdir(dir, "p")
 			end
 		end
 	end
@@ -135,12 +136,13 @@ You're recommended to install PowerShell for better experience.]],
 
 		local basecmd = "-NoLogo -MTA -ExecutionPolicy RemoteSigned"
 		local ctrlcmd = "-Command [console]::InputEncoding = [console]::OutputEncoding = [System.Text.Encoding]::UTF8"
-		vim.api.nvim_set_option_value("shell", vim.fn.executable("pwsh") == 1 and "pwsh" or "powershell", {})
-		vim.api.nvim_set_option_value("shellcmdflag", string.format("%s %s;", basecmd, ctrlcmd), {})
-		vim.api.nvim_set_option_value("shellredir", "-RedirectStandardOutput %s -NoNewWindow -Wait", {})
-		vim.api.nvim_set_option_value("shellpipe", "2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode", {})
-		vim.api.nvim_set_option_value("shellquote", nil, {})
-		vim.api.nvim_set_option_value("shellxquote", nil, {})
+		local set_opts = vim.api.nvim_set_option_value
+		set_opts("shell", vim.fn.executable("pwsh") == 1 and "pwsh" or "powershell", {})
+		set_opts("shellcmdflag", string.format("%s %s;", basecmd, ctrlcmd), {})
+		set_opts("shellredir", "-RedirectStandardOutput %s -NoNewWindow -Wait", {})
+		set_opts("shellpipe", "2>&1 | Out-File -Encoding UTF8 %s; exit $LastExitCode", {})
+		set_opts("shellquote", "", {})
+		set_opts("shellxquote", "", {})
 	end
 end
 
@@ -160,10 +162,8 @@ local load_core = function()
 	require("core.pack")
 	require("keymap")
 
-	local colorscheme = settings.colorscheme
-	local background = settings.background
-	vim.api.nvim_command("set background=" .. background)
-	vim.api.nvim_command("colorscheme " .. colorscheme)
+	vim.api.nvim_set_option_value("background", settings.background, {})
+	vim.cmd.colorscheme(settings.colorscheme)
 end
 
 load_core()

lua/core/mapping.lua

@@ -34,6 +34,7 @@ local core_map = {
 	["n|<C-q>"] = map_cr("wq"):with_desc("edit: Save file and quit"),
 	["n|<A-S-q>"] = map_cr("q!"):with_desc("edit: Force quit"),
 	["n|<leader>o"] = map_cr("setlocal spell! spelllang=en_us"):with_desc("edit: Toggle spell check"),
+	["n|<leader>bn"] = map_cu("enew"):with_noremap():with_silent():with_desc("buffer: New"),
 	["n|tn"] = map_cr("tabnew"):with_noremap():with_silent():with_desc("tab: Create a new tab"),
 	["n|tk"] = map_cr("tabnext"):with_noremap():with_silent():with_desc("tab: Move to next tab"),
 	["n|tj"] = map_cr("tabprevious"):with_noremap():with_silent():with_desc("tab: Move to previous tab"),