sane-fmt

Opinionated code formatter for TypeScript and JavaScript.

Rules

Prefer single quotes.
No semicolons.
Trailing commas for multi-line.
No function parentheses for arrow function with single argument.
Multi-line union and intersection use consistent leading separator.

Preview.

Read rules/mod.rs and tests/rules.rs for more information.

Installation

Download prebuilt binaries

Go to the release page.

From crates.io

cargo install sane-fmt

From NPM

WASM (all platform)

npm i -g @sane-fmt/wasm32-wasi

Native binaries

The WASM package while work on all platform, it is slow to start. For better speed, install one of the following packages instead:

For Linux: * @sane-fmt/x8664-unknown-linux-gnu * @sane-fmt/x8664-unknown-linux-musl

For macOS: * @sane-fmt/x86_64-apple-darwin

For Windows: * @sane-fmt/x8664-pc-windows-gnu * @sane-fmt/x8664-pc-windows-msvc

From Arch User Repository

Download source and compile

yay -S sane-fmt

Download prebuilt binary

yay -S sane-fmt-bin

Usage

Format all TypeScript and JavaScript files

sh sane-fmt --write

This command would reformat all TypeScript and JavaScript files.

Check for all TypeScript and JavaScript files

sh sane-fmt

This command would check all TypeScript and JavaScript files.

Format only some files

sh sane-fmt --write foo.ts bar.js

This command would only reformat foo.ts and bar.js.

Format all TypeScript and JavaScript files in a directory

sh sane-fmt --write src/

This command would reformat all TypeScript and JavaScript files within src/ directory.

GitHub Actions

sane-fmt also provides a convenient way to integrate with GitHub Actions. To use it, simply add --log-format=github-actions, like so:

sh sane-fmt --log-format=github-actions --details=diff

When this command is executed within a GitHub Actions runner, it will: * Annotates unformatted files. * Group diffs by file names (if --details=diff). * Export total, changed, and unchanged as outputs.

Recommendation: This action will install sane-fmt and execute it for you.

Print help message

sh sane-fmt --help

Become a Patron

My Patreon Page.

Frequently Asked Questions

What is this program?

sane-fmt is an opinionated code formatter for TypeScript and JavaScript powered by dprint. You can think of it as a portable Dprint config file that is always up-to-date.

What is the point of this program?

I want to apply a single, consistent formatting for all my codes regardless of environment without complex tooling.

I have considered using Prettier or Dprint, but that would mean having to set up Node.js even in non-Node.js environments. I also don't like copying my config files back-and-forth to update them.

On the other hand, setting up sane-fmt is simple: just download the binary.

How to customize the rules?

Customization is antithetical to the purpose of this project, and as such, the sane-fmt command does not have customization capability.

However, if you still want a copy of sane-fmt with your own customized rules, do one of the following: * Use sane-fmt as a library crate. * Fork this project. * Just use dprint.