chore: updated readme

This commit is contained in:
2026-07-06 09:58:59 +02:00
parent be88287383
commit 61a03b6dd2
+34 -15
View File
@@ -1,26 +1,45 @@
# NeoVim Configs
This repository contains my NeoVim configs, including some of my snippets.
It uses Lazy.nvim as the plugin manager, lspconfig for the language server configuration, none-ls for formatting, telescope, tree-sitter and many other plugins. Partially documented and fairly well organized
It uses:
- Lazy.nvim as the plugin manager
- NeoVim's built-in LSP support, with lspconfig for the language server configuration
- none-ls for formatters
- Snacks.nvim for search, file explorer and more
- blink.cmp for completions, with LuaSnip for snippets
- Nightfox theme, with customized colours
- TODO comment highlighting
- Debugger support (through nvim-dap)
- Neotest integrated for a few languages
- tree-sitter for syntax highlighting
Partially documented and fairly well organized
## Update
A new version of these configs is in the works, removing many plugins that are now all consolidated in Snacks
Lazy.nvim might be replaced with NeoVim's native 0.12+ package manager
## Linter configs
## Usage notes
### Linter configs
You may find the linter configs and setup-scripts for some linters that require some extra setup [here](https://git.janishutz.com/janishutz/dotfiles/)
# Lua notes
To get your luarocks packages to be picked up by the language server, it is currently configured to only look at the `cwd` that nvim is open in.
I may expand that in the future to do a proper search for all open buffers, but that would require a language server restart to apply on every buffer add
### Luarocks
To get your `luarocks` packages to be picked up by the language server, it is currently configured to only look at the `cwd` that nvim is open in,
unless you add a `.luarc.json` file with the following content:
```json
{
"workspace": {
"library": [
"/path/to/library"
]
},
"diagnostics": {
"globals": ["any globals to add"]
}
}
```
# Issues with jdtls
### Java
#### jdtls
Ensure you have jdk21-opnejdk or newer installed. On Arch (and derivatives) you can switch the preferred java version using `archlinux-java set <version name>`
# Fixing the errors in Java files
Copy the pom.xml file to the root of your project, then run `mvn dependency:resolve` to download the support files
#### Missing Deps
The `pom.xml` file in this repo makes `maven` download `junit`.
If you need that, copy the file to the root of your project, then run `mvn dependency:resolve` to download the dependencies