Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.44 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.44 KB

Node.js CI License NPM package

openscad-parser

This package facilitates parsing, formatting and validating the OpenSCAD language using TypeScript and JavaScript.

Installation (formatter)

$ npm i -g openscad-parser

Usage:

$ scadfmt <file> # outputs the formatted OpenSCAD code to stdout

Installation (as a node module)

npm install openscad-parser

Features

  • Parsing and full error reporting (reports even better errors than the default OpenSCAD parser)
  • Symbol tree generation (VSCode "Outline" view)
  • Formatting (fully AST-aware, needs some more work with breaking up large vectors)
  • Semantic code completions (provides code completions for VSCode)
  • Jump to definition (provides a "Go to definition" context menu item)

I will soon release a vscode extension with full OpenSCAD support, it just needs some more work.

Documentation

The API documentation is available here.

License

MIT