SCADFormat is a source code formatter / beautifier for OpenSCAD.
SCADFormat is, shall we say, "opinionated" in the way that it formats OpenSCAD code. In other words, there are no configuration options that alter the way code is formatted. That's not because I feel strongly that OpenSCAD code should be formatted a certain way - it's just that I haven't had time to implement options.
The easiest way to install is to download one of the pre-built binary releases:
https://github.com/hugheaves/scadformat/releases
Download the zip file for your operating system (windows.zip, linux,zip, macos.zip) and extract the contents.
SCADFormat is a command line tool.
SCADFormat can be run directly on a file by specifying the filename on the command line:
$ scadformat my-source.scad
INFO formatting file my-source.scad
In this mode, SCADFormat will overwrite the existing code with the formatted version. Note that SCADFormat creates a backup of the original file (with a .scadbak extension) before overwriting it.
SCADFormat can also read from stdin and write to stdout as follows:
$ scadformat <my-source.scad >my-source-formatted.scad
SCADFormat is written in Go, and uses the ANTLR v4 parser generator. You'll need to install both tools to build the sourcecode.
See https://go.dev/doc/install to install Go (v1.21 or later) and https://github.com/antlr/antlr4/blob/master/doc/getting-started.md to install ANTLR.
After installation, run the "antlr4" command to verify the command is available in your search path:
$ antlr4
ANTLR Parser Generator Version 4.13.1
-o ___ specify output directory where all output is generated
-lib ___ specify location of grammars, tokens files
-atn generate rule augmented transition network diagrams
...
Once ANTLR and Go are installed, the SCADFormat can be built as follows:
# Checkout source code
git clone https:;//github.com/hugheaves/scadformat
# Go into the respository
cd scadformat
# Generate ANTLR parser
go generate ./...
# Build the executable
go build -o scadformat cmd/main.go