
Code-Sniff-ai是一個Shell腳本,可以自動審查代碼更改。 git diff用於提取某些文件格式的更改內容,並通過API對更改的代碼進行審查。
code-sniff-ai
├── .env
├── .env.sample
├── .gitignore
├── README.md
├── example
│ ├── javascript
│ │ └── HelloWorld.js
│ └── python
│ └── hello_world.py
└── run-review.sh
通過參考.env.sample文件並設置必要的環境變量來創建.env文件。
此腳本需要jq 。如果未安裝jq ,則可以使用以下命令安裝它。
Ubuntu/Linux :
sudo apt-get install jqmacos :
brew install jq Windows :您可以從JQ官方發布頁面下載並使用jq.exe 。將下載的文件保存到適當的路徑中,並將路徑添加到系統路徑。
git add .run-review.sh腳本以執行染色文件的代碼評論。 ./run-review.sh該腳本應在GIT存儲庫的根目錄上運行,並回顧GIT中上演的更改。
基本上,我們查看以下擴展名的文件。您可以根據需要將其設置為環境變量。
example/javascript/HelloWorld.js文件包含一個簡單的JavaScript類示例。
class HelloWorld {
constructor ( ) {
this . message = "Hello, World!" ;
}
sayHello ( ) {
console . log ( this . message ) ;
}
}該代碼是“ sayHello ,世界!”這是一個簡單的類,將消息輸出到控制台。
example/python/hello_world.py文件包含一個簡單的Python類示例。
class HelloWorld :
def __init__ ( self ):
self . message = 'Hello, World!'
def say_hello ( self ):
print ( self . message )
if __name__ == "__main__" :
hello = HelloWorld ()
hello . say_hello ()該代碼是“ say_hello ,世界!”這是一個簡單的類,將消息輸出到控制台。
您要在Ollama中使用的模型必須使用ollama pull命令下載。例如,要使用gemma2模型,請在下面運行命令下載該模型:
ollama pull gemma2我們正在研究如何將code-sniff-ai集成到GIT工作流程中,以使代碼審查自動化更加有效。例如,我們正在尋找推送到特定分支時自動觸發代碼評論的方法,或者在創建PR時運行自動評論。這種集成可以通過將其包括在CI/CD管道中來改善開發過程。
我們正在研究應用及時工程以提高代碼審查的準確性和質量的可能性。我們正在嘗試各種及時的配置措施,以便AI模型可以提供更複雜的反饋,這將最大程度地提高代碼審核過程的效率。
如果您想貢獻,請分叉該項目,創建一個新分支,反映更改並提交完整的請求。
該項目獲得了MIT許可證的許可。