Jak debugować skrypty Linux Bash za pomocą ShellCheck

Czy masz problemy ze skryptem Bash, który napisałeś dla swojego komputera z systemem Linux ? Zamiast przeszukiwać niezliczone wątki na StackExchange w celu uzyskania pomocy programistycznej, rozważ użycie narzędzia ShellCheck do debugowania skryptów Linux Bash i automatycznego znajdowania błędów w kodzie.

Pobierz ShellCheck

ShellCheck to przydatne narzędzie, ale nie jest dostarczane z systemem operacyjnym Linux po wyjęciu z pudełka. Zamiast tego, jeśli chcesz go użyć, musisz go najpierw zainstalować. W tym samouczku omówimy, jak zainstalować ShellCheck z różnych oficjalnych źródeł oprogramowania. Pokażemy również, jak sprawić, by program działał za pośrednictwem generycznego pliku binarnego Linuksa.

Otwórz okno terminala i zaktualizuj swoje pakiety. Następnie postępuj zgodnie z instrukcjami, które odpowiadają Twojemu systemowi operacyjnemu Linux.

Ubuntu

ShellCheck znajduje się w oficjalnych źródłach oprogramowania Ubuntu, więc instalacja jest dość łatwa. W terminalu użyj menedżera pakietów Apt i uzyskaj działającą najnowszą wersję ShellCheck.

sudo apt install shellcheck

Debiana

Debian Stable ma starszą wersję ShellCheck gotową do zainstalowania przez użytkowników. Należy pamiętać, że ta wersja jest wstrzymywana ze względu na sposób, w jaki robi to Debian.

Uwaga: chcesz nowszą wersję programu ShellCheck? Postępuj zgodnie z naszym przewodnikiem i dowiedz się, jak uzyskać bardziej nowoczesne oprogramowanie na Debianie .

sudo apt-get install shellcheck

Arch Linux

Aby uzyskać ShellCheck w Arch Linux, musisz najpierw włączyć repozytorium oprogramowania „Społeczność”. Włączenie „Społeczności” wymaga edycji pliku Pacman.conf. Aby edytować plik, otwórz Pacman.conf w Nano.

sudo nano /etc/pacman.conf

Przewiń (za pomocą klawiszy strzałek) i znajdź sekcję „Społeczność” pliku. Usuń wszystkie wystąpienia symbolu # (około trzech linii). Następnie zapisz zmiany naciskając klawisze Ctrl + O przycisku.

Po wykonaniu nowych zmian w Pacman.conf naciśnij Ctrl + X, aby zamknąć Nano. Następnie ponownie zsynchronizuj Pacmana, aby skonfigurować dostęp do repozytorium Arch Linux „Community”.

sudo pacman -Syyuu

Na koniec zainstaluj ShellCheck do Arch Linux za pomocą:

sudo pacman -S shellcheck

Fedora

Aby uzyskać narzędzie do analizy skryptów ShellCheck w Fedorze Linux, otwórz terminal i użyj narzędzia do zarządzania pakietami DNF.

sudo dnf zainstaluj ShellCheck

OpenSUSE

Instalacja ShellCheck w OpenSUSE nie wymaga żadnych specjalnych kroków, tak jak ma to miejsce w głównych źródłach oprogramowania dystrybucji. Aby go uzyskać, wprowadź następujące polecenie pakietu Zypper w oknie terminala.

sudo zypper zainstaluj ShellCheck

Ogólny Linux

Użytkownicy mniej znanych dystrybucji Linuksa, którzy chcą mieć dostęp do narzędzia do analizy skryptów ShellCheck, muszą zainstalować uniwersalną wersję binarną. Na szczęście to wydanie binarne jest łatwe do zainstalowania i nie wymaga majstrowania przy kodzie źródłowym. Aby to działało, wykonaj poniższe czynności!

Krok 1:   wyeksportuj wersję ShellCheck, którą zamierzasz pobrać, do środowiska terminala.

export scversion= " stabilna "  # lub "v0.4.7" lub "najnowsza"

Krok 2: korzystając z narzędzia do pobierania wget, pobierz najnowszą wersję binarną ShellCheck.

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

Krok 3: rozpakuj archiwum ShellCheck TarXZ za pomocą  polecenia smoła  .

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

Krok 4: zainstaluj ShellCheck na komputerze z systemem Linux za pomocą polecenia cp .

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

Debuguj skrypty za pomocą ShellCheck

Głównym celem ShellCheck jest przeglądanie skryptu (zwykle Bash), wykrywanie niewłaściwie użytych poleceń i oferowanie poprawek. W przypadku podstawowego użycia wykonaj następujące czynności.

Najpierw CD do miejsca, w którym skrypt, który chcesz sprawdzić, znajduje się na komputerze z systemem Linux. W tym samouczku nasz skrypt znajduje się w ~/shell-scripts . Twoje mogą się różnić.

cd ~/skrypty-powłoki

Uruchom polecenie ls i wyświetl wszystkie pliki w bieżącym katalogu.

Uwaga: jeśli zamierzasz używać ShellCheck w katalogu z wieloma typami plików, dobrym pomysłem jest połączenie  grep  i  ls  razem. Użycie tych dwóch poleceń razem pozwala odfiltrować wszystkie pliki inne niż skrypty.

ls

Lub połącz z grep, aby wyświetlić tylko pliki skryptów.

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

Znajdź nazwę pliku skryptu w wierszu polecenia ls i podświetl nazwę pliku myszą. Gdy będziesz gotowy, uruchom go przez ShellCheck i sprawdź swój kod.

shellcheck nazwa-pliku.sh

lub

shellcheck nazwa-pliku.bash

Natychmiast po uruchomieniu polecenia shellcheck wykryje problemy z twoim kodem i umieści go w wierszu zachęty terminala. Przeczytaj i dowiedz się, jak ulepszyć swoje programowanie, postępując zgodnie z sugestiami, które ci daje.

Zapisz raport ShellCheck do pliku

Otrzymanie natychmiastowego raportu w terminalu dla twojego programowania bash jest bardzo przydatne, jednak możesz go stracić, jeśli zamkniesz terminal. Aby obejść utratę raportu z kontroli powłoki, zalecamy zapisanie danych wyjściowych do pliku tekstowego, uruchamiając program w połączeniu z funkcją >> w terminalu.

shellcheck nazwa-pliku.sh >> ~/Dokumenty/shellcheck-nazwa-raportu-pliku.sh

lub

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

Wyświetl zapisany raport w terminalu za pomocą polecenia cat .

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

lub

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