Skip to content

Doc update #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
s1n7ax merged 4 commits into from
Dec 3, 2025
Merged

Doc update #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1087c00
docs: add platform compatibility badges
s1n7ax Dec 3, 2025
91d2952
chore: doc update
s1n7ax Dec 3, 2025
c2a18d0
chore: update readme
s1n7ax Dec 3, 2025
c21d218
docs: add missing features to readme
s1n7ax Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
![Neovim](https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white)
![Lua](https://img.shields.io/badge/lua-%232C2D72.svg?style=for-the-badge&logo=lua&logoColor=white)

![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows11&logoColor=white)
![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white)

---

Just install and start writing `public static void main(String[] args)`.

> [!TIP]
Expand All @@ -27,13 +33,15 @@ Just install and start writing `public static void main(String[] args)`.
- :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)

## :bulb: Why

- Everything necessary will be installed automatically
- Uses native `vim.lsp.config` to setup `jdtls`
- Realtime server settings updates is possible using [neoconf](https://github.com/folke/neoconf.nvim)
- Auto loads necessary `jdtls` plugins
- Supported plugins are,
- `spring-boot-tools`
Expand Down Expand Up @@ -369,11 +377,6 @@ require('java').setup({
version = '17',
},

-- Notifications
notifications = {
dap = true, -- Show DAP configuration messages
},

-- Logging
log = {
use_console = true,
Expand Down
7 changes: 1 addition & 6 deletions doc/nvim-java.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,12 +407,7 @@ want, following options are available
auto_install = true,
version = '17.0.2',
},

notifications = {
-- enable 'Configuring DAP' & 'DAP configured' messages on start up
dap = true,
},


-- We do multiple verifications to make sure things are in place to run this
-- plugin
verification = {
Expand Down
7 changes: 0 additions & 7 deletions lua/java/config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ local V = jdtls_version_map[JDTLS_VERSION]
---@field java_debug_adapter { enable: boolean, version: string }
---@field spring_boot_tools { enable: boolean, version: string }
---@field jdk { auto_install: boolean, version: string }
---@field notifications { dap: boolean }
---@field log java-core.Log2Config

---@class java.PartialConfig
Expand All @@ -31,7 +30,6 @@ local V = jdtls_version_map[JDTLS_VERSION]
---@field java_debug_adapter? { enable?: boolean, version?: string }
---@field spring_boot_tools? { enable?: boolean, version?: string }
---@field jdk? { auto_install?: boolean, version?: string }
---@field notifications? { dap?: boolean }
---@field log? java-core.PartialLog2Config

---@type java.Config
Expand Down Expand Up @@ -72,11 +70,6 @@ local config = {
version = V.jdk,
},

notifications = {
-- enable 'Configuring DAP' & 'DAP configured' messages on start up
dap = true,
},

log = {
use_console = true,
use_file = true,
Expand Down