第一次程式碼審查

昨天，我的程式碼第一次被其他人審查。作為我正在參加的開源開發課程的作業之一，我們必須審查彼此的程式碼。在這個練習中，我與 Vinh 搭檔，他是我的一個朋友，碰巧也是一位非常優秀的程式設計師。我們的任務是測試和歸檔彼此在課程中一直在使用的命令列工具工作的問題。

Vinh Nhan關注

/維尼揚

非同步與同步方法

我們透過文字同步和透過 GitHub 問題非同步進行程式碼審查。我發現同步方法可以更快地得到結果，因為我可以諮詢程式碼作者，了解他們在編寫程式碼時為什麼採用某種方法，並立即得到答案。然而，非同步方法消除了在兩個人的日程安排中找到固定時間來完成工作的需要。

測試 Vinh 的程序

Vinh 創建了一個名為「barrierless」的命令列工具，它使用人工智慧將文字短語翻譯成其他語言，我認為這是一個很酷的主意。當我開始測試 Vinh 的程式時，它還處於早期開發階段，所以還沒有 README（現在有了，去看看吧！）。

維尼揚 / 無障礙的

什麼是無障礙

Barrierless 是一款命令列工具，旨在透過提供從一種語言到另一種語言的無縫翻譯來打破語言障礙。該工具由 GROQCloud 提供支持，允許用戶快速將文字翻譯成所需的目標語言，使不同語言之間的溝通變得輕鬆。

特點

• 自動偵測語言。
• 多語言支援：在多種語言之間翻譯文字。
• GROQCloud 整合：利用 GROQCloud 的高效能翻譯 API。
• 易於使用：簡單的命令列介面，可快速翻譯。
• 可自訂：可輕鬆擴充以取得其他語言功能或 API 支援。

使用方法

安裝

1. 複製儲存庫並導航至專案目錄：

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

2. 導覽至專案目錄：

cd barrierless

3. 安裝所需的依賴項：

npm install

4. 建立一個 .env 檔案來儲存 Groq API 金鑰
   注意：有關如何取得和儲存 Groq API Key 的說明，請參閱 .env.example

5. 如果在步驟 3 中使用了 npm install -g 則省略此步驟...

在 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

專案同時使用了 ES6 import 和 CommonJS require，因為 chalk 模組需要使用 import，對 package.json 使用 import 會導致錯誤。添加評論來解釋這一點會很有幫助。

在 GitHub 上查看

輪到我了

接下來輪到我接受審核了。我不確定會出現什麼樣的問題，但 Vinh 最終發現了一堆我沒有註意到的問題：

• 新增 npm 連結作為另一個選項，這樣就不必在自述文件的說明中為工具添加節點前綴

README.md 不包含執行「npm link」的指令 #2

維尼揚 發佈於 2024 年 9 月 12 日

README.md 檔案缺少執行 npm 連結的指令，這是 CLI 工具本地開發和測試所必需的

在 GitHub 上查看

• 使用 Commander.js 進行不必要的命令分配

`program.command("run")` 是不必要的，因為 CLI 沒有子指令 #3

維尼揚 發佈於 2024 年 9 月 12 日

在 GitHub 上查看

• 變數名稱拼字錯誤

變數名拼字錯誤 #4

維尼揚 發佈於 2024 年 9 月 12 日

index.js 第 31 行：變數名稱中的拼字錯誤：reponseStream

在 GitHub 上查看

結論

我認為我做得很好，但事實證明，總是會有一個可能被遺漏的錯誤或一個可以改進的功能。有一雙新的眼睛來審視我寫的程式碼真是太棒了。目前，我修復了拼字錯誤並更新了自述文件，但其他問題需要測試，我計劃在發布 0.1 版本之前解決這些問題。

以上是第一次程式碼審查的詳細內容。更多資訊請關注PHP中文網其他相關文章！