Leathong / openscad-support-vscode

OpenSCAD language support for VSCode

Note: I will be busy with work in the months. So only some critical bugs will be fixed and the development of new features will be delayed.

OpenSCAD Language Support

VS Code Marketplace: [OpenSCAD Language Support]

Visual Studio Code extension utilizing the OpenSCAD language server，providing language support for OpenSCAD. The extension is available on Mac, Linux, and Windows. If you like this extension, please light up the stars in GitHub.

Project is available at: https://github.com/Leathong/openscad-support-vscode

Related projects

• The language server, written in Rust: https://github.com/Leathong/openscad-LSP.git
• The parser, https://github.com/bollian/tree-sitter-openscad

Features

• builtin function/module documents
• formatter, you need install clang-format yourself
• jump to definition
• code auto-completion
  
• path auto-completion
  
• document symbols (cmd + shift + o on Mac)
• hover information
  
• simple error diagnosis
• preview and CheatSheet (from vscode-openscad)

Settings

• scad-lsp.searchPaths:
  The extension will read OPENSCADPATH Environment Variable to point to the library(s), or you can set search paths by this property.

• scad-lsp.launchPath:
  Command to launch openscad. Either the path to the openscad executable, or just "openscad" (no quotes) if the executable is in the path. If left blank, it will use the default path for your system noted below:

  • Windows: C:\\Program Files\\Openscad\\openscad.exe
  • MacOS: /Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD
  • Linux: openscad (Automatically in path).

• scad-lsp.fmtStyle:
  clang format style, options: LLVM, GNU, Google, Chromium, Microsoft, Mozilla, WebKit, file. If you'd like to customize your style, set this property to file, and place your .clang-format file to your source code directory.

• scad-lsp.fmtExePath:
  clang format executable path.

• scad-lsp.defaultParam:
  if true, will include default params in auto-completion.

TODO

• symbol rename.

For more information, see: Using an external Editor with OpenSCAD