Commit 0b799b51 authored by Éloïs's avatar Éloïs

[doc] remove old clippy install methods

parent 416d20ee
......@@ -53,32 +53,16 @@ I strongly recommend that you create an alias in your shell configuration (~/.ba
If you contribute to Duniter's Rust implementation you will also need to use the Clippy linter. And in any case it's strongly recommended to beginners in Rust to use it, indeed clippy is very educational and will help you learn a lot how to code in Rust.
There are two ways to install clippy :
Run the following command to install Clippy :
1. Compile it locally : it's long but it will run faster, it poses a major problem: you have to recompile it in nightly each time you update the toolchain rust and it often happens that clippy no longer compiles after an update. I therefore strongly advise against this method.
2. Running Clippy in docker: this is the method I recommend and use, it makes the execution of clippy a little slower but still allows to have a functional clippy and not to have to recompile it with each update.
rustup component add clippy-preview --toolchain nightly
### Clippy : method 1
Run the following command :
cargo +nightly install clippy
Warning it's taking a long time, and you must wait until the compilation is finished before launching Clippy.
To launch clippy, go to the root of your project and execute the following command :
cargo +nightly 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").
### Clippy method 2
You need to install docker on your development workstation. Then, go to the root of your project and execute the following command :
docker run --rm -v "$(pwd)":/app -w /app instrumentisto/clippy
`instrumentisto/clippy` is a docker image that is automatically discarded and republished each time Clippy is updated, the big advantage is that the image is republished only if Clippy has been successfully compiled, so you are always guaranteed to be able to run the latest functional version of Clippy.
## Vscode
https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions
......
......@@ -42,28 +42,15 @@ Je vous recommande fortement de créer un alias dans la configuration de votre s
Si vous contribuez à l'implémentation Rust de Duniter vous devrez également utiliser le linteur Clippy. Et dans tout les cas il est vivement recommandé aux débutants en Rust de l'utiliser, en effet clippy est très pédagogique et vas beaucoup vous aider a apprendre comment il conviens de coder en Rust.
Il y a deux façons d'installer clippy :
1. L'installer en local : il faut le réinstaller a chaque mise a jours de clippy.
2. Éxécuter Clippy dans docker : c'est la méthode que je préconise et que j'utilise, cela rend l'éxécution de clippy un peu plus lente mais permet d'avoir toujours un clippy fonctionnel et de ne pas a voir besoin de le recompiler a chaque mise à jours.
### Clippy : méthode 1
Éxécutez la commande suivante :
Éxécutez la commande suivante pour installer clippy :
rustup component add clippy-preview --toolchain nightly
Pour lancer clippy, rendez-vous a la racine de votre projet puis éxécutez la commande suivante :
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".
### Clippy méthode 2
Il vous faut installer docker sur votre poste de développement. Ensuite, rendez-vous a la racine de votre projet puis éxécutez la commande suivante :
cargo +nightly clippy --all
docker run --rm -v "$(pwd)":/app -w /app instrumentisto/clippy
`instrumentisto/clippy` est une image docker qui est automatiquement rebuiltée et republiée à chaque mise a jours de Clippy, le gros avantage c'est que l'image n'est republiée que si Clippy s'est compilé avec succès, vous avez donc la garantie de toujours pouvoir éxécuter la dernière version fonctionnelle de clippy.
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".
## Vscode
......
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