README.md

   1 # rustfmt
   2
   3 A tool for formatting Rust code according to style guidelines.
   4
   5 ## Gotchas
   6
   7 * For things you do not want rustfmt to mangle, use one of
   8    ```rust
   9    #[rustfmt_skip]
  10    #[cfg_attr(rustfmt, rustfmt_skip)]
  11     ```
  12 * When you run rustfmt use a file called rustfmt.toml to override the default
  13   settings of rustfmt.
  14 * We create a functioning executable called `rustfmt` in the target directory
  15
  16 ## Installation
  17
  18 > **Note:** this method currently requires you to be running a nightly install
  19 > of Rust as `cargo install` has not yet made its way onto the stable channel.
  20
  21 ```
  22 cargo install --git https://github.com/nrc/rustfmt
  23 ```
  24
  25 or if you're using `multirust`
  26
  27 ```
  28 multirust run nightly cargo install --git https://github.com/nrc/rustfmt
  29 ```
  30
  31 ## How to build and test
  32
  33 First make sure you've got Rust **1.3.0** or greater available, then:
  34
  35 `cargo build` to build.
  36
  37 `cargo test` to run all tests.
  38
  39 `cargo run -- filename` to run on a file, if the file includes out of line modules,
  40 then we reformat those too. So to run on a whole module or crate, you just need
  41 to run on the top file.
  42
  43 You'll probably want to specify the write mode. Currently, there are the replace,
  44 overwrite and display mode. The replace mode is the default and overwrites the
  45 original files after renaming them. In overwrite mode, rustfmt does not backup
  46 the source files. To print the output to stdout, use the display mode. The write
  47 mode can be set by passing the `--write-mode` flag on the command line.
  48
  49 `cargo run -- filename --write-mode=display` prints the output of rustfmt to the
  50 screen, for example.