NOTICE: Because clang-format produces poor formatting results for OpenSCAD, we have completely removed support for clang-format and switched to the new formatter topiary.

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/openscad/tree-sitter-openscad

Features

• builtin function/module documents
• formatter, utilizing topiary.
• 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.inlinePreview: When enabled, shows previews directly in VSCode rather than opening externally.

• 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.fmtIdent: The indentation string. Defaults to " " if not provided. Any string can be provided, but in most instances will be some whitespace: " ", " ", or "\t".

• scad-lsp.fmtQueryFilePath: The query file used for topiary formatting, more detail refer to topiary.

• 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