Comment créer un modèle d'en-tête personnalisé pour les scripts Shell dans Vim

Dans cet article, nous allons vous montrer un moyen simple de configurer un en-tête personnalisé pour tous les scripts bash nouvellement créés dans l'éditeur Vim. Cela signifie que chaque fois que vous ouvrez un nouveau fichier .sh à l'aide de l'éditeur vi/vim, l'en-tête personnalisé sera automatiquement ajouté au fichier.

Comment créer un fichier de modèle d'en-tête de script Bash personnalisé

Commencez par créer le fichier modèle appelé sh_header.temp, qui contient votre en-tête de script bash personnalisé, éventuellement dans le répertoire ~/.vim/ sous votre domicile.

vi ~/.vim/sh_header.temp

Ajoutez ensuite les lignes suivantes (n'hésitez pas à définir votre propre emplacement de fichier modèle et votre en-tête personnalisé) et enregistrez le fichier.

#!/bin/bash 

###################################################################
#Script Name	:                                                                                              
#Description	:                                                                                 
#Args           	:                                                                                           
#Author       	:Aaron Kili Kisinga                                                
#Email         	:[email                                            
###################################################################

Le modèle ci-dessus ajoutera automatiquement la ligne « shebang » requise : « #!/bin/bash » et vos autres en-têtes personnalisés. Notez que dans cet exemple, vous ajouterez manuellement le nom, la description et les arguments du script lors de la modification du contenu de votre script.

Configurer autocmd dans le fichier Vimrc

Ouvrez maintenant votre fichier d'initialisation vim ~/.vimrc pour le modifier et ajoutez-y la ligne suivante.

au bufnewfile *.sh 0r /home/aaronkilik/.vim/sh_header.temp

Où :

au – signifie autocmd
bufnewfile – événement pour ouvrir un fichier qui n'existe pas pour le modifier.
*.sh – prend en compte tous les fichiers avec l'extension .sh.

Ainsi, la ligne ci-dessus demande à l'éditeur vi/vim de lire le contenu du fichier modèle (/home/aaronkilik/.vim/sh_header.temp) et de l'insérer dans chaque nouveau .sh fichier ouvert par un utilisateur.

Tester l'en-tête de script Bash personnalisé dans un nouveau fichier de script

Vous pouvez maintenant tester si tout fonctionne en ouvrant un nouveau fichier .sh à l'aide de l'éditeur vi/vim, et votre en-tête personnalisé devrait y être automatiquement ajouté.

vi test.sh

Pour plus d'informations, consultez la documentation Vim autocmd.

Enfin, voici quelques guides utiles concernant les scripts bash et l'éditeur vim :

10 conseils utiles pour écrire des scripts Bash efficaces sous Linux
10 raisons pour lesquelles vous devriez utiliser l'éditeur de texte Vi/Vim sous Linux
Comment protéger par mot de passe un fichier Vim sous Linux
Comment activer la mise en évidence de la syntaxe dans l'éditeur Vi/Vim

C'est tout! Si vous avez des questions ou des conseils et astuces utiles en matière de scripts bash à partager, utilisez le formulaire de commentaires ci-dessous.