https://github.com/nvim-java/nvim-java
Painless Java in Neovim
https://github.com/nvim-java/nvim-java
autocompletion debugging diagnostics language-server-client language-server-protocol neovim neovim-plugin neovim-plugins running spring spring-boot testing
Last synced: 18 days ago
JSON representation
Painless Java in Neovim
- Host: GitHub
- URL: https://github.com/nvim-java/nvim-java
- Owner: nvim-java
- License: mit
- Created: 2023-11-10T10:40:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-11T05:58:26.000Z (2 months ago)
- Last Synced: 2025-12-12T00:49:31.619Z (2 months ago)
- Topics: autocompletion, debugging, diagnostics, language-server-client, language-server-protocol, neovim, neovim-plugin, neovim-plugins, running, spring, spring-boot, testing
- Language: Lua
- Homepage:
- Size: 488 KB
- Stars: 1,500
- Watchers: 14
- Forks: 79
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - nvim-java/nvim-java - Everything you need for a painless Java experience. (Programming Languages Support / Diagnostics)
- awesome-neovim-sorted - nvim-java/nvim-java
- trackawesomelist - nvim-java/nvim-java (⭐945) - Everything you need for a painless Java experience. (Recently Updated / [Dec 11, 2024](/content/2024/12/11/README.md))
README
# :coffee: nvim-java
---
Just install and start writing `public static void main(String[] args)`.
---
> [!TIP]
> You can find cool tips & tricks here https://github.com/nvim-java/nvim-java/wiki/Tips-&-Tricks
## :loudspeaker: Demo
## :dizzy: Features
- :white_check_mark: Spring Boot Tools
- :white_check_mark: Diagnostics & Auto Completion
- :white_check_mark: Automatic Debug Configuration
- :white_check_mark: Organize Imports & Code Formatting
- :white_check_mark: Running Tests
- :white_check_mark: Run & Debug Profiles
- :white_check_mark: Built-in Application Runner with Log Viewer
- :white_check_mark: Profile Management UI
- :white_check_mark: Decompiler Support
- :white_check_mark: [Code Actions](https://github.com/nvim-java/nvim-java/wiki/Tips-&-Tricks#running-code-actions)
## :hammer: How to Install
:small_orange_diamond:details
**Requirements:** Neovim 0.11.5+
### Using `vim.pack`
```lua
vim.pack.add({
{
src = 'https://github.com/JavaHello/spring-boot.nvim',
version = '218c0c26c14d99feca778e4d13f5ec3e8b1b60f0',
},
'https://github.com/MunifTanjim/nui.nvim',
'https://github.com/mfussenegger/nvim-dap',
'https://github.com/nvim-java/nvim-java',
})
require('java').setup()
vim.lsp.enable('jdtls')
```
### Using `lazy.nvim`
Install using [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
'nvim-java/nvim-java',
config = function()
require('java').setup()
vim.lsp.enable('jdtls')
end,
}
```
Yep! That's all :)
## :keyboard: Commands
:small_orange_diamond:details
### Build
- `JavaBuildBuildWorkspace` - Runs a full workspace build
- `JavaBuildCleanWorkspace` - Clear the workspace cache
(for now you have to close and reopen to restart the language server after
the deletion)
### Runner
- `JavaRunnerRunMain` - Runs the application or selected main class (if there
are multiple main classes)
```vim
:JavaRunnerRunMain
:JavaRunnerRunMain
```
- `JavaRunnerStopMain` - Stops the running application
- `JavaRunnerToggleLogs` - Toggle between show & hide runner log window
### DAP
- `JavaDapConfig` - DAP is autoconfigured on start up, but in case you want to
force configure it again, you can use this API
### Test
- `JavaTestRunCurrentClass` - Run the test class in the active buffer
- `JavaTestDebugCurrentClass` - Debug the test class in the active buffer
- `JavaTestRunCurrentMethod` - Run the test method on the cursor
- `JavaTestDebugCurrentMethod` - Debug the test method on the cursor
- `JavaTestViewLastReport` - Open the last test report in a popup window
### Profiles
- `JavaProfile` - Opens the profiles UI
### Refactor
- `JavaRefactorExtractVariable` - Create a variable from value at cursor/selection
- `JavaRefactorExtractVariableAllOccurrence` - Create a variable for all
occurrences from value at cursor/selection
- `JavaRefactorExtractConstant` - Create a constant from the value at cursor/selection
- `JavaRefactorExtractMethod` - Create a method from the value at cursor/selection
- `JavaRefactorExtractField` - Create a field from the value at cursor/selection
### Settings
- `JavaSettingsChangeRuntime` - Change the JDK version to another
## :computer: APIs
:small_orange_diamond:details
### Build
- `build.build_workspace` - Runs a full workspace build
```lua
require('java').build.build_workspace()
```
- `build.clean_workspace` - Clear the workspace cache
(for now you have to close and reopen to restart the language server after
the deletion)
```lua
require('java').build.clean_workspace()
```
### Runner
- `built_in.run_app` - Runs the application or selected main class (if there
are multiple main classes)
```lua
require('java').runner.built_in.run_app({})
require('java').runner.built_in.run_app({'arguments', 'to', 'pass', 'to', 'main'})
```
- `built_in.stop_app` - Stops the running application
```lua
require('java').runner.built_in.stop_app()
```
- `built_in.toggle_logs` - Toggle between show & hide runner log window
```lua
require('java').runner.built_in.toggle_logs()
```
### DAP
- `config_dap` - DAP is autoconfigured on start up, but in case you want to force
configure it again, you can use this API
```lua
require('java').dap.config_dap()
```
### Test
- `run_current_class` - Run the test class in the active buffer
```lua
require('java').test.run_current_class()
```
- `debug_current_class` - Debug the test class in the active buffer
```lua
require('java').test.debug_current_class()
```
- `run_current_method` - Run the test method on the cursor
```lua
require('java').test.run_current_method()
```
- `debug_current_method` - Debug the test method on the cursor
```lua
require('java').test.debug_current_method()
```
- `view_report` - Open the last test report in a popup window
```lua
require('java').test.view_last_report()
```
### Profiles
```lua
require('java').profile.ui()
```
### Refactor
- `extract_variable` - Create a variable from value at cursor/selection
```lua
require('java').refactor.extract_variable()
```
- `extract_variable_all_occurrence` - Create a variable for all occurrences from
value at cursor/selection
```lua
require('java').refactor.extract_variable_all_occurrence()
```
- `extract_constant` - Create a constant from the value at cursor/selection
```lua
require('java').refactor.extract_constant()
```
- `extract_method` - Create method from the value at cursor/selection
```lua
require('java').refactor.extract_method()
```
- `extract_field` - Create a field from the value at cursor/selection
```lua
require('java').refactor.extract_field()
```
### Settings
- `change_runtime` - Change the JDK version to another
```lua
require('java').settings.change_runtime()
```
## :clamp: How to Use JDK X.X Version?
:small_orange_diamond:details
Use `vim.lsp.config()` to override the default JDTLS settings:
```lua
vim.lsp.config('jdtls', {
settings = {
java = {
configuration = {
runtimes = {
{
name = "JavaSE-21",
path = "/opt/jdk-21",
default = true,
}
}
}
}
}
})
```
## :wrench: Configuration
:small_orange_diamond:details
For most users changing the default configuration is not necessary. But if you
want, following options are available:
```lua
require('java').setup({
-- Startup checks
checks = {
nvim_version = true, -- Check Neovim version
nvim_jdtls_conflict = true, -- Check for nvim-jdtls conflict
},
-- JDTLS configuration
jdtls = {
version = '1.43.0',
},
-- Extensions
lombok = {
enable = true,
version = '1.18.40',
},
java_test = {
enable = true,
version = '0.40.1',
},
java_debug_adapter = {
enable = true,
version = '0.58.2',
},
spring_boot_tools = {
enable = true,
version = '1.55.1',
},
-- JDK installation
jdk = {
auto_install = true,
version = '17',
},
-- Logging
log = {
use_console = true,
use_file = true,
level = 'info',
log_file = vim.fn.stdpath('state') .. '/nvim-java.log',
max_lines = 1000,
show_location = false,
},
})
```
## :golf: Architecture
:small_orange_diamond:details
Following is the high level idea. Jdtls is the language server nvim-java
communicates with. However, we don't have all the features we need just in
Jdtls. So, we are loading java-test & java-debug-adapter extensions when we
launch Jdtls. Once the language server is started, we communicate with the
language server to do stuff.
For instance, to run the current test,
- Request Jdtls for test classes
- Request Jdtls for class paths, module paths, java executable
- Request Jdtls to start a debug session and send the port of the session back
- Prepare TCP connections to listen to the test results
- Start nvim-dap and let user interactions to be handled by nvim-dap
- Parse the test results as they come in
- Once the execution is done, open a window show the test results
```text
┌────────────┐ ┌────────────┐
│ │ │ │
│ Neovim │ │ VSCode │
│ │ │ │
└─────▲──────┘ └──────▲─────┘
│ │
│ │
│ │
│ │
┌───────▼───────┐ ┌──────────────▼──────────────┐
│ │ │ │
│ nvim-java │ │ Extension Pack for Java │
│ │ │ │
└───────▲───────┘ └──────────────▲──────────────┘
│ │
│ │
│ │
│ │
│ │
│ ┌───────────┐ │
│ │ │ │
└──────────────► JDTLS ◄────────────┘
│ │
└───▲───▲───┘
│ │
│ │
│ │
│ │
│ │
┌───────────────┐ │ │ ┌────────────────────────┐
│ │ │ │ │ │
│ java-test ◄────────┘ └─────────► java-debug-adapter │
│ │ │ │
└───────────────┘ └────────────────────────┘
```
## :bookmark_tabs: Projects Acknowledgement
- [spring-boot.nvim](https://github.com/JavaHello/spring-boot.nvim) is the one
that starts sts4 & do other necessary `jdtls` `sts4` sync command registration
in `nvim-java`.
- [nvim-jdtls](https://github.com/mfussenegger/nvim-jdtls) is a plugin that follows
"Keep it simple, stupid!" approach. If you love customizing things by yourself,
then give nvim-jdtls a try.