blob: 64fe299446c6212464e66ebeee67cd5329940e01 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# cargo-fix(1)
{{*set actionverb="Fix"}}
{{*set multitarget=true}}
## NAME
cargo-fix --- Automatically fix lint warnings reported by rustc
## SYNOPSIS
`cargo fix` [_options_]
## DESCRIPTION
This Cargo subcommand will automatically take rustc's suggestions from
diagnostics like warnings and apply them to your source code. This is intended
to help automate tasks that rustc itself already knows how to tell you to fix!
Executing `cargo fix` will under the hood execute {{man "cargo-check" 1}}. Any warnings
applicable to your crate will be automatically fixed (if possible) and all
remaining warnings will be displayed when the check process is finished. For
example if you'd like to apply all fixes to the current package, you can run:
cargo fix
which behaves the same as `cargo check --all-targets`.
`cargo fix` is only capable of fixing code that is normally compiled with
`cargo check`. If code is conditionally enabled with optional features, you
will need to enable those features for that code to be analyzed:
cargo fix --features foo
Similarly, other `cfg` expressions like platform-specific code will need to
pass `--target` to fix code for the given target.
cargo fix --target x86_64-pc-windows-gnu
If you encounter any problems with `cargo fix` or otherwise have any questions
or feature requests please don't hesitate to file an issue at
<https://github.com/rust-lang/cargo>.
### Edition migration
The `cargo fix` subcommand can also be used to migrate a package from one
[edition] to the next. The general procedure is:
1. Run `cargo fix --edition`. Consider also using the `--all-features` flag if
your project has multiple features. You may also want to run `cargo fix
--edition` multiple times with different `--target` flags if your project
has platform-specific code gated by `cfg` attributes.
2. Modify `Cargo.toml` to set the [edition field] to the new edition.
3. Run your project tests to verify that everything still works. If new
warnings are issued, you may want to consider running `cargo fix` again
(without the `--edition` flag) to apply any suggestions given by the
compiler.
And hopefully that's it! Just keep in mind of the caveats mentioned above that
`cargo fix` cannot update code for inactive features or `cfg` expressions.
Also, in some rare cases the compiler is unable to automatically migrate all
code to the new edition, and this may require manual changes after building
with the new edition.
[edition]: https://doc.rust-lang.org/edition-guide/editions/transitioning-an-existing-project-to-a-new-edition.html
[edition field]: ../reference/manifest.html#the-edition-field
## OPTIONS
### Fix options
{{#options}}
{{#option "`--broken-code`" }}
Fix code even if it already has compiler errors. This is useful if `cargo fix`
fails to apply the changes. It will apply the changes and leave the broken
code in the working directory for you to inspect and manually fix.
{{/option}}
{{#option "`--edition`" }}
Apply changes that will update the code to the next edition. This will not
update the edition in the `Cargo.toml` manifest, which must be updated
manually after `cargo fix --edition` has finished.
{{/option}}
{{#option "`--edition-idioms`" }}
Apply suggestions that will update code to the preferred style for the current
edition.
{{/option}}
{{#option "`--allow-no-vcs`" }}
Fix code even if a VCS was not detected.
{{/option}}
{{#option "`--allow-dirty`" }}
Fix code even if the working directory has changes.
{{/option}}
{{#option "`--allow-staged`" }}
Fix code even if the working directory has staged changes.
{{/option}}
{{/options}}
{{> section-package-selection }}
### Target Selection
When no target selection options are given, `cargo fix` will fix all targets
(`--all-targets` implied). Binaries are skipped if they have
`required-features` that are missing.
{{> options-targets }}
{{> section-features }}
### Compilation Options
{{#options}}
{{> options-target-triple }}
{{> options-release }}
{{> options-profile-legacy-check }}
{{> options-ignore-rust-version }}
{{> options-timings }}
{{/options}}
### Output Options
{{#options}}
{{> options-target-dir }}
{{/options}}
### Display Options
{{#options}}
{{> options-display }}
{{> options-message-format }}
{{/options}}
### Manifest Options
{{#options}}
{{> options-manifest-path }}
{{> options-locked }}
{{/options}}
{{> section-options-common }}
### Miscellaneous Options
{{#options}}
{{> options-jobs }}
{{> options-keep-going }}
{{/options}}
{{> section-environment }}
{{> section-exit-status }}
## EXAMPLES
1. Apply compiler suggestions to the local package:
cargo fix
2. Update a package to prepare it for the next edition:
cargo fix --edition
3. Apply suggested idioms for the current edition:
cargo fix --edition-idioms
## SEE ALSO
{{man "cargo" 1}}, {{man "cargo-check" 1}}
|
