* [Atom](atom.md)
* Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.
+
## Checking style on a CI server
To keep your code base consistently formatted, it can be helpful to fail the CI build
-when a pull request contains unformatted code. Using `--write-mode=check` instructs
+when a pull request contains unformatted code. Using `--check` instructs
rustfmt to exit with an error code if the input is not formatted correctly.
-It will also print any found differences.
+It will also print any found differences. (Older versions of Rustfmt don't
+support `--check`, use `--write-mode diff`).
A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
```yaml
language: rust
+rust:
+- nightly
before_script:
- rustup component add rustfmt-preview
script:
-- cargo fmt --all -- --write-mode=check
+- cargo fmt --all -- --check
- cargo build
- cargo test
```
+See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
+for more info.
+
## How to build and test
`cargo build` to build.
* For things you do not want rustfmt to mangle, use one of
```rust
- #[rustfmt_skip] // requires nightly and #![feature(custom_attribute)] in crate root
+ #[rustfmt::skip] // requires nightly Rust and #![feature(tool_attributes)] in crate root
#[cfg_attr(rustfmt, rustfmt_skip)] // works in stable
```
* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
target file directory or its parents to override the default settings of
rustfmt. You can generate a file containing the default configuration with
- `rustfmt --dump-default-config rustfmt.toml` and customize as needed.
+ `rustfmt --print-config default rustfmt.toml` and customize as needed.
* After successful compilation, a `rustfmt` executable can be found in the
target directory.
* If you're having issues compiling Rustfmt (or compile errors when trying to
(Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
+* You can change the way rustfmt emits the changes with the --emit flag:
+
+ Example:
+
+ ```
+ cargo fmt --emit files
+ ```
+
+ Options:
+
+ | Flag |Description| Nightly Only |
+ |:---:|:---:|:---:|
+ | files | overwrites output to files | No |
+ | stdout | writes output to stdout | No |
+ | coverage | displays how much of the input file was processed | Yes |
+ | checkstyle | emits in a checkstyle format | Yes |
+
## License
Rustfmt is distributed under the terms of both the MIT license and the