openscad-LSP

A LSP (Language Server Protocol) server for OpenSCAD.

inspired by dzhu/openscad-language-server

Tested with VSCode on Mac and Windows. [vscode extension]

Tested with lsp-mode on Emacs on Linux by @Lenbok.

Features

• builtin function/module documents
• code and path auto-completion
• jump to definition
• code snippets
• function/module signatures on hover
• document symbols
• formatter, utilizing clang-format, you need install it yourself, it is not built-in.
• hover and suggestion documentation, read from comments before the function/module.
  

IDE plugins

| IDE | Plugin | Note | | --- | ------ | ----- | | Neovim | mason.nvim | Only tested on Mac and Linux | | Neovim | nvim-lspconfig | Only tested on Mac and Linux | | VS Code | openscad-language-support | Only tested on Mac and Windows |

Install

openscad-LSP is written in Rust, in order to use it, you need to install Rust toolchain.

{.sh} cargo install openscad-lsp

Build

{.sh} cd openscad-LSP cargo build --release

Usage

The server communicates over TCP socket (127.0.0.1:3245).

``` USAGE: openscad-lsp [OPTIONS]

OPTIONS: --builtin external builtin functions file path, if set, the built-in builtin functions file will not be used [default: ] --fmt-exe clang format executable file path [default: clang-format] --fmt-style LLVM, GNU, Google, Chromium, Microsoft, Mozilla, WebKit, file [default: Microsoft] -h, --help Print help information --ignore-default exclude default params in auto-completion --ip [default: 127.0.0.1] -p, --port [default: 3245] --stdio use stdio instead of tcp -V, --version Print version information ```

To change the config during running, you can send notification workspace/didChangeConfiguration

js // example { "settings": { "openscad": { "search_paths": "/libs", "fmt_exe": "/usr/bin/clang-format", "fmt_style": "file", "default_param": true } } }