java.util documentation for completion incomplete

[chrisovergaauw]

Hi,

How do i show full documentation when hovering completion items in java?

vim.lsp.buf.hover shows documentation for java.util.concurrent.atomic.AtomicLong like it should

the completions should show documentation as well but here I only see the package declaration.

I installed java with sdkman (21.0.9-tem) and installed jdtls via homebrew (macos 15.5)

nvim-cmp config

	{
		"hrsh7th/nvim-cmp",
		version = false, -- last release is way too old
		event = "InsertEnter",
		dependencies = {
			"hrsh7th/cmp-nvim-lsp",
			"hrsh7th/cmp-buffer", -- source for test in buffer
			"hrsh7th/cmp-path", -- source for file system paths
			"L3MON4D3/LuaSnip", -- snippet engine
			"saadparwaiz1/cmp_luasnip", --for autocompletion
			"rafamadriz/friendly-snippets", -- useful snippets
			"roobert/tailwindcss-colorizer-cmp.nvim",
		},
		opts = function()
			vim.api.nvim_set_hl(0, "CmpGhostText", { link = "Comment", default = true })
			local cmp = require("cmp")
			local defaults = require("cmp.config.default")()
			return {
				completion = {
					completeopt = "menu,menuone,noinsert",
				},
				window = {
					completion = cmp.config.window.bordered(),
					documentation = cmp.config.window.bordered(),
				},
				mapping = cmp.mapping.preset.insert({
					["<C-n>"] = cmp.mapping.select_next_item({ behavior = cmp.SelectBehavior.Replace }),
					["<C-p>"] = cmp.mapping.select_prev_item({ behavior = cmp.SelectBehavior.Replace }),
					["<C-b>"] = cmp.mapping.scroll_docs(-4),
					["<C-f>"] = cmp.mapping.scroll_docs(4),
					["<C-Space>"] = cmp.mapping.complete(),
					["<C-e>"] = cmp.mapping.abort(),
					["<CR>"] = cmp.mapping.confirm({
						behavior = cmp.ConfirmBehavior.Replace,
						select = true,
					}), -- Accept currently selected item. Set `select` to `false` to only confirm explicitly selected items.
					["<S-CR>"] = cmp.mapping.confirm({
						behavior = cmp.ConfirmBehavior.Insert,
						select = true,
					}), -- Accept currently selected item. Set `select` to `false` to only confirm explicitly selected items.
					["K"] = cmp.mapping(function(fallback)
						if cmp.visible_docs() then
							cmp.close_docs()
						elseif cmp.visible() then
							cmp.open_docs()
						else
							fallback()
						end
					end),
				}),
				sources = cmp.config.sources({
					{
						name = "nvim_lsp",
						entry_filter = function(entry, ctx)
							return true
						end,
					},
					{ name = "luasnip" },
					{ name = "buffer" },
					{ name = "path" },
					{ name = "tailwindcss" },
				}),
				experimental = {
					ghost_text = {
						hl_group = "CmpGhostText",
					},
				},
				sorting = defaults.sorting,
			}
		end,
	},

nvim/ftplugin/java.lua

local status, jdtls = pcall(require, "jdtls")
if not status then
	return
end

-- Determine OS
local home = os.getenv("HOME")
if vim.fn.has("mac") == 1 then
	WORKSPACE_PATH = home .. "/.local/state/jdtls-workspaces/"
	CONFIG = "mac"
elseif vim.fn.has("unix") == 1 then
	WORKSPACE_PATH = home .. "/workspace/"
	CONFIG = "linux"
else
	print("Unsupported system")
end

-- Find root of project
local root_markers = { ".git", "mvnw", "gradlew", "pom.xml", "build.gradle" }
local root_dir = require("jdtls.setup").find_root(root_markers)
if root_dir == "" then
	return
end

local extendedClientCapabilities = jdtls.extendedClientCapabilities
extendedClientCapabilities.resolveAdditionalTextEditsSupport = true

