Configurando seu projeto Node.js para Codespaces

Comece com seu projeto JavaScript, Node.js ou TypeScript em Codespaces criando um contêiner de desenvolvimento personalizado.

Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. Para obter mais informações, consulte os "produtos do GitHub".

Introdução

Este guia mostra como configurar seu projeto JavaScript, Node.js ou TypeScript em Codespaces. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo.

Pré-requisitos

  • Você deve ter um projeto existente de JavaScript, Node.js ou TypeScript em um repositório em GitHub.com. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/microsoft/vscode-remote-try-node
  • Você precisa ter Codespaces habilitado para a sua organização.

Etapa 1: Abra o seu projeto em um codespace

  1. No nome do repositório, use o menu suspenso Código de e na aba Codespaces de código, clique em Novo codespace.

    Botão de codespace novo

    Se você não vir esta opção, significa que Codespaces não está disponível para o seu projeto. Consulte Acesso a Codespaces para mais informações.

Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner para o seu código possui muitas linguagens e tempos de execução, incluindo Node.js, JavaScript, Typescript, nvm, npm e yarn. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano.

Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, adicionando dotfiles para personalizar seu ambienteou modificando as ferramentas e scripts instalados.

Codespaces usa um arquivo denominado devcontainer.json para armazenar configurações. Ao iniciar, Codespaces usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "Introdução a contêineres de desenvolvimento".

Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo

O contêiner de codespaces padrão será compatível com a execução de projetos de Node.js como vscode-remote-try-node fora da caixa. Ao configurar um contêiner personalizado, você poderá personalizar as ferramentas e scripts que são executados como parte da criação de código e garantir um ambiente reprodutível para todos os usuários de Codespaces no seu repositório.

Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo devcontainer.json para definir o ambiente. Em Codespaces, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "Introdução a contêineres de desenvolvimento".

  1. Access the Paleta de Comando do VS Code (Shift + Command + P / Ctrl + Shift + P), then start typing "dev container". Selecione Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento....

    "Codespaces: Add Development Container Configuration Files..." in the Paleta de Comando do VS Code

  2. Para este exemplo, clique em Node.js. Se você precisar de funcionalidades adicionais, você poderá selecionar qualquer contêiner específico para o Node ou uma combinação de ferramentas como Node e MongoDB. Selecione a opção Node na lista

  3. Clique na versão recomendada do Node.js. Seleção de versão do Node.js

  4. Access the Paleta de Comando do VS Code (Shift + Command + P/ Ctrl + Shift + P), then start typing "rebuild". Selecione Codespaces: Reconstruir Contêiner.

    Opção de reconstruir contêiner

Anatomia do seu contêiner de desenvolvimento

A adição do modelo de contêiner de desenvolvimento do Node.js adiciona uma pasta .devcontainer à raiz do repositório do seu projeto com os seguintes arquivos:

  • devcontainer.json
  • arquivo Docker

O arquivo recém-adicionado devcontainer.json define algumas propriedades que são descritas após a amostra.

devcontainer.json

// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node
{
    "name": "Node.js",
    "build": {
        "dockerfile": "Dockerfile",
        // Update 'VARIANT' to pick a Node version: 10, 12, 14
        "args": { "VARIANT": "14" }
    },

    // Set *default* container specific settings.json values on container create.
    "settings": {
        "terminal.integrated.shell.linux": "/bin/bash"
    },

    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
        "dbaeumer.vscode-eslint"
    ],

    // Use 'forwardPorts' to make a list of ports inside the container available locally.
    // "forwardPorts": [],

    // Use 'postCreateCommand' to run commands after the container is created.
    // "postCreateCommand": "yarn install",

    // Comment out connect as root instead. Mais informações: https://aka.ms/vscode-remote/containers/non-root.
    "remoteUser": "node"
}
  • Nome - Você pode dar qualquer nome ao seu contêiner de desenvolvimento. Este é apenas o padrão.
  • Build - As propriedades de compilação.
    • Arquivo Docker - No objeto de compilação, o arquivo Docker é uma referência ao arquivo Docker que também foi adicionado a partir do modelo.
    • Args
      • Variante: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker.
  • Configurações - Estas são configurações de Visual Studio Code que você pode definir.
    • Terminal.integrated.shell.linux - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação.
  • Extensões - Estas são extensões incluídas por padrão.
    • <Dbaeumer.vscode-eslint - ES lint é uma ótima extensão para linting, mas para o JavaScript, há uma série de ótimas extensões do Marketplace que você também pode incluir.
  • forwardPorts - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "Encaminhando portas no seu codespace".
  • postCreateCommand - Se você quiser executar qualquer coisa depois de chegar ao seu codespace que não está definido no arquivo Docker, você poderá fazer isso aqui.
  • remoteUser - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root.

arquivo Docker

# [Choice] Node.js version: 14, 12, 10
ARG VARIANT="14-buster"
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}

# [Optional] Uncomment this section to install additional OS packages.
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
#     && apt-get -y install --no-install-recommends <your-package-list-here>

# [Optional] Uncomment if you want to install an additional version of node using nvm
# ARG EXTRA_NODE_VERSION=10
# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"

# [Optional] Uncomment if you want to install more global node modules
# RUN su node -c "npm install -g <your-package-list-here>"

Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do sistema operacional, versões de nó ou pacotes globais que queremos que sejam incluídos no nosso arquivo Docker.

Etapa 3: Modifique seu arquivo devcontainer.json

Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar o npm quando seu codespace for lançado e para fazer uma lista de portas dentro do contêiner disponível localmente.

  1. No Explorer, selecione o arquivo devcontainer.json a partir da árvore para abri-lo. Você pode ter que expandir a pasta .devcontainer para vê-la.

    Arquivo devcontainer.json no Explorador

  2. Adicione as seguintes linhas ao seu arquivo devcontainer.json após as extensões:

    JSON
    "postCreateCommand": "npm install",
    "forwardPorts": [4000],

    Para obter mais informações sobre as propriedades devcontainer.json, consulte a referência de devcontainer.json na documentação de Visual Studio Code.

  3. Access the Paleta de Comando do VS Code (Shift + Command + P/ Ctrl + Shift + P), then start typing "rebuild". Selecione Codespaces: Reconstruir Contêiner.

    Opção de reconstruir contêiner

    A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner.

Etapa 4: Execute o seu aplicativo

Na seção anterior, você usou o postCreateCommand para instalar um conjunto de pacotes via npm. Agora você pode usar isso para executar nosso aplicativo com npm.

  1. Execute seu comando inicial no terminal comnpm start.

    início do npm no terminal

  2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa.

    Notificação de encaminhamento de porta

Etapa 5: Faça commit das suas alterações

Depois de realizar alterações no seu código, tanto novo código como de configuração, você deverá fazer commit das suas alterações. O commit das alterações no seu repositório garante que qualquer pessoa que crie um codespace deste repositório tenha a mesma configuração. Isto também significa que qualquer personalização que você faça, como adicionar extensões deVisual Studio Code, aparecerá para todos os usuários.

Para obter informações, consulte "Usando o controle de fonte no seu codespace".

Próximas etapas

Agora você deve estar pronto para começar a desenvolver seu projeto JavaScript em Codespaces. Aqui estão alguns recursos adicionais para cenários mais avançados.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.