Première révision du code

Hier, mon code a été révisé par quelqu'un d'autre pour la première fois. Dans le cadre du cours de développement open source que je suis, nous avons dû réviser le code de chacun. Pour cet exercice, je me suis associé à Vinh, un de mes amis qui se trouve également être un très bon programmeur. Nous avons été chargés de tester et de signaler les problèmes liés au travail de chacun pour l'outil de ligne de commande sur lequel nous avons travaillé dans le cours.

Vinh NhanSuivre

/vinhyan

Approche asynchrone ou synchrone

Nous avons effectué nos révisions de code à la fois de manière synchrone sur le texte et de manière asynchrone sur les problèmes GitHub. J'ai trouvé que l'approche synchrone conduisait à des résultats plus rapides, car je pouvais consulter l'auteur du code pour savoir pourquoi il avait adopté une certaine approche lors de l'écriture de son code et obtenir immédiatement une réponse. Cependant, l'approche asynchrone élimine le besoin de trouver une heure fixe dans les horaires des deux personnes pour effectuer le travail.

Tester le programme de Vinh

Vinh a créé un outil en ligne de commande appelé sans barrière qui utilise l'IA pour traduire des phrases de texte dans d'autres langues, ce qui m'a semblé une bonne idée. Lorsque j'ai commencé à tester le programme de Vinh, il en était encore aux premiers stades de développement et il n'avait donc pas encore de README (c'est le cas maintenant, allez le vérifier !).

vinhyan / sans barrière

Qu'est-ce que le sans barrière

Barrierless est un outil en ligne de commande conçu pour éliminer les barrières linguistiques en fournissant des traductions transparentes d'une langue à une autre. Propulsé par GROQCloud, cet outil permet aux utilisateurs de traduire rapidement du texte dans la langue cible souhaitée, facilitant ainsi la communication entre différentes langues.

Caractéristiques

• Détecte automatiquement les langues.
• Prise en charge de plusieurs langues : traduisez du texte entre un large éventail de langues.
• Intégration GROQCloud : utilise l'API de traduction hautes performances de GROQCloud.
• Facile à utiliser : interface de ligne de commande simple pour des traductions rapides.
• Personnalisable : facilement extensible pour des fonctionnalités linguistiques supplémentaires ou une prise en charge API.

Comment utiliser

Installation

1. Clonez le référentiel et accédez au répertoire du projet :

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

2. Accédez au répertoire du projet :

cd barrierless

3. Installez les dépendances requises :

npm install

4. Créez un fichier .env pour stocker la clé API Groq
   Remarque : reportez-vous à .env.example pour savoir comment obtenir et stocker la clé API Groq

5. Omettez cette étape si npm install -g a été utilisé à l'étape 3…

Voir sur 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

Le projet utilise à la fois l'importation ES6 et CommonJS en raison du module Chalk nécessitant l'utilisation de l'importation et de l'utilisation de l'importation pour package.json entraînant une erreur. Il serait utile d'ajouter un commentaire expliquant cela.

Voir sur GitHub

Mon tour

Ensuite, ce fut à mon tour d'être révisé. Je n'étais pas sûr du genre de problèmes qui surviendraient, mais Vinh a fini par trouver un tas de problèmes auxquels je n'avais pas prêté attention :

• Ajout du lien npm comme autre option pour ne pas avoir à préfixer l'outil avec node dans les instructions du README

README.md n'inclut pas l'instruction pour exécuter `npm link` #2

vinhyan publié le 12 septembre 2024

Il manque des instructions dans le fichier README.md pour exécuter le lien npm, ce qui est nécessaire pour le développement local et les tests de l'outil CLI

Voir sur GitHub

• Affectation de commandes inutiles à l'aide de commander.js

`program.command("run")` n'est pas nécessaire puisque la CLI n'a pas de sous-commandes #3

vinhyan publié le 12 septembre 2024

Voir sur GitHub

• Une faute de frappe dans le nom d'une variable

Faute de frappe dans le nom de la variable #4

vinhyan publié le 12 septembre 2024

index.js ligne 31 : faute de frappe dans le nom de la variable : reponseStream

Voir sur GitHub

Conclusion

Je pensais avoir fait du très bon travail, mais cela montre qu'il y a toujours un bug qui aurait pu être manqué ou une fonctionnalité qui pourrait être améliorée. C'était formidable d'avoir une nouvelle paire d'yeux scrutant le code que j'ai écrit. Pour l'instant, j'ai corrigé la faute de frappe et mis à jour le README, mais les autres problèmes nécessitent des tests et je prévois d'y accéder avant de publier la version 0.1.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!