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

이 프로젝트는 가져오기를 사용해야 하는 초크 모듈과 package.json에 가져오기를 사용하면 오류가 발생하기 때문에 ES6 가져오기와 CommonJS 요구 사항을 모두 사용합니다. 이를 설명하는 댓글을 추가해 주시면 도움이 될 것입니다.

GitHub에서 보기

내 차례

다음은 제가 리뷰할 차례였습니다. 어떤 문제가 나타날지 확신할 수 없었지만 Vinh은 결국 제가 주의를 기울이지 않았던 많은 문제를 발견하게 되었습니다.

• README의 지침에서 도구 앞에 노드를 붙일 필요가 없도록 또 다른 옵션으로 npm 링크를 추가합니다.

README.md에는 `npm link` 실행 지침이 포함되어 있지 않습니다. #2

빈얀 게시일: 2024년 9월 12일

README.md 파일에는 CLI 도구의 로컬 개발 및 테스트에 필요한 npm 링크 실행 지침이 없습니다

GitHub에서 보기

• commander.js를 사용한 불필요한 명령 할당

CLI에는 하위 명령이 없으므로 `program.command("run")`은 필요하지 않습니다. #3

빈얀 게시일: 2024년 9월 12일

GitHub에서 보기

• 변수명 오타

변수 이름 오타 #4

빈얀 게시일: 2024년 9월 12일

index.js 31행: 변수 이름에 오타가 있습니다: responseStream

GitHub에서 보기

결론

아주 잘했다고 생각했지만 항상 놓쳤을 수 있는 버그나 개선할 수 있는 기능이 있다는 것을 보여주려고 합니다. 내가 작성한 코드를 새로운 눈으로 자세히 살펴볼 수 있어서 정말 좋았습니다. 지금은 오타를 수정하고 README를 업데이트했지만 다른 문제는 테스트가 필요하므로 버전 0.1을 출시하기 전에 해당 문제를 해결할 계획입니다.

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