local project_name = vim.fn.fnamemodify(vim.fn.getcwd(), ":p:h:t")

local workspace_dir = WORKSPACE_PATH .. project_name

-- Homebrew jdtls installation path
local jdtls_install = "/opt/homebrew/opt/jdtls/libexec"

local is_file_exist = function(path)
	local f = io.open(path, "r")
	return f ~= nil and io.close(f)
end

local get_lombok_javaagent = function()
	local lombok_dir = home .. "/.m2/repository/org/projectlombok/lombok/"
	local lombok_versions = io.popen('ls -1 "' .. lombok_dir .. '" | sort -r')
	if lombok_versions ~= nil then
		local lb_i, lb_versions = 0, {}
		for lb_version in lombok_versions:lines() do
			lb_i = lb_i + 1
			lb_versions[lb_i] = lb_version
		end
		lombok_versions:close()
		if next(lb_versions) ~= nil then
			local lombok_jar = vim.fn.expand(string.format("%s%s/*.jar", lombok_dir, lb_versions[1]))
			if is_file_exist(lombok_jar) then
				return string.format("--jvm-arg=-javaagent:%s", lombok_jar)
			end
		end
	end
	return ""
end

local get_java_debug_jar = function()
	local jdj_full_path = fn.expand(java_debug_jar)
	if is_file_exist(jdj_full_path) then
		return jdj_full_path
	end
	return ""
end

local get_cmd = function()
	local cmd = {
		home .. "/.sdkman/candidates/java/current/bin/java", -- or '/path/to/java11_or_newer/bin/java'
		-- depends on if `java` is in your $PATH env variable and if it points to the right version.

		"-Declipse.application=org.eclipse.jdt.ls.core.id1",
		"-Dosgi.bundles.defaultStartLevel=4",
		"-Declipse.product=org.eclipse.jdt.ls.core.product",
		"-Dlog.protocol=true",
		"-Dlog.level=ALL",
		"-Xms1g",
		"--add-modules=ALL-SYSTEM",
		"--add-opens",
		"java.base/java.util=ALL-UNNAMED",
		"--add-opens",
		"java.base/java.lang=ALL-UNNAMED",

		"-jar",
		vim.fn.glob(jdtls_install .. "/plugins/org.eclipse.equinox.launcher_*.jar"),
		-- Point to the Homebrew jdtls installation

		"-configuration",
		jdtls_install .. "/config_" .. CONFIG,
		-- Point to the Homebrew jdtls configuration

		-- See `data directory configuration` section in the README
		"-data",
		workspace_dir,
	}

	local lombok_javaagent = get_lombok_javaagent()
	if lombok_javaagent ~= "" then
		table.insert(cmd, lombok_javaagent)
	end

	-- 💀
	-- See `data directory configuration` section in the README
	table.insert(cmd, "-data")
	table.insert(cmd, workspace_dir)

	return cmd
end

-- TODO: Testing
local bundles = {
	vim.fn.glob(home .. "/git/java-debug/com.microsoft.java.debug.plugin/target/com.microsoft.java.debug.plugin-*.jar"),
}

vim.list_extend(bundles, vim.split(vim.fn.glob(home .. "/git/vscode-java-test/server/*.jar"), "\n"))

