Comment augmenter la productivité avec des extraits de texte sublimes

Pour faire court, j'ai récemment été affecté à un projet dans lequel je dois créer de nombreux scripts bash. Je viens d'un milieu python et j'utilise Jupyter Notebook pour tous mes travaux de développement. Le problème avec les scripts bash pour moi est son utilisation déroutante des crochets et son bloc de codes répétitif dans tous mes scripts.

Jusque-là, j'utilisais l'éditeur Nano pour créer des scripts bash. Nano fournit quelques fonctionnalités de base en tant qu'éditeur de terminal, mais pas au-delà d'un certain point. J'ai donc fait mes recherches et sélectionné « SUBLIME TEXT 3 » comme éditeur de prédilection pour bash et d'autres langages de programmation. J'ai créé de nombreux extraits de fonctions répétitives, des one-liners et des blocs de contrôle pour les scripts bash, ce qui non seulement m'a fait gagner du temps, mais a également amélioré ma productivité.

Qu’est-ce qu’un extrait ?

Les extraits de code sont une fonctionnalité de programmation populaire fournie avec de nombreux éditeurs de texte ou éditeurs IDE modernes. Vous pouvez considérer les extraits de code comme un modèle qui peut être réutilisé chaque fois que nécessaire. Les extraits ne sont pas limités à des langages de programmation particuliers. Vous pouvez simplement créer un nouvel extrait, ajouter le texte que vous souhaitez insérer et attribuer un mot déclencheur. Nous verrons toutes ces fonctionnalités dans la section suivante.

Pour répertorier les extraits définis dans un texte sublime

Par défaut, le texte sublime est livré avec des extraits prédéfinis pour la bash. Il affichera intelligemment les extraits de code en fonction du fichier actuel à partir duquel nous recherchons l'extrait. Je suis dans un script shell et lorsque j'invoque la commande pallet et que je tape snippet, elle fournit automatiquement une liste d'extraits définis pour le bash.

Il existe deux manières d'accéder aux extraits de code dans Sublime Text.

Piloté par menu ⇒ TEXTE SUBLIME → OUTILS → EXTRAITS
PALETTE DE COMMANDE ⇒ TEXTE SUBLIME → PALETTE DE COMMANDE (CTRL+MAJ+P) → EXTRAITS DE TYPE

Créer de nouveaux extraits dans Sublime Text

Le texte Sublime fournit un modèle par défaut au format XML lorsque nous créons un nouvel extrait. Pour créer le modèle, accédez à SUBLIME TEXT → TOOLS → DEVELOPER → NEW SNIPPET.

Comprenons la définition du modèle et modifions les paramètres.

Le contenu réel ou le bloc de code à insérer doit être placé dans . Je vais créer un extrait pour « commentaire d'en-tête ». Chaque script que vous créez aura un commentaire d'en-tête définissant les informations sur le script comme le nom de l'auteur, la date de création, le numéro de version, la date de déploiement, etc.
Tabtrigger (Facultatif) qui lie un « TEXTE » qui agit comme un déclencheur pour l'extrait de code. Lorsque le nom du déclencheur est saisi et que vous appuyez sur « TAB », l'extrait sera inséré. Il est commenté par défaut, supprimez le commentaire et ajoutez du texte pour le déclencheur. Choisissez un nom descriptif et court. Par exemple : je choisis « hcom » pour insérer des commentaires d'en-tête. Cela peut être n'importe quoi de votre choix.
Portée (Facultatif) définit la langue à laquelle vos extraits de code sont liés. Vous pouvez travailler avec 2 ou 3 langages de programmation différents à la fois et utiliser le même nom pour différents extraits de code dans différents langages de programmation. Dans ce cas, la portée contrôle dans quelle langue votre extrait doit être inséré pour éviter ainsi la collision. Vous pouvez obtenir la liste des étendues à partir de Link. Vous pouvez également accéder à OUTILS → DÉVELOPPEUR → AFFICHER LE NOM DE LA PORTÉE ou appuyer sur pour obtenir le nom de la portée de la langue que vous utilisez.
La Description (Facultatif) ne sera pas disponible dans le modèle par défaut, mais vous pouvez l'utiliser pour définir un certain contexte sur ce que fait cet extrait.

