ENIB Rust 01_Setup - Environnement de travail

{} Installation et configuration des outils

Le site https://rustup.rs/ fournit le moyen à privilégier pour installer Rust et une variété de composants complémentaires.

{} Poste fonctionnant sous Linux

Il suffit de copier la commande affichée sur la page d'accueil du site https://rustup.rs/✍ puis de la coller dans un terminal.
La validation des choix par défaut convient tout à fait.
N.B. : il ne faut pas effectuer l'opération précédente sur les postes de travail de l'ENIB qui sont équipés du système d'exploitation Linux ; Rust y est déjà installé.

Le terminal d'installation doit être fermé ; l'ouverture d'un nouveau terminal doit maintenant prendre en compte l'installation précédente.

Nous utiliserons l'outil de formatage du code source livré avec le langage ; il doit être configuré en créant le fichier ~/.rustfmt.toml✍ par cette commande (dans un terminal) :

cat >~/.rustfmt.toml <<'EOF'
edition="2021"
max_width=78
fn_args_layout="Vertical"
EOF

La complétion automatique de la ligne de commande facilite grandement les opérations courantes.
Pour en bénéficier avec le shell bash, il faut exécuter ces commandes (dans un terminal) :

mkdir -p ~/.local/share/bash-completion/completions
for cmd in rustup cargo ; do
  rustup completions bash ${cmd} >~/.local/share/bash-completion/completions/${cmd}
done

N.B. : il ne faut pas effectuer l'opération précédente sur les postes de travail de l'ENIB qui sont équipés du système d'exploitation Linux ; la complétion pour Rust y est déjà installée.

Le terminal précédent doit à nouveau être fermé ; l'ouverture d'un nouveau terminal doit maintenant prendre en compte la complétion pour les commandes rustup et cargo.
En saisissant l'une ou l'autre de ces commandes suivie de plusieurs appuis sur la touche de tabulation, vous devez constater que le shell propose des options ou des mot-clefs qui lui sont spécifiques.

{} Poste fonctionnant sous MacOSX

{} Poste fonctionnant sous Windows

N.B. : il n'est pas nécessaire d'utiliser Windows Subsystem for Linux (WSL) dans le cadre de cet enseignement✍.

Le site https://rustup.rs/ propose de télécharger le programme d'installation rustup-init.exe.
Un fois celui-ci récupéré, il suffit de le lancer par un double-clic depuis le répertoire de téléchargement.
La validation des choix par défaut convient tout à fait.
Attention : l'installation sous Windows peut se montrer assez récalcitrante :

il se peut en particulier que d'autres outils doivent être installés avant, voir notamment cette page,
il se peut également qu'il faille désactiver l'antivirus pour l'installation, voire pour l'usage de Rust (des faux-positifs sont reportés par certains antivirus, Avast notamment).

Le terminal d'installation doit être fermé ; l'ouverture d'un nouveau terminal PowerShell doit maintenant prendre en compte l'installation précédente.
Toutes les commandes en terminal sous Windows doivent utiliser un terminal PowerShell✍.

Nous utiliserons l'outil de formatage du code source livré avec le langage ; il doit être configuré en créant le fichier $Env:USERPROFILE\.rustfmt.toml✍ par cette commande (dans un terminal PowerShell) :

echo @'
edition="2021"
max_width=78
fn_args_layout="Vertical"
'@ | Out-File -Encoding utf8 $Env:USERPROFILE\.rustfmt.toml

Il n'existe pas encore de complétion automatique de la ligne de commande pour Rust dans ce système✍.

Pour bénéficier des mises à jour de Rust✍ il suffit de saisir cette commande (dans un terminal) :

rustup update

Il peut être utile de remettre en place la complétion automatique de la ligne de commande (voir les installations spécifiques un peu plus haut), afin que d'éventuelles nouvelles options des commandes rustup ou cargo soient proposées.
N.B. : il ne faut pas effectuer l'opération précédente sur les postes de travail de l'ENIB qui sont équipés du système d'exploitation Linux ; Rust et sa complétion y sont déjà installés.

L'outil facultatif cargo-cache est utile pour faire du ménage parmi les bibliothèques variées (les crates, selon la terminologie de Rust) qui peuvent être téléchargées lors de divers développements✍.
Son installation se fait par cette commande (dans un terminal) :

cargo install cargo-cache

Un moyen radical de tout effacer est alors obtenu par la commande (dans un terminal) :

cargo cache -r all

Après un tel ménage, toutes les crates ont été supprimées, seules celles réellement nécessaires à votre réalisation seront téléchargées à nouveau lors de sa prochaine fabrication.

{} Configuration de l'éditeur de code source

En théorie, n'importe quel éditeur de texte, même extrêmement simple, permet de rédiger un code source en Rust.
Cependant, les éditeurs de texte élaborés peuvent être étendus par des fonctionnalités qui connaissent les règles d'écriture spécifiques à ce langage.
Dans ces conditions, l'éditeur peut reformater automatiquement le code afin que ce dernier ait un aspect homogène et facile à lire par tous, quel que soit le programmeur qui l'a rédigé.
L'éditeur peut également mettre en évidence les erreurs et proposer la complétion et des reformulations du code en cours de rédaction.

Une grande variété d'éditeurs de texte existent ; il serait illusoire de tenter de les passer en revue ici.
L'éditeur de texte Sublime-Text a été retenu dans le cadre de cet enseignement pour plusieurs raisons :

il est extrêmement léger et rapide✍
Contrairement à d'autres solutions comme Eclipse ou Visual-Studio-Code qui nécessitent plus de ressources pour fonctionner confortablement et qui occupent beaucoup plus d'espace de stockage.
Ce sont d'ailleurs ses qualités de sobriété qui distinguent le plus Sublime-Text des autres éditeurs évolués.
,
il est très simple à utiliser a minima, même si on ne le connaît pas,
il est très riche en facilités et en fonctionnalités évoluées lorsqu'on le connaît un peu plus,
il est extrêmement configurable et extensible, ce qui permet de l'adapter à des besoins très variés et de le personnaliser,
bien qu'une licence soit requise pour un usage professionnel✍
Il serait bienvenu de s'acquitter de la licence lors d'un usage en stage par exemple.
, le service commercial de l'éditeur de cet outil nous a confirmé que la version d'évaluation est utilisable librement pour tous les étudiants dans le cadre de l'enseignement.

Parmi les éditeurs de texte, Visual-Studio-Code est très populaire ; il est théoriquement utilisable ici, à condition de savoir le configurer pour obtenir les fonctionnalités qui nous sont utiles.
De nombreux témoignages rapportent qu'il est EXTRÊMEMENT CONSOMMATEUR DE RESSOURCES (processeur, mémoire et stockage).
- Il finira probablement par remplir votre compte utilisateur à l'ENIB (ou le disque dur de votre poste personnel) si vous n'effacez pas très régulièrement les nombreux et volumineux fichiers qu'il produit en continu.

La page d'installation indique la manière de l'installer selon chaque système supporté✍.
N.B. : il ne faut pas effectuer cette installation sur les postes de travail de l'ENIB qui sont équipés du système d'exploitation Linux ; Sublime-Text y est déjà installé.

Pour lancer cet éditeur de texte, il est probable qu'il apparaisse dans le menu des applications de votre environnement graphique.
En ligne de commande sous Linux, il est probable que

subl

permette de le lancer.
En ligne de commande sous MacOSX, il est probable que

/Applications/Sublime\ Text.app/Contents/MacOS/sublime_text

permette de le lancer.
En ligne de commande sous Windows, il est probable que

"C:\Program Files\Sublime Text\subl.exe"

permette de le lancer.

Une fois l'éditeur lancé, les préférences générales seront exprimées dans la partie droite de la fenêtre ouverte par le menu Preferences / Settings :

{
    "color_scheme": "Monokai.sublime-color-scheme",
    "draw_white_space": ["all"],
    "font_size": 12,
    "hot_exit": "disabled",
    "rulers": [80],
    "overlay_scroll_bars": "disabled",
    "tab_completion": false,
    "auto_complete_include_snippets": false,
    "tab_size": 4,
    "translate_tabs_to_spaces": true,
    "ensure_newline_at_eof_on_save": true,
    "ignored_packages": ["Vintage",],
    "update_check": false,
}

Pour installer des composants supplémentaires dans cet éditeur, il faut commencer par utiliser le menu Tools / Install Package Control.

L'outil de formatage du code source livré avec le langage sera utilisé par l'éditeur.
L'installation du composant dédié s'obtient par le menu Preferences / Package Control: Install Package en choisissant le paquet RustFmt.
Les préférences de ce paquet seront ensuite exprimées dans la partie droite de la fenêtre ouverte par le menu Preferences / Package Settings / RustFmt / Settings :

{
    "error_messages": false,
}

Pour mettre en évidence les erreurs et proposer la complétion et des reformulations du code en cours de rédaction, l'éditeur a besoin de deux composants.
Le premier est installé par le menu Preferences / Package Control: Install Package en choisissant le paquet LSP.
Les préférences de ce paquet seront ensuite exprimées dans la partie droite de la fenêtre ouverte par le menu Preferences / Package Settings / LSP / Settings :

{
    "show_diagnostics_panel_on_save": 0,
}

Le second est installé par le menu Preferences / Package Control: Install Package en choisissant le paquet LSP-rust-analyzer.
Les préférences de ce paquet seront ensuite exprimées dans la partie droite de la fenêtre ouverte par le menu Preferences / Package Settings / LSP / Servers / LSP-rust-analyzer :

{
    "settings": {
        "rust-analyzer.inlayHints.enable": false,
    },
    // use the "command" setting ONLY on ENIB workstations
    // "command": ["/local/rust/rust-analyzer"],
}

Bien entendu, il est tout à fait possible d'obtenir des fonctionnalités équivalentes avec un autre éditeur de votre choix dont vous savez vous servir.
Si vous maîtrisez effectivement un tel autre outil, vous serez alors en mesure de le configurer en vous référant à cette page et celle-ci ou encore celle-là.