開始使用 Checks 程式碼規範

程式碼規範是透過 Checks CLI 使用,結果會上傳至 Checks 控制台。

安裝程式碼規範

如要開始使用,請按照 Checks CLI 的安裝說明操作。

安裝完成後,您就能執行程式碼規範指令:

checks code <command>

掃描專案

安裝 Checks Code Compliance 後,您可以掃描程式碼集,瞭解系統如何收集、共用或處理私密資料。

如要使用 Code Compliance CLI 掃描存放區程式碼,請使用 checks code scan 指令。

舉例來說,如要測試 repositories/personal 資料夾中的 my-swift-app 存放區:

checks code scan repositories/personal/my-swift-app

根據預設,程式碼法規遵循功能會以文字格式將結果輸出至終端機。

以 JSON 格式輸出測試結果

如要在終端機中將結果匯出為 JSON 格式,請執行下列步驟:

checks code scan PATH --format=json > ./checks-code-results

如要將結果匯出為 JSON 格式並儲存至本機檔案,請按照下列步驟操作:

checks code scan PATH --format=json > ./checks-code-results.json

以 HTML 格式輸出測試結果

如要在終端機中將結果匯出為 HTML 格式,請執行下列操作:

checks code scan PATH --format=html > ./checks-code-results

如要將結果匯出為 HTML 格式並儲存至本機檔案,請按照下列步驟操作:

checks code scan PATH --format=html > ./checks-code-results.html

其他說明

執行 checks code scan --help

設定自動掃描

如要設定自動程式碼法規遵循掃描,請參閱 CI/CD 總覽說明文件。

取得支援

如需 Checks Code Compliance 或 Checks 一般相關協助,請傳送電子郵件至 checks-support@google.com。