Registry / devops / openscad-format

openscad-format

library1.0.0jsnpmunverified

An opinionated source code formatter for the OpenSCAD language (v1.0.0). It packages clang-format internally for most platforms, so no separate clang-format installation is needed. Supports configuration via .openscad-format files and offers features like javadoc comment templates. Suitable for developers working with OpenSCAD files.

devops

npm install openscad-format

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OPENSCAD-FORMAT

openscad-format

devopsjavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

openscad-format (CLI)

✓ openscad-format -i input.scad -o output.scad

✗ require('openscad-format')

This package is a CLI tool, not a library. Importing via require is not supported for programmatic use.

Formats all .scad files recursively in place using the default config.

openscad-format -i './**/*.scad' -f

Debug

Known issues

gotchaRequires Node.js >=8.0.0 due to engine constraint.

fix

Upgrade Node.js to version 8 or higher.

affects: <8.0.0

gotchaPackage bundles clang-format, which may not be available for all platforms (e.g., some Linux ARM variants).

fix

Install clang-format separately or use a platform that is supported by the bundled binary.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'clang-format'

The bundled clang-format binary is missing or not installed correctly.

fix

Reinstall openscad-format globally: npm install -g openscad-format

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

eslint-config-airbnb-baseoptionalPeer dependency for development linting, not needed at runtime.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/Maxattax97/openscad-format ↗

packageopenscad-format ↗

homepagehttps://github.com/Maxattax97/openscad-format#readme ↗