Configurar Codespaces para tu proyecto

Acerca de las configuraciones predeterminadas de los codespaces

Puedes crear una configuración predeterminada de codespaces para tu repositorio, la cual determine el ambiente de cada codespace nuevo que alguien cree para este repositorio. La configuración define un contenedor de desarrollo que puede incluir marcos de trabajo, herramientas, extensiones y redireccionamiento de puertos.

Si no defines una configuración en tu repositorio, GitHub creará un codespace con una imagen base de Linux. La imagen base de Linux incluye herramientas para Node.js, JavaScript, TypeScript, Python, C++, Java, C#, .NET Core, PHP, y PowerShell. Para obtener más información acerca de la imagen base de Linux, consulta el repositorio microsoft/vscode-dev-containers.

También puedes personalizar los aspectos del ambiente de un codespace para cad acodespace que tu cuenta cree. La personalización puede incluir preferencias de shell y herramientas adicionales.Tu personalización de dotfiles se aplica antes de una configuración predeterminada de codespaces de un repositorio.Para obtener más información, consulta la sección "Personalizar Codespaces para tu cuenta".

Puedes crear una configuración predeterminada para tus codespaces utilizando una configuración de contenedor pre-compilado para tu tipo de proyecto, o puedes crear una configuración personalizada específica para las necesidades de tu proyecto.

Codespaces utiliza una configuración que se contiene en un archivo llamado devcontainer.json en la raíz del repositorio o en una carpeta .devcontainer. Puedes utilizar devcontainer.json para configurar los ajustes predeterminados para todo el ambiente del codespace, incluyendo el editor de Visual Studio Code, pero también puedes configurar los ajustes específicos para el editor en un archivo llamado .vscode/settings.json.

Los cambios a la configuración de un codespace en un repositorio se aplican únicamente a cada codespace nuevo y no afectan a los ya existentes.

Utilizar una configuración de contenedor pre-compilado

Puedes utilizar cualquier configuración de contenedor pre-compilado para Visual Studio Code que se encuentre disponible en el repositorio vscode-dev-containers. Las definiciones de los contenedores pre-compilados incluyen una configuración común para un tipo de proyecto en particular, y pueden ayudarte a comenzar rápidamente con una configuración que ya tenga las opciones adecuadas para el contenedor, los ajustes de Visual Studio Code, y las extensiones de Visual Studio Code que deben estar instaladas.

1. Clona o descarga el repositorio vscode-dev-containers.
2. En el repositorio vscode-dev-containers, navega a la carpeta containers, y luego escoge una configuración de contenedor de acuerdo con las necesidades de tu proyecto. Utilizaremos la configuración del contenedor de Node.js & JavaScript como ejemplo.
3. Desde la carpeta de Node.js & JavaScript, copia la carpeta .devcontainer a la raíz del repositorio de tu proyecto.
4. Confirma y carga la nueva confirmación al repositorio de tu proyecto en GitHub.

Cada coedspace nuevo que crées desde una rama que contenga la carpeta .devcontainer se configurará de acuerdo con el contenido de la misma. Para obtener más información, consulta la sección "Crear un codespace".

Crear una configuración personalizada para un codespace

Si ninguna de las configuraciones pre-compiladas se ajusta a tus necesidades, puedes crear una configuración personalizada si agregas un archivo devcontainer.json a la raíz de tu repositorio o una carpeta .devcontainer. En el archivo, puedes utilizar claves de configuración compatibles para especificar aspectos del ambiente del codespace, como por ejemplo, qué extensiones de Visual Studio Code deben instalarse.

Cuando configuras los ajustes de editor para Visual Studio Code, hay tres alcances disponibles: Espacio de trabajo, [Codespaces] Remotos , y Usuario. Si una configuración se define en varios alcances, los ajustes de espacio de trabajo tomarán prioridad, luego los de [Codespaces] Remotos, y luego los de Usuario.

Puedes definir la configuración predeterminada del editor para Visual Studio Code en dos lugares.

• La configuración del editor que se definió en .vscode/settings.json se aplica como una configuración con alcance de Workspace- en este codespace.
• La configuración del editor que se definió en la clave settings en devcontainer.json se aplica como una configuración con alcance de Remote [Codespaces] en este codespace.

Claves de configuración compatibles con los codespaces

Puedes utilizar claves de configuración compatibles con Codespaces en devcontainer.json.

Ajustes generales

• name (nombre)
• parámetros
• extensions
• forwardPorts
• devPort
• postCreateCommand

Ajustes de Docker, Dockerfile o de imagen

• imagen
• dockerFile
• context
• containerEnv
• remoteEnv
• containerUser
• remoteUser
• updateRemoteUserUID
• mounts
• workspaceMount
• workspaceFolder
• runArgs
• overrideCommand
• shutdownAction
• dockerComposeFile

Para obtener más información acerca de los ajustes disponibles para devcontainer.json, consulta la sección devcontainer.json reference en la documentación de Visual Studio Code.