code sniff ai

代码 - 尼夫-ai

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

安装和设置

0。支持服务

• 霍拉马
• Openai Chatgpt
• 人类克劳德（Claude）
• Google双子座
• 谷

1。.NV文件设置

通过参考.env.sample文件并设置必要的环境变量来创建.env文件。

2。安装所需的依赖项

此脚本需要jq 。如果未安装jq ，则可以使用以下命令安装它。

• Ubuntu/Linux ：

  sudo apt-get install jq

• macos ：

  brew install jq

• Windows ：您可以从JQ官方发布页面下载并使用jq.exe 。将下载的文件保存到适当的路径中，并将路径添加到系统路径。

用法

运行代码评论

1. 修改代码后，将更改分为git。

git add .

2. 运行run-review.sh脚本以执行染色文件的代码评论。

./run-review.sh

该脚本应在GIT存储库的根目录上运行，并回顾GIT中上演的更改。

支持文件扩展名

基本上，我们查看以下扩展名的文件。您可以根据需要将其设置为环境变量。

• .json
• .xml
• .ts
• .js
• .html
• .VUE
• .sh
• .tsx
• .jsx
• .py
• .css

例子

JavaScript示例

example/javascript/HelloWorld.js文件包含一个简单的JavaScript类示例。

 class HelloWorld {
  constructor ( ) {
    this . message = "Hello, World!" ;
  }

  sayHello ( ) {
    console . log ( this . message ) ;
  }
}

该代码是“ sayHello ，世界！”这是一个简单的类，将消息输出到控制台。

python示例

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中使用的模型必须使用ollama pull命令下载。例如，要使用gemma2模型，请在下面运行命令下载该模型：

ollama pull gemma2

需要研究的内容

1。git工作流程自动化

我们正在研究如何将code-sniff-ai集成到GIT工作流程中，以使代码审查自动化更加有效。例如，我们正在寻找推送到特定分支时自动触发代码评论的方法，或者在创建PR时运行自动评论。这种集成可以通过将其包括在CI/CD管道中来改善开发过程。

2。通过迅速工程提高质量

我们正在研究应用及时工程以提高代码审查的准确性和质量的可能性。我们正在尝试各种及时的配置措施，以便AI模型可以提供更复杂的反馈，这将最大程度地提高代码审核过程的效率。

3。分析各种观点或多数-LLM推理后，衍生综合意见

4。应用开发团队的代码风味

5。在继承/实现的类的情况下，将相关的接口或类一起发送，以确认代码是根据上下文实现的。

贡献

如果您想贡献，请分叉该项目，创建一个新分支，反映更改并提交完整的请求。

执照

该项目获得了MIT许可证的许可。

参考

• Ollama安装指南页面

起源

• 在Kwon do -eon的Velog上发布的Claude是改善代码审查体验的内容的叉子版本。
• 权do -eon，谢谢您提供尤里卡点。

实际上...？

• 该项目代码的基础是Dodim的代码，大多数修改/生成的代码和图像是由Claude 3.5十四行诗（Chat-GPT-4O）创建的。