Comment créer « Vim Editor » en tant que Bash-IDE sous Linux

Un IDE (Integrated Development Environment) est simplement un logiciel qui offre des fonctionnalités et des composants de programmation indispensables dans un seul programme, pour maximiser la productivité du programmeur. Les IDE proposent un programme unique dans lequel tout le développement peut être effectué, permettant à un programmeur d'écrire, de modifier, de compiler, de déployer et de déboguer des programmes.

Dans cet article, nous décrirons comment installer et configurer l'éditeur Vim en tant que Bash-IDE à l'aide du plug-in vim bash-support.

Qu'est-ce que le plug-in bash-support.vim ?

bash-support est un plug-in vim hautement personnalisable, qui vous permet d'insérer : des en-têtes de fichiers, des instructions complètes, des commentaires, des fonctions et des extraits de code. Il vous permet également d'effectuer une vérification de syntaxe, de rendre un script exécutable, de démarrer un débogueur simplement d'une simple frappe sur une touche ; faites tout cela sans fermer l'éditeur.

Cela rend généralement les scripts bash amusants et agréables grâce à l'écriture/insertion organisée et cohérente du contenu du fichier à l'aide de touches de raccourci (mappages).

La version actuelle du plug-in est 4.3, la version 4.0 était une réécriture de la version 3.12.1 ; version 4.0 ou supérieure, sont basés sur un système de modèles entièrement nouveau et plus puissant, avec une syntaxe de modèle modifiée contrairement aux versions précédentes.

Comment installer le plug-in de support Bash sous Linux

Commencez par télécharger la dernière version du plug-in bash-support à l'aide de la commande ci-dessous :

cd Downloads
curl http://www.vim.org/scripts/download_script.php?src_id=24452 >bash-support.zip

