https://github.com/Leathong/openscad-support-vscode

OpenSCAD language support for VSCode
https://github.com/Leathong/openscad-support-vscode

language-server openscad openscad-language-support vscode vscode-extension

Last synced: about 1 year ago
JSON representation

OpenSCAD language support for VSCode

• Host: GitHub
• URL: https://github.com/Leathong/openscad-support-vscode
• Owner: Leathong
• License: gpl-3.0
• Created: 2022-04-30T12:09:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-05-27T08:44:53.000Z (about 1 year ago)
• Last Synced: 2025-05-27T09:51:20.899Z (about 1 year ago)
• Topics: language-server, openscad, openscad-language-support, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 117 MB
• Stars: 89
• Watchers: 4
• Forks: 8
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
> **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](https://github.com/tweag/topiary).**

# OpenSCAD Language Support

VS Code Marketplace: [[OpenSCAD Language Support](https://marketplace.visualstudio.com/items?itemName=Leathong.openscad-language-support)]

Visual Studio Code extension utilizing the [OpenSCAD language server](https://github.com/Leathong/openscad-LSP.git)，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: 

### Related projects

- The language server, written in Rust: 

- 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](https://github.com/Antyos/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.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](https://github.com/tweag/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](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_an_external_Editor_with_OpenSCAD)