Comment développer sur un serveur SSH distant avec le code Visual Studio –

L’édition de fichiers stockés sur un serveur distant n’a pas besoin d’être un gâchis de commandes shell et d’éditeurs de texte de base. Visual Studio Code est l’un des IDE de développement les plus populaires et une extension officiellement prise en charge vous permet d’ajouter des connexions SSH à votre espace de travail.

L’extension Remote – SSH peut se connecter aux serveurs du réseau, répertorier leur structure de répertoires et ouvrir et modifier des fichiers. Presque toutes les fonctionnalités de Visual Studio Code sont disponibles, y compris la complétion de code IntelliSense, le débogage intégré et les extensions tierces.

Commencer

Commencez par ajouter l’extension Remote – SSH à votre éditeur. Appuyez sur Ctrl+Maj+P pour ouvrir la palette de commandes et tapez « installer ». La barre latérale des extensions apparaîtra sur la gauche. Recherchez « remote – ssh » et installez l’extension correspondante. Il est publié et pris en charge par Microsoft.

Vous devez maintenant vous connecter à votre serveur SSH. L’extension fonctionne avec les hôtes exécutant Ubuntu, Debian, CentOS, RHEL et Raspbian. Les serveurs Windows sont également pris en charge, à condition que le serveur OpenSSH officiel de Microsoft soit utilisé. Les hôtes macOS doivent avoir la fonction de connexion à distance du système d’exploitation activée.

Avant de continuer, assurez-vous d’avoir copié votre clé publique SSH locale sur le authorized_keys fichier. VS Code ne prend pas entièrement en charge l’authentification par mot de passe ; même si cela fonctionnera, vous devrez ressaisir votre mot de passe chaque fois qu’une commande est exécutée.

Appuyez sur Ctrl+Maj+P pour afficher la palette de commandes. Recherchez « remote explorer » et exécutez la commande « View: Show Remote Explorer » pour afficher le panneau latéral distant. Sélectionnez « Cibles SSH » dans la liste déroulante en haut si elle n’est pas déjà sélectionnée.

Passez la souris sur l’en-tête « Cibles SSH » dans le panneau latéral. Cliquez sur le bouton plus pour créer une nouvelle connexion. Une fenêtre contextuelle apparaîtra vous permettant de saisir les détails de votre serveur. Cela devrait être une commande de connexion SSH complète avec le -A indicateur pour activer le transfert d’agent. Cela vous permet d’utiliser vos clés locales lors de l’exécution des commandes SSH suivantes sur le serveur.

ssh user@example.com -A

Vous serez invité à choisir un fichier de configuration SSH dans lequel écrire. Vous pouvez choisir parmi votre fichier utilisateur par défaut, le fichier de paramètres système ou un emplacement personnalisé. La sélection de la valeur par défaut dans votre répertoire personnel est généralement la meilleure option si vous n’êtes pas sûr.

Votre nouvel hôte sera ajouté à la barre latérale de Remote Explorer. Cliquez sur l’icône du dossier à côté de son nom pour ouvrir une connexion dans une nouvelle fenêtre Visual Studio Code. La configuration de la première exécution peut prendre quelques instants pendant que Visual Studio configure l’hôte distant et active son composant serveur.

Utilisation des connexions à distance

Une fois l’installation terminée, vous vous retrouverez dans une fenêtre de code Visual Studio standard qui exécute des opérations sur l’hôte sélectionné. Cliquez sur le bouton « Ouvrir le dossier » en haut à gauche de la barre latérale pour trouver un répertoire sur votre serveur. Vous pouvez être invité à accuser réception d’une invite Workspace Trust ; si tel est le cas, cliquez sur « oui » pour marquer le répertoire comme étant de confiance et activer toutes les fonctionnalités de l’éditeur.

Vous verrez maintenant le répertoire côté serveur apparaître dans le volet Explorateur standard de VS Code. Vous pouvez ouvrir des fichiers, afficher leur contenu et les modifier à l’aide du flux de travail familier. Si vous travaillez dans un référentiel Git, vous pouvez utiliser les fonctionnalités de contrôle de source intégrées pour organiser et valider les modifications comme d’habitude.

Répertoires avec .vscode Les fichiers activent des fonctionnalités telles que les builds et le débogage. VS Code peut exécuter le contenu de répertoires distants, vous offrant une expérience de développement complète. Appuyez sur F5 pour démarrer votre application si un système de build est défini. Vous pouvez définir des points d’arrêt et parcourir votre code de la même manière que les projets locaux.

Le panneau VS Code Terminal en bas de votre fenêtre se connectera également à l’hôte sélectionné. Vous pouvez l’utiliser pour exécuter des commandes sur votre serveur distant.

Une fois que vous avez ouvert un répertoire une fois, il apparaîtra dans la barre latérale de l’explorateur distant à l’avenir. Cliquez sur son nom sous l’hôte SSH pour lancer une nouvelle fenêtre VS Code directement dans ce répertoire distant.

Comment ça marche?

Les capacités à distance fonctionnent en installant un composant de serveur VS Code sur votre machine distante. Cela se produit automatiquement la première fois que vous vous connectez. Le serveur surveille le système de fichiers, applique les modifications et lance les processus demandés par l’éditeur.

Le serveur est nécessaire pour que VS Code ait un accès complet au système de fichiers et la possibilité d’exécuter du code et d’exécuter le débogage sur votre hôte. Vous n’avez normalement pas besoin d’interagir avec le processus serveur car il est entièrement géré par votre client éditeur. Vous pouvez le redémarrer à partir de la palette de commandes si vous en avez besoin.

Des extensions dans votre .vscode sera également installé sur l’hôte distant. Cela leur donne le même accès sans compromis à vos fichiers, de sorte que la plupart des extensions fonctionneront sans problème.

Lorsque vous éditez dans VS Code, vous obtenez des performances quasi natives avec peu de frais généraux. Les demandes de lecture et d’écriture de fichiers sont relayées depuis la fenêtre de votre éditeur de code VS vers le processus serveur sur l’hôte distant. Celui-ci interagit avec le système de fichiers pour fournir les données demandées et appliquer les modifications nécessaires.

Contrairement à d’autres extensions d’édition à distance, celle-ci se concentre sur la fourniture d’une expérience de développement à distance complète, et pas seulement sur une simple édition de fichiers. L’inclusion du composant serveur est vitale pour cette approche car les fonctionnalités de base de l’éditeur restent proches du code. Ils sont découplés de la fenêtre d’édition que vous voyez et avec laquelle vous interagissez.

Configuration de l’extension

L’extension dispose de plusieurs paramètres auxquels vous pouvez accéder via la commande « Remote-SSH : Paramètres ». En haut de la page, vous pouvez spécifier le chemin d’accès à un fichier de configuration SSH personnalisé et ajouter un délai d’expiration de connexion par défaut. Cela empêche Visual Studio de se bloquer trop longtemps lorsqu’un hôte distant ne répond plus. Plus bas sur la page, le paramètre « Tentatives maximales de reconnexion » vous permet de modifier le comportement de Visual Studio lorsqu’une connexion échoue.

Le paramètre « Extensions par défaut » vous permet d’ajouter des extensions de code VS qui seront installées sur tous les hôtes SSH distants. Ces extensions seront disponibles universellement, même si vous ne les avez pas ajoutées à votre projet actif .vscode fichier.

Les cases à cocher suivantes contrôlent le transfert automatique de l’agent. Ceux-ci correspondent aux paramètres par défaut du client SSH dans votre fichier de configuration SSH.

D’autres paramètres vous permettent de personnaliser la façon dont VS Code expose et se connecte au serveur distant. Vous pouvez choisir d’utiliser un socket au lieu d’un port, de regrouper les connexions sur des fenêtres ouvertes et d’utiliser un chemin binaire SSH personnalisé. Ces paramètres sont spécifiques à l’environnement ; chacun est accompagné d’une description de son utilisation prévue.

Résumé

L’extension Remote SSH de VS Code simplifie le travail avec des fichiers sur des hôtes distants. Vous bénéficiez d’une expérience de développement de premier ordre sans synchroniser manuellement les fichiers entre les machines.

Le flux de travail améliore l’utilité des environnements de développement distants. Vous pouvez configurer votre chaîne d’outils sur un seul serveur et laisser les développeurs y accéder à distance. VS Code est plus fiable, performant et puissant que les approches traditionnelles telles que le montage local du système de fichiers distant ou l’utilisation d’un logiciel d’accès à distance comme VNC.

Outre les connexions SSH, VS Code comprend également les conteneurs Docker, le sous-système Windows pour Linux et les espaces de code GitHub. Vous bénéficiez de toutes les fonctionnalités de l’éditeur de code VS, quel que soit l’endroit où se trouve votre code, ce qui vous donne plus de flexibilité lors de la configuration d’un nouvel environnement.