Skip to content
This repository has been archived by the owner on Nov 24, 2023. It is now read-only.

README update aiming to clarify things for less experienced rustaceans #222

Merged
merged 3 commits into from
Oct 16, 2023
Merged

README update aiming to clarify things for less experienced rustaceans #222

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c249c97
README update aiming to clarify things for less experienced rustaceans
3tilley Oct 15, 2023
b416b98
Update Readme.md
Manishearth Oct 16, 2023
7806962
Update Readme.md
Manishearth Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
# rustfix

The goal of this tool is to read and apply the suggestions made by rustc.
[![Latest Version](https://img.shields.io/crates/v/rustfix.svg)](https://crates.io/crates/rustfix)
[![Rust Documentation](https://docs.rs/rustfix/badge.svg)](https://docs.rs/rustfix)

Rustfix is a library defining useful structures that represent fix suggestions from rustc.

## Current status

Currently, rustfix is split into two crates:

- `rustfix`, a library for consuming and applying suggestions in the format that `rustc` outputs
- and `cargo-fix`, a binary that works as cargo subcommand and that end users will use to fix their code.
- `rustfix`, a library for consuming and applying suggestions in the format that `rustc` outputs (this crate)
- `cargo-fix`, a binary that works as cargo subcommand and that end users will use to fix their code (maintained in the [cargo](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/fix.rs) repo).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I may link to https://github.com/rust-lang/cargo/blob/master/src/bin/cargo/commands/fix.rs, which is more like the entry of the entire "binary" part of cargo-fix.



The magic of rustfix is entirely dependent on the diagnostics implemented in the Rust compiler (and external lints, like [clippy]).
The library (and therefore this repo) is considered largely feature-complete. This is because:
* There is no compiler or even rust-specific logic here
* New lints and suggestions come from the Rust compiler (and external lints, like [clippy]).
* `rustfix` doesn't touch the filesystem to implement fixes, or read from disk

[clippy]: https://github.com/rust-lang-nursery/rust-clippy

## Installation

To use the rustfix library, add it to your `Cargo.toml`.
`cargo fix` is a built-in command in Cargo since Rust 1.29. There is no need to install it separately from crates.io.

To get the tool to automatically fix warnings in, run `cargo install cargo-fix`. This will give you `cargo fix`.
To use the rustfix library for use in your own fix project, add it to your `Cargo.toml`.

## Using `cargo fix --edition` to transition to Rust 2021

Expand Down