어제 처음으로 다른 사람이 내 코드를 검토했습니다. 제가 수강하고 있는 오픈 소스 개발 과정의 과제 중 하나로서 우리는 서로의 코드를 검토해야 했습니다. 이 연습을 위해 나는 꽤 좋은 프로그래머이기도 한 내 친구 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:
Uncaught exception in index.js
#7
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);
});
Could simplify code
#8
Some changes may be made to to the project make it easier to understand and work on:
Add comments explaining mixed import/require
#9
이 프로젝트는 가져오기를 사용해야 하는 초크 모듈과 package.json에 가져오기를 사용하면 오류가 발생하기 때문에 ES6 가져오기와 CommonJS 요구 사항을 모두 사용합니다. 이에 대해 설명하는 댓글을 추가해 주시면 도움이 될 것입니다.
다음은 제가 리뷰할 차례였습니다. 어떤 문제가 나타날지 확신할 수 없었지만 Vinh은 결국 제가 주의를 기울이지 않았던 많은 문제를 발견하게 되었습니다.
README.md에는 `npm link` 실행 지침이 포함되어 있지 않습니다.
#2
README.md 파일에는 CLI 도구의 로컬 개발 및 테스트에 필요한 npm 링크 실행 지침이 없습니다
CLI에는 하위 명령이 없으므로 `program.command("run")`은 필요하지 않습니다.
#3
변수 이름 오타
#4
index.js 31행: 변수 이름 오타: responseStream
아주 잘했다고 생각했지만 항상 놓쳤을 수 있는 버그나 개선할 수 있는 기능이 있다는 것을 보여주려고 합니다. 내가 작성한 코드를 새로운 눈으로 자세히 살펴볼 수 있어서 정말 좋았습니다. 지금은 오타를 수정하고 README를 업데이트했지만 다른 문제는 테스트가 필요하므로 버전 0.1을 출시하기 전에 해당 문제를 해결할 계획입니다.
위 내용은 첫 번째 코드 검토의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!
![[웹 프런트엔드] Node.js 빠른 시작](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
