wasilibs / go-prettier

go-prettier

go-prettier is a distribution of prettier, that can be built with Go. It does not actually reimplement core functionality of prettier in Go (though does reimplement the CLI), instead packaging it with the lightweight JS runtime QuickJS, and executing with the pure Go Wasm runtime wazero. This means that go install or go run can be used to execute it, with no need to rely on separate package managers such as pnpm, on any platform that Go supports.

Prettier can format files like YAML and Markdown which are commonly used in Go projects, and integrates well with IDEs like VSCode. This project is primarily designed for Go, or other non-JS projects, that would like to still use prettier to format such non-logic files.

Include prettier plugins

External plugins are not supported because the entire bundle must be compiled to Wasm. We currently bundle all standard prettier plugins (e.g., JS, YAML, Markdown) along with the following third-party plugins:

• prettier-plugin-sh: shell, Dockerfile, properties, etc

Behavior differences

• If .gitignore is specified as an ignore path (included by default), all .gitignore files found searching up to a .git directory will be used. Prettier only looks in the current directory. We have changed the behavior since it seems most intuitive for .gitignore to be applied in the same way as git. This will generally result in less files to process without changing the result on actual source-controlled files. .prettierignore or any other ignore file will only be resolved against the current directory.
• External plugins are not supported.
• Caching is not supported.
• Config must be JSON, YAML, or TOML. JS configs are not supported.
• Formatting options via CLI flags are not supported. Use a prettier config to make sure it is reflected in IDE integrations.
• Performance is worse for many files. The intent is to format a few yaml or markdown type files in a Go repository but not to replace formatting in a full NodeJS project. It is recommended to specify globs for the files that should be formatted rather than relying on auto-detection on a large directory.
• Other minor features, mostly for editor integration, are not supported. Check the CLI usage for what flags are supported.

Installation

Precompiled binaries are available in the releases. Alternatively, install the plugin you want using go install.

go install github.com/wasilibs/go-prettier/cmd/prettier@latest

To avoid installation entirely, it can be convenient to use go run

go run github.com/wasilibs/go-prettier/cmd/prettier@latest -o formatted.md unformatted.md