-- See `:help vim.lsp.start_client` for an overview of the supported `config` options.
local config = {
	-- The command that starts the language serve
	-- See: https://github.com/eclipse/eclipse.jdt.ls#running-from-the-command-line
	cmd = get_cmd(),

	-- This is the default if not provided, you can remove it. Or adjust as needed.
	-- One dedicated LSP server & client will be started per unique root_dir
	root_dir = root_dir,

	-- Here you can configure eclipse.jdt.ls specific settings
	-- See https://github.com/eclipse/eclipse.jdt.ls/wiki/Running-the-JAVA-LS-server-from-the-command-line#initialize-request
	-- for a list of options
	settings = {
		java = {
			eclipse = {
				downloadSources = true,
			},
			maven = {
				downloadSources = true,
			},
			implementationsCodeLens = {
				enabled = true,
			},
			referencesCodeLens = {
				enabled = true,
			},
			references = {
				includeDecompiledSources = true,
			},
			format = {
				enabled = true,
			},
			contentProvider = { preferred = "fernflower" },
			extendedClientCapabilities = extendedClientCapabilities,
		},
		signatureHelp = { enabled = true },
		completion = {
			favoriteStaticMembers = {
				"org.hamcrest.MatcherAssert.assertThat",
				"org.hamcrest.Matchers.*",
				"org.hamcrest.CoreMatchers.*",
				"org.junit.jupiter.api.Assertions.*",
				"java.util.Objects.requireNonNull",
				"java.util.Objects.requireNonNullElse",
				"org.mockito.Mockito.*",
			},
		},
		sources = {
			organizeImports = {
				starThreshold = 9999,
				staticStarThreshold = 9999,
			},
		},
		codeGeneration = {
			toString = {
				template = "${object.className}{${member.name()}=${member.value}, ${otherMembers}}",
			},
			useBlocks = true,
		},
	},

	flags = {
		allow_incremental_sync = true,
	},

	-- Language server `initializationOptions`
	-- You need to extend the `bundles` with paths to jar files
	-- if you want to use additional eclipse.jdt.ls plugins.
	--
	-- See https://github.com/mfussenegger/nvim-jdtls#java-debug-installation
	--
	-- If you don't plan on using the debugger or other eclipse.jdt.ls plugins you can remove this
	init_options = {
		bundles = bundles,
	},
}

-- This starts a new client & server,
-- or attaches to an existing client & server depending on the `root_dir`.
require("jdtls").start_or_attach(config)

vim.cmd(
	"command! -buffer -nargs=? -complete=custom,v:lua.require'jdtls'._complete_compile JdtCompile lua require('jdtls').compile(<f-args>)"
)
vim.cmd(
	"command! -buffer -nargs=? -complete=custom,v:lua.require'jdtls'._complete_set_runtime JdtSetRuntime lua require('jdtls').set_runtime(<f-args>)"
)
vim.cmd("command! -buffer JdtUpdateConfig lua require('jdtls').update_project_config()")
vim.cmd("command! -buffer JdtBytecode lua require('jdtls').javap()")

local status_ok, which_key = pcall(require, "which-key")
if not status_ok then
	return
end

local mappings = {
	mode = "n",
	prefix = "<leader>",
	buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
	silent = true,
	noremap = true,
	nowait = true,
	remap = false,
	{ "<leader>j", group = "Java", nowait = true, remap = false },
	{ "<leader>jT", "<Cmd>lua require'jdtls'.test_class()<CR>", desc = "Test Class", nowait = true, remap = false },
	{
		"<leader>jc",
		"<Cmd>lua require('jdtls').extract_constant()<CR>",
		desc = "Extract Constant",
	},
	{
		"<leader>jo",
		"<Cmd>lua require'jdtls'.organize_imports()<CR>",
		desc = "Organize Imports",
	},
	{
		"<leader>jt",
		"<Cmd>lua require'jdtls'.test_nearest_method()<CR>",
		desc = "Test Method",
	},
	{ "<leader>ju", "<Cmd>JdtUpdateConfig<CR>", desc = "Update Config", nowait = true, remap = false },
	{
		"<leader>jv",
		"<Cmd>lua require('jdtls').extract_variable()<CR>",
		desc = "Extract Variable",
	},
}

