Go to file
Christoph Burgdorf 33c5776d30 Implements struct_lit_force_multiline
With struct_lit_force_multiline set to true
rustfmt won't ever mangle multiple struct properties
into one line.

Fixes #253
2015-09-08 01:25:44 +02:00
src Implements struct_lit_force_multiline 2015-09-08 01:25:44 +02:00
tests Implements struct_lit_force_multiline 2015-09-08 01:25:44 +02:00
.gitignore add gitignore 2015-04-30 13:20:44 +02:00
.travis.yml Make travis use Rust nightly 2015-05-22 15:50:58 +12:00
Cargo.lock Refactor diff handling in tests 2015-08-30 22:31:26 +02:00
Cargo.toml Refactor diff handling in tests 2015-08-30 22:31:26 +02:00
Contributing.md Readme cleanup 2015-08-31 21:02:19 -07:00
Design.md Readme cleanup 2015-08-31 21:02:19 -07:00
README.md Readme cleanup 2015-08-31 21:02:19 -07:00

rustfmt

A tool for formatting Rust code according to style guidelines.

Gotchas

  • For things you do not want rustfmt to mangle, use
 #[rustfmt_skip]
  • When you run rustfmt use a file called rustfmt.toml to override the settings in default.toml
  • We create a functioning executable called rustfmt in the target directory

How to build and test

You'll need a pretty up to date version of the nightly version of Rust.

cargo build to build.

cargo test to run all tests.

cargo run -- filename to run on a file, if the file includes out of line modules, then we reformat those too. So to run on a whole module or crate, you just need to run on the top file.

You'll probably want to specify the write mode. Currently, there are the replace, overwrite and display mode. The replace mode is the default and overwrites the original files after renaming them. In overwrite mode, rustfmt does not backup the source files. To print the output to stdout, use the display mode. The write mode can be set by passing the --write-mode flag on the command line.

cargo run -- filename --write-mode=display prints the output of rustfmt to the screen, for example.