第一次代码审查

昨天，我的代码第一次被其他人审查。作为我正在参加的开源开发课程的作业之一，我们必须审查彼此的代码。在这个练习中，我与 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中文网其他相关文章！