source-foundry / ufofmt

A fast, flexible UFO source file formatter based on the Rust Norad library

ufofmt

A fast, flexible UFO source file formatter based on the Rust Norad library

About

ufofmt is a Rust executable that supports customizable UFO source file formatting.

Default source file format

	glif	plist	fea
line endings	line feed	line feed	line feed
indentation spacing	single tab per level	single tab per level	n/a
XML declaration attributes	double quotes	double quotes	n/a

Custom formatting options are described in the Usage section below.

Installation

The installation process installs the ufofmt executable.

Install Rust, then follow the instructions below.

User installation

The following command installs the latest release build:

$ cargo install ufofmt

Upgrade a previous installation to a new release version with:

$ cargo install --force 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.

Custom source formatting options

Indentation spacing character type

Single tab indentation spacing per level is the default. Switch to space characters with the --indent-space command line option. See the section below to define the number of indentation spacing characters per level.

Indentation spacing character number per level

Define between 1 - 4 tab or space indentation chars with the --indent-number [NUMBER] command line option. See the section above to use spaces instead of tabs.

XML declaration quote style

XML declaration attributes are enclosed in double quotes by default. Convert to single quotes with the --singlequotes command line option.

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

ufofmt's Issues

Support custom single / double quote formatting in write files

norad's default is double quote formatting of the XML declaration attribute definitions in all UFO XML / plist files.

This is another source of multi-file diffs across UFO serializer tools. Some format the attribute definitions with single quotes.

The most flexible, useful formatting approach may be one where the user is permitted to define what they want?

This is not currently supported in the norad lib / its plist lib dependency TMK.

Related #18

Set up clippy for CI

It has some nice linting tips.

Serialize consistent cross-platform line endings across plist, glif, and feature files

Support line feed line endings as the cross-platform default across glif, plist, and fea files.

Requires linebender/norad#172 changes in norad

Normalize UFO with f64 floating point numbers (conversion from f32)

linebender/norad#164

Areas where f32 changes to f64 are documented in this PR linebender/norad#184

Evaluate UFO source format diffs across commonly used UFO serializers

Release on crates.io

Add option to limit floating point value precision

This is another source of diff across some UFO serializers out there

linebender/norad#189

Add option(s) to write to a different out UFO directory path

Default writes are in-place. It would be useful to provide the option to write to a different path.

norad default UFO serialization format

Thread to track the stability of the norad UFO write format.

Current status: unstable
norad v1.0 tracker: linebender/norad#195

Defaults:

• line endings: line feed (\n) across plist, glif, and fea files on all platforms
• spacing: single tab per level
• XML declaration header quote style around attributes: double quotes
• plist lib keys are sorted in lexicographic ordering by Unicode code point value (see #22 (comment))

	glif	plist	fea
line ending	line feed	line feed	line feed
XML declaration	double quotes	double quotes	n/a
indentation spacing	single tab	single tab	n/a

Improve invalid source path error messages

$ target/release/ufofmt 1 2 3 4 5
[ERROR] Read error in "4": Io(Os { code: 2, kind: NotFound, message: "No such file or directory" })
[ERROR] Read error in "5": Io(Os { code: 2, kind: NotFound, message: "No such file or directory" })
[ERROR] Read error in "3": Io(Os { code: 2, kind: NotFound, message: "No such file or directory" })
[ERROR] Read error in "1": Io(Os { code: 2, kind: NotFound, message: "No such file or directory" })
[ERROR] Read error in "2": Io(Os { code: 2, kind: NotFound, message: "No such file or directory" })

Create custom errors

Hm, you may want to lean more on Rust for the errors. You can make your own error container like https://github.com/linebender/norad/blob/master/src/error.rs#L11-L47 and then implement Display for it for formatting them for printing: https://github.com/linebender/norad/blob/master/src/error.rs#L150-L201

Originally posted by @madig in #5 (comment)

Display chained errors

I'm trying to make norad cleanly chain errors instead of hoisting the error messages form lower into wrapping error messages. Compare what anyhow does:

Error: Failed to read glyph file from 'C:\...\MutatorSansLightWide.ufo\glyphs\A_.glif'

Caused by:
    0: Failed to read or parse XML file
    1: Expecting </array> found </dict>

vs. ufofmt's

[ERROR] norad read error: C:\...\MutatorSansLightWide.ufo: Failed to read glyph file from 'C:\...\MutatorSansLightWide.ufo\glyphs\A_.glif'

Remove validators module

I thought that we may need multiple file path validators on this side but it looks like these may be available in custom error types to support error msgs here linebender/norad#146

Will remove the validators module and transition to a norad lib error handling approach if those changes land in a release.

Related #11

Support custom indentation space formatting in write files

Related linebender/norad#145

It might be useful for a user to define the type (tab, space) and length (one, two, four) of space formatting in the file writes. This would reduce text diffs relative to other tooling used in a UFO work pipeline. I'm not sure that it is necessary to be dogmatic about this issue. The goal is to achieve consistent formatting and that can be, at least partially, user-defined + project-specific?

This would require support in the norad project.