Maintenant, nous avons fait quelques choses de base. Nous avons défini un extrait de code qui insérera un simple commentaire d'en-tête lié au déclencheur de l'onglet « hcom » et provenant du script shell.

Ouvrons maintenant un nouveau fichier bash et « tapez hcom ». Si vous regardez l'image ci-dessous lorsque je « tapez h », la définition de mon extrait apparaît avec la description que nous avons donnée. Tout ce que j'ai à faire est d'appuyer sur la touche <tab> pour le développer.

Des champs

Les champs sont indiqués par $1, $2, $3 et ainsi de suite. À l'aide du champ, vous pouvez accéder à la position où le marqueur de champ est placé en appuyant simplement sur la touche <tab>.

Si vous regardez mon extrait, j'ai ajouté deux marqueurs de champ $1 et $2, ce que cela fait, c'est que lorsque j'insère mon extrait, le curseur sera placé sur $1 pour que je puisse taper quelque chose à cette position.

Ensuite, je dois appuyer sur la touche <tab> pour passer au marqueur suivant $2 et taper quelque chose. Il est à noter que lorsque vous avez un marqueur identique, disons $1 dans ce cas à 2 positions, la mise à jour du champ à une position mettra à jour les champs identiques ($1).

Touche <tab> → Passer au marqueur de champ suivant.
Touche → Passer au marqueur de champ précédent.
Touche → Sortir du cycle de terrain.
$0 → Contrôle le point de sortie.

Espace réservé

Les espaces réservés sont comme une paire clé-valeur définie entre accolades $ {0:} ; le marqueur de champ sera étiqueté avec une valeur par défaut. Vous pouvez soit modifier la valeur, soit la laisser telle quelle. Lorsque l'extrait est inséré et si vous appuyez sur la tabulation, le curseur sera placé à la valeur par défaut.

Maintenant, l'extrait est inséré avec la valeur par défaut et la souris est placée sur $1 qui est v1 dans ce cas. Soit je peux modifier la valeur, soit simplement appuyer sur <tab> la touche pour passer au marqueur suivant.

Le seul inconvénient des extraits de Sublime Text est que vous ne pouvez pas regrouper tous les extraits dans un seul fichier. Un seul extrait de code par fichier est autorisé, ce qui est fastidieux. Mais il existe d'autres options comme la création de fichiers .sublime-completion. Pour en savoir plus, consultez la documentation.

Où est stocké mon fichier d’extrait de code ?

Les fichiers d'extraits doivent être enregistrés avec le suffixe .sublime-snippet. Accédez à PRÉFÉRENCES → PARcourir les forfaits. Cela ouvrira le répertoire dans lequel les paramètres définis par l'utilisateur sont stockés. Accédez au répertoire « Utilisateur » où votre fichier d'extrait sera enregistré.

Générateur d'extraits

Snippet-generator-app fournit une génération automatique d'extraits de code sur le Web en fonction de nos entrées. Il est disponible pour Sublime Text, Atom et VSCode. Tapez la description, le déclencheur de l'onglet et le contenu sur le côté gauche qui généreront du code en direct sur le côté droit de la page.

Exemple d'extrait qui obtiendra le nom du cluster de l'API Ambari.

C'est tout pour aujourd'hui. Nous avons vu les avantages de l'utilisation de extraits dans un texte sublime. Je viens d'utiliser un simple pseudo-texte comme exemple pour démontrer la fonctionnalité d'extraits de code, mais il y a bien plus à faire. Je tiens également à souligner que cette fonctionnalité est disponible dans tous les éditeurs/IDE comme Vim, Atom, Eclipse, Pycharm , Vscode, etc.