-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
132 additions
and
17,000 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,169 1,7 @@ | ||
| # nwscript-lsp | ||
| # Arclight.py | ||
|
|
||
| [](https://badge.fury.io/py/nwscript-language-server) | ||
| These are tools related to the Arclight project | ||
|
|
||
| ## [nwscriptd](arclight/nwscriptd/README.md) | ||
|
|
||
| The LSP is built on [pygls](https://github.com/openlawlibrary/pygls) and [rollnw](https://github.com/jd28/rollnw). It is derived from the [Pygls Playground](https://github.com/openlawlibrary/pygls/tree/main/examples/vscode-playground) and aims, at this point, only to be a tested bed for implementing LSP features. A more robust implementation will come later maybe integrating with [nasher.cfg](https://github.com/squattingmonk/nasher#nashercfg). For now only the current document path will be added to the include path of the script context resman. | ||
|
|
||
| That the testbed extension is for vscode is out of simplicity, obviously plugins for any LSP client emacs, (neo)vim, etc will be supported. | ||
|
|
||
| Currently, it implements: | ||
| * Completions | ||
| * Hover | ||
| * Workspace Diagnostics | ||
| * Document Symbols | ||
| * Signature Help | ||
|
|
||
| ## Setup - Neovim | ||
|
|
||
| 1. Install required package | ||
| ``` | ||
| python -m pip install rollnw | ||
| ``` | ||
|
|
||
| 2. Install the language server | ||
| ``` | ||
| python -m pip install nwscript-language-server | ||
| ``` | ||
|
|
||
| Note: Sometimes "--break-system-packages" is needed to install | ||
| ``` | ||
| python -m pip install --break-system-packages rollnw | ||
| python -m pip install --break-system-packages nwscript-language-server | ||
| ``` | ||
|
|
||
| 3. Make sure ``nwscript-language-server`` is on your PATH! | ||
|
|
||
| 4. Setup neovim config - Obviously people's tastes will differ here and not all of it is fully implemented. | ||
| ```lua | ||
| require("config.lazy") | ||
|
|
||
| vim.api.nvim_exec( | ||
| [[ | ||
| autocmd FileType nwscript setlocal lsp | ||
| ]], | ||
| false | ||
| ) | ||
|
|
||
| local lspconfig = require("lspconfig") | ||
| local configs = require("lspconfig.configs") | ||
|
|
||
| if not configs.nwscript_language_server then | ||
| configs.nwscript_language_server = { | ||
| default_config = { | ||
| cmd = { "nwscript-language-server" }, | ||
| filetypes = { "nwscript" }, | ||
| root_dir = lspconfig.util.root_pattern(".git", "nasher.cfg"), | ||
| }, | ||
| } | ||
| end | ||
|
|
||
| lspconfig.nwscript_language_server.setup({ | ||
| on_attach = function(client, bufnr) | ||
| -- Custom on_attach function (optional) | ||
| print("nwscript language server attached!") | ||
|
|
||
| require("lsp_signature").on_attach({ | ||
| bind = true, -- This is mandatory, otherwise border config won't get registered. | ||
| handler_opts = { | ||
| border = "rounded", | ||
| }, | ||
| }, bufnr) | ||
|
|
||
| -- Enable snippet support (if your completion plugin supports snippets) | ||
| vim.bo[bufnr].expandtab = false | ||
| vim.bo[bufnr].shiftwidth = 4 | ||
| end, | ||
| settings = { | ||
| ["nwscript-language-server"] = { | ||
| disableSnippets = "on", | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| -- Global mappings. | ||
| -- See `:help vim.diagnostic.*` for documentation on any of the below functions | ||
| vim.keymap.set("n", "<space>e", vim.diagnostic.open_float) | ||
| vim.keymap.set("n", "[d", vim.diagnostic.goto_prev) | ||
| vim.keymap.set("n", "]d", vim.diagnostic.goto_next) | ||
| vim.keymap.set("n", "<space>q", vim.diagnostic.setloclist) | ||
|
|
||
| -- Use LspAttach autocommand to only map the following keys | ||
| -- after the language server attaches to the current buffer | ||
| vim.api.nvim_create_autocmd("LspAttach", { | ||
| group = vim.api.nvim_create_augroup("UserLspConfig", {}), | ||
| callback = function(ev) | ||
| -- Enable completion triggered by <c-x><c-o> | ||
| vim.bo[ev.buf].omnifunc = "v:lua.vim.lsp.omnifunc" | ||
|
|
||
| -- Buffer local mappings. | ||
| -- See `:help vim.lsp.*` for documentation on any of the below functions | ||
| local opts = { buffer = ev.buf } | ||
| vim.keymap.set("n", "gD", vim.lsp.buf.declaration, opts) | ||
| vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts) | ||
| vim.keymap.set("n", "K", vim.lsp.buf.hover, opts) | ||
| vim.keymap.set("n", "gi", vim.lsp.buf.implementation, opts) | ||
| vim.keymap.set("n", "<C-k>", vim.lsp.buf.signature_help, opts) | ||
| vim.keymap.set("n", "<space>wa", vim.lsp.buf.add_workspace_folder, opts) | ||
| vim.keymap.set("n", "<space>wr", vim.lsp.buf.remove_workspace_folder, opts) | ||
| vim.keymap.set("n", "<space>wl", function() | ||
| print(vim.inspect(vim.lsp.buf.list_workspace_folders())) | ||
| end, opts) | ||
| vim.keymap.set("n", "<space>D", vim.lsp.buf.type_definition, opts) | ||
| vim.keymap.set("n", "<space>rn", vim.lsp.buf.rename, opts) | ||
| vim.keymap.set({ "n", "v" }, "<space>ca", vim.lsp.buf.code_action, opts) | ||
| vim.keymap.set("n", "gr", vim.lsp.buf.references, opts) | ||
| vim.keymap.set("n", "<space>f", function() | ||
| vim.lsp.buf.format({ async = true }) | ||
| end, opts) | ||
| end, | ||
| }) | ||
| ``` | ||
|
|
||
| ## Setup - VS Code Extension debug mode | ||
|
|
||
| ### Install Server Dependencies | ||
|
|
||
| Open a terminal in the repository's root directory | ||
|
|
||
| 1. Create a virtual environment | ||
| ``` | ||
| python -m venv env | ||
| ``` | ||
|
|
||
| 2. Install pygls | ||
| ``` | ||
| python -m pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| ### Install Client Dependencies | ||
|
|
||
| Open terminal in the same directory as this file and execute following commands: | ||
|
|
||
| 1. Install node dependencies | ||
|
|
||
| ``` | ||
| npm install | ||
| ``` | ||
| 2. Compile the extension | ||
|
|
||
| ``` | ||
| npm run compile | ||
| ``` | ||
| Alternatively you can run `npm run watch` if you are going to be actively working on the extension itself. | ||
|
|
||
| ### Run Extension | ||
|
|
||
| 1. Open this directory in VS Code | ||
|
|
||
| 2. The playground relies on the [Python extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-python.python) for choosing the appropriate Python environment in which to run the example language servers. | ||
| If you haven't already, you will need to install it and reload the window. | ||
|
|
||
| 3. Open the Run and Debug view (`ctrl shift D`) | ||
|
|
||
| 4. Select `Launch Client` and press `F5`, this will open a second VSCode window with the `vscode-playground` extension enabled. | ||
|
|
||
| 5. You will need to make sure that VSCode is using a virtual environment that contains an installation of `pygls`. | ||
| The `Python: Select Interpreter` command can be used to pick the correct one. | ||
|
|
||
| Alternatively, you can set the `pygls.server.pythonPath` option in the `.vscode/settings.json` file | ||
| A language server for nwscript. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,119 @@ | ||
| # nwscriptd | ||
|
|
||
|
|
||
| The LSP is built on [pygls](https://github.com/openlawlibrary/pygls) and [rollnw](https://github.com/jd28/rollnw). It is derived from the [Pygls Playground](https://github.com/openlawlibrary/pygls/tree/main/examples/vscode-playground) and aims, at this point, only to be a tested bed for implementing LSP features. A more robust implementation will come later maybe integrating with [nasher.cfg](https://github.com/squattingmonk/nasher#nashercfg). For now only the current document path will be added to the include path of the script context resman. | ||
|
|
||
| That the testbed extension is for vscode is out of simplicity, obviously plugins for any LSP client emacs, (neo)vim, etc will be supported. | ||
|
|
||
| Currently, it implements: | ||
| * Completions | ||
| * Hover | ||
| * Workspace Diagnostics | ||
| * Document Symbols | ||
| * Signature Help | ||
|
|
||
| ## Setup - Neovim | ||
|
|
||
| 1. Install required package | ||
| ``` | ||
| python -m pip install rollnw | ||
| ``` | ||
|
|
||
| 2. Install the language server | ||
| ``` | ||
| python -m pip install nwscriptd | ||
| ``` | ||
|
|
||
| Note: Sometimes "--break-system-packages" is needed to install | ||
| ``` | ||
| python -m pip install --break-system-packages rollnw | ||
| python -m pip install --break-system-packages nwscriptd | ||
| ``` | ||
|
|
||
| 3. Make sure ``nwscriptd`` is on your PATH! | ||
|
|
||
| 4. Setup neovim config - Obviously people's tastes will differ here. | ||
| ```lua | ||
| require("config.lazy") | ||
|
|
||
| vim.api.nvim_exec( | ||
| [[ | ||
| autocmd FileType nwscript setlocal lsp | ||
| ]], | ||
| false | ||
| ) | ||
|
|
||
| local lspconfig = require("lspconfig") | ||
| local configs = require("lspconfig.configs") | ||
|
|
||
| if not configs.nwscript_language_server then | ||
| configs.nwscript_language_server = { | ||
| default_config = { | ||
| cmd = { "nwscriptd" }, | ||
| filetypes = { "nwscript" }, | ||
| root_dir = lspconfig.util.root_pattern(".git", "nasher.cfg"), | ||
| }, | ||
| } | ||
| end | ||
|
|
||
| lspconfig.nwscript_language_server.setup({ | ||
| on_attach = function(client, bufnr) | ||
| -- Custom on_attach function (optional) | ||
| print("nwscript language server attached!") | ||
|
|
||
| require("lsp_signature").on_attach({ | ||
| bind = true, -- This is mandatory, otherwise border config won't get registered. | ||
| handler_opts = { | ||
| border = "rounded", | ||
| }, | ||
| }, bufnr) | ||
|
|
||
| -- Enable snippet support (if your completion plugin supports snippets) | ||
| vim.bo[bufnr].expandtab = false | ||
| vim.bo[bufnr].shiftwidth = 4 | ||
| end, | ||
| settings = { | ||
| ["nwscriptd"] = { | ||
| disableSnippets = "on", | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| -- Global mappings. | ||
| -- See `:help vim.diagnostic.*` for documentation on any of the below functions | ||
| vim.keymap.set("n", "<space>e", vim.diagnostic.open_float) | ||
| vim.keymap.set("n", "[d", vim.diagnostic.goto_prev) | ||
| vim.keymap.set("n", "]d", vim.diagnostic.goto_next) | ||
| vim.keymap.set("n", "<space>q", vim.diagnostic.setloclist) | ||
|
|
||
| -- Use LspAttach autocommand to only map the following keys | ||
| -- after the language server attaches to the current buffer | ||
| vim.api.nvim_create_autocmd("LspAttach", { | ||
| group = vim.api.nvim_create_augroup("UserLspConfig", {}), | ||
| callback = function(ev) | ||
| -- Enable completion triggered by <c-x><c-o> | ||
| vim.bo[ev.buf].omnifunc = "v:lua.vim.lsp.omnifunc" | ||
|
|
||
| -- Buffer local mappings. | ||
| -- See `:help vim.lsp.*` for documentation on any of the below functions | ||
| local opts = { buffer = ev.buf } | ||
| vim.keymap.set("n", "gD", vim.lsp.buf.declaration, opts) | ||
| vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts) | ||
| vim.keymap.set("n", "K", vim.lsp.buf.hover, opts) | ||
| vim.keymap.set("n", "gi", vim.lsp.buf.implementation, opts) | ||
| vim.keymap.set("n", "<C-k>", vim.lsp.buf.signature_help, opts) | ||
| vim.keymap.set("n", "<space>wa", vim.lsp.buf.add_workspace_folder, opts) | ||
| vim.keymap.set("n", "<space>wr", vim.lsp.buf.remove_workspace_folder, opts) | ||
| vim.keymap.set("n", "<space>wl", function() | ||
| print(vim.inspect(vim.lsp.buf.list_workspace_folders())) | ||
| end, opts) | ||
| vim.keymap.set("n", "<space>D", vim.lsp.buf.type_definition, opts) | ||
| vim.keymap.set("n", "<space>rn", vim.lsp.buf.rename, opts) | ||
| vim.keymap.set({ "n", "v" }, "<space>ca", vim.lsp.buf.code_action, opts) | ||
| vim.keymap.set("n", "gr", vim.lsp.buf.references, opts) | ||
| vim.keymap.set("n", "<space>f", function() | ||
| vim.lsp.buf.format({ async = true }) | ||
| end, opts) | ||
| end, | ||
| }) | ||
| ``` |
2 changes: 1 addition & 1 deletion
2
nwscript_language_server/__init__.py → arclight/nwscriptd/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 1,4 @@ | ||
| """NWScript Language Server.""" | ||
| from importlib.metadata import version | ||
|
|
||
| __version__ = version("nwscript-language-server") | ||
| __version__ = version("arclight") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.