Snippets

Table des matières

1. Built-in Snippets

Les snippets sont des morceaux de code préprogrammé (comme un try...catch...) qui permettent de générer du code sans avoir à le taper.

Selon le fichier ouvert et le langage de celui-ci (php, js, markdown, ...), VSCode va proposer des snippets standards et il sera aussi possible de programmer les siens.

La combinaison CTRLSHIFTP puis Insert snippet va faire apparaître une liste pour le langage de programmation du fichier édité :

markdown

2. User Snippets

Il est toutefois possible d’écrire ses propres snippets : CTRLSHIFTP puis Configure User Snippets. On choisit le langage de programmation, p.ex. javascript ce qui aura pour effet d’ouvrir un éditeur avec, ici, le fichier javascript.json ouvert.

Exemple :

{
  "Debug": {
    "prefix": "log",
    "body": [
      " /**/",
      "if (marknotes.settings.debug) {",
      "   console.log('xyz');",
      "}",
      "/**/"
    ]
  }
}

Une fois sauvé, il faut fermer VSCode pour qu’il puisse alors charger le fichier. Lorsqu’on sera dans un fichier javascript; il suffira de taper log pour que l’éditeur propose le User snippet. Si on appuie sur le touche TAB, le prefix sera alors remplacé par le contenu (se trouvant dans le body).

Si TAB est sans effet, vérifier que le paramètre de configuration editor.tabCompletion est bien sur true.

Note : les User snippets sont stockés dans le dossier %APPDATA%\code\user\snippets sous la forme de fichier .json.

Astuce : l’extension snippet-creator simplifie la création d’un snippet depuis un code existant. Il suffit de sélectionner le code déjà présent dans un fichier puis de faire un CTRLSHIFTP Create Snippet pour faire appel au wizard.