shell linter

Linter shell

Tindakan GitHub yang melakukan analisis statis untuk skrip shell menggunakan shellcheck.

Penggunaan

Shell linter dapat melakukan analisis statis dengan berbagai cara. Secara default, ia memindai semua skrip shell yang didukung kerang (sh/bash/dash/ksh) di proyek Anda. Namun, Anda dapat menggunakan parameter path untuk memindai file atau folder tertentu atau menggunakan parameter exclude-paths untuk mengecualikan file atau folder dari pemindaian. Dengan Shell Linter, Anda juga dapat menentukan keparahan kesalahan minimum untuk dipertimbangkan menggunakan parameter severity . Kasus penggunaan khusus bersama dengan contoh ditunjukkan di bawah ini:

Jalankan analisis statis untuk semua skrip shell yang didukung di repositori Anda:

 jobs :
  lint :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v1
      - name : Run ShellCheck
        uses : azohra/shell-linter@latest 

Jalankan analisis statis untuk skrip shell tunggal:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup.sh " 

Jalankan analisis statis untuk beberapa skrip shell dengan atau tanpa ekstensi:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup,deploy.sh " 

Jalankan analisis statis untuk semua skrip shell dalam folder:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src " 

Jalankan analisis statis menggunakan jalur wildcard :

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh " 

Kecualikan file dan folder dari analisis statis:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          exclude-paths : " src/setup.sh,tests/unit_tests " 

Perhatikan bahwa exclude-paths hanya menerima jalur relatif terhadap direktori root proyek Anda. Namun, jangan termasuk ./ Di awal jalan.

Untuk mengecualikan folder dan kontennya secara rekursif hanya menyediakan jalur folder tanpa / di ujungnya. Dalam contoh di atas, seluruh folder di Path tests/unit_tests akan dikecualikan dari linting.

Jalankan analisis statis untuk semua skrip shell dan hanya melaporkan masalah dengan keparahan kesalahan:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh "
          severity : " error " 

Jalankan analisis dengan menggunakan versi spesifik shell linter:

      - name : Run ShellCheck
        uses : azohra/[email protected]

Masukan

path

Opsional. Jalankan Lint Check pada file atau folder tertentu. Bawaan: .

exclude-paths

Opsional. Kecualikan file dan folder dari scan shellcheck.

severity

Opsional. Tentukan keparahan kesalahan minimum untuk dipertimbangkan [gaya, info, peringatan, kesalahan]. Default: style

Lisensi

Perangkat lunak ini tersedia sebagai open source di bawah ketentuan lisensi MIT.