-
INDEX
-
CONTEÚDO
-
Objetivo:
-
Trechos de código (snippets) são modelos que facilitam a inserção de padrões de código repetidos, como loops ou instruções condicionais. No Visual Studio Code, snippets aparecem no IntelliSense (Ctrl + Space) misturados com outras sugestões, bem como em um seletor de snippet dedicado ( Insert Snippet na Paleta de Comandos = Crtl+ Shift +P).
Caso queira que o conteúdo do campo body seja inserido após teclar no tab é necessário habilitar no campo "editor.tabCompletion": "on" da opção /File/Preferences/Settings.
O uso é simples, ao digitar uma palavra no editor, a mesma é localizada no campo prefix do arquivo de snippets e após pressionar Tab o conteúdo do campo body do arquivo de snippets é inserido na posição do cursor. -
[🔙]
-
-
Pre-requisitos:
-
Editor vsCode.
-
Extensões do editor vscode:
- JavaScript
(ES6) code snippets.
- Esta extensão do vscode suporta as linguagens:
- JavaScript (.js)
- TypeScript (.ts)
- JavaScript React (.jsx)
- TypeScript React (.tsx)
- Html (.html)
- Vue (.vue)
- Esta extensão do vscode suporta as linguagens:
- ...
- JavaScript
(ES6) code snippets.
-
...
-
[🔙]
-
-
Benefícios:
-
Os snippets permitem que o programador seja mais produtivo nas seguintes situação:
- Códigos repetitivos podem ser replicado com apenas duas ou três letras + a tecla tab;
- Memorização de comandos das linguagens para que o programador não tenha que gravar todas as opções de uma linguagem em sua memória.
- Padronização de modelos de código onde um arquivo inteiro pode ser inserido com apenas 2 a 4 letras.
-
[🔙]
-
-
Descrição
-
A padronização de código através de snippets é possível através de extensões já programadas tais como:
- JavaScript (ES6) code snippets paras as linguagens javascript, typescript e html;
- Angular Snippets (Version 11) para é código pre-programados para ser usados com o framework Angular;
- Linguagem c/c++
-
É possível também criar snippets padronizados e sava-los na pasta ~/.config/Code/User/snippets/.
-
Os arquivos de snippets tem extensão .json e possuem o seguinte formato:
-
Código json:
{ " incluir script ./js": // Nome reduzido do snippets. { "prefix": "script", //Chave a ser pesquisada para localizar o snippets quando tiver editando o arquivo. "body": // Entre as tags [] deve ter o código a ser inserido na posição do cursor. [ "<script type= 'application/x-javascript' src= '$1.js' ></script>", "$2" ], "description": "Descrição detalhada do snippets" } , // Separa outra chave com novo código "incluir arquivo ./css": //Nome reduzido do snippets { "prefix": "css", //Chave a ser pesquisada para localizar o snippets quando tiver editando o arquivo. "body": [ //Entre as tags [] deve ter o código a ser inserido na posição do cursor. "<link type='text/css' href='../../css/$1.css' rel='stylesheet' />" "$2" ], "description": "Descrição detalhada do snippets" }, {//.... }, {//....}, }
-
-
A forma mais fácil de editar um código snippets é usar o site snippet generator para inserir no lugar certo o nome reduzido, prefixo e o body.
- Nota: Depois do snippets pronto é só copiar do site e colocar no arquivo selecionado da pasta: ~/.config/Code/User/snippets/.
-
[🔙]
-
-
Exemplos.
-
Como adicionar dois snippets sendo um script para incluir um arquivo javascript (.js) e outro snippets para incluir um arquivo .css:
- Pressione as sequencia de teclas CRTL + SHIFT + P para acessar a Paleta de Comandos;
- Escreva a palavra snippets na linha de pesquisa;
- Selecione a opção: Preferences: Configure User Snippets;
- Se o arquivo de snippets não existe ainda, digite o nome do arquivo para a customização. Obs: Eu uso o nome da linguagem para associar o arquivo a linguagem do snippets;
- Adicione o código json abaixo no arquivo de snippets que vocẽ criou na pasta
~/.config/Code/User/snippets/
-
Código json:
{ " incluir script ./js": { "prefix": "script", "body": [ "<script type= 'application/x-javascript' src= '$1.js' ></script>", "$2" ], "description": "Script para incluir um código application/x-javascript na página html" }, "incluir arquivo ./css": { "prefix": "css", "body": [ "<link type='text/css' href='../../css/$1.css' rel='stylesheet' />" "$2" ], "description": "Incluir arquivo .css na posição do cursor" } }
-
-
...
-
[🔙]
-
-
REFERÊNCIAS
-
HISTÓRICO
- 19/05/2021
- Criar este documento baseado no modelo02.md ;
- Escrever tópico Objetivos;
- Escrever tópico Pre-requisitos
- Escrever tópico Benefícios
- Escrever tópico Descrição
- Escrever tópico Exemplos
- Escrever tópico Referências
- Atualizar o histórico deste documento.
- Ler no dia seguinte este documento para checar os erros de português.
- 19/05/2021
-