Приложение D: Полезные инструменты разработки
В этом приложении мы поговорим о некоторых полезных инструментах разработки, которые предоставляет проект Rust. Мы рассмотрим автоматическое форматирование, быстрые способы применения исправлений предупреждений, линтер и интеграцию с IDE.
Автоматическое форматирование с помощью rustfmt
Инструмент rustfmt переформатирует код в соответствии с общепринятым стилем оформления кода. Многие совместные проекты используют rustfmt, чтобы избежать споров о том, какой стиль использовать при написании кода на Rust: каждый форматирует свой код с помощью этого инструмента.
Установки Rust по умолчанию включают rustfmt, поэтому программы rustfmt и cargo-fmt уже должны быть в системе. Эти две команды аналогичны rustc и cargo в том смысле, что rustfmt обеспечивает более тонкий контроль, а cargo-fmt понимает соглашения проекта, использующего Cargo. Чтобы отформатировать любой проект Cargo, введите следующую команду:
$ cargo fmt
Выполнение этой команды переформатирует весь код Rust в текущем крейте. Это должно изменить только стиль кода, но не его семантику. Для получения дополнительной информации о rustfmt см. его документацию.
Исправление кода с помощью rustfix
Инструмент rustfix включён в установки Rust и может автоматически исправлять предупреждения компилятора, которые имеют чёткий способ решения проблемы, вероятно, именно тот, который нужен. Ранее уже встречались предупреждения компилятора. Например, рассмотрим этот код:
Имя файла: src/main.rs
fn main() {
let mut x = 42;
println!("{x}");
}
Здесь мы определяем переменную x как изменяемую, но фактически никогда её не изменяем. Rust предупреждает об этом:
$ cargo build
Compiling myprogram v0.1.0 (file:///projects/myprogram)
warning: variable does not need to be mutable
--> src/main.rs:2:9
|
2 | let mut x = 0;
| ----^
| |
| help: remove this `mut`
|
= note: `#[warn(unused_mut)]` on by default
Предупреждение предлагает удалить ключевое слово mut. Мы можем автоматически применить это предложение с помощью инструмента rustfix, выполнив команду cargo fix:
$ cargo fix
Checking myprogram v0.1.0 (file:///projects/myprogram)
Fixing src/main.rs (1 fix)
Finished dev [unoptimized + debuginfo] target(s) in 0.59s
Если снова посмотреть на src/main.rs, можно увидеть, что cargo fix изменил код:
Имя файла: src/main.rs
fn main() {
let x = 42;
println!("{x}");
}
Переменная x теперь неизменяемая, и предупреждение больше не появляется.
Также можно использовать команду cargo fix для перехода кода между различными редакциями Rust. Редакции рассматриваются в Приложении E.
Больше линтов с Clippy
Инструмент Clippy — это набор линтов для анализа кода, позволяющих выявить распространённые ошибки и улучшить код на Rust. Clippy входит в стандартные установки Rust.
Чтобы запустить линты Clippy для любого проекта Cargo, введите следующую команду:
$ cargo clippy
Например, предположим, что написана программа, использующая приближение математической константы, такой как пи, как в этой программе:
fn main() {
let x = 3.1415;
let r = 8.0;
println!("the area of the circle is {}", x * r * r);
}
Запуск cargo clippy для этого проекта приведёт к следующей ошибке:
error: approximate value of `f{32, 64}::consts::PI` found
--> src/main.rs:2:13
|
2 | let x = 3.1415;
| ^^^^^^
|
= note: `#[deny(clippy::approx_constant)]` on by default
= help: consider using the constant directly
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#approx_constant
Эта ошибка сообщает, что в Rust уже определена более точная константа PI, и программа была бы более корректной, если бы использовалась эта константа. Затем следует изменить код, чтобы использовать константу PI.
Следующий код не вызывает никаких ошибок или предупреждений от Clippy:
fn main() {
let x = std::f64::consts::PI;
let r = 8.0;
println!("the area of the circle is {}", x * r * r);
}
Для получения дополнительной информации о Clippy см. его документацию.
Интеграция с IDE с помощью rust-analyzer
Для помощи с интеграцией с IDE сообщество Rust рекомендует использовать
rust-analyzer. Этот инструмент представляет собой набор утилит, ориентированных на компилятор, которые общаются по Language Server Protocol — спецификации для взаимодействия IDE и языков программирования друг с другом. Различные клиенты могут использовать rust-analyzer, например, плагин Rust Analyzer для Visual Studio Code.
Посетите домашнюю страницу проекта rust-analyzer для получения инструкций по установке, затем установите поддержку языкового сервера в вашей конкретной IDE. Ваша IDE получит такие возможности, как автодополнение, переход к определению и встроенные ошибки.