Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install typstyle

It will make the typstyle command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall typstyle uninstalls.

Back to the crate overview.

Readme

typstyle

A beautiful and reliable code formatter for Typst.

Try Online First

Try typstyle instantly in your browser: 🎮 Playground

The playground runs the latest version of typstyle with live formatting. Perfect for testing formatting behavior before installing locally.

Installation and Usage

Use as a CLI

Installation

You can install typstyle using any of the following methods:

Download the binary from the release page.
Install it from your package manager: https://repology.org/project/typstyle/versions.
1. Notably, typstyle is available in Archlinux CN repo.
Install using cargo-binstall:
```
cargo binstall typstyle
```
Install it with cargo:
```
cargo install typstyle --locked
```

CLI Usage

Beautiful and reliable typst code formatter

Usage: typstyle [OPTIONS] [INPUT]...

Arguments:
  [INPUT]...  List of files or directories to format [default: stdin]

Options:
  -i, --inplace  Format the file in place
      --check    Run in 'check' mode. Exits with 0 if input is formatted correctly. Exits with a non-zero status code if formatting is required
      --diff     Run in 'diff' mode. Shows unified diff of what formatting changes would be made. Exits with 0 if input is formatted correctly. Exits with a non-zero status code if formatting is required
  -h, --help     Print help
  -V, --version  Print version

Format Configuration:
  -l, --line-width <LINE_WIDTH>      Maximum width of each line [default: 80] [aliases: column] [short aliases: c]
  -t, --indent-width <INDENT_WIDTH>  Number of spaces per indentation level [default: 2] [aliases: tab-width]
      --no-reorder-import-items      Disable alphabetical reordering of import items
      --wrap-text                    Wrap text in markup to fit within the line width, and collapse spaces in markup

Debug Options:
  -a, --ast         Print the AST of the input file
  -p, --pretty-doc  Print the pretty document
      --timing      Show elapsed time taken by the formatter

Log Levels:
  -v, --verbose  Enable verbose logging
  -q, --quiet    Print diagnostics, but nothing else

Examples

Format a file in place:
```
typstyle -i file.typ
```
Format a file and print the result to stdout:
```
typstyle file.typ
```
Format multiple files in place:
```
typstyle -i file1.typ file2.typ dir/
```
Format all files in a directory:
```
typstyle -i dir
```

Read from stdin and print the result to stdout:

cat file.typ | typstyle > file-formatted.typ

Use in your editor

Typstyle has been integrated into tinymist. You can use it in your editor by installing the tinymist plugin and set tinymist.formatterMode to typstyle.

Use in typst.app

Checkout typstyle-tampermonkey, a userscript that integrates typstyle into the typst.app editor.

Use as a web app

Try the playground at: https://typstyle-rs.github.io/typstyle/playground

The playground integrates the latest version of typstyle. If you encounter formatting issues, please verify them in the playground first before reporting bugs.

Use as a Library

Rust: https://crates.io/crates/typstyle-core
WebAssembly: https://www.npmjs.com/package/@typstyle/typstyle-wasm-bundler

Use as a GitHub Action

The typstyle-action maintained by @grayespinoza can install and run typstyle in a GitHub Action.

Features & Design

Design Goals

Opinionated: We want to have a consistent style across all codebases.
Code only: We want to format only the code. Contents should be left untouched as much as possible.
Convergence: Running the formatter twice should not change the code.
Correctness: The formatter should not change the looking of the rendered output.

Escape Hatch

If you find typstyle is not working as expected, you can use // @typstyle off or /* @typstyle off */ to disable the formatter on the next node of code.

Typstyle also gives up formatting part of the code if it is not able to format it correctly. Specifically, it will print that part as is if:

contains syntax error
contains syntaxes that are not supported by the formatter

And please let us know the issue by creating an issue on the GitHub repository

Testing

We maintain a comprehensive suite of tests to ensure the correctness and reliability of typstyle.

Convergence tests: Format result must be the same when applied twice.
Snapshot tests: Format result are stored in the snapshots directory and are compared to the current result when running the tests.
Correctness test: We compare the rendered output of the code before and after formatting and ensure they are the same.
E2E Correctness test: We collect a bunch of typst code repo including tablex, cetz, fletcher... and format them to ensure: (a) the format result converges, and (b) the rendered output is the same.
CLI tests: We ensure that the CLI arguments can correctly control the behavior of the program, and the output is desirable.

Benchmark

We provide benchmarks for node attribute computation and pretty printing. Typically, it can format a large document (given parsed source) within 5ms (e.g., tablex.typ with ~3000 lines).

We also have continuous benchmarking for each commit on master branch. See https://typstyle-rs.github.io/typstyle-bench-results/dev/bench/.

Why Another Formatter?

Why there is a need for another formatter? We already have typstfmt, typstfmt, prettypst. Why another one?

Typstyle started because I had a bunch of ideas on how to improve typst source code formatting but kept finding typstfmt wasn't a good codebase to explore them with. Namely:

I wanted to use Wadler's pretty printer (implemented by pretty.rs) to get consistent and beautiful output for any width. (Note that it is the same technique used in the prettier formatter)
I didn't have much energy to maintain a bunch combination of configuration options. It turns out to be very hard to make everything correct. So I decided to make it opinionated.
I wanted to experiment with more testing techniques and make sure the formatter is correct.

So I decided to write something from scratch. I started it about half a year ago and kept working on it in my spare time. Currently it lacks some advanced features but it is already usable for most of the cases. I hope you like it!

Documentation

See https://typstyle-rs.github.io/typstyle/.

Roadmap

See the tracking issue.

Known Issues

You tell us! Bad formatting? Incorrect output? Please create an issue on the GitHub repository!

We've set up comprehensive test suites to ensure the correctness of the formatter. If you find any issues, please let us know! And we can add more tests to prevent the issue from happening again.

Contributing

See CONTRIBUTING.md for details.