Tutorial: Como Criar e Usar Snippets Personalizados no VS Code

Os snippets (ou "atalhos de código") são trechos de código reutilizáveis que podem ser acionados rapidamente no Visual Studio Code (VS Code). Eles são ideais para evitar a repetição de padrões de código comuns, como estruturas HTML, estilos CSS ou funções JavaScript. Neste tutorial, você aprenderá a criar seus próprios snippets em 3 passos simples.


Passo 1: Acessar a Configuração de Snippets

  1. Abra o VS Code.
  2. No menu superior, clique em File (Arquivo) > Preferences (Preferências) > Configure User Snippets (Configurar Snippets do Usuário).
  3. Uma lista de linguagens de programação será exibida. Escolha a linguagem para a qual deseja criar um snippet (por exemplo, HTML, CSS, JavaScript, etc.).

Passo 2: Definir o Snippet

Após selecionar a linguagem, um arquivo JSON será aberto. Esse arquivo é onde você define seus snippets. Aqui está um exemplo de como criar um snippet para uma estrutura CSS Flexbox:

{
  "Flexbox Container": {
    "prefix": "flex",
    "body": [
      "display: flex;",
      "justify-content: center;",
      "align-items: center;"
    ],
    "description": "Cria um container com display flex e alinhamento centralizado."
  }
}

Explicação do Código:


Passo 3: Usar o Snippet

  1. Salve o arquivo JSON após definir o snippet.
  2. Abra um arquivo da linguagem para a qual você criou o snippet (por exemplo, um arquivo CSS).
  3. Digite o prefixo do snippet (flex, no exemplo acima) e pressione Tab. O snippet será expandido automaticamente:
display: flex;
justify-content: center;
align-items: center;

Dicas Avançadas

  1. Tabstops: Use $1, $2, etc., para criar pontos de interação no snippet. Por exemplo:

    "body": [
      "display: flex;",
      "justify-content: $1;",
      "align-items: $2;"
    ]
    

    Isso permitirá que você navegue rapidamente entre os valores justify-content e align-items ao usar o snippet.

  2. Snippets Globais: Se você quiser usar o mesmo snippet em várias linguagens, crie um arquivo de snippet global (como mencionado no Passo 1).

  3. Cheat Sheet de Atalhos: Para explorar mais funcionalidades do VS Code, confira este cheat sheet completo.


Exemplos Práticos

Snippet para HTML Básico

{
  "HTML Boilerplate": {
    "prefix": "html5",
    "body": [
      "<!DOCTYPE html>",
      "<html lang=\"en\">",
      "<head>",
      "    <meta charset=\"UTF-8\">",
      "    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">",
      "    <title>$1</title>",
      "</head>",
      "<body>",
      "    $2",
      "</body>",
      "</html>"
    ],
    "description": "Cria um template básico de HTML5."
  }
}

Snippet para uma Função JavaScript

{
  "Arrow Function": {
    "prefix": "afn",
    "body": [
      "const ${1:functionName} = (${2:params}) => {",
      "    $3",
      "};"
    ],
    "description": "Cria uma função arrow."
  }
}

Conclusão

Criar snippets personalizados no VS Code é uma maneira eficiente de acelerar seu fluxo de trabalho e evitar repetições. Com os exemplos acima, você pode começar a criar seus próprios snippets e explorar as infinitas possibilidades que o VS Code oferece.

Se precisar de mais referências, não deixe de consultar o cheat sheet do VS Code para descobrir outros atalhos e dicas úteis.