feat: add config option to install jdk17 via mason

s1n7ax · s1n7ax · commit 29e631803903 · 2023-12-05T01:40:45.000+05:30
* now the jdk-17 will be auto installed unless configured otherwise
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Just install and start writing `public static void main(String[] args)`.
 
 - Uses [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) to setup `jdtls`
 - Realtime server settings updates is possible using [neoconf](https://github.com/folke/neoconf.nvim)
-- Everything necessary will be installed automatically (except JDKs)
+- Everything necessary will be installed automatically
 - Uses `jdtls` and auto loads `jdtls` plugins from [mason.nvim](https://github.com/williamboman/mason.nvim)
   - Supported plugins are,
     - `lombok`
@@ -38,9 +38,8 @@ Just install and start writing `public static void main(String[] args)`.
 <summary>:pushpin: details</summary>
 
 - Pre-requisites
-  - [JDK 17](https://jdk.java.net/archive/) - jdtls is running on JDK 17
+
   - [Python 3.9](https://www.python.org/downloads/) - for running `jdtls` wrapper launch script
-  - [Node 16](https://nodejs.org/dist/v16.9.1/) - for building `vscode-java-test`
 
 - Install the plugin
 
diff --git a/lua/java.lua b/lua/java.lua
@@ -1,18 +1,24 @@
-local deps = require('java.utils.dependencies')
-local mason = require('java.utils.mason')
-local lspconfig = require('java.utils.lspconfig')
+local decomple_watch = require('java.startup.decompile-watcher')
+local mason_dep = require('java.startup.mason-dep')
+local nvim_dep = require('java.startup.nvim-dep')
+local setup_wrap = require('java.startup.lspconfig-setup-wrap')
 
 local test = require('java.api.test')
 local dap = require('java.api.dap')
--- local ts = require('java.treesitter')
+
+local global_config = require('java.config')
 
 local M = {}
 
-function M.setup()
-	deps.check()
-	mason.install_dependencies()
-	lspconfig.wrap_lspconfig_setup()
-	lspconfig.register_class_file_decomplier()
+function M.setup(custom_config)
+	local config = vim.tbl_deep_extend('force', global_config, custom_config)
+
+	nvim_dep.check()
+	mason_dep.install(config)
+
+	setup_wrap.setup(config)
+	decomple_watch.setup()
+
 	dap.setup_dap_on_lsp_attach()
 end
 
diff --git a/lua/java/config.lua b/lua/java/config.lua
@@ -0,0 +1,31 @@
+---@class java.Config
+---@field root_markers string[] list of file that exists in root of the project
+---@field jdtls_plugins string[] what plugins to load
+---@field java_test { enable: boolean }
+---@field java_debug_adapter { enable: boolean }
+---@field jdk { auto_install: boolean }
+
+local config = {
+	root_markers = {
+		'settings.gradle',
+		'settings.gradle.kts',
+		'pom.xml',
+		'build.gradle',
+		'mvnw',
+		'gradlew',
+		'build.gradle',
+		'build.gradle.kts',
+		'.git',
+	},
+	java_test = {
+		enable = true,
+	},
+	java_debug_adapter = {
+		enable = true,
+	},
+	jdk = {
+		auto_install = false,
+	},
+}
+
+return config
diff --git a/lua/java/startup/decompile-watcher.lua b/lua/java/startup/decompile-watcher.lua
@@ -1,51 +1,20 @@
-local lspconfig = require('lspconfig')
-
-local log = require('java.utils.log')
 local jdtls = require('java.utils.jdtls')
 local get_error_handler = require('java.handlers.error')
 
-local server = require('java-core.ls.servers.jdtls')
 local async = require('java-core.utils.async').sync
 
 local JavaCoreJdtlsClient = require('java-core.ls.clients.jdtls-client')
 
 local M = {}
 
-function M.wrap_lspconfig_setup()
-	log.info('wrap lspconfig.java.setup function to inject a custom java config')
-	---@type fun(config: LspSetupConfig)
-	local org_setup = lspconfig.jdtls.setup
-
-	lspconfig.jdtls.setup = function(user_config)
-		local config = server.get_config({
-			root_markers = {
-				'settings.gradle',
-				'settings.gradle.kts',
-				'pom.xml',
-				'build.gradle',
-				'mvnw',
-				'gradlew',
-				'build.gradle',
-				'build.gradle.kts',
-				'.git',
-			},
-			jdtls_plugins = { 'java-test', 'java-debug-adapter' },
-		})
-
-		config = vim.tbl_deep_extend('force', user_config, config)
-
-		org_setup(config)
-	end
-end
-
 ---@class BufReadCmdCallbackArgs
 ---@field buf integer buffer number
 ---@field event string name of the event
 ---@field file string name of the file
 ---@field id integer event id?
 ---@field match string matched pattern in autocmd match
 
-function M.register_class_file_decomplier()
+function M.setup()
 	vim.api.nvim_create_autocmd('BufReadCmd', {
 		pattern = 'jdt://*',
 		---@param opts BufReadCmdCallbackArgs
diff --git a/lua/java/startup/lspconfig-setup-wrap.lua b/lua/java/startup/lspconfig-setup-wrap.lua
@@ -0,0 +1,36 @@
+local lspconfig = require('lspconfig')
+local log = require('java.utils.log')
+
+local server = require('java-core.ls.servers.jdtls')
+
+local M = {}
+
+---comment
+---@param config java.Config
+function M.setup(config)
+	log.info('wrap lspconfig.java.setup function to inject a custom java config')
+	---@type fun(config: LspSetupConfig)
+	local org_setup = lspconfig.jdtls.setup
+
+	lspconfig.jdtls.setup = function(user_config)
+		local jdtls_plugins = {}
+
+		if config.java_test.enable then
+			table.insert(jdtls_plugins, 'java-test')
+		end
+
+		if config.java_debug_adapter.enable then
+			table.insert(jdtls_plugins, 'java-debug-adapter')
+		end
+
+		local default_config = server.get_config({
+			root_markers = config.root_markers,
+			jdtls_plugins = jdtls_plugins,
+			use_mason_jdk = config.jdk.auto_install,
+		})
+
+		org_setup(vim.tbl_extend('force', user_config, default_config))
+	end
+end
+
+return M
diff --git a/lua/java/startup/mason-dep.lua b/lua/java/startup/mason-dep.lua
@@ -1,21 +1,32 @@
 local log = require('java.utils.log')
 local mason_reg = require('mason-registry')
+local mason_ui = require('mason.ui')
+local notify = require('java-core.utils.notify')
 
 local M = {}
 
 local dependecies = {
 	{ name = 'jdtls', version = 'v1.29.0' },
-	{ name = 'java-test', version = '0.40.2' },
+	{ name = 'java-test', version = '0.40.1' },
 	{ name = 'java-debug-adapter', version = '0.52.0' },
 }
 
 ---Install mason package dependencies for nvim-java
-function M.install_dependencies()
+---@param config java.Config
+function M.install(config)
 	log.info('check mason dependecies')
 
+	local is_installing = false
+
+	if config.jdk.auto_install then
+		table.insert(dependecies, { name = 'openjdk-17', version = '17.0.2' })
+	end
+
 	for _, dep in ipairs(dependecies) do
 		if not M.is_installed(dep.name, dep.version) then
-			log.fmt_info('installing mason pkg: %s', dep.name)
+			log.info('installing mason pkg: ' .. tostring(dep.name))
+
+			is_installing = true
 
 			local pkg = mason_reg.get_package(dep.name)
 
@@ -25,9 +36,17 @@ function M.install_dependencies()
 			})
 		end
 	end
+
+	if is_installing then
+		mason_ui.open()
+		notify.warn(
+			'Please restart the editor after dependency installation is done'
+		)
+	end
 end
 
 ---Returns true if the package and its expected version is already installed
+---@private
 ---@param pkg_name string name of the package
 ---@param expc_version string expected version of the package
 ---@return boolean true if the package and its version is already installed
diff --git a/lua/java/startup/nvim-dep.lua b/lua/java/startup/nvim-dep.lua
@@ -25,6 +25,7 @@ function M.check()
 	M.neovim_plugin_check()
 end
 
+---@private
 function M.neovim_plugin_check()
 	for _, pkg in ipairs(pkgs) do
 		local ok, _ = pcall(require, pkg.name)
