dzhu / openscad-language-server Goto Github PK

Hi there. I stumbled across this yesterday while searching to see if there was tree-sitter support for openscad (hoping for some structural editing support in emacs). I've previously been using the openscad LSP from the PR, so was keen to try yours out. I found it was very easy to get going, fast, and doesn't negatively interact with my normal openscad workflow. The main features I'm missing are support for:

• jumping to definition (textDocument/definition)
• find references (textDocument/references)
• detection of undefined variables/modules (the LSP PR does this, I'm not sure how easy it is to add to your server).

As a side note, I also noticed that your (upstream) grammar wants a trailing semicolon on use/include lines such as:

use <Lenbok_Utils/utils.scad>

whereas openscad itself does not care.

Hi @dzhu

Are you interested in supporting hover documentation (at least for builtins)? I've built a proof of concept and it looks like this:

The documentation is stored in builtins.scad as comments:

// Creates a cube in the first octant. When center is true, the cube is centered on the origin.
// Argument names are optional if given in the order shown here. 
//
// Parameters:
// - size
//    single value, cube with all sides this length
//    3 value array [x,y,z], cube with dimensions x, y and z.
// - center
//    false (default), 1st (positive) octant, one corner at (0,0,0)
//    true, cube is centered at (0,0,0)
module cube(size, center) {}

If you are interested, I can open a PR.