Debuggen von Linux Bash-Skripten mit ShellCheck

Haben Sie Probleme mit einem Bash-Skript?hat für deinen Linux PC geschrieben? Anstatt unzählige Threads in StackExchange nach Programmierhilfen zu durchsuchen, sollten Sie das ShellCheck-Tool verwenden, um Linux Bash-Scrips zu debuggen und automatisch Fehler in Ihrem Code zu finden.

Holen Sie sich ShellCheck

ShellCheck ist ein nützliches Tool, das es jedoch nicht gibtmit Ihrem Linux-Betriebssystem aus der Box. Wenn Sie es stattdessen verwenden möchten, müssen Sie es zuerst installieren. In diesem Tutorial erfahren Sie, wie Sie ShellCheck von verschiedenen offiziellen Software-Quellen installieren. Außerdem zeigen wir Ihnen, wie Sie das Programm über die generische Linux-Binärdatei zum Laufen bringen.

Öffnen Sie ein Terminalfenster und aktualisieren Sie Ihre Pakete. Folgen Sie dann den Anweisungen, die Ihrem Linux-Betriebssystem entsprechen.

Ubuntu

ShellCheck ist in den offiziellen Ubuntu-Softwarequellen enthalten, daher ist die Installation recht einfach. Verwenden Sie in einem Terminal den Apt-Paketmanager, um die neueste Version von ShellCheck zum Laufen zu bringen.

sudo apt install shellcheck

Debian

Debian Stable verfügt über eine ältere Version von ShellCheck, die von Benutzern installiert werden kann. Denken Sie daran, dass diese Version aufgrund der Funktionsweise von Debian zurückgehalten wird.

Hinweis: Möchten Sie eine neuere Version des ShellCheck-Programms? Folgen Sie unserem Leitfaden und erfahren Sie, wie Sie modernere Software für Debian erhalten.

sudo apt-get install shellcheck

Arch Linux

Um ShellCheck unter Arch Linux zu erhalten, müssen Sie zuerstmüssen das "Community" -Software-Repository aktivieren. Zum Aktivieren von "Community" muss die Datei Pacman.conf bearbeitet werden. Öffnen Sie Pacman.conf in Nano, um die Datei zu bearbeiten.

sudo nano /etc/pacman.conf

Scrollen Sie (mit den Pfeiltasten) durch die Datei und suchen Sie den Abschnitt "Community". Entfernen Sie alle Vorkommen des Symbols # (ungefähr drei Zeilen). Speichern Sie dann die Änderungen, indem Sie auf drücken Strg + O Taste.

Drücken Sie, um die neuen Änderungen an Pacman.conf zu erledigen Strg + X Nano zu schließen. Synchronisieren Sie anschließend Pacman erneut, um den Zugriff auf das Arch Linux-Community-Repository einzurichten.

sudo pacman -Syyuu

Zum Schluss installieren Sie ShellCheck in Arch Linux mit:

sudo pacman -S shellcheck

Fedora

Um das ShellCheck-Skriptanalysetool unter Fedora Linux abzurufen, öffnen Sie ein Terminal und verwenden Sie das DNF-Paketverwaltungstool.

sudo dnf install ShellCheck

OpenSUSE

Für die Installation von ShellCheck unter OpenSUSE sind keine besonderen Schritte erforderlich, da es sich um die wichtigsten Softwarequellen der Distribution handelt. Geben Sie dazu den folgenden Zypper-Paketbefehl in ein Terminalfenster ein.

sudo zypper install ShellCheck

Generisches Linux

Benutzer von weniger bekannten Linux-Distributionen, dieFür den Zugriff auf das ShellCheck-Skriptanalysetool muss die universelle Binärversion installiert sein. Glücklicherweise ist diese Binärversion einfach zu installieren und erfordert keine Eingriffe in den Quellcode. Um es zum Laufen zu bringen, folge den Schritten unten!

Schritt 1: Exportieren Sie die Version von ShellCheck, die Sie herunterladen möchten, in Ihre Terminalumgebung.

export scversion="stable" # or "v0.4.7", or "latest"

Schritt 2: Verwendung der wget Download-Tool, holen Sie sich die neueste ShellCheck-Binärversion.

wget "https://storage.googleapis.com/shellcheck/shellcheck-${scversion}.linux.x86_64.tar.xz"

Schritt 3: entpacke das ShellCheck TarXZ Archiv mit dem Teer Befehl.

tar --xz -xvf shellcheck-"${scversion}".linux.x86_64.tar.xz

Schritt 4: Installieren Sie ShellCheck auf Ihrem Linux - PC mit cp Befehl.

cp shellcheck-"${scversion}"/shellcheck /usr/bin/

Debuggen Sie Skripte mit ShellCheck

Der Hauptzweck von ShellCheck besteht darin, ein Skript (normalerweise Bash) zu durchsuchen, missbräuchliche Befehle zu erkennen und Korrekturen anzubieten. Führen Sie für die grundlegende Verwendung die folgenden Schritte aus.

Zuerst, CD Das zu überprüfende Skript befindet sich auf Ihrem Linux-PC. In diesem Tutorial befindet sich unser Skript in ~ / Shell-Skripte. Ihre können abweichen.

cd ~/shell-scripts

Führen Sie die ls Befehl und alle Dateien im aktuellen Verzeichnis anzeigen.

Hinweis: Wenn Sie ShellCheck in einem Verzeichnis mit mehreren Dateitypen verwenden möchten, empfiehlt es sich, diese zu kombinieren grep und ls zusammen. Wenn Sie diese beiden Befehle zusammen verwenden, können Sie alle Nicht-Skript-Dateien herausfiltern.

ls

Oder kombinieren Sie mit grep um nur Skriptdateien anzuzeigen.

ls | grep ".sh"
ls | grep ".bash"

Suchen Sie den Namen einer Skriptdatei im ls Eingabeaufforderung und markieren Sie den Dateinamen mit der Maus. Wenn Sie fertig sind, führen Sie es über ShellCheck aus und überprüfen Sie Ihren Code.

shellcheck name-of-file.sh

oder

shellcheck name-of-file.bash

Unmittelbar nach dem Shellcheck Wenn der Befehl ausgeführt wird, werden Probleme mit Ihrem Code erkannt und in die Eingabeaufforderung des Terminals eingegeben. Lesen und lernen Sie, wie Sie Ihre Programmierung verbessern können, indem Sie den darin enthaltenen Vorschlägen folgen.

Speichern Sie den ShellCheck-Bericht in einer Datei

Erhalten eines Sofortberichts im Terminal fürIhre Bash-Programmierung ist sehr nützlich. Sie können sie jedoch verlieren, wenn Sie das Terminal schließen. Um den Shellcheck-Bericht nicht zu verlieren, empfehlen wir, die Ausgabe in einer Textdatei zu speichern, indem Sie das Programm in Kombination mit dem Befehl ausführen >> Funktion im Terminal.

shellcheck name-of-file.sh >> ~/Documents/shellcheck-report-name-of-file.sh

oder

shellcheck name-of-file.bash >> ~/Documents/shellcheck-report-name-of-file.bash

Zeigen Sie Ihren gespeicherten Bericht im Terminal über an Katze Befehl.

cat ~/Documents/shellcheck-report-name-of-file.sh | more

oder

cat ~/Documents/shellcheck-report-name-of-file.bash | more