code sniff ai

Kode-sniff-ai

Code-Sniff-AI adalah skrip shell yang secara otomatis meninjau perubahan kode. Git Diff digunakan untuk mengekstrak konten yang diubah untuk format file tertentu, dan ulasan kode yang diubah melalui API.

Struktur proyek

 code-sniff-ai
├── .env
├── .env.sample
├── .gitignore
├── README.md
├── example
│   ├── javascript
│   │   └── HelloWorld.js
│   └── python
│       └── hello_world.py
└── run-review.sh

Instalasi dan Pengaturan

0. Layanan yang Didukung

• Ollama
• Openai Chatgpt
• Antropik Claude
• Google Gemini
• Groq

1. Pengaturan file .nv

Buat file .env dengan mengacu pada file .env.sample dan atur variabel lingkungan yang diperlukan.

2. Pemasangan ketergantungan yang diperlukan

Script ini membutuhkan jq . Jika jq tidak diinstal, Anda dapat menginstalnya menggunakan perintah berikut.

• Ubuntu/Linux :

  sudo apt-get install jq

• MacOS :

  brew install jq

• Windows : Anda dapat mengunduh dan menggunakan jq.exe dari halaman rilis resmi JQ. Simpan file yang diunduh ke jalur yang sesuai dan tambahkan jalur ke jalur sistem.

Penggunaan

Jalankan tinjauan kode

1. Setelah memodifikasi kode, perubahan dipentaskan ke git.

git add .

2. Jalankan run-review.sh skrip untuk melakukan ulasan kode untuk file yang diwarnai.

./run-review.sh

Skrip ini harus dijalankan pada direktori root dari repositori git dan meninjau perubahan yang dipentaskan dalam git.

Dukungan ekstensi file

Pada dasarnya, kami meninjau file ekstensi berikut. Anda dapat mengaturnya sebagai variabel lingkungan sesuai kebutuhan.

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

Contoh

Contoh JavaScript

File example/javascript/HelloWorld.js berisi contoh kelas JavaScript sederhana.

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

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

Kode ini adalah " sayHello , Dunia!" Ini adalah kelas sederhana yang menghasilkan pesan ke konsol.

Contoh Python

File example/python/hello_world.py berisi contoh kelas python sederhana.

 class HelloWorld :
    def __init__ ( self ):
        self . message = 'Hello, World!'

    def say_hello ( self ):
        print ( self . message )

if __name__ == "__main__" :
    hello = HelloWorld ()
    hello . say_hello ()

Kode ini adalah " say_hello , Dunia!" Ini adalah kelas sederhana yang menghasilkan pesan ke konsol.

Unduh Kamus Model Ollama

Model yang ingin Anda gunakan di Ollama harus diunduh menggunakan perintah ollama pull terlebih dahulu. Misalnya, untuk menggunakan model gemma2 , jalankan perintah di bawah ini untuk mengunduh model:

ollama pull gemma2

Isi yang membutuhkan penelitian

1. Otomatisasi alur kerja git

Kami sedang mempelajari cara mengintegrasikan code-sniff-ai ke dalam alur kerja git untuk membuat otomatisasi tinjauan kode lebih efisien. Misalnya, kami mencari cara untuk secara otomatis memicu ulasan kode saat mendorong ke cabang tertentu, atau menjalankan ulasan otomatis saat membuat PR. Integrasi semacam itu dapat meningkatkan proses pengembangan dengan memasukkannya ke dalam pipa CI/CD.

2. Peningkatan kualitas melalui rekayasa cepat

Kami sedang mempelajari kemungkinan menerapkan rekayasa cepat untuk meningkatkan akurasi dan kualitas ulasan kode. Kami sedang bereksperimen dengan berbagai langkah konfigurasi cepat sehingga model AI dapat memberikan umpan balik yang lebih canggih, yang akan memaksimalkan efisiensi proses peninjauan kode.

3. Turunan pendapat terintegrasi setelah menganalisis berbagai perspektif atau penalaran multi -llm

4. Menerapkan rasa kode tim pengembangan

5. Dalam kasus kelas yang diwariskan/diimplementasikan, antarmuka atau kelas terkait dikirim bersama untuk mengkonfirmasi bahwa kode diimplementasikan sesuai dengan konteksnya.

Kontribusi

Jika Anda ingin berkontribusi, garpu proyek, buat cabang baru, mencerminkan perubahan, dan mengirimkan permintaan penuh.

Lisensi

Proyek ini diberi lisensi dengan lisensi MIT.

Referensi

• Halaman Panduan Instalasi Ollama

Asal

• Claude yang diposting di Kwon do -Eon's Velog adalah versi garpu dari konten meningkatkan pengalaman tinjauan kode.
• Kwon do -eon, terima kasih telah menyediakan Eureka Point.

nyatanya...?

• Dasar dari kode proyek ini adalah kode Dodim, dan sebagian besar kode dan gambar yang dimodifikasi/dihasilkan dibuat oleh Claude 3.5 sonnet, Chat-GPT-4O.