Extension of Bash in der Praxis Bash-Bibliotheken mit xsh

Mit eXtension of baSH erstellen, verwalten und publizieren Sie eigene Libraries für Scripting-Projekte via Git-Repository.

Aliasse und lose Funktionssammlungen helfen eine Weile, werden aber irgendwann unübersichtlich, sind schwierig zu verwalten und lassen sich nicht wirklich gut mit anderen teilen. Dann bieten sich Bibliotheken an, die die Bash und andere Shells mit etlichen Standardwerkzeugen aufwerten.

Einige der spannendsten Bash-Library-Projekte haben wir bereits beleuchtet. Natürlich fehlt solchen vorgefertigten Bibliotheken die persönliche Note von über Jahre aufgelaufenen Aliassen. Und da kommt das Framework eXtension of baSH, kurz xsh, ins Spiel.

Xsh ist primär ein Framework zum Nutzen, Erstellen, Verwalten und Veröffentlichen eigener Bibliotheken. Es gibt aber auch einige Standardbibliotheken, so dass xsh auch Out-of-the-Box nützliche Funktionen bereitstellt, beispielsweise für eine strukturierte Verwaltung: Einfacher Umgang mit Hilfe-/Usage-Texten für Funktionen, Basis-Logging, Debugging, Versionierung und natürlich das Laden, Deinstallieren und Updaten von Bibliotheken.

Die Bibliotheken selbst bestehen lediglich aus Skript-Dateien in einer simplen Ordnerstruktur in Form eines Git-Repositories, welches direkt über den xsh-Befehl geladen werden kann. Die eigentlichen Funktionen sind dann in zwei Ausführungen realisierbar: Standardmäßig beinhaltet etwa eine Datei „foobar.sh“ genau eine Funktion plus Usage-Informationen in vorgegebener Formatierung.

Alternativ lassen sich auch komplette Skripte über die Bibliothek nutzen, die in einem eigenen Unterordner liegen und keine Funktion (im Sinne von „function“ natürlich) beinhalten müssen. Soweit die Theorie. Wie einfach xsh in der Praxis ist, und zwar sowohl bezüglich der Nutzung existierender als auch der Entwicklung eigener Bibliotheken, sehen Sie im Folgenden Schritt für Schritt.

Xsh und Core-Bibliothek aufsetzen

Die Installation von xsh ist trivial: Klonen Sie das Repository, führen Sie das Installationsskript aus, das xsh an Ihr Umgebung anpasst, und starten Sie xsh:

Damit ist das Framework selbst installiert, testen lässt es mit „xsh version“.

Nun können Sie die xsh-eigene Bibliothek „core“ installieren:

Welche Bibliotheken geladen sind, erfahren Sie über „xsh list“, was etwa folgende Ausgabe produziert:

Wichtig ist hier das vorangestellte „x“: Das ist der intern genuzte Name der Bibliothek, über den Sie zum Beispiel alle Funktionen/Tools dieser Core-Bibliothek auflisten können:

… produziert eine Liste mit Einträgen wie:

Es handelt sich hier um eine Funktion (bei Skripten wäre [script] vorangestellt) namens „parser“ in der Bibliothek „x“ im Package/Unterordner „json“. Wenn Sie die oben erwähnten standardisierten Usage-Informationen sehen wollen:

Fehlt noch ein letzter Schritt, nämlich die Nutzung dieses Tools. Dafür gibt es zwei Optionen – zunächst der Aufruf via xsh-Befehl:

Oder Sie importieren das gesamte Package und verzichten auf xsh:

Es werden hier also alle Tools (aka sh-Dateien) im Package (aka Unterordner) „jason“ aus der Bibliothek „x“ geladen – darunter eben auch „parser“. Über die Syntax „Bibliothek-Package-Tool“ kann der JSON-Parser dann direkt aufgerufen werden.

Eigene Bibliothek realisieren

Die erste eigene Bibliothek ist nun nur noch ein paar Schritte entfernt. Sie benötigen Zugriff auf einen Git-Server, hier im Beispiel soll es GitHub sein.

Die Beispiel-Bibliothek „mylib“ soll hier nur aus einer Funktion in einer Datei bestehen: „XforU“ tauscht schlicht X gegen U in einem gegebenen String – sinnvoller Weise landet diese Funktion in einem Package namens „testing“.

Die Ordnerstruktur Ihrer Bibliothek ist simpel:

In der Datei „xsh.lib“ wird lediglich der interne Name der Bibliothek konfiguriert:

Spannend wird es nun in der Datei „xforu.sh“:

Die #-Zeilen liefern die Usage-Informationen – den Kommentarstil müssen Sie exakt so umsetzen, damit später Aufrufe wie „xsh help mylib/testing/xforu“ funktionieren. Die Funktion selbst ist dann einfach Standard-Bash-Skript, hier wird also der als Argument übergebene String via „echo“ ausgegeben und via „tr“ manipuliert, um große und kleine Xe gegen entsprechende Us zu tauschen.

Nun können Sie ein Repo anlegen, etwa „meine-xsh-lib“, die Ordnerstruktur committen und pushen, und anschließend mit xsh laden:

Nun sollten folgende Befehle funktionieren:

Die Option „-b master“ dient dazu, xsh mitzuteilen, dass die letzte, ungetaggte Version zu Testzwecken geladen wird. Heißt: Es fehlt noch das Publizieren.

Erstellen Sie dazu einfach ein Release mit einem Versions-Tag, also etwa „1.0.0“ – am besten geht das direkt über die GitHub-Weboberfläche über „Releases/Draft a new release“, wo Sie zum Release direkt einen Tag anlegen lassen können.

Anschließend lässt sich die Bibliothek ohne explizite Testing-Hinweise in xsh laden:

Über „xsh list“ sehen Sie dann Ihre versionierte Bibliothek:

Wenn Sie später Änderungen durchführen, erstellen Sie einfach einen neuen Release „2.0.0“ und schon können Sie mit …

… auf die neue Version aktualisieren.

Wenn Sie xsh antesten wollen, können Sie auch auf ein xsh-Template bei GitHub zurückgreifen, das ein Repository mit dem korrekten Layout erzeugt.

Man muss sich bei xsh vielleicht kurz daran gewöhnen, dass mal die Ordnernamen und mal der intern konfigurierte Name für die Bibliothek zum Einsatz kommt und auch ein paar intern genutzte Begrifflichkeiten sind nicht wirklich intuitiv verständlich. Aber grundsätzlich ist xsh ein extrem einsteigerfreundliches, schlankes Framework, das dennoch alles Wichtige abdeckt.

Sicherlich dürfte es ein paar Stündchen dauern, ein paar Dutzend Aliasse und Mini-Skripte in die xsh-Struktur zu überführen – es lohnt sich! Die Verwaltung ist wesentlich einfacher als bei der üblichen Loseblattsammlung, dank Git-Hosting stehen Funktionen auf beliebigen Rechnern binnen Sekunden zur Verfügung und letztlich können natürlich auch Kollegen mit den nützlichen Helferlein versorgt werden – die dann vielleicht ihrerseits ein paar Zeilen Code spendieren.

Ein Tipp noch zu privaten GitHub-Repos: Laut offizieller Dokumentation funktioniert xsh auch damit, hier führte der Versuch jedoch zu einer Login-Credentials-Schleife und Fehlermeldungen. Nach dem Umstellen auf öffentliche Sichtbarkeit lief alles problemlos.

(ID:48482757)