ホームページ > 記事 > ウェブフロントエンド > 最初のコードレビュー
昨日、私は初めて自分のコードを他の人にレビューしてもらいました。私が受講しているオープンソース開発コースの課題の 1 つとして、お互いのコードをレビューする必要がありました。この演習では、友人であり、非常に優れたプログラマーでもある Vinh とペアを組みました。私たちは、コースでそれぞれ取り組んできたコマンド ライン ツールについて、お互いの作業をテストし、問題を提出するという任務を負っていました。
私たちはコード レビューをテキスト上で同期的に、および GitHub の問題上で非同期的に行いました。コードを作成する際に特定のアプローチを採用した理由についてコードの作成者に相談でき、すぐに返答が得られるため、同期アプローチの方が結果が早くなることがわかりました。ただし、非同期アプローチを使用すると、作業を完了するために両方の人のスケジュールから固定時間を見つける必要がなくなります。
Vinh は、AI を使用してテキスト フレーズを他の言語に翻訳する、barrierless と呼ばれるコマンド ライン ツールを作成しました。これは素晴らしいアイデアだと思いました。私が Vinh のプログラムのテストを開始したとき、それはまだ開発初期段階だったので、まだ README がありませんでした (現在はあります。ぜひチェックしてください!)。
Barrierless は、ある言語から別の言語へのシームレスな翻訳を提供することにより、言語の壁を取り除くように設計されたコマンドライン ツールです。 GROQCloud を利用したこのツールを使用すると、ユーザーはテキストを希望のターゲット言語にすばやく翻訳できるため、異なる言語間でのコミュニケーションが容易になります。
git clone git@github.com:vinhyan/barrierless.git
cd barrierless
npm install
Groq API キーを保存する .env ファイルを作成します
注: Groq API キーを取得して保存する方法については、.env.example を参照してください
ステップ 3 で npm install -g を使用した場合は、このステップを省略します…
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:
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);
});
Some changes may be made to to the project make it easier to understand and work on:
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.
Seterusnya giliran saya untuk disemak. Saya tidak pasti jenis isu yang akan timbul, tetapi Vinh akhirnya menemui banyak isu yang saya tidak ambil perhatian:
Fail README.md tiada arahan untuk menjalankan pautan npm, yang diperlukan untuk pembangunan tempatan dan ujian alat CLI
baris index.js 31: kesilapan menaip dalam nama berubah: reponseStream
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.
以上が最初のコードレビューの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。