Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tigersoldier/lsp-javacomp
Emacs Language Server client backed by JavaComp
https://github.com/tigersoldier/lsp-javacomp
emacs java language-server-protocol
Last synced: about 2 months ago
JSON representation
Emacs Language Server client backed by JavaComp
- Host: GitHub
- URL: https://github.com/tigersoldier/lsp-javacomp
- Owner: tigersoldier
- License: gpl-3.0
- Created: 2017-10-03T07:42:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-11T05:22:36.000Z (over 2 years ago)
- Last Synced: 2024-06-15T13:33:32.872Z (3 months ago)
- Topics: emacs, java, language-server-protocol
- Language: Emacs Lisp
- Size: 27.3 KB
- Stars: 25
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://melpa.org/#/lsp-javacomp)
# Emacs Language Server client backed by [JavaComp][javacomp]
lsp-javacomp is a [lsp-mode][lsp-mode] client that provides Java code-completion
and other IDE features for Emacs. It's backed by [JavaComp][javacomp].
## Usage
### Enable lsp-javacomp
lsp-javacomp is available on [MELPA]. To install it, first [setup
MELPA][setup-melpa], then M-x `package-install` RET
`lsp-javacomp` RET.
After installing it, add the snippet below to your `.emacs` file to enable it
for `java-mode`:
```elisp
(require 'lsp-javacomp)
(add-hook 'java-mode-hook #'lsp-javacomp-enable)
```
I recommend using lsp-javacomp in with [company-lsp][compan-lsp]. If you are
lazy-loading company-lsp, make sure it's loaded before calling
`lsp-javacomp-enable`. You can lazily load lsp-javacomp and company-lsp with
[use-package][use-package]:
```elisp
(use-package lsp-javacomp
:init
(add-hook 'java-mode-hook
(lambda ()
;; Load lsp-javacomp before enabling lsp, so that javacomp client
;; is registed.
(require 'lsp-javacomp')
(lsp)
;; Use company-lsp as the company completion backend
(set (make-variable-buffer-local 'company-backends) '(company-lsp))
;; Optional company-mode settings
(set (make-variable-buffer-local 'company-idle-delay) 0.1)
(set (make-variable-buffer-local 'company-minimum-prefix-length) 1)))
;; Optional, make sure JavaComp is installed. See below.
:config
(lsp-javacomp-install-server))
```
### Install/Update JavaComp server
After installing lsp-javacomp to your Emacs, you can use `M-x
lsp-javacomp-install-server` to install the JavaComp server.
If you want to update to the latest version of JavaComp, you can use `M-x
lsp-javacomp-update-server`.
Alternatively, you can build or download the jar file manually. You must rename
the jar file to `javacomp.jar` and put it into the directory specified by the
`lsp-javacomp-server-install-dir` variable. The default value of
`lsp-javacomp-server-install-dir` is `~/.emacs.d/javacomp/`.
### Complete using `completion-at-point`
If you don't use company-lsp, you can use the vanilla `completion-at-point`
implemented by lsp-mode.
Run `M-x completion-at-point` in a .java file buffer to get completion
candidates. The default key binding is `C-M-i`.
### Customizing JavaComp server behavior
You can provide initialization options to JavaComp by setting the following
variables:
* `lsp-javacomp-server-log-path`
* `lsp-javacomp-server-log-level`
* `lsp-javacomp-server-ignore-paths`
* `lsp-javacomp-server-type-index-files`
If there is `javacomp.json` file in the project root, the corresponding options
will be overridden if specified in the `javacomp.json` file.
[company-lsp]: http://https://github.com/tigersoldier/company-lsp/
[javacomp]: https://github.com/tigersoldier/JavaComp
[lsp-mode]: https://github.com/emacs-lsp/lsp-mode
[melpa]: https://melpa.org
[setup-melpa]: https://melpa.org/#/getting-started
[use-package]: https://github.com/jwiegley/use-package