Semakan kod pertama

Semalam saya telah menyemak kod saya oleh orang lain buat kali pertama. Sebagai salah satu tugasan kami untuk kursus pembangunan sumber terbuka yang saya ambil, kami terpaksa menyemak kod masing-masing. Untuk latihan ini saya berpasangan dengan Vinh, rakan saya yang juga seorang pengaturcara yang cukup baik. Kami ditugaskan untuk menguji dan memfailkan isu pada kerja masing-masing untuk alat baris arahan yang setiap satu telah kami usahakan dalam kursus.

Vinh NhanIkuti

/vinhyan

Pendekatan Asynchronous vs Synchronous

Kami melakukan semakan kod kami secara serentak melalui teks dan tidak segerak atas isu GitHub. Saya mendapati pendekatan segerak membawa kepada hasil yang lebih pantas kerana saya boleh merujuk pengarang kod tentang sebab mereka mengambil pendekatan tertentu semasa menulis kod mereka, dan segera mendapat respons. Walau bagaimanapun, pendekatan tak segerak menghilangkan keperluan untuk mencari masa tetap dalam jadual kedua-dua orang untuk menyelesaikan kerja.

Menguji program Vinh

Vinh mencipta alat baris perintah yang dipanggil tanpa halangan yang menggunakan AI untuk menterjemah frasa teks ke dalam bahasa lain, yang saya fikir adalah idea yang bagus. Apabila saya mula menguji program Vinh, ia masih dalam pembangunan awal, jadi ia belum mempunyai README lagi (ia ada sekarang, pergi semaknya!).

vinhyan / tanpa halangan

Apa itu Tanpa Penghalang

Barrierless ialah alat baris arahan yang direka untuk memecahkan halangan bahasa dengan menyediakan terjemahan lancar dari satu bahasa ke bahasa lain. Dikuasakan oleh GROQCloud, alat ini membolehkan pengguna menterjemah teks dengan cepat ke dalam bahasa sasaran yang diingini, menjadikan komunikasi merentas bahasa berbeza menjadi mudah.

Ciri

• Auto mengesan bahasa.
• Sokongan Pelbagai Bahasa: Terjemah teks antara pelbagai bahasa.
• Penyepaduan GROQCloud: Menggunakan API terjemahan berprestasi tinggi GROQCloud.
• Mudah Digunakan: Antara muka baris perintah yang ringkas untuk terjemahan pantas.
• Boleh disesuaikan: Boleh dilanjutkan dengan mudah untuk ciri bahasa tambahan atau sokongan API.

Cara menggunakan

Pemasangan

1. Klon repositori dan navigasi ke direktori projek:

git clone git@github.com:vinhyan/barrierless.git

2. Navigasi ke direktori projek:

cd barrierless

3. Pasang kebergantungan yang diperlukan:

npm install

4. Buat fail .env untuk menyimpan Kunci API Groq
   Nota: rujuk .env.contoh untuk arahan tentang cara mendapatkan dan menyimpan Kunci API Groq

5. Tinggalkan langkah ini jika npm install -g digunakan dalam langkah 3…

Lihat di GitHub

A feature I really liked is the colorful output text which makes the user experience a little bit more pleasant - something I neglected in my own program in trying to model it after CLI tools like git.

I read the package.json file to find out how the program should be run, and when it immediately crashed I realized I forgot to add the API key as an environment variable. After adding my API key, the program ran without errors, although I did find an interesting quirk - the program defaults the output language to English, so if you didn't specify one, and the input was in English, it seemed to choose a language to translate to on its own - either randomly, or based on context from the input.

I opened a few other issues, mostly to do with improving code quality:

• A missing try/catch block around an async function call

Uncaught exception in index.js #7

uday-rana posted on Sep 12, 2024

index.js contains the following async function calls which are not wrapped in a try/catch block and may lead to an uncaught exception:

export async function main(text, targetLang) {
  const chatCompletion = await getGroqChatCompletion(text, targetLang);
  console.log(chatCompletion.choices[0]?.message?.content || '');
}

...

program
  ...
  .action(async (text, options) => {
    console.log(chalk.blue(`Translating  <span class="pl-s1"><span class="pl-kos">${text}</span>...`</span>));

    await main(text, options.language);
  });

View on GitHub

• Some suggestions to make code easier to understand

Could simplify code #8

uday-rana posted on Sep 12, 2024

Some changes may be made to to the project make it easier to understand and work on:

• [x] Move Groq configuration above program initialization with commander
• [x] main() seems unnecessary since it contains two lines of code and there are more lines of code involved in creating and invoking the function than if it was omitted
• [ ] prompt.js seems unnecessary since it just contains a single function which places arguments into a template literal and returns them
• [x] Exporting main() and getGroqChatCompletion() seems unnecessary

View on GitHub

• Adding a comment to explain the use of both import and require statements

Add comments explaining mixed import/require #9

uday-rana posted on Sep 12, 2024

Projek ini menggunakan import ES6 dan keperluan CommonJS kerana modul kapur yang memerlukan penggunaan import dan menggunakan import untuk package.json yang membawa kepada ralat. Adalah berguna untuk menambah ulasan yang menerangkan perkara ini.

Lihat di GitHub

giliran saya

Seterusnya giliran saya untuk disemak. Saya tidak pasti jenis isu yang akan timbul, tetapi Vinh akhirnya menemui banyak isu yang saya tidak ambil perhatian:

• Menambah pautan npm sebagai pilihan lain kerana tidak perlu memberi awalan alat dengan nod dalam arahan dalam README

README.md tidak termasuk arahan untuk menjalankan `pautan npm` #2

vinhyan disiarkan pada 12 Sep 2024

Fail README.md tiada arahan untuk menjalankan pautan npm, yang diperlukan untuk pembangunan tempatan dan ujian alat CLI

Lihat di GitHub

• Penugasan arahan yang tidak perlu menggunakan commander.js

`program.command("run")` tidak diperlukan kerana CLI tidak mempunyai subperintah #3

vinhyan disiarkan pada 12 Sep 2024

Lihat di GitHub

• Taip nama berubah

Nama boleh ubah kesilapan menaip #4

vinhyan disiarkan pada 12 Sep 2024

baris index.js 31: kesilapan menaip dalam nama berubah: reponseStream

Lihat di GitHub

Kesimpulan

Saya fikir saya telah melakukan kerja yang cukup baik tetapi menunjukkan bahawa sentiasa ada pepijat yang mungkin terlepas atau ciri yang boleh diperbaiki. Ia sangat bagus apabila sepasang mata segar meneliti kod yang saya tulis. Buat masa ini, saya membetulkan kesilapan menaip dan mengemas kini README, tetapi isu lain memerlukan ujian dan saya merancang untuk mendapatkannya sebelum saya mengeluarkan versi 0.1.

Atas ialah kandungan terperinci Semakan kod pertama. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!