ufofmt

A highly opinionated UFO source file formatter based on the Norad library

Installation

The installation process installs the ufofmt executable.

User installation

The following command installs the latest release build:

$ cargo install ufofmt

Developer installation

The following command installs a build from the latest commit in the main branch of the repository:

$ git clone https://github.com/source-foundry/ufofmt.git $ cd ufofmt && cargo install --path .

Usage

Pass one or more UFO source directory paths to the ufofmt executable:

$ ufofmt [OPTIONS] [UFO PATH 1] ... [UFO PATH N]

Use the command ufofmt --help to view all available command line options.

Contributing

Contributions to the project are welcomed! All contributions are accepted under the project license defined in the License section below.

Source contributions

Test local changes in the executable with:

$ cargo run -- [ARGS]

Add tests to cover your source changes and run the test suite locally with:

$ cargo test

Please open a GitHub pull request with your change proposal.

Documentation contributions

Please build and review your documentation changes locally with:

$ cargo doc --open

Please open a GitHub pull request with your change proposal.

License

Apache License v2.0