local vmappings = {
	mode = { "v" },
	prefix = "<leader>",
	buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
	silent = true, -- use `silent` when creating keymaps
	noremap = true, -- use `noremap` when creating keymaps
	nowait = true, -- use `nowait` when creating keymaps
	remap = false,
	{ "<leader>j", group = "Java", nowait = true, remap = false },
	{
		"<leader>jc",
		"<Esc><Cmd>lua require('jdtls').extract_constant(true)<CR>",
		desc = "Extract Constant",
	},
	{
		"<leader>jm",
		"<Esc><Cmd>lua require('jdtls').extract_method(true)<CR>",
		desc = "Extract Method",
	},
	{
		"<leader>jv",
		"<Esc><Cmd>lua require('jdtls').extract_variable(true)<CR>",
		desc = "Extract Variable",
	},
}

which_key.add(mappings)
which_key.add(vmappings)

vim.cmd([[setlocal shiftwidth=2]])
vim.cmd([[setlocal tabstop=2]])

[chrisovergaauw]

Adding the capabilities to my config informed jdtls that the client is capable of displaying docs.
They were not send before.
excluded is new because I didn't need jacocagent and it was not working.
idk if configuring runtimes made a difference but I kept it as it seems to work now.

working config:

local status, jdtls = pcall(require, "jdtls")
if not status then
	return
end

local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities.textDocument.completion.completionItem.documentationFormat = { "markdown", "plaintext" }
capabilities.textDocument.completion.completionItem.snippetSupport = true
capabilities.textDocument.completion.completionItem.preselectSupport = true
capabilities.textDocument.completion.completionItem.insertReplaceSupport = true
capabilities.textDocument.completion.completionItem.labelDetailsSupport = true
capabilities.textDocument.completion.completionItem.deprecatedSupport = true
capabilities.textDocument.completion.completionItem.commitCharactersSupport = true
capabilities.textDocument.completion.completionItem.tagSupport = { valueSet = { 1 } }
capabilities.textDocument.completion.completionItem.resolveSupport = {
	properties = {
		"documentation",
		"detail",
		"additionalTextEdits",
	},
}

-- Determine OS
local home = os.getenv("HOME")
if vim.fn.has("mac") == 1 then
	WORKSPACE_PATH = home .. "/.local/state/jdtls-workspaces/"
	CONFIG = "mac"
elseif vim.fn.has("unix") == 1 then
	WORKSPACE_PATH = home .. "/workspace/"
	CONFIG = "linux"
else
	print("Unsupported system")
end

-- Find root of project
local root_markers = { ".git", "mvnw", "gradlew", "pom.xml", "build.gradle" }
local root_dir = require("jdtls.setup").find_root(root_markers)
if root_dir == "" then
	return
end

local extendedClientCapabilities = jdtls.extendedClientCapabilities
extendedClientCapabilities.resolveAdditionalTextEditsSupport = true

local project_name = vim.fn.fnamemodify(vim.fn.getcwd(), ":p:h:t")

local workspace_dir = WORKSPACE_PATH .. project_name
local metadata_path = workspace_dir .. "/.metadata/.plugins/org.eclipse.jdt.ls.core/completion-data"
vim.fn.mkdir(metadata_path, "p")

-- Homebrew jdtls installation path
local jdtls_install = "/opt/homebrew/opt/jdtls/libexec"

local is_file_exist = function(path)
	local f = io.open(path, "r")
	return f ~= nil and io.close(f)
end

local get_lombok_javaagent = function()
	local lombok_dir = home .. "/.m2/repository/org/projectlombok/lombok/"
	local lombok_versions = io.popen('ls -1 "' .. lombok_dir .. '" | sort -r')
	if lombok_versions ~= nil then
		local lb_i, lb_versions = 0, {}
		for lb_version in lombok_versions:lines() do
			lb_i = lb_i + 1
			lb_versions[lb_i] = lb_version
		end
		lombok_versions:close()
		if next(lb_versions) ~= nil then
			local lombok_jar = vim.fn.expand(string.format("%s%s/*.jar", lombok_dir, lb_versions[1]))
			if is_file_exist(lombok_jar) then
				return string.format("--jvm-arg=-javaagent:%s", lombok_jar)
			end
		end
	end
	return ""
end

