Hvordan feilsøke Linux Bash-skript med ShellCheck

Har du problemer med et Bash-skript duskrevet for din Linux-PC? I stedet for å lete gjennom utallige tråder på StackExchange for å få hjelp til programmering, kan du vurdere å bruke ShellCheck-verktøyet til å feilsøke Linux Bash-skript og automatisk finne feil i koden din.

Få ShellCheck

ShellCheck er et nyttig verktøy, men det kommer ikkemed Linux-operativsystemet ditt ut av boksen. I stedet, hvis du vil bruke den, må du installere den først. I denne opplæringen vil vi dekke hvordan du installerer ShellCheck fra forskjellige offisielle programvarekilder. I tillegg viser vi deg hvordan du får programmet til å fungere via den generiske Linux-binæren.

Åpne et terminalvindu og oppdater pakkene dine. Følg deretter instruksjonene som tilsvarer ditt Linux-operativsystem.

Ubuntu

ShellCheck er i de offisielle Ubuntu-programvarekildene, så det er ganske enkelt å installere det. Bruk Apt-pakkehåndtereren i en terminal og få den nyeste versjonen av ShellCheck som fungerer.

sudo apt install shellcheck

Debian

Debian Stable har en eldre versjon av ShellCheck klar for brukere å installere. Husk at denne versjonen holdes tilbake på grunn av hvordan Debian gjør ting.

Merk: vil du ha en nyere versjon av ShellCheck-programmet? Følg guiden vår og lær om hvordan du får mer moderne programvare på Debian.

sudo apt-get install shellcheck

Arch Linux

For å få ShellCheck på Arch Linux, må du førsttrenger å aktivere programvarelageret “Community”. Aktivering av “Community” krever redigering av Pacman.conf-filen. Hvis du vil redigere filen, åpner du Pacman.conf i Nano.

sudo nano /etc/pacman.conf

Bla gjennom (med piltastene) og finn "Community" -delen av filen. Fjern alle forekomster av # -symbolet (omtrent tre linjer). Lagre redigeringene ved å trykke på Ctrl + O knapp.

Med de nye redigeringene til Pacman.conf tatt vare på, trykk Ctrl + X å lukke Nano. Deretter synkroniserer du Pacman for å sette opp tilgang til Arch Linux “Community” -lageret.

sudo pacman -Syyuu

Til slutt installerer ShellCheck til Arch Linux med:

sudo pacman -S shellcheck

Fedora

For å få ShellCheck-skriptanalyseverktøyet på Fedora Linux, åpne opp en terminal og bruk DNF-pakkehåndteringsverktøyet.

sudo dnf install ShellCheck

Opensuse

Å installere ShellCheck på OpenSUSE krever ingen spesielle trinn, da det er i distribusjonens viktigste programvarekilder. For å få det, skriver du inn følgende Zypper-pakke-kommando i et terminalvindu.

sudo zypper install ShellCheck

Generisk Linux

Brukere av mindre kjente Linux-distribusjoner somsom ønsker tilgang til ShellCheck-skriptanalyseverktøyet må installere den universelle binære utgivelsen. Heldigvis er denne binære utgivelsen enkel å installere og krever ingen forvirring med kildekoden. Følg trinnene nedenfor for å få det til å fungere!

Trinn 1: eksportere versjonen av ShellCheck du skal laste ned til terminalmiljøet ditt.

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

Steg 2: bruker wget laste ned verktøy, ta tak i den siste ShellCheck binære utgivelsen.

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

Trinn 3: trekke ut ShellCheck TarXZ arkivet med tjære kommando.

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

Trinn 4: installer ShellCheck på din Linux-PC med cp kommando.

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

Feilsøk skript med ShellCheck

ShellChecks hovedformål er å se over et skript (vanligvis Bash), oppdage misbrukte kommandoer og tilby korreksjoner. For grunnleggende bruk, gjør du følgende.

Først, CD hvor skriptet du ønsker å sjekke, er på din Linux-PC. I denne opplæringen er skriptet vårt i ~ / Skall-skript. Din kan avvike.

cd ~/shell-scripts

Kjør ls kommando og se alle filene i den gjeldende katalogen.

Merk: Hvis du har tenkt å bruke ShellCheck i en katalog med flere filtyper, er det lurt å kombinere grep og ls sammen. Ved å bruke disse to kommandoene sammen kan du filtrere ut alle filer som ikke er skript.

ls

Eller kombiner med grep for å vise bare skriptfiler.

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

Finn navnet på en skriptfil i ls spør og merk filnavnet med musen. Når du er klar, kjør den gjennom ShellCheck og sjekk koden din.

shellcheck name-of-file.sh

eller

shellcheck name-of-file.bash

Umiddelbart etter shellcheck kommandoen kjøres, vil den oppdage problemer med koden din og sette den i terminalteksten. Les gjennom og lær hvordan du kan forbedre programmeringen ved å følge forslagene den gir deg.

Lagre ShellCheck-rapporten i en fil

Få en øyeblikkelig rapport i terminalen forbash-programmeringen din er imidlertid super nyttig, men du kan miste den hvis du lukker terminalen. For å unngå å miste shellcheck-rapporten, anbefaler vi at du lagrer utdataene i en tekstfil ved å kjøre programmet i kombinasjon med >> funksjon i terminalen.

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

eller

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

Vis den lagrede rapporten i terminalen via katt kommando.

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

eller

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