Comment créer et gérer des snippets de code dans VS Code

Par Sayaib SarkarMis à jour le 4 min de lecture

Sur cette page 5 sections

Réponse courte : VS Code intègre les snippets : lancez Snippets: Configure Snippets, choisissez un langage ou un fichier de projet, et écrivez chaque snippet en JSON avec un prefix et un body. Pour aller plus vite, sélectionnez du code et enregistrez-le comme snippet en quelques secondes avec Create Snippet de DevSnip Pro, et utilisez ses snippets ds- pour Spring Boot, ASP.NET Core, FastAPI, React, Next.js, Flutter et SwiftUI.

Un bon snippet fait gagner plus que des frappes au clavier. Il capture la version d’un motif que vous avez déjà débogué : le gestionnaire d’erreurs avec les bons codes de statut, le test avec la bonne configuration, le wrapper fetch qui vérifie response.ok.

Où VS Code range les snippets

PortéeFichierÀ utiliser pour
Un langagetypescript.json dans votre dossier de snippets utilisateurDes snippets personnels pour un langage
Global*.code-snippets dans votre dossier de snippets utilisateurDes snippets personnels pour plusieurs langages
Projet.vscode/*.code-snippets dans le dépôtDes snippets d’équipe, commités avec le code

Ouvrez n’importe lequel avec Snippets: Configure Snippets (dans les anciennes versions, Preferences: Configure User Snippets) depuis la palette de commandes, Ctrl/Cmd+Shift+P.

Écrire un snippet à la main

Un snippet est une entrée nommée avec le texte que vous tapez (prefix), les lignes qu’il insère (body) et une description facultative affichée dans IntelliSense :

JSON
{
  "Express route handler": {
    "prefix": "exroute",
    "scope": "javascript,typescript",
    "body": [
      "router.${1|get,post,put,delete|}('/${2:path}', async (req, res, next) => {",
      "  try {",
      "    $0",
      "  } catch (err) {",
      "    next(err);",
      "  }",
      "});"
    ],
    "description": "Async Express route that passes errors to next()"
  }
}

La syntaxe qui rend les snippets utiles :

  • $1, $2 … sont des points d’arrêt de tabulation : Tab passe de l’un à l’autre, et $0 est l’endroit où le curseur termine.
  • ${1:path} est un emplacement avec un texte par défaut que vous pouvez remplacer.
  • ${1|get,post,put,delete|} est un choix : une liste déroulante de valeurs.
  • Des variables comme $TM_FILENAME_BASE, $CURRENT_YEAR et $CLIPBOARD insèrent du contexte. ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} transforme user-card en UserCard.
  • scope (dans les fichiers .code-snippets) limite un snippet à certains langages.

Dans body, échappez un $ littéral en \\$, et un } dans un emplacement en \\}.

Enregistrer un snippet à partir du code sélectionné

Écrire du JSON à la main, avec ses guillemets échappés, c’est la partie lente. Avec DevSnip Pro :

  1. Sélectionnez le code à réutiliser.
  2. Lancez DevSnip Pro: Create Snippet.
  3. Saisissez le préfixe que vous taperez, un nom et une description facultative.
  4. Rechargez la fenêtre quand on vous le propose. VS Code charge les snippets fournis au démarrage.

Le snippet apparaît ensuite dans IntelliSense pour ce langage (39 sont pris en charge). Si le préfixe est déjà utilisé par un autre de vos snippets, on vous le demande d’abord, pour éviter d’en avoir deux qui apparaissent ensemble. DevSnip Pro: Saved Snippets liste tout ce que vous avez enregistré et supprime ce que vous n’utilisez plus.

Utiliser des snippets de frameworks prêts à l’emploi

Tapez ds- dans un fichier pris en charge, ou lancez DevSnip Pro: Framework Snippets pour choisir dans une liste. Il y en a 56, et chacun a été développé par VS Code puis compilé (et exécuté quand le framework le permet) : ils fonctionnent tels qu’insérés.

  • Spring Boot : ds-rest-controller, ds-service, ds-entity, ds-repository, ds-controller-advice, ds-webmvctest, ds-junit
  • ASP.NET Core : ds-minimal-api, ds-api-controller, ds-exception-handler, ds-dbcontext, ds-xunit, ds-webapp-test
  • Python : ds-fastapi-app, ds-fastapi-router, ds-pydantic, ds-flask-route, ds-django-view, ds-pytest, ds-pytest-fixture
  • React et Next.js : ds-rfc, ds-hook, ds-context, ds-next-page, ds-next-route, ds-server-action, ds-rtl
  • TypeScript et Node.js : ds-express-router, ds-express-error, ds-zod, ds-fetch-json, ds-vitest
  • Flutter et SwiftUI : ds-stless, ds-stful, ds-future-builder, ds-swiftui-view, ds-view-model

Java, C#, Python et Swift ont aussi un snippet ds-logger. Il crée le logger qu’Insert Debug Log utilise ensuite pour ses lignes de débogage.

Garder une collection de snippets utile

  • Nommez les préfixes d’après ce qu’ils produisent, pas d’après leur provenance : exroute vaut mieux que snippet3. Un début commun (comme ds-) les regroupe dans IntelliSense.
  • Gardez des snippets courts. Un snippet qui génère un fichier entier est difficile à adapter ; quand il vous faut une ressource complète, un générateur convient mieux. L’API Resource Scaffolder de DevSnip Pro crée une API CRUD validée avec pagination pour Express, NestJS, Next.js, Fastify, Spring Boot, ASP.NET Core ou FastAPI.
  • Partagez les snippets d’équipe via le dépôt. Un fichier .vscode/project.code-snippets est versionné et relu comme du code, et toute personne qui ouvre le projet en profite.
  • Faites le tri. Si vous n’avez pas utilisé un snippet depuis des mois, supprimez-le pour retrouver plus facilement ceux que vous utilisez.

Essayez-le dans votre propre éditeur

Gratuit, sans compte, en local. Pour VS Code 1.93+ et les IDE JetBrains sous Windows, macOS ou Linux.

code --install-extension sayaib.hue-console