Skip to main content

Apertura automática de archivos en los codespaces de un repositorio

Puedes establecer archivos concretos para que se abran automáticamente cada vez que alguien crea un codespace para el repositorio y abre dicho codespace en el cliente web de Visual Studio Code.

¿Quién puede utilizar esta característica?

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

Información general

Si hay un archivo concreto que resulta útil para que los usuarios vean cuándo crean un codespace para el repositorio, puedes establecer que este archivo se abra automáticamente en el cliente web de VS Code. Esto se configura en el archivo de configuración del contenedor de desarrollo para el repositorio.

El archivo, o los archivos, que especificas solo se abren la primera vez que se abre un codespace en el cliente web. Si la persona cierra los archivos especificados, esos archivos no se vuelven a abrir automáticamente la próxima vez que la persona abra o reinicie el codespace.

Note

Esta automatización solo se aplica al cliente web de VS Code, no a la aplicación de escritorio de VS Code u otros editores compatibles.

Establecimiento de los archivos que se abrirán automáticamente

  1. Puedes configurar los codespaces creados para el repositorio agregando configuraciones a un archivo devcontainer.json. Si el repositorio aún no contiene un archivo devcontainer.json, puedes agregar uno ahora. Consulte "Incorporación de una configuración de contenedor de desarrollo al repositorio".

  2. Edita el archivo devcontainer.json, agregando una propiedad customizations.codespaces.openFiles. La propiedad customizations reside en el nivel superior del archivo, dentro del objeto JSON envolvente. Por ejemplo:

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

    El valor de la propiedad openFiles es una matriz de uno o varios archivos del repositorio. Las rutas de acceso son relativas a la raíz del repositorio (no se admiten rutas de acceso absolutas). Los archivos se abren en el cliente web en el orden especificado, con el primer archivo de la matriz mostrado en el editor.

  3. Guarda el archivo y confirma tus cambios a la rama requerida del repositorio.

Información adicional