https://github.com/gbroques/neovim-configuration
Personal Neovim configuration.
https://github.com/gbroques/neovim-configuration
neovim- neovim-conf neovim-config neovim-configs neovim-configuration neovim-dotfiles
Last synced: about 1 month ago
JSON representation
Personal Neovim configuration.
- Host: GitHub
- URL: https://github.com/gbroques/neovim-configuration
- Owner: gbroques
- Created: 2020-04-20T20:51:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T19:58:52.000Z (9 months ago)
- Last Synced: 2025-01-07T20:45:05.099Z (9 months ago)
- Topics: neovim-, neovim-conf, neovim-config, neovim-configs, neovim-configuration, neovim-dotfiles
- Language: Lua
- Homepage:
- Size: 268 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim Configuration
gbroques' personal Neovim configuration with the following goals and philosophy:
* Configure Neovim with IDE features like Visual Studio Code.
* Stable. Plugins are pinned to specific versions.
* Omit specifying defaults and refer to [`:help`](https://neovim.io/doc/user/helphelp.html) instead.
* Include comments for someone new to Vim / Neovim.
* Explain all mnemonics.
* Efficient.
* There should not be dupicate mappings for an operation unless the alternative mapping is less keystrokes.
* Fast.
* Minimal.
* Tailored for [Colemak](https://en.wikipedia.org/wiki/Colemak) over [QWERTY](https://en.wikipedia.org/wiki/QWERTY).
## Prerequisites
1. [Neovim](https://neovim.io/) (`nvim`).
2. [JetBrainsMono Nerd Font](https://github.com/ryanoasis/nerd-fonts/releases/download/v2.3.3/JetBrainsMono.zip)
* Support ligatures and italics.
3. [ripgrep](https://github.com/BurntSushi/ripgrep#installation) (for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim))
4. `make` (for [telescope-fzf-native.nvim](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation))
5. Install desired language servers. See below sections.
### Java
1. Install Java 21 in the following directory:
/Library/Java/JavaVirtualMachines/zulu-21.jdk/Contents/Home
2. Save formatter settings at `~/.vscode/formatter.xml`.
3. Install the tree-sitter Java parser from inside Neovim:
:TSInstall java
4. Install the following dependencies via Mason (to find the latest versions goto https://mason-registry.dev/registry/list):
:MasonInstall jdtls@1.46.1 java-debug-adapter@0.58.1 java-test@0.43.1
jdtls requires `wget` to be available on the `PATH`.
### C++
1. Install the tree-sitter C++ parser from inside Neovim:
:TSInstall cpp
2. Install the following dependencies via Mason:
:MasonInstall clangd@19.1.2
3. A [`compile_commands.json`](https://clangd.llvm.org/installation.html#compile_commandsjson) file must be generated on a per-project basis.
### JavaScript
1. Install TypeScript and ESLint language servers:
:MasonInstall typescript-language-server eslint-lsp
**References:** (if MasonInstall fails)
* https://github.com/neovim/nvim-lspconfig/blob/v2.3.0/lua/lspconfig/configs/ts_ls.lua#L26
* https://github.com/neovim/nvim-lspconfig/blob/v2.3.0/lua/lspconfig/configs/eslint.lua#L171
2. Install the tree-sitter JavaScript parser from inside Neovim:
:TSInstall javascript
3. Setup ESLint for formatting and diagnostics.
Two enviroment variables, `ESLINT_NODE_PATH` and `ESLINT_CONFIG_FILE`, specifying a path with `node_modules` containing ESLint and a path to the ESLint configuration file MUST be set.
### Tree-sitter
Install the Tree-sitter query parser for [query editor highlighting](https://github.com/nvim-treesitter/playground):
:TSInstall query
### Python
Install the following dependencies:
:MasonInstall jedi-language-server flake8 autopep8 isort mypy
Install the tree-sitter Python parser from inside Neovim:
:TSInstall python
### YAML
Install the [YAML language server](https://github.com/redhat-developer/yaml-language-server):
npm install -g yaml-language-server
## Setup
Clone to Neovim configuration directory depending on operating system:
| Operating System | Clone Command |
| ---------------- | ------------- |
| Linux / MacOS | `git clone git@github.com:gbroques/neovim-configuration.git ~/.config/nvim` |
| Windows | `git clone git@github.com:gbroques/neovim-configuration.git ~/AppData/Local/nvim` |
`:help config`
## Operators
* `c`hange (*built-in*)
* `cs` change surrounding (*surround.vim*)
* `d`elete (*built-in*)
* `ds` delete surrounding (*surround.vim*)
* `gb` go blockwise comment (*Comment.nvim*)
* `gc` go linewise comment (*Comment.nvim*)
* `gs` go substitute (*substitute.nvim*)
* `gu` make lowercase (*built-in*)
* `gU` make uppercase (*built-in*)
* `y`ank (*built-in*)
* `ys` add surrounding (*surround.vim*)
* `>` shift right (*built-in*)
* `<` shift left (*built-in*)
See `:help operator` for details on built-in operators.
## Text Objects
All of the built-in vim text-objects are maintained, with some additional ones mainly from tree-sitter.
* `a`rgument (*tree-sitter*)
* `b` alias for () (*built-in*)
* `B` alias for {} (*built-in*)
* `c`lass (*tree-sitter*)
* con`d`itional (*tree-sitter*)
* `f`unction (*tree-sitter*)
* `gn` next search pattern (*built-in*)
* `gN` last search pattern (*built-in*)
* `h`unk (only ih 'inner hunk' supported) (*gitsigns*)
* `l`oop (*tree-sitter*)
* `p`aragraph (*built-in*)
* `w`ord (*built-in*)
* `s`entence (*built-in*)
* `t`ag (*built-in*)
* `[]`, `<>`, `()`, `{}`, `"`, `'`, `` ` `` (*built-in*)
See `:help text-objects` for details on built-in text-objects.
## References
Neovim IDE Distributions:
* [LunarVim](https://github.com/LunarVim/LunarVim)
* [AstroNvim](https://github.com/AstroNvim/AstroNvim)
* [NvChad](https://github.com/NvChad/NvChad)
* [LazyVim](https://github.com/LazyVim/LazyVim)
Other sources:
* [Christian Chiarulli](https://www.youtube.com/@chrisatmachine)
* [Neovim from Scratch YouTube Playlist](https://www.youtube.com/watch?v=ctH-a-1eUME&list=PLhoH5vyxr6Qq41NFL4GvhFp-WLd5xzIzZ)
* [Neovim from Scratch GitHub Repository](https://github.com/LunarVim/Neovim-from-scratch)
* [More recent & stable 'Neovim from Scratch' GitHub Repository](https://github.com/LunarVim/nvim-basic-ide)
* [Neovim Lua from Scratch YouTube Playlist](https://www.youtube.com/playlist?list=PLPDVgSbOnt7LXQ8DTzu37UwCpA0elyD0V)