/idea-openscad

OpenSCAD language plugin for the IntelliJ platform.

Primary LanguageJava

Java CI

OpenSCAD Language Support for IntelliJ Platform

This is a plugin for the products based on IntelliJ Platform (Idea, PyCharm, etc.) for the OpenSCAD language. It supports :

  • syntax highlighting
  • formatting
  • code folding support
  • structure views
  • code completion
  • code navigation
  • library support
  • actions for opening OpenSCAD and exporting model

A color scheme coming close to what the built-in OpenSCAD editor uses is provided and can be selected in the preferences : Editor/Color Scheme/OpenSCAD/Scheme/OpenSCAD.Default.

Formatting options are configurable in the preferences : Editor/Code Style/OpenSCAD.

OpenSCAD executable is searched on standard paths. If your installation is custom, configure it in the preferences : Languages & Frameworks/OpenSCAD Language. Global libraries are automatically detected.

It is planned to implement the rest of IntelliJ Platform features :

  • refactorings;
  • intention actions;
  • etc.

How to contribute

Issues and new feature requests

For bugs and new features, create an issue.

Simple examples to reproduce the issue or the expected behavior will be a great help.

Pull requests

All PR are welcomed ! If they are linked to an issue please refer to it.

Test development version

We have implemented GitHub actions so that the plugin gets automatically packaged by GitHub.

To test a specific version, go in the Actions tab. Click on the execution related to the branch or the sha-1 you want to test, download the zip file and unzip it to get the plugin zip distribution archive inside main zip file.

In IntelliJ, go in File -> Settings... -> Plugins -> configuration icon -> Install Plugin from Disk... and select the distribution zip file you have unzipped.

Restart IntelliJ to test development version.

Not that you can also get a distribution zip files from forks to test PRs.