numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-10-03 20:18:11 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: link to treefmt-nix instead of duplicating the examples

Browse Source
This commit is contained in:
zimbatm 2024-05-30 14:18:08 +02:00
parent fccb46367c
commit 7792121c95
1 changed files with 5 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
docs/configure.md
View File

@ -77,143 +77,12 @@ selectors such as `*` and `?`.
## Supported Formatters
Here is a list of all the formatters we tested. Feel free to send a PR to add other ones!
Any formatter that follows the [spec] is supported out of the box.
### [prettier](https://prettier.io/)
Already 60+ formatters are supported.
An opinionated code formatter that supports many languages.
To find example usage, take a look at <https://github.com/numtide/treefmt-nix/tree/main/examples>.
```toml
command = "prettier"
options = ["--write"]
includes = [
"*.css",
"*.html",
"*.js",
"*.json",
"*.jsx",
"*.md",
"*.mdx",
"*.scss",
"*.ts",
"*.yaml",
]
```
If you are a Nix users, you might also like <https://github.com/numtide/treefmt-nix> that uses Nix to pull the right formatter package as well and integrates both together in a seamless fashion.
### [Black](https://github.com/psf/black)
A python formatter.
```toml
command = "black"
includes = ["*.py"]
```
### [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code.
```toml
command = "clang-format"
options = [ "-i" ]
includes = [ "*.c", "*.cpp", "*.cc", "*.h", "*.hpp" ]
```
Note: This example focuses on C/C++ but can be modified to use with other languages.
### Elm
```toml
command = "elm-format"
options = ["--yes"]
includes = ["*.elm"]
```
### Go
```toml
command = "gofmt"
options = ["-w"]
includes = ["*.go"]
```
### [Ormolu](https://github.com/tweag/ormolu)
Haskell formatter. Make sure to use ormolu 0.1.4.0+ as older versions don't
adhere to the spec.
```toml
command = "ormolu"
options = [
"--ghc-opt", "-XBangPatterns",
"--ghc-opt", "-XPatternSynonyms",
"--ghc-opt", "-XTypeApplications",
"--mode", "inplace",
"--check-idempotence",
]
includes = ["*.hs"]
```
### [stylish-haskell](https://github.com/jaspervdj/stylish-haskell)
Another Haskell formatter.
```toml
command = "stylish-haskell"
options = [ "--inplace" ]
includes = [ "*.hs" ]
```
### [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
Nix code formatter.
```toml
command = "nixpkgs-fmt"
includes = ["*.nix"]
```
### rustfmt
```toml
command = "rustfmt"
options = ["--edition", "2018"]
includes = ["*.rs"]
```
### [rufo](https://github.com/ruby-formatter/rufo)
Rufo is an opinionated ruby formatter. By default it exits with status 3 on
file change so we have to pass the `-x` option.
```toml
command = "rufo"
options = ["-x"]
includes = ["*.rb"]
```
### cargo fmt
`cargo fmt` is not supported as it doesn't follow the spec. It doesn't allow
to pass arbitrary files to be formatted, which treefmt relies on. Use `rustfmt`
instead (which is what `cargo fmt` uses under the hood).
### [shfmt](https://github.com/mvdan/sh)
A shell code formatter.
```toml
command = "shfmt"
options = [
"-i",
"2", # indent 2
"-s", # simplify the code
"-w", # write back to the file
]
includes = ["*.sh"]
```
### terraform
terraform fmt only supports formatting one file at the time. See
https://github.com/hashicorp/terraform/pull/28191
[spec]: formatter-spec