Accès direct au contenu Accès direct à la navigation

Bash, pour "Bourne-Again-Shell" [1], est un "shell" UNIX écrit pour le projet GNU comme un remplacement libre du shell original "Bourne shell" (ou "sh"). La présente bibliothèque est un outil pour faciliter le développement de scripts Bash. Bash est le language le plus couramment utilisé par les terminaux et consoles Unix/Linux.

Ce paquet est notre bibliothèque "Bash".

Utilisation de la bibliothèque

Installation

Vous pouvez installer le paquet de différentes manières décrites ci-dessous ; le plus conseillé est d’utiliser l’interface interne comme décrit en dernier.

Installation classique

Lorsque vous avez téléchargé ou cloné les sources du paquet, copiez simplement le script src/piwi-bash-library.sh dans le répertoire de votre projet pour commencer à l’utiliser ...

Pour une utilisation globale sur votre machine (ou votre serveur), copiez la bibliothèque dans votre répertoire bin/.

Comme tout autre script exécutable, celui-ci doit avoir les droits d’exécution pour tous les utilisateurs.

Une installation directe et complète, incluant le téléchargement, pourrait être :

  1. ~$ wget --no-check-certificate https://github.com/atelierspierrot/piwi-bash-library/archive/master.tar.gz
  2. ~$ tar -xvf master.tar.gz
  3. ~$ cp piwi-bash-library-master/src/piwi-bash-library.sh path/to/your/project/bin/
  4. ~$ chmod +x path/to/your/project/bin/piwi-bash-library.sh
Installation via Composer

Si vous êtes un utilisateur de Composer, vous pouvez ajouter la librairie dans vos paquets requis :

  1.     "atelierspierrot/piwi-bash-library": "1.*"

Elle sera ainsi automatiquement téléchargée et placée dans le répertoire bin du projet.

Interface interne

La librarie propose une interface interne pour gérer (installer/mettre à jour/désinstaller) une copie locale ou globale. Pour l’utiliser, exécutez :

  1. ~$ path/to/piwi-bash-library.sh help

Il peut être intéressant d’intégrer manuellement la bibliothèque dans votre projet en l’incluant sous votre gestionnaire de version. L’interface gérera ainsi les fichiers de la bibliothèque pour vous.

Utilisation

Pour utiliser la bibliothèque, vous devez simplement "sourcer" le script en haut de votre code, ou avant tout appel à ses méthodes ou variables :

  1. #!/bin/bash
  2. source path/to/piwi-bash-library.sh

Pour un chargement complet, avec message d’erreur si le bibliothèque n’est pas trouvée, vous pouvez utiliser :

  1. LIBFILE="path/to/piwi-bash-library.sh"
  2. if [ -f "$LIBFILE" ]; then source "$LIBFILE"; else
  3.     PADDER=$(printf '%0.1s' "#"{1..1000})
  4.     printf "\n### %*.*s\n    %s\n    %s\n%*.*s\n\n" 0 $(($(tput cols)-4)) "ERROR! $PADDER" \
  5.         "Unable to find required library file '$LIBFILE'!" \
  6.         "Sent in '$0' line '${LINENO}' by '`whoami`' - pwd is '`pwd`'" \
  7.         0 $(tput cols) "$PADDER";
  8.     exit 1
  9. fi

De cette façon, si le script n’est pas chargé, l’exécution s’arrêtera avec le message d’erreur suivant :

  1. ### ERROR! ###########################################################
  2.     Unable to find required library file 'path/to/piwi-bash-library.sh'!
  3.     Sent in 'current-file.sh' line '0' by 'username' - pwd is '...'
  4. ######################################################################

Documentation de développement

Des fichiers de documentations sont inclus dans le répertoire doc/ du dépôt.

Un résumé rapide de toutes les méthodes et variables de la bibliothèque peut être rendu en console en exécutant (l’option -v augmentera la verbosité) :

  1. ~$ ./path/to/piwi-bash-library.sh (-v) documentation

Fichiers de démonstration

Un ensemble de tests et démonstrations est inclus dans le répertoire bin/ du paquet. Ces fichiers ne sont pas requis pour une utilisation normale de la librairie.

Pour exécuter l’un de ces tests, exécutez simplement, selon votre système :

  1. ~$ cd path/to/downloaded/package/piwi-bash-library
  2. ~$ ./bin/file-test.sh
  3. OR
  4. ~$ sh bin/file-test.sh
  5. OR
  6. ~$ bash bin/file-test.sh

Vous pouvez utiliser l’option -h pour obtenir une aide.

  1. ~$ ./bin/file-test.sh -h
Voir en ligne : Sources sur GitHub
GNU GPL
Les sources disponibles à l'adresse « https://github.com/atelierspierrot/piwi-bash-library  » sont mises à disposition sous les termes de la licence Licence Publique Générale (GNU General Public License).

[1"bourne again shell" est un jeu de mot anglais avec l’expression "born again" pour "re-naître".