目次
バリアレスとは
特徴
使用方法
インストール

最初のコードレビュー

Sep 14, 2024 am 06:28 AM

昨日、私は初めて自分のコードを他の人にレビューしてもらいました。私が受講しているオープンソース開発コースの課題の 1 つとして、お互いのコードをレビューする必要がありました。この演習では、友人であり、非常に優れたプログラマーでもある Vinh とペアを組みました。私たちは、コースでそれぞれ取り組んできたコマンド ライン ツールについて、お互いの作業をテストし、問題を提出するという任務を負っていました。

First code review

ヴィンニャン

/ヴィンヒャン

非同期アプローチと同期アプローチ

私たちはコード レビューをテキスト上で同期的に、および GitHub の問題上で非同期的に行いました。コードを作成する際に特定のアプローチを採用した理由についてコードの作成者に相談でき、すぐに返答が得られるため、同期アプローチの方が結果が早くなることがわかりました。ただし、非同期アプローチを使用すると、作業を完了するために両方の人のスケジュールから固定時間を見つける必要がなくなります。

Vinh のプログラムをテストする

Vinh は、AI を使用してテキスト フレーズを他の言語に翻訳する、barrierless と呼ばれるコマンド ライン ツールを作成しました。これは素晴らしいアイデアだと思いました。私が Vinh のプログラムのテストを開始したとき、それはまだ開発初期段階だったので、まだ README がありませんでした (現在はあります。ぜひチェックしてください!)。

First code review ヴィンヒャン / バリアレス

バリアレスとは

Barrierless は、ある言語から別の言語へのシームレスな翻訳を提供することにより、言語の壁を取り除くように設計されたコマンドライン ツールです。 GROQCloud を活用したこのツールを使用すると、ユーザーはテキストを希望のターゲット言語にすばやく翻訳できるため、異なる言語間でのコミュニケーションが容易になります。

特徴

  • 言語を自動検出します。
  • 複数言語のサポート: テキストを幅広い言語間で翻訳します。
  • GROQCloud 統合: GROQCloud の高性能翻訳 API を利用します。
  • 使いやすさ: シンプルなコマンドライン インターフェイスで迅速に翻訳できます。
  • カスタマイズ可能: 追加の言語機能や API サポートのために簡単に拡張できます。

使用方法

インストール

  1. リポジトリのクローンを作成し、プロジェクト ディレクトリに移動します。
git clone git@github.com:vinhyan/barrierless.git
ログイン後にコピー
  1. プロジェクト ディレクトリに移動します:
cd barrierless
ログイン後にコピー
  1. 必要な依存関係をインストールします:
npm install
ログイン後にコピー
  1. Groq API キーを保存する .env ファイルを作成します
    注: Groq API キーを取得して保存する方法については、.env.example を参照してください

  2. ステップ 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.

First code review

First code review

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

First code review
uday-rana posted on

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);
  });
ログイン後にコピー
Enter fullscreen mode Exit fullscreen mode
View on GitHub
  • Some suggestions to make code easier to understand

Could simplify code #8

First code review
uday-rana posted on

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

First code review
uday-rana posted on

プロジェクトは ES6 インポートと CommonJS の両方を使用しています。これは、Chalk モジュールがインポートの使用を必要とし、package.json にインポートを使用するとエラーが発生するためです。これについて説明するコメントを追加していただけると助かります。

GitHub で表示

私の番

次に私がレビューされる番でした。どのような問題が発生するかわかりませんでしたが、Vinh は最終的に、私が注目していなかった多くの問題を見つけてくれました。

  • README の手順でツールの前にノードを付ける必要がないようにするための別のオプションとして npm リンクを追加します。

README.md には「npm link」を実行するための命令が含まれていません。 #2

First code review
ヴィンヒャン 投稿日:

README.md ファイルには、CLI ツールのローカル開発とテストに必要な npm リンクを実行するための手順がありません

GitHub で表示
  • commandor.jsを使用した不要なコマンドの割り当て

CLI にはサブコマンドがないため、`program.command("run")` は不要です #3

First code review
ヴィンヒャン 投稿日:
GitHub で表示
  • 変数名のタイプミス

変数名のタイプミス #4

First code review
ヴィンヒャン 投稿日:

index.js 31 行目: 変数名のタイプミス: reponseStream

GitHub で表示

結論

私はかなり良い仕事をしたと思っていましたが、見落とされた可能性のあるバグや改善できる機能が常に存在することを示しています。自分が書いたコードを新鮮な目で精査してもらえるのはとてもうれしかったです。現時点では、タイプミスを修正し、README を更新しましたが、他の問題についてはテストが必要なので、バージョン 0.1 をリリースする前に解決する予定です。