local get_java_debug_jar = function()
	local jdj_full_path = fn.expand(java_debug_jar)
	if is_file_exist(jdj_full_path) then
		return jdj_full_path
	end
	return ""
end

local get_cmd = function()
	local cmd = {
		home .. "/.sdkman/candidates/java/current/bin/java", -- or '/path/to/java11_or_newer/bin/java'
		-- depends on if `java` is in your $PATH env variable and if it points to the right version.

		"-Declipse.application=org.eclipse.jdt.ls.core.id1",
		"-Dosgi.bundles.defaultStartLevel=4",
		"-Declipse.product=org.eclipse.jdt.ls.core.product",
		"-Dlog.protocol=true",
		"-Dlog.level=ALL",
		"-Xms1g",
		"--add-modules=ALL-SYSTEM",
		"--add-opens",
		"java.base/java.util=ALL-UNNAMED",
		"--add-opens",
		"java.base/java.lang=ALL-UNNAMED",

		"-jar",
		vim.fn.glob(jdtls_install .. "/plugins/org.eclipse.equinox.launcher_*.jar"),
		-- Point to the Homebrew jdtls installation

		"-configuration",
		jdtls_install .. "/config_" .. CONFIG,
		-- Point to the Homebrew jdtls configuration

		-- See `data directory configuration` section in the README
		"-data",
		workspace_dir,
	}

	local lombok_javaagent = get_lombok_javaagent()
	if lombok_javaagent ~= "" then
		table.insert(cmd, lombok_javaagent)
	end

	-- 💀
	-- See `data directory configuration` section in the README
	table.insert(cmd, "-data")
	table.insert(cmd, workspace_dir)

	return cmd
end

-- TODO: Testing
local bundles = {
	vim.fn.glob(home .. "/git/java-debug/com.microsoft.java.debug.plugin/target/com.microsoft.java.debug.plugin-*.jar"),
}
local java_test_bundles = vim.split(vim.fn.glob(home .. "/git/vscode-java-test/server/*.jar", 1), "\n")

local excluded = {
	"com.microsoft.java.test.runner-jar-with-dependencies.jar",
	"jacocoagent.jar",
}
for _, java_test_jar in ipairs(java_test_bundles) do
	local fname = vim.fn.fnamemodify(java_test_jar, ":t")
	if not vim.tbl_contains(excluded, fname) then
		table.insert(bundles, java_test_jar)
	end
end

-- See `:help vim.lsp.start_client` for an overview of the supported `config` options.
local config = {
	-- The command that starts the language serve
	-- See: https://github.com/eclipse/eclipse.jdt.ls#running-from-the-command-line
	cmd = get_cmd(),

	-- This is the default if not provided, you can remove it. Or adjust as needed.
	-- One dedicated LSP server & client will be started per unique root_dir
	root_dir = root_dir,

	capabilities = capabilities,

	-- Here you can configure eclipse.jdt.ls specific settings
	-- See https://github.com/eclipse/eclipse.jdt.ls/wiki/Running-the-JAVA-LS-server-from-the-command-line#initialize-request
	-- for a list of options
	settings = {
		java = {
			configuration = {
				runtimes = {
					{
						name = "JavaSE-21",
						path = "/Users/chris/.sdkman/candidates/java/21.0.9-tem",
					},
				},
			},
			eclipse = {
				downloadSources = true,
			},
			maven = {
				downloadSources = true,
			},
			implementationsCodeLens = {
				enabled = true,
			},
			referencesCodeLens = {
				enabled = true,
			},
			references = {
				includeDecompiledSources = true,
			},
			format = {
				enabled = true,
			},
			contentProvider = { preferred = "fernflower" },
		},
		extendedClientCapabilities = extendedClientCapabilities,
		signatureHelp = { enabled = true },
		completion = {
			favoriteStaticMembers = {
				"org.hamcrest.MatcherAssert.assertThat",
				"org.hamcrest.Matchers.*",
				"org.hamcrest.CoreMatchers.*",
				"org.junit.jupiter.api.Assertions.*",
				"java.util.Objects.requireNonNull",
				"java.util.Objects.requireNonNullElse",
				"org.mockito.Mockito.*",
			},
		},
		sources = {
			organizeImports = {
				starThreshold = 9999,
				staticStarThreshold = 9999,
			},
		},
		codeGeneration = {
			toString = {
				template = "${object.className}{${member.name()}=${member.value}, ${otherMembers}}",
			},
			useBlocks = true,
		},
	},

	flags = {
		allow_incremental_sync = true,
	},

	-- Language server `initializationOptions`
	-- You need to extend the `bundles` with paths to jar files
	-- if you want to use additional eclipse.jdt.ls plugins.
	--
	-- See https://github.com/mfussenegger/nvim-jdtls#java-debug-installation
	--
	-- If you don't plan on using the debugger or other eclipse.jdt.ls plugins you can remove this
	init_options = {
		bundles = bundles,
	},
}

