shellcheck-configuration

概覽

什麼是 shellcheck-configuration？

shellcheck-configuration 是一項技能，旨在協助開發者與 DevOps 團隊設定並使用 ShellCheck，一款針對 shell 腳本的靜態分析工具。它提供實用指引，協助建立 linting 基礎架構、修正程式碼問題，並確保腳本在不同環境間的可攜性。此技能非常適合希望強制執行最佳實務、捕捉常見 shell 腳本錯誤，並將品質檢查整合進 CI/CD 流程的人員。

誰適合使用此技能？

• 撰寫 Bash、sh、dash 或 ksh 腳本的開發者
• 維護自動化腳本的 DevOps 工程師
• 在 shell 腳本中強制執行程式碼品質標準的團隊
• 將 shell 腳本 linting 整合至 CI/CD 工作流程的任何人

解決的問題

• 偵測常見的 shell 腳本錯誤與陷阱
• 強制執行一致的程式碼標準
• 協助腳本遷移以符合品質門檻
• 支援專案特定的設定與誤報抑制

使用方式

安裝步驟

1. 使用以下指令安裝技能：
   npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration
2. 閱讀 SKILL.md 檔案，獲得詳細的設定與使用指引。
3. 探索 README.md、AGENTS.md 與 metadata.json 等輔助檔案，了解更多背景資訊。

設定 ShellCheck

• 使用您平台的套件管理工具安裝 ShellCheck：
  • macOS：brew install shellcheck
  • Ubuntu/Debian：apt-get install shellcheck
  • 從原始碼安裝：克隆官方 repo，並執行 make build && make install
• 使用 shellcheck --version 確認安裝成功

配置 ShellCheck

• 在專案中建立 .shellcheckrc 檔案，自訂規則與目標 shell。
• 將 ShellCheck 整合至 CI/CD 管線，實現自動化 linting。
• 利用 ShellCheck 旗標調整分析以符合專案需求。

調整工作流程

• 從提供的技能檔案開始，依據您的程式庫與工具調整設定。
• 避免直接複製設定，請根據團隊需求與作業限制進行客製化。

常見問題

我在哪裡可以找到設定範例？

請參考 SKILL.md 與 .shellcheckrc 檔案，內含範例設定與推薦作法。

shellcheck-configuration 可以用於 CI/CD 嗎？

可以，此技能設計上便於整合至 CI/CD 管線，實現自動化 shell 腳本 linting 與品質檢查。

支援哪些 shell？

ShellCheck 支援 Bash、sh、dash、ksh 以及其他符合 POSIX 標準的 shell。

如何抑制誤報？

您可以在 .shellcheckrc 檔案或腳本內聯設定中，調整規則集並抑制特定警告。

我應該從哪裡開始？

建議先閱讀 SKILL.md 檔案以獲得完整概覽，接著探索其他輔助檔案以深入了解。您也可以使用檔案標籤查看完整檔案結構，包括參考資料與輔助腳本。