Ensuite, installez-le comme suit : créez le répertoire .vim dans votre dossier personnel (au cas où il n'existe pas), déplacez-vous dedans et extrayez-y le contenu de bash-support.zip :

mkdir ~/.vim
cd .vim
unzip ~/Downloads/bash-support.zip

Ensuite, activez-le depuis le fichier .vimrc :

vi ~/.vimrc

En insérant la ligne ci-dessous :

filetype plugin on   
set number   #optionally add this to show line numbers in vim

Comment utiliser le plug-in de support Bash avec Vim Editor

Pour simplifier son utilisation, les constructions fréquemment utilisées, ainsi que certaines opérations, peuvent être insérées/effectuées respectivement avec des mappages de touches. Les mappages sont décrits dans ~/.vim/doc/bashsupport.txt et ~/.vim/bash-support/doc/bash-hotkeys.pdf ou Fichiers ~/.vim/bash-support/doc/bash-hotkeys.tex.

Important:

Tous les mappages (combinaison (\)+charater(s)) sont spécifiques au type de fichier : ils ne fonctionnent qu'avec les fichiers 'sh', afin d'éviter les conflits avec les mappages d'autres des plug-ins.
La vitesse de frappe est importante : lors de l'utilisation du mappage des touches, la combinaison d'un leader ('\') et du ou des caractères suivants ne sera reconnue que pendant une courte période (peut-être moins de 3< secondes – basé sur une hypothèse).

Ci-dessous certaines fonctionnalités remarquables de ce plug-in que nous allons expliquer et apprendre à utiliser :

Comment générer un en-tête automatique pour les nouveaux scripts

Regardez l'exemple d'en-tête ci-dessous, pour que cet en-tête soit créé automatiquement dans tous vos nouveaux scripts bash, suivez les étapes ci-dessous.

Commencez par définir vos informations personnelles (nom de l'auteur, référence de l'auteur, organisation, entreprise, etc.). Utilisez la carte \ntw dans un tampon Bash (ouvrez un script de test comme celui ci-dessous) pour démarrer l'assistant de configuration du modèle.

Sélectionnez l'option (1) pour configurer le fichier de personnalisation, puis appuyez sur [Entrée].

vi test.sh

Ensuite, appuyez à nouveau sur [Entrée]. Sélectionnez ensuite l'option (1) une fois de plus pour définir l'emplacement du fichier de personnalisation et appuyez sur [Entrée].

L'assistant copiera le fichier modèle .vim/bash-support/rc/personal.templates dans .vim/templates/personal.templates et l'ouvrira pour le modifier, où vous peut insérer vos coordonnées.

Appuyez sur i pour insérer les valeurs appropriées entre les guillemets simples, comme indiqué dans la capture d'écran.

Une fois que vous avez défini les valeurs correctes, tapez :wq pour enregistrer et quitter le fichier. Fermez le script de test Bash, ouvrez un autre script pour vérifier la nouvelle configuration. L'en-tête du fichier devrait maintenant contenir vos informations personnelles similaires à celles de la capture d'écran ci-dessous :

test2.sh

Rendre l'aide du plug-in compatible Bash accessible

Pour ce faire, tapez la commande ci-dessous sur la ligne de commande Vim et appuyez sur [Entrée], cela créera un fichier .vim/doc/tags :

:helptags $HOME/.vim/doc/

Comment insérer des commentaires dans les scripts Shell

Pour insérer un commentaire encadré, tapez \cfr en mode normal :

Comment insérer des instructions dans un script Shell

Voici les mappages de touches pour l'insertion d'instructions (n – mode normal, i – mode insertion) :

\sc – cas dans … esac (n, I)
\sei – elif alors (n, I)
\sf – pour ce qui est fait (n, i, v)
\sfo – pour ((…)) faire (n, i, v)
\si – si alors fi (n, i, v)
\sie – si alors sinon fi (n, i, v)
\ss – sélectionner dans do done (n, i, v)
\su – jusqu'à ce que ce soit fait (n, i, v)
\sw – while do done (n, i, v)
\sfu – fonction (n, i, v)
\se – echo -e « … » (n, i, v)
\sp – printf « … » (n, i, v)
\sa – élément de tableau, $ {.[.]} (n, i, v) et bien d'autres fonctionnalités de tableau.

Insérer une fonction et un en-tête de fonction

Tapez \sfu pour ajouter une nouvelle fonction vide, puis ajoutez le nom de la fonction et appuyez sur [Entrée] pour la créer. Ensuite, ajoutez votre code de fonction.

Pour créer un en-tête pour la fonction ci-dessus, tapez \cfu, entrez le nom de la fonction, cliquez sur [Entrée], et remplissez les valeurs appropriées (nom, description, paramètres et retours) :

Plus d'exemples d'ajout d'instructions Bash

Vous trouverez ci-dessous un exemple montrant l'insertion d'une instruction if à l'aide de \si :

L'exemple suivant montre l'ajout d'une instruction echo en utilisant \se :

Comment utiliser l'opération d'exécution dans l'éditeur Vi

Voici une liste de certains mappages de touches d’opérations d’exécution :

\rr – mettre à jour le fichier, exécuter le script (n, I)
\ra – définit les arguments de la ligne cmd du script (n, I)
\rc – mettre à jour le fichier, vérifier la syntaxe (n, I)
\rco – options de vérification de la syntaxe (n, I)
\rd – démarre le débogueur (n, I)
\re – rendre le script exécutable/non exec.(*) (in)

Rendre le script exécutable

Après avoir écrit le script, enregistrez-le et tapez \re pour le rendre exécutable en appuyant sur [Entrée].

Comment utiliser des extraits de code prédéfinis dans un script Bash

Les extraits de code prédéfinis sont des fichiers contenant du code déjà écrit destiné à un objectif spécifique. Pour ajouter des extraits de code, tapez \nr et \nw pour lire/écrire des extraits de code prédéfinis. Exécutez la commande suivante pour répertorier les extraits de code par défaut :

.vim/bash-support/codesnippets/

Pour utiliser un extrait de code tel que free-software-comment, tapez \nr et utilisez la fonction de saisie semi-automatique pour sélectionner son nom, puis appuyez sur [Entrée] :

Créer des extraits de code prédéfinis personnalisés

Il est possible d'écrire vos propres extraits de code sous ~/.vim/bash-support/codesnippets/. Surtout, vous pouvez également créer vos propres extraits de code à partir du code de script normal :

choisissez la section de code que vous souhaitez utiliser comme extrait de code, puis appuyez sur \nw et donnez-lui un nom de fichier.
pour le lire, tapez \nr et utilisez le nom du fichier pour ajouter votre extrait de code personnalisé.

Afficher l'aide pour le module intégré et la commande sous le curseur

Pour afficher l'aide, en mode normal, tapez :

\hh – pour une aide intégrée
\hm – pour une aide sur les commandes

Pour plus de référence, lisez le fichier :

~/.vim/doc/bashsupport.txt  #copy of online documentation
~/.vim/doc/tags

Visitez le référentiel Github du plug-in de support Bash : https://github.com/WolfgangMehner/bash-support
Visitez le plug-in de support Bash sur le site Web de Vim : http://www.vim.org/scripts/script.php?script_id=365

C'est tout pour l'instant, dans cet article, nous avons décrit les étapes d'installation et de configuration de Vim en tant qu'IDE Bash sous Linux à l'aide du plug-in de support bash. Découvrez les autres fonctionnalités intéressantes de ce plug-in et partagez-les avec nous dans les commentaires.