-- This starts a new client & server,
-- or attaches to an existing client & server depending on the `root_dir`.
require("jdtls").start_or_attach(config)

vim.cmd(
	"command! -buffer -nargs=? -complete=custom,v:lua.require'jdtls'._complete_compile JdtCompile lua require('jdtls').compile(<f-args>)"
)
vim.cmd(
	"command! -buffer -nargs=? -complete=custom,v:lua.require'jdtls'._complete_set_runtime JdtSetRuntime lua require('jdtls').set_runtime(<f-args>)"
)
vim.cmd("command! -buffer JdtUpdateConfig lua require('jdtls').update_project_config()")
vim.cmd("command! -buffer JdtBytecode lua require('jdtls').javap()")

local status_ok, which_key = pcall(require, "which-key")
if not status_ok then
	return
end

local mappings = {
	mode = "n",
	prefix = "<leader>",
	buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
	silent = true,
	noremap = true,
	nowait = true,
	remap = false,
	{ "<leader>j", group = "Java", nowait = true, remap = false },
	{ "<leader>jT", "<Cmd>lua require'jdtls'.test_class()<CR>", desc = "Test Class", nowait = true, remap = false },
	{
		"<leader>jc",
		"<Cmd>lua require('jdtls').extract_constant()<CR>",
		desc = "Extract Constant",
	},
	{
		"<leader>jo",
		"<Cmd>lua require'jdtls'.organize_imports()<CR>",
		desc = "Organize Imports",
	},
	{
		"<leader>jt",
		"<Cmd>lua require'jdtls'.test_nearest_method()<CR>",
		desc = "Test Method",
	},
	{ "<leader>ju", "<Cmd>JdtUpdateConfig<CR>", desc = "Update Config", nowait = true, remap = false },
	{
		"<leader>jv",
		"<Cmd>lua require('jdtls').extract_variable()<CR>",
		desc = "Extract Variable",
	},
}

local vmappings = {
	mode = { "v" },
	prefix = "<leader>",
	buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
	silent = true, -- use `silent` when creating keymaps
	noremap = true, -- use `noremap` when creating keymaps
	nowait = true, -- use `nowait` when creating keymaps
	remap = false,
	{ "<leader>j", group = "Java", nowait = true, remap = false },
	{
		"<leader>jc",
		"<Esc><Cmd>lua require('jdtls').extract_constant(true)<CR>",
		desc = "Extract Constant",
	},
	{
		"<leader>jm",
		"<Esc><Cmd>lua require('jdtls').extract_method(true)<CR>",
		desc = "Extract Method",
	},
	{
		"<leader>jv",
		"<Esc><Cmd>lua require('jdtls').extract_variable(true)<CR>",
		desc = "Extract Variable",
	},
}

which_key.add(mappings)
which_key.add(vmappings)

vim.cmd([[setlocal shiftwidth=2]])
vim.cmd([[setlocal tabstop=2]])