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 ?

The Visual Studio Code Remote - Containers extension lets you use a Docker container as a fully-featured development environment. It allows you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code’s full feature set. A devcontainer.json file in your project tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack. This container can be used to run an application or to separate tools, libraries, or runtimes needed for working with a 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

Configuring and setting up the Dockerfile as well the configuration for the devcontainer can be a bit more involved. The good thing is you don’t have to do it. Usually it should be enough to install Docker on your system and ensure its available on your command line. Additionally, install the 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 :