Erste Codeüberprüfung

Gestern habe ich meinen Code zum ersten Mal von jemand anderem überprüfen lassen. Als eine unserer Aufgaben für den Open-Source-Entwicklungskurs, an dem ich teilnehme, mussten wir den Code des anderen überprüfen. Für diese Übung habe ich mich mit Vinh zusammengetan, einem Freund von mir, der zufällig auch ein ziemlich guter Programmierer ist. Wir wurden damit beauftragt, die Arbeit des jeweils anderen, an dem wir im Kurs gearbeitet haben, für das Befehlszeilentool zu testen und einzureichen.

Vinh NhanFolgen

/vinhyan

Asynchroner vs. synchroner Ansatz

Wir haben unsere Codeüberprüfungen sowohl synchron über Text als auch asynchron über GitHub-Probleme durchgeführt. Ich habe festgestellt, dass der synchrone Ansatz zu schnelleren Ergebnissen führte, da ich den Autor des Codes fragen konnte, warum er beim Schreiben seines Codes einen bestimmten Ansatz gewählt hat, und sofort eine Antwort erhalten konnte. Durch den asynchronen Ansatz entfällt jedoch die Notwendigkeit, in den Zeitplänen beider Personen einen festen Zeitpunkt für die Erledigung der Arbeit zu finden.

Vinhs Programm testen

Vinh hat ein Befehlszeilentool namens Barrierless entwickelt, das mithilfe von KI Textphrasen in andere Sprachen übersetzt, was ich für eine coole Idee hielt. Als ich anfing, Vinhs Programm zu testen, befand es sich noch in einem frühen Entwicklungsstadium und daher gab es noch keine README-Datei (das ist jetzt der Fall, schauen Sie es sich an!).

Vinhyan / barrierefrei

Was ist barrierefrei?

Barrierless ist ein Befehlszeilentool, das Sprachbarrieren abbaut, indem es nahtlose Übersetzungen von einer Sprache in eine andere ermöglicht. Dieses von GROQCloud unterstützte Tool ermöglicht es Benutzern, Texte schnell in die gewünschte Zielsprache zu übersetzen und so die Kommunikation über verschiedene Sprachen hinweg mühelos zu gestalten.

Funktionen

• Sprachen automatisch erkennen.
• Unterstützung mehrerer Sprachen: Übersetzen Sie Text zwischen einer Vielzahl von Sprachen.
• GROQCloud-Integration: Nutzt die leistungsstarke Übersetzungs-API von GROQCloud.
• Einfach zu bedienen: Einfache Befehlszeilenschnittstelle für schnelle Übersetzungen.
• Anpassbar: Leicht erweiterbar für zusätzliche Sprachfunktionen oder API-Unterstützung.

Anwendung

Installation

1. Klonen Sie das Repository und navigieren Sie zum Projektverzeichnis:

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

2. Navigieren Sie zum Projektverzeichnis:

cd barrierless

3. Installieren Sie die erforderlichen Abhängigkeiten:

npm install

4. Erstellen Sie eine .env-Datei zum Speichern des Groq-API-Schlüssels
   Hinweis: Anweisungen zum Erhalten und Speichern des Groq-API-Schlüssels finden Sie unter .env.example

5. Lassen Sie diesen Schritt weg, wenn npm install -g in Schritt 3 verwendet wurde …

Auf GitHub ansehen

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

Das Projekt verwendet sowohl ES6-Import als auch CommonJS Require, da das Chalk-Modul die Verwendung von Import erfordert und die Verwendung von Import für package.json zu einem Fehler führt. Es wäre hilfreich, einen Kommentar hinzuzufügen, der dies erklärt.

Auf GitHub ansehen

Ich bin dran

Als nächstes war ich an der Reihe, überprüft zu werden. Ich war mir nicht sicher, welche Art von Problemen auftauchen würden, aber am Ende fand Vinh eine Reihe von Problemen, auf die ich nicht geachtet hatte:

• Hinzufügen des npm-Links als weitere Option, um dem Tool in den Anweisungen in der README-Datei nicht das Präfix node voranstellen zu müssen

README.md enthält keine Anweisung zum Ausführen von „npm link“. #2

Vinhyan veröffentlicht am 12. September 2024

In der Datei README.md fehlen Anweisungen zum Ausführen des npm-Links, der für die lokale Entwicklung und das Testen des CLI-Tools erforderlich ist

Auf GitHub ansehen

• Unnötige Befehlszuweisung mit commander.js

„program.command("run")` ist unnötig, da die CLI keine Unterbefehle hat #3

Vinhyan veröffentlicht am 12. September 2024

Auf GitHub ansehen

• Ein Tippfehler beim Variablennamen

Tippfehler beim Variablennamen #4

Vinhyan veröffentlicht am 12. September 2024

index.js Zeile 31: Tippfehler im Variablennamen: reponseStream

Auf GitHub ansehen

Abschluss

Ich dachte, ich hätte ziemlich gute Arbeit geleistet, aber es zeigt, dass es immer einen Fehler gibt, der möglicherweise übersehen wurde, oder eine Funktion, die verbessert werden könnte. Es war großartig, den Code, den ich geschrieben habe, mit neuen Augen unter die Lupe zu nehmen. Im Moment habe ich den Tippfehler behoben und die README-Datei aktualisiert, aber die anderen Probleme müssen getestet werden und ich habe vor, diese zu beheben, bevor ich Version 0.1 veröffentliche.

Das obige ist der detaillierte Inhalt vonErste Codeüberprüfung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!