Go to file

Eli Friedman 1c235de97d Fix crash speculatively parsing macro arguments as expressions. The problem is essentially that if we try to parse a token tree using a CodeMap different from the one the tree was originally parsed with, spans become nonsense. Since CodeMaps can't be cloned, we're basically forced to use the original ParseSess for additional parsing. Ideally, rustfmt would be a bit more clever and figure out how to parse macro arguments based on the definition of the macro itself, rather than just guessing that a particular token sequence looks like an expression, but this is good enough for now. Fixes #538.		2015-10-27 23:41:32 -07:00
src	Fix crash speculatively parsing macro arguments as expressions.	2015-10-27 23:41:32 -07:00
tests	Fix crash speculatively parsing macro arguments as expressions.	2015-10-27 23:41:32 -07:00
.gitignore	add gitignore	2015-04-30 13:20:44 +02:00
.travis.yml	Test on stable/beta branches on Travis as well	2015-10-23 13:46:14 -07:00
Cargo.lock	Move option parsing to crates.io-based getopts crate	2015-10-23 13:46:14 -07:00
Cargo.toml	Move option parsing to crates.io-based getopts crate	2015-10-23 13:46:14 -07:00
Contributing.md	Add a brief overview of rustfmt tests	2015-10-24 16:24:51 +02:00
Design.md	Readme cleanup	2015-08-31 21:02:19 -07:00
README.md	Add a brief overview of rustfmt tests	2015-10-24 16:24:51 +02:00

README.md

rustfmt

A tool for formatting Rust code according to style guidelines.

Gotchas

For things you do not want rustfmt to mangle, use one of
```
#[rustfmt_skip]
#[cfg_attr(rustfmt, rustfmt_skip)]
```
When you run rustfmt, place a file named rustfmt.toml in target file directory or its parents to override the default settings of rustfmt.
After successful compilation, a rustfmt executable can be found in the target directory.

Installation

Note: this method currently requires you to be running a nightly install of Rust as cargo install has not yet made its way onto the stable channel.

cargo install --git https://github.com/nrc/rustfmt

or if you're using multirust

multirust run nightly cargo install --git https://github.com/nrc/rustfmt

How to build and test

First make sure you've got Rust 1.3.0 or greater available, then:

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, display and coverage modes. 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.