shellcheck
ShellCheck,一個用於 Shell 指令稿的靜態分析工具
shellcheck 是什麼?
ShellCheck,一個用於 Shell 指令稿的靜態分析工具
shellcheck 概覽
這是什麼
ShellCheck 是一個以 GPL-3.0 授權的 bash/sh shell 指令碼靜態分析工具,會提供警告與建議。其目標是指出並釐清會讓 shell 產生晦澀錯誤訊息的典型初學者語法問題、會讓 shell 行為怪異且反直覺的中階語意問題,以及可能導致進階使用者原本可運作的指令碼在未來情境下失敗的細微注意事項、邊界情況與陷阱。它可在網頁上、終端機中、編輯器內,以及建置或測試套件中使用。
主要功能
- 為 bash/sh shell 指令碼提供警告與建議。
- 找出初學者語法問題、中階語意問題,以及細微的注意事項與陷阱。
- 可從終端機執行
shellcheck yourscript。 - 可整合至 Vim、Emacs、Sublime、Pulsar Edit、VSCode 等編輯器,其他編輯器可透過 GCC 錯誤相容性整合。
- 可加入建置或測試套件,並使用結束代碼。
- 可輸出人類可讀文字、JSON、CheckStyle 相容 XML,以及 GCC 相容警告。
- 在 Travis CI、Codacy、Code Climate、Code Factor、透過 ShellCheck Orb 的 CircleCI、GitHub(僅 Linux)、Trunk Code Quality 與 CodeRabbit 等服務與平台上可預先安裝使用。
使用情境
可用 ShellCheck 互動式檢視 shell 指令碼、在 Makefile 或 CI 設定中檢查指令碼,並在支援的編輯器中查看建議。它主要供互動使用,但也可加入建置或測試套件。也可在網頁上貼上 shell 指令碼以取得即時回饋。
快速開始
可透過套件管理員安裝,或使用 README 中的指令。 sh sudo apt install shellcheck shellcheck yourscript
授權與價格
ShellCheck 採用 GPL-3.0 授權。中繼資料將價格類型列為開放原始碼。未說明價格。
內容整理自該專案公開的 README 與儲存庫資訊。