Utiliser les conteneurs VS Code Remote

Lorsque nous travaillons sur Flower, nous voulons nous assurer que tous les contributeurs utilisent le même environnement de développement pour formater le code ou exécuter des tests. À cette fin, nous utilisons l’extension VSCode Remote Containers. Qu’est-ce que c’est ?

L’extension Visual Studio Code Remote - Containers vous permet d’utiliser un conteneur Docker comme environnement de développement complet. Il vous permet d’ouvrir n’importe quel dossier à l’intérieur (ou monté dans) un conteneur et de profiter du plein potentiel de Visual Studio Code. Un fichier devcontainer.json dans votre projet indique à VS Code comment accéder (ou créer) un conteneur de développement avec une pile d’outils et de runtime bien définie. Ce conteneur peut être utilisé pour exécuter une application ou pour séparer les outils, bibliothèques ou runtimes nécessaires pour travailler sur un codebase.

Les fichiers de l’espace de travail sont montés à partir du système de fichiers local ou copiés ou clonés dans le conteneur. Les extensions sont installées et exécutées à l’intérieur du conteneur, où elles ont un accès complet aux outils, à la plateforme et au système de fichiers. Cela signifie que tu peux changer de façon transparente tout ton environnement de développement simplement en te connectant à un autre conteneur.

Source : Official VSCode documentation

Pour commencer

La configuration et la mise en place du Dockerfile ainsi que la configuration pour le conteneur de développement peuvent être un peu plus complexes. La bonne nouvelle est que vous n’avez pas à le faire. Généralement, il suffit d’installer Docker sur votre système et de s’assurer qu’il soit disponible dans votre ligne de commande. De plus, installez VSCode Containers Extension.

Maintenant, tu devrais être prêt à partir. Au démarrage de VSCode, il te demandera de fonctionner dans l’environnement du conteneur et - si tu confirmes - construira automatiquement le conteneur et l’utilisera. Pour demander manuellement à VSCode d’utiliser le devcontainer, tu peux, après avoir installé l’extension, cliquer sur la zone verte dans le coin inférieur gauche de ta fenêtre VSCode et sélectionner l’option (Re)Ouvrir le dossier dans le conteneur.

Dans certains cas, ton installation peut être plus complexe. Pour ces cas-là, consulte les sources suivantes :