本格的な開発の前に、開発をより快適に進められるための環境セットアップ方法です。
便利なcomponent追加
下記コマンドで便利なcomponentを追加しておくのがおすすめです。
rustup component add clippy rust-src rustfmt rust-analyzer rust-docs
それぞれ下記の役割を持っています。
- clippy: rust版linter。チェックだけでなく修正オプションもあります
- rust-src: 標準ライブラリのソースコードコピー。rust-analyzerで下記恩恵を得られます
- 標準ライブラリへの定義ジャンプ
- 型推論の精度向上
- ソース閲覧
- rustfmt: その名の通りformatterです
- rust-analyzer: 新しいrustのlanguage serverです（rlsというlanguage serverは古いので非推奨）
- rust-docs: これについては任意です。公式のRustドキュメンテーションのローカルコピーなので、ドキュメントを手軽に見たい人は入れておく感じ
追加定義の推奨コマンド
利用頻度の高いコマンド
下記コマンドは開発で頻繁に利用します。
cargo fmt
cargo clippy --fix --allow-dirty --allow-staged
前者はrustfmtを追加することで利用可能となるフォーマット修正コマンドです。
後者はclippyを追加することで利用可能となるチェックコマンドで、オプションはそれぞれ下記役割を持ちます。
- fix: clippyの提案する修正を自動適用する
- allow-dirty: gitで未commitの変更が存在する状態でも許可する
- allow-staged: gitでステージング状態であっても許可する
まとめて実行コマンドを定義しておくと便利
上記のコマンドはまとめて実行することがほとんどなので、ひとつのコマンドに統合しておくと便利です。
方法は色々ですが、個人的にはjustというCLIツールをおすすめします。
詳細はこちらの記事がとてもわかりやすいです。
# cargoでインストール可能です
cargo install just
# プロジェクト内にjustfileというファイルを作成し、コマンドを定義します
fix:
cargo clippy --fix --allow-dirty --allow-staged
cargo fmt
# コマンド実行方法
just fix
これでシンプルな1コマンドにより、まとめてformatterとlinterによる修正を適用することができます。