projects / rustc.git / blame
| Commit | Line | Data |
|---|---|---|
| 83c7162d XL |
1 | # rustfix |
| 2 | ||
| 94b46f34 | 3 | The goal of this tool is to read and apply the suggestions made by rustc. |
| 83c7162d | 4 | |
| 94b46f34 XL |
5 | [](https://travis-ci.org/rust-lang-nursery/rustfix) |
| 6 | [](https://ci.appveyor.com/project/rust-lang-libs/rustfix/branch/master) | |
| 83c7162d | 7 | |
| 94b46f34 | 8 | ## Current status |
| 83c7162d | 9 | |
| 94b46f34 | 10 | Currently, rustfix is split into two crates: |
| 83c7162d | 11 | |
| 94b46f34 XL |
12 | - `rustfix`, a library for consuming and applying suggestions in the format that `rustc` outputs |
| 13 | - and `cargo-fix`, a binary that works as cargo subcommand and that end users will use to fix their code. | |
| 83c7162d | 14 | |
| 94b46f34 | 15 | The magic of rustfix is entirely dependent on the diagnostics implement in the Rust compiler (and external lints, like [clippy]). |
| 83c7162d | 16 | |
| 94b46f34 | 17 | [clippy]: https://github.com/rust-lang-nursery/rust-clippy |
| 83c7162d XL |
18 | |
| 19 | ## Installation | |
| 20 | ||
| 94b46f34 | 21 | To use the rustfix libary, add it to your `Cargo.toml`. |
| 83c7162d | 22 | |
| 94b46f34 | 23 | To get the tool to automatically fix warnings in, run `cargo install cargo-fix`. This will give you `cargo fix`. |
| 83c7162d XL |
24 | |
| 25 | ## License | |
| 26 | ||
| 27 | Licensed under either of | |
| 28 | ||
| 29 | - Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>) | |
| 30 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) | |
| 31 | ||
| 32 | at your option. | |
| 33 | ||
| 34 | ### Contribution | |
| 35 | ||
| 36 | Unless you explicitly state otherwise, any contribution intentionally | |
| 37 | submitted for inclusion in the work by you, as defined in the Apache-2.0 | |
| 38 | license, shall be dual licensed as above, without any additional terms or | |
| 39 | conditions. |