https://github.com/EmmyLua/EmmyLua-LanguageServer
https://github.com/EmmyLua/EmmyLua-LanguageServer
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/EmmyLua/EmmyLua-LanguageServer
- Owner: EmmyLua
- Created: 2018-03-22T04:19:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T21:32:26.000Z (over 1 year ago)
- Last Synced: 2024-11-23T06:34:11.253Z (about 1 year ago)
- Language: Java
- Size: 2.06 MB
- Stars: 153
- Watchers: 8
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Emmy Lua Language Server
Use [EmmyLuaAnalyzer](https://github.com/CppCXY/EmmyLuaAnalyzer) Please
CI status | Download
---------- | ----------
[](https://ci.appveyor.com/project/EmmyLua/emmylua-languageserver)|[EmmyLua-LS-all.jar](https://ci.appveyor.com/project/EmmyLua/emmylua-languageserver/build/artifacts)
Emmy lua Language server have lots of features for lua language, including:
* Find usages
* Go to definition
* Comment based type/class annotation
* Basic completion
For an exhaustive list of features see the [intellij plugin description](https://github.com/EmmyLua/IntelliJ-EmmyLua).
## Requirements
* [install JDK](https://www3.ntu.edu.sg/home/ehchua/programming/howto/JDK_Howto.html)
## Building
Run from root:
$ gradlew shadowJar
The `EmmyLua-LS-all.jar` file will be created in `EmmyLua-LanguageServer/EmmyLua-LS/build` .
## Running Server
To run the language server use:
$ java -cp EmmyLua-LS-all.jar com.tang.vscode.MainKt
## Adding to an Sublime
Just pass the instantiating instruction to the LSP plugin.
Example: adding EmmyLua to [SublimeText](https://www.sublimetext.com/) with [Sublime-LSP](https://github.com/tomv564/LSP):
* install the `LSP` plugin in sublime
* add emmy as a client to `LSP.sublime-settings`:
```json
{
"clients":
{
"emmy":
{
"command":
[
"java",
"-cp",
"/*",
"com.tang.vscode.MainKt"
],
"enabled": true,
"languageId": "lua",
"scopes":
[
"source.lua"
],
"syntaxes":
[
"Packages/Lua/Lua.sublime-syntax"
]
}
}
}
```
## Adding to Emacs
you can use [lsp-lua-emmy](https://github.com/phenix3443/lsp-lua-emmy) as lsp client.
add following code to your `~/.emacs` or `.emacs.d/init.el` .
``` emacs-lisp
(use-package lsp-mode
:ensure t
:commands lsp
:hook ((lua-mode) . lsp)
:config
)
(use-package company-lsp
:ensure t
:after lsp-mode
:config
(setq company-lsp-enable-recompletion t)
(setq lsp-auto-configure nil) ;该功能会自动执行(push company-lsp company-backends)
)
(use-package lsp-lua-emmy
:demand
:ensure nil
:load-path "~/github/lsp-lua-emmy"
:hook (lua-mode . lsp)
:config
(setq lsp-lua-emmy-jar-path (expand-file-name "EmmyLua-LS-all.jar" user-emacs-directory))
)
(defun set-company-backends-for-lua()
"Set lua company backend."
(setq-local company-backends '(
(
company-lsp
company-lua
company-keywords
company-gtags
company-yasnippet
)
company-capf
company-dabbrev-code
company-files
)))
(use-package lua-mode
:ensure t
:mode "\\.lua$"
:interpreter "lua"
:hook (lua-mode . set-company-backends-for-lua)
:config
(setq lua-indent-level 4)
(setq lua-indent-string-contents t)
(setq lua-prefix-key nil)
)
```
work with company-mode and lua-mode in Emacs 26.1:
## Adding to Vim/NeoVim
Install [Vim-EasyComplete](https://github.com/jayli/vim-easycomplete). Run `InstallLspServer` after opening a lua file with vim.