Commit e98b5529 authored by Éloïs's avatar Éloïs

[doc] install fmt & clippy with stable toolchain

parent 0957c94a
......@@ -23,29 +23,26 @@ You can find instructions on how to install vscode for your system on the Intern
You can also develop in Rust with the following IDE/editors :
* IntelliJ Rust
* Eclipse/Corrosion
* Emacs
* VIM/Rust.vim
* Geany
* Neovim
* IntelliJ Rust
* Eclipse/Corrosion
* Emacs
* VIM/Rust.vim
* Geany
* Neovim
And many others..
## Fmt : le formateur de code
I strongly recommend that you install the essential automatic code formatter, especially since it is maintained by the official Rust language team so you have the guarantee that your code will always compile (and will always have the same behavior) after the formatter's pass.
To install it you will need the toolchain nightly :
I strongly recommend that you install the essential automatic code formatter, especially since it is maintained by the official Rust language team so you have the guarantee that your code will always compile (and will always have the same behavior) after the formatter's pass.
rustup install nightly
Install `fmt` :
Finally install `fmt` :
rustup component add rustfmt-preview --toolchain nightly
rustup component add rustfmt-preview
To automatically format your code, go to the root of your project and execute the following command :
cargo +nightly fmt
cargo fmt
I strongly recommend that you create an alias in your shell configuration (~/.bashrc if you use bash). As an example I created the alias `fmt="cargo +nightly fmt"`.
......@@ -55,17 +52,17 @@ If you contribute to Duniter's Rust implementation you will also need to use the
Run the following command to install Clippy :
rustup component add clippy-preview --toolchain nightly
rustup component add clippy-preview
To launch clippy, go to the root of your project and execute the following command :
cargo +nightly clippy --all
cargo clippy --all
Clippy will then inform you in a very educational way about everything that needs to be modified in your code to be more in the "rust spirit" (We say then that your code is more "rusty").
## Vscode
https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions
[https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions)
Once vscode is installed we will need the following 3 plugins :
......@@ -99,7 +96,7 @@ An example of a `launch.conf` file for VSCode :
There is still to install RLS (Rust Language Server) and LLDB (debugger), the first one allows you to compile your code on the fly to highlight errors in red directly in your IDE/Editor, the second one is a debugger.
LLDB Installation Instructions : https://github.com/vadimcn/vscode-lldb/wiki/Installing-on-Linux
LLDB Installation Instructions : [https://github.com/vadimcn/vscode-lldb/wiki/Installing-on-Linux](https://github.com/vadimcn/vscode-lldb/wiki/Installing-on-Linux)
Then restart vscode (after installing the plugins indicate if above), it should spontaneously offer you to install RLS, say yes.
If this fails for RLS, you will need to install it manually with the following command:
......@@ -116,7 +113,7 @@ In the case of Durs you will need the openssl library for developers :
sudo apt-get install libssl-dev
This dependency on the ssl lib is optional, you can still compile Durs without it provided you disable the default features :
This dependency on the ssl lib is optional, you can still compile Durs without it provided you disable the default features :
cargo build --no-default-features
......
......@@ -56,7 +56,7 @@ Si vous avez besoin d'effectuer une action qui ne rentre dans aucun de ses types
On met à jour uniquement avec des rebase, les merge sont strictement interdits !
Chaque fois que la branche `dev` est mise a jours, vous devez rebaser chacun de vos branche de travail sur dev. Pour chaque branche :
Chaque fois que la branche `dev` est mise a jours, vous devez rebaser chacun de vos branche de travail sur dev. Pour chaque branche :
1. Placez vous sur votre branche
2. Lancez un rebase sur dev
......
......@@ -18,23 +18,31 @@ Ajoutez ~/.cargo/bin a votre variable d'environnement PATH :
Je vous recommande vivement d'ajouter cette ligne dans le fichier de configuration de votre terminal pour ne pas avoir a la recopier a chaque fois, si vous ne savez pas de quoi je parle alors vous utilisez très probablement le shell par défaut (bash) et le fichier auquel vous devez ajouter cette ligne est `~/.bashrc`
Vous aurez aussi besoin d'un environnement de développement intégré, je vous recommande vscode car il supporte a la fois NodeJs et Rust :)
Vous aurez aussi besoin d'un environnement de développement intégré, je vous recommande VScode car il supporte a la fois NodeJs et Rust :)
Vous trouverez les instructions d'installation de vscode pour votre système sur internet.
Vous pouvez également développer en Rust avec les IDE/Editeurs suivants :
* IntelliJ Rust
* Eclipse/Corrosion
* Emacs
* VIM/Rust.vim
* Geany
* Neovim
Et bien d'autres..
## Fmt : le formateur de code
Je vous recommande vivement d'installer l'indispensable formateur automatique de code, d'autant qu'il est maintenue par l'équipe officielle du langage Rust donc vous avez la garantie que votre code compilera toujours (et aura toujours le même comportement) après le passage du formateur.
Pour l'installer vous aurez besoin de la toolchain nightly:
rustup install nightly
Enfin installez `fmt` :
Pour installer `fmt` :
rustup component add rustfmt-preview --toolchain nightly
rustup component add rustfmt-preview
Pour formater automatiquement votre code, placez vous a la racine de votre projet et éxécutez la commande suivante :
cargo +nightly fmt
cargo fmt
Je vous recommande fortement de créer un alias dans la configuration de votre shell (~/.bashrc si vous utilisez bash). a titre d'exemple j'ai créer l'alias `fmt="cargo +nightly fmt"`.
......@@ -44,11 +52,11 @@ Si vous contribuez à l'implémentation Rust de Duniter vous devrez également u
Éxécutez la commande suivante pour installer clippy :
rustup component add clippy-preview --toolchain nightly
rustup component add clippy-preview
Pour lancer clippy, rendez-vous a la racine de votre projet puis éxécutez la commande suivante :
cargo +nightly clippy --all
cargo clippy --all
Clippy vas alors vous signaler de façopn très pédagogique tout ce qu'il conviens de modifier dans votre code pour être plus dans "l'esprit rust".
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment