feat: API for generating jdtls config (#2)

fixes: s1n7ax/nvim-java#1

Author: s1n7ax

.devcontainer/devcontainer.json

@@ -0,0 +1,9 @@
+{
+	"name": "Container",
+	"image": "ubuntu:latest",
+	"features": {
+		"ghcr.io/s1n7ax/devcontainer-features/neovim-essentials:0": {},
+		"ghcr.io/s1n7ax/devcontainer-features/neovim:0": {},
+		"ghcr.io/s1n7ax/devcontainer-features/astronvim:0": {}
+	}
+}

.stylua.toml

@@ -1,6 +1,6 @@
-column_width = 120
+column_width = 80
 line_endings = "Unix"
-indent_type = "Spaces"
+indent_type = "Tabs"
 indent_width = 2
-quote_style = "AutoPreferDouble"
+quote_style = "AutoPreferSingle"
 no_call_parentheses = false

Makefile

@@ -1,11 +1,11 @@
-TESTS_INIT=tests/minimal_init.lua
+PREPARE_CONFIG=tests/prepare_config.lua
+TEST_CONFIG=tests/test_config.lua
 TESTS_DIR=tests/
 
 .PHONY: test
 
 test:
 	@nvim \
 		--headless \
-		--noplugin \
-		-u ${TESTS_INIT} \
-		-c "PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TESTS_INIT}' }"
+		-u ${PREPARE_CONFIG} \
+		"+PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TEST_CONFIG}' }"

README.md

@@ -1,47 +1,40 @@
-# A Neovim Plugin Template
+# :construction: nvim-java (WIP)
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge)
-![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
+No need to put up with [jdtls](https://github.com/eclipse-jdtls/eclipse.jdt.ls) nonsense anymore.
+Just install and start writing `public static void main(String[] args)`.
 
-A template repository for Neovim plugins.
+## Features
 
-## Using it
+:white_check_mark: are supported features. :x: are pending features.
 
-Via `gh`:
+- :white_check_mark: Diagnostics & Auto Completion
+- :x: Automatic [DAP](https://github.com/mfussenegger/nvim-dap) debug configuration
+- :x: Running tests
 
-```
-$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
-```
+## Why
 
-Via github web page:
+- Uses [nvim-lspconfig]() to setup `jdtls`
+- Uses `jdtls` and auto loads `jdtls` plugins from [mason.nvim](https://github.com/williamboman/mason.nvim) (If they are installed)
+  - Supported plugins are,
+    - `lombok` (mason `jdtls` package contains the lombok jar. So no need to installed it separately)
+    - `java-test`
+    - `java-debug-adapter`
+- Typed & documented APIs
+- No callback hells I [promise](https://github.com/pyericz/promise-lua)
 
-Click on `Use this template`
+## How to Use
 
-![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)
+```lua
+local java = require('java')
 
-## Features and structure
+require('lspconfig').jdtls.setup(java.get_config())
 
-- 100% Lua
-- Github actions for:
-  - running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)
-  - check for formatting errors (Stylua)
-  - vimdocs autogeneration from README.md file
-  - luarocks release (LUAROCKS_API_KEY secret configuration required)
+vim.api.nvim_create_autocmd('LspAttach', {
+  callback = function(args)
+		local buffer = args.buf
 
-### Plugin structure
-
-```
-.
-├── lua
-│   ├── plugin_name
-│   │   └── module.lua
-│   └── plugin_name.lua
-├── Makefile
-├── plugin
-│   └── plugin_name.lua
-├── README.md
-├── tests
-│   ├── minimal_init.lua
-│   └── plugin_name
-│       └── plugin_name_spec.lua
+		-- add your language server keymaps here
+	end,
+	group = vim.api.nvim_create_augroup('LSP Keymaps', {}),
+})
 ```

dev/gen_jdtls_types.py

@@ -0,0 +1,75 @@
+import re
+import urllib.request
+
+things_to_export = []
+
+def _iface(text):
+    lines = text.split('\n')
+    lua_lines = []
+
+    for line in lines:
+        line = line.strip()
+        if line.startswith("interface"):
+            interface_name = line.split(" ")[1]
+            lua_lines.append(f'---@class {interface_name}')
+        elif line.startswith("{") or line.startswith("}"):
+            continue
+        elif line.startswith("/") or line.startswith("*"):
+            continue
+        elif line:
+            properties = re.findall('\s*(\w*\?*):(\?*) *(\w*)', line)
+            lua_lines.append(f'---@field {properties[0][0]} {properties[0][2]}')
+
+    lua_lines.append('\n')
+    lua_annotation = "\n".join(lua_lines)
+
+    return lua_annotation
+
+def _enum(text):
+    lines = text.split('\n')
+    lua_lines = []
+
+    for line in lines:
+        line = line.strip()
+        if line.startswith("enum"):
+            interface_name = line.split(" ")[1]
+            lua_lines.append(f'---@enum {interface_name}')
+            lua_lines.append(f'M.{interface_name} = {{')
+            things_to_export.append(interface_name)
+        elif line.startswith("{") or line.startswith("}"):
+            continue
+        elif line.startswith("/") or line.startswith("*"):
+            continue
+        elif line:
+            suffix = ''
+            if line.endswith(',') != True:
+                suffix = ','
+            lua_lines.append('\t' + line + suffix)
+
+    lua_lines.append('}')
+    lua_lines.append('\n')
+    lua_annotation = "\n".join(lua_lines)
+
+    return lua_annotation
+
+lua_doc = ''
+
+lua_doc = lua_doc + 'local M = {}\n'
+
+content = urllib.request.urlopen("https://raw.githubusercontent.com/wiki/eclipse-jdtls/eclipse.jdt.ls/Running-the-JAVA-LS-server-from-the-command-line.md").read().decode('utf-8')
+
+code_block_pattern = r'```typescript[a-zA-Z]*\n(.*?)```'
+code_blocks = re.findall(code_block_pattern, content, re.DOTALL)
+
+
+for code_block in code_blocks:
+    text = code_block.strip()
+    if re.match('^interface', text):
+        lua_doc = lua_doc + _iface(text)
+    elif re.match('^enum', text):
+        lua_doc = lua_doc + _enum(text)
+
+lua_doc = lua_doc + 'return M\n'
+
+with open("./lua/java/jdtls-types.lua", "w") as f:
+    f.write(lua_doc)

dev/init.lua

@@ -0,0 +1,42 @@
+local cwd = vim.fn.getcwd()
+vim.opt.runtimepath:prepend(cwd)
+
+--[[
+-- plugin name will be used to reload the loaded modules
+--]]
+local package_name = 'java'
+
+-- add the escape character to special characters
+local escape_pattern = function(text)
+	return text:gsub('([^%w])', '%%%1')
+end
+
+-- unload loaded modules by the matching text
+local unload_packages = function()
+	local esc_package_name = escape_pattern(package_name)
+
+	for module_name, _ in pairs(package.loaded) do
+		if string.find(module_name, esc_package_name) then
+			package.loaded[module_name] = nil
+		end
+	end
+end
+
+-- executes the run method in the package
+local run_action = function()
+	vim.cmd.messages('clear')
+
+	require(package_name).__run()
+end
+
+-- unload and run the function from the package
+function _G.Reload_and_run()
+	unload_packages()
+	run_action()
+end
+
+---@diagnostic disable-next-line: undefined-global
+local set_keymap = vim.api.nvim_set_keymap
+
+set_keymap('n', '<leader><leader>r', '<cmd>luafile dev/init.lua<cr>', {})
+set_keymap('n', '<leader><leader>w', '<cmd>lua Reload_and_run()<cr>', {})

lua/java.lua

@@ -0,0 +1,28 @@
+local server = require('java.server')
+local config = require('java.config')
+local settings = require('java.settings')
+
+---@class Java
+---@field config JavaConfig
+local M = {}
+
+---Setup the plugin
+---@param args JavaConfig
+M.setup = function(args)
+	config = vim.tbl_deep_extend('force', config, args or {})
+end
+
+---Returns the jdtls config
+---@param root_markers? string[] list of files to find the root dir of a project
+---@return LSPSetupConfig
+function M.get_config(root_markers)
+	return server.get_config({
+		root_markers = root_markers or config.root_markers,
+	})
+end
+
+M.__run = function()
+	settings.change_settings({})
+end
+
+return M

lua/java/config.lua

@@ -0,0 +1,20 @@
+---@class JavaConfig
+---@field workspace_root string path to the root of workspaces
+---@field root_markers string[] list of files that indicates the project root
+local config = {
+	workspace_root = vim.fn.stdpath('data') .. '/nvim-java/workspaces',
+
+	root_markers = {
+		'settings.gradle',
+		'settings.gradle.kts',
+		'pom.xml',
+		'build.gradle',
+		'mvnw',
+		'gradlew',
+		'build.gradle',
+		'build.gradle.kts',
+		'.git',
+	},
+}
+
+return config