SCADFormat

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.

• SCADFormat
  • Changes in this fork
  • Installation
  • Usage
    • Specifying a filename
    • Read from stdin/write to stdout
    • Format all .scad recursively
  • Building
    • Install prerequisites
    • Checkout source
    • Build with make
    • Build without make

---

Changes in this fork

Compared to hugheaves/scadformat not much has changed. All I did was increase the indent size from 2 to 4, since that's also my personal preference, and the VSCode extension I use has a hard time with 2 indents. Other than that, I also removed the creation of the backup file (files suffixed with a date and .scadbak), as my directory got cluttered with old backups quite quickly, even though I had no use for those files.

Installation

The easiest way to install is to download one of the pre-built binary releases. I can only provide a Linux x64 build tho. Check out the release page for that.

Usage

SCADFormat is a command-line tool.

Specifying a filename

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

Read from stdin/write to stdout

SCADFormat can also read from stdin and write to stdout as follows:

scadformat <my-source.scad >my-source-formatted.scad

Format all .scad recursively

Format all .scad files in the directory recursively. Note that if the scadformat command is not in your search PATH, you'll need to specify the full path to scadformat after the -exec- option. (e.g., -exec $HOME\scasformat\scadformat)

find . -type f -name "*.scad" -exec scadformat "{}" \;

Building

Install prerequisites

SCADFormat is written in Go, and uses the ANTLR v4 parser generator. You'll need to install both tools to build the source code.

See this to install Go (v1.21 or later) and this to install ANTLR.

python3 -m venv venv
. ./venv/bin/activate
pip install antlr4-tools

After installation, run the antlr4 command to verify the command is available in your search pathm which should display something like this:

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
...

Checkout source

Checkout the source code and cd into the scadformat directory:

git clone https://github.com/hugheaves/scadformat
cd scadformat

Build with make

If you have GNU Make (or a compatible make utility installed), you can build the program just by running the make command. You should see output similar to the following:

go generate ./...
patching file internal/parser/openscad_base_visitor.go
go test ./...
?       github.com/hugheaves/scadformat [no test files]
?       github.com/hugheaves/scadformat/cmd [no test files]
?       github.com/hugheaves/scadformat/internal/logutil    [no test files]
?       github.com/hugheaves/scadformat/internal/parser [no test files]
ok      github.com/hugheaves/scadformat/internal/formatter  (cached)
go build cmd/scadformat.go

Build without make

If you don't have make installed (i.e., on Windows), you can still build the program by running the necessary commands manually:

• Generate ANTLR parser

  go generate ./...

• Build the executable

  go build -o scadformat cmd/scadformat.go

• Run tests

  go test -v ./...

• Run on a file

  ./scadformat ./internal/formatter/testdata/solo_adapter.scad