From 21a20079b158678dc0a05f2afb137fe49d7845a9 Mon Sep 17 00:00:00 2001 From: Anthony Borghi <anthony.borghi@veremes.com> Date: Tue, 28 Feb 2023 15:02:06 +0100 Subject: [PATCH] =?UTF-8?q?cr=C3=A9ation=20de=20snippet?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/vscode/presentation.md | 40 +++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/source/vscode/presentation.md b/source/vscode/presentation.md index bb0465b..2b9a46b 100644 --- a/source/vscode/presentation.md +++ b/source/vscode/presentation.md @@ -7,6 +7,46 @@ C'est une application développée avec électron, d'ailleurs une [version Web]( Certains raccourcis pourront être erronés, une partie de l'équipe utilisant une extension pour reprendre les raccourcis de l'IDE Atom anciennement utilisé. +### Créer un snippet personnalisé + +Un snippet est un raccourcis qui va vous permettre de pré-générer du code. + +Il est possible d'en partager dans le dépot ou de les définir localement pour votre vscode. + +Pour définir un snippet, il faut aller dans `File > Preferences > Configure User Snippets`, il faudra saisir un nom pour le fichier générique la première fois. + +Ci-dessous un exemple de syntaxe pour définir un snippet : +```json +{ + "ajax promise" : { + "scope": "javascript,typescript", + "prefix": "v-ajaxp", + "body": [ + "this.vitisRequest.ajaxRequestPromise({", + "\tmethod: '',", + "\turl: env.properties.app_api_url + '/',", + "}).then((resp) => {});"] + } +} +``` + +La clé sert de nom pour le snippet, le prefixe est ce qu'il faudra saisir pour déclencher la génération de code. + +Avec cet exemple si je tape `v-ajaxp` dans un fichier js ou ts je récupérerai le code suivant : +```js +this.vitisRequest.ajaxRequestPromise({ + method: '', + url: env.properties.app_api_url + '/', +}).then((resp) => {}); +``` + +Je n'ai plus qu'à le personnaliser, remplacer le this par services dans certains cas, ... + +Il y a plein d'utilisations possibles, génération de code récurent pour logguer, débugguer par exemple. + +pour avoir plus d'information sur le sujet la documentation est disponible via [ce lien](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets). + + ## Configuration Pour accéder au fichier de configuration JSON de vscode Il faut passer par la palette de commande `CTRL+MAJ+P` et choisir `Preferences : Open User Settings (JSON)`. -- GitLab