Modern Neovim Configuration

Neovim + Linux = Best Almighty IDE

This configuration is for linux only.

Mainly Supported Language/Framework List

Rust
Javascript/Typescript
Shell
SQL
Lua
GLSL
WGSL
Vue
React

To support a new one, check these.

treesitter
lsp
dap
formatter
source
snippet

Personal Environment

OS: Gentoo

Terminal: Alacritty

Neovim: V0.10+

Dependencies

nodejs, go, rust (required for mason.nvim and nvim-treesitter). Use :h mason-requirements to check more dependencies.
rg, fd command (required for telescope.nvim)
trashy command (required for nvim-tree.lua)
fcitx5 (required for fcitx.nvim)
deeplx (required for translate.nvim)
cargo-nextest (required for neotest-rust.nvim)
@vue/typescript-plugin (required for vue project)
dolphin (required for nvim-tree.lua)

QuickStart

Installation

Install all dependencies.
git clone https://github.com/niuiic/modern-neovim-configuration ~/.config/nvim
Open neovim and then all plugins would be installed automatically.
Install lsps, formatters, linters, debuggers with mason.nvim. Check lua/plugin/mason.lua for details.
Check if something is missing with :checkhealth.
Look for specific functions in lua/plugins.lua.

Keymap

which-key.nvim will tell you. Check lua/plugin/* and lua/keymap.lua for details.

leader: \

localLeader: <space>

LSP

Create lspname.lua in lua/lsp.

Update lsp_list in lua/lsp/init.lua.

Remap lsp commands with lsp-utils.nvim in lua/plugin/lsp-utils.lua.

Formatter

Use your favorite formatters with niuiic/format.nvim.

DAP

Create dapname.lua in lua/debugger.

Update debugger_list in lua/debugger/init.lua.

Custom Snippets and Sources

Create filetype.lua in lua/snippet or lua/source.

Update lang_list in lua/snippet/init.lua or lua/source/init.lua.

Snippet examples and snippet document may help you.

Config for Workspace

The root path of a workspace is where .git located. $rootPath/.nvim/init.lua is the entry of the local configuration.

Tasks

overseer.nvim is the default task manager. Here is the recommended way to define tasks.

Create .nvim/task/ in the root path of the project.
Add tasks to .nvim/task/task.sh and .nvim/task/init.lua.

.nvim/task/init.lua

local core = require("core")

local overseer = require("overseer")

local scriptPath = core.file.root_path() .. "/.nvim/task/task.sh"

overseer.register_template({
	name = "checkTs",
	builder = function()
		return {
			cmd = { scriptPath },
			args = { "checkTs" },
			components = { "on_output_quickfix", "default", "on_complete_notify" },
		}
	end,
})

overseer.register_template({
	name = "lint",
	builder = function()
		return {
			cmd = { scriptPath },
			args = { "lint" },
			components = {
				"on_output_quickfix",
				"default",
				"on_complete_notify",
			},
		}
	end,
})

.nvim/task/task.sh

set -eE

if [ "$1" = "checkTs" ]; then
	pnpm vue-tsc --noEmit
elif [ "$1" = "lint" ]; then
	pnpm lint:eslint --rule "no-console: error" -f unix
	pnpm lint:stylelint -f unix
fi