以上が最初のコードレビューの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

Video Face Swap

Video Face Swap

完全無料の AI 顔交換ツールを使用して、あらゆるビデオの顔を簡単に交換できます。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

フロントエンドのサーマルペーパーレシートのために文字化けしたコード印刷に遭遇した場合はどうすればよいですか? フロントエンドのサーマルペーパーレシートのために文字化けしたコード印刷に遭遇した場合はどうすればよいですか? Apr 04, 2025 pm 02:42 PM

フロントエンドのサーマルペーパーチケット印刷のためのよくある質問とソリューションフロントエンド開発におけるチケット印刷は、一般的な要件です。しかし、多くの開発者が実装しています...

javascriptの分解:それが何をするのか、なぜそれが重要なのか javascriptの分解:それが何をするのか、なぜそれが重要なのか Apr 09, 2025 am 12:07 AM

JavaScriptは現代のWeb開発の基礎であり、その主な機能には、イベント駆動型のプログラミング、動的コンテンツ生成、非同期プログラミングが含まれます。 1)イベント駆動型プログラミングにより、Webページはユーザー操作に応じて動的に変更できます。 2)動的コンテンツ生成により、条件に応じてページコンテンツを調整できます。 3)非同期プログラミングにより、ユーザーインターフェイスがブロックされないようにします。 JavaScriptは、Webインタラクション、シングルページアプリケーション、サーバー側の開発で広く使用されており、ユーザーエクスペリエンスとクロスプラットフォーム開発の柔軟性を大幅に改善しています。

誰がより多くのPythonまたはJavaScriptを支払われますか? 誰がより多くのPythonまたはJavaScriptを支払われますか? Apr 04, 2025 am 12:09 AM

スキルや業界のニーズに応じて、PythonおよびJavaScript開発者には絶対的な給与はありません。 1. Pythonは、データサイエンスと機械学習でさらに支払われる場合があります。 2。JavaScriptは、フロントエンドとフルスタックの開発に大きな需要があり、その給与もかなりです。 3。影響要因には、経験、地理的位置、会社の規模、特定のスキルが含まれます。

Shiseidoの公式Webサイトのように、視差スクロールと要素のアニメーション効果を実現する方法は?
または:
Shiseidoの公式Webサイトのようにスクロールするページを伴うアニメーション効果をどのように実現できますか? Shiseidoの公式Webサイトのように、視差スクロールと要素のアニメーション効果を実現する方法は? または: Shiseidoの公式Webサイトのようにスクロールするページを伴うアニメーション効果をどのように実現できますか? Apr 04, 2025 pm 05:36 PM

この記事の視差スクロールと要素のアニメーション効果の実現に関する議論では、Shiseidoの公式ウェブサイト(https://www.shisido.co.co.jp/sb/wonderland/)と同様の達成方法について説明します。

JavaScriptは学ぶのが難しいですか? JavaScriptは学ぶのが難しいですか? Apr 03, 2025 am 12:20 AM

JavaScriptを学ぶことは難しくありませんが、挑戦的です。 1)変数、データ型、関数などの基本概念を理解します。2)非同期プログラミングをマスターし、イベントループを通じて実装します。 3)DOM操作を使用し、非同期リクエストを処理することを約束します。 4)一般的な間違いを避け、デバッグテクニックを使用します。 5)パフォーマンスを最適化し、ベストプラクティスに従ってください。

JavaScriptの進化:現在の傾向と将来の見通し JavaScriptの進化:現在の傾向と将来の見通し Apr 10, 2025 am 09:33 AM

JavaScriptの最新トレンドには、TypeScriptの台頭、最新のフレームワークとライブラリの人気、WebAssemblyの適用が含まれます。将来の見通しは、より強力なタイプシステム、サーバー側のJavaScriptの開発、人工知能と機械学習の拡大、およびIoTおよびEDGEコンピューティングの可能性をカバーしています。

JavaScriptを使用して、同じIDを持つArray要素を1つのオブジェクトにマージする方法は? JavaScriptを使用して、同じIDを持つArray要素を1つのオブジェクトにマージする方法は? Apr 04, 2025 pm 05:09 PM

同じIDを持つ配列要素をJavaScriptの1つのオブジェクトにマージする方法は?データを処理するとき、私たちはしばしば同じIDを持つ必要性に遭遇します...

Zustand非同期操作:UseStoreが取得した最新の状態を確保する方法は? Zustand非同期操作:UseStoreが取得した最新の状態を確保する方法は? Apr 04, 2025 pm 02:09 PM

Zustand非同期操作のデータの更新問題。 Zustand State Management Libraryを使用する場合、非同期操作を不当にするデータ更新の問題に遭遇することがよくあります。 �...

See all articles