Skip to main content

Ouverture automatique de fichiers dans les codespaces d’un référentiel

Vous pouvez définir des fichiers particuliers à ouvrir automatiquement chaque fois qu’une personne crée un codespace pour votre référentiel et ouvre le codespace dans le client web Visual Studio Code.

Who can use this feature?

People with write permissions to a repository can create or edit the codespace configuration.

Vue d’ensemble

Si un fichier particulier est utile aux utilisateurs quand ils créent un codespace pour votre référentiel, vous pouvez définir ce fichier afin qu’il s’ouvre automatiquement dans le client web VS Code. Vous configurez cette option dans le fichier de configuration du conteneur de développement pour votre référentiel.

Le ou les fichiers que vous spécifiez sont ouverts uniquement la première fois qu’un codespace est ouvert dans le client web. Si la personne ferme les fichiers spécifiés, ceux-ci ne sont pas rouverts automatiquement la prochaine fois que l’utilisateur ouvre ou redémarre le codespace.

Remarque : cette automatisation s’applique uniquement au client web VS Code, pas à l’application de bureau VS Code ni aux autres éditeurs pris en charge.

Définition des fichiers devant s’ouvrir automatiquement

  1. Vous pouvez configurer les codespaces créés pour votre dépôt en ajoutant des paramètres à un fichier devcontainer.json. Si votre dépôt ne contient pas encore de fichier devcontainer.json, vous pouvez en ajouter un maintenant. Consultez « Ajout d’une configuration de conteneur de développement à votre dépôt ».

  2. Modifiez le fichier devcontainer.json en ajoutant une propriété customizations.codespaces.openFiles. La propriété customizations se trouve au niveau supérieur du fichier, dans l’objet JSON englobant. Par exemple :

    JSON
    "customizations": {
      "codespaces": {
        "openFiles": [
          "README.md",
          "scripts/tsconfig.json",
          "docs/main/CODING_STANDARDS.md"
        ]
      }
    }
    

    La valeur de la propriété openFiles est un tableau d’un ou plusieurs fichiers dans votre référentiel. Les chemins d’accès sont relatifs à la racine du référentiel (les chemins absolus ne sont pas pris en charge). Les fichiers sont ouverts dans le client web dans l’ordre spécifié, le premier fichier du tableau étant affiché dans l’éditeur.

  3. Enregistrez le fichier et commitez vos changements dans la branche nécessaire du dépôt.

Pour aller plus loin