Formatage et peluchage pour plus de cohérence

Cette activité consiste à implémenter des outils d'analyse statistique dans mon projet open source GENEREADME pour améliorer la qualité et la cohérence du code.

cleobnvntra / Genereadme

GENEREADME est un outil de ligne de commande qui récupère un fichier de code source et génère un fichier README.md qui explique le code du fichier à l'aide d'un LLM.

Contributions

Les contributions à GENEREADME sont les bienvenues ! Veuillez consulter CONTRIBUTING.md pour obtenir des directives sur la configuration de l'environnement, comment exécuter et tester l'outil et soumettre des modifications.

GENEREADME

GENEREADME est un outil de ligne de commande qui récupère un fichier, le traite et génère un fichier README avec une explication ou une documentation du contenu du fichier. L'outil utilise la complétion du chat OpenAI pour analyser le fichier et générer du contenu.

Utilisation

L'outil prend actuellement en charge Groq et OpenRouter, qui utilise Groq par défaut. Une clé API valide pour le fournisseur approprié doit être fournie.

Fournissez une clé API valide soit en créant un fichier .env, soit via l'indicateur -a ou --api-key lors de l'utilisation de la commande :

API_KEY=API_KEY

or

genereadme <files> -a API_KEY
genereadme <files> --api-key API_KEY

Installer les dépendances :

npm install -g

Exécutez l'outil avec les exemples de fichiers existants ou commencez à utiliser les vôtres :

genereadme <files&gt
genereadme examples/sum.js
genereadme examples/createUser.js

…

Voir sur GitHub

Formateur

Pour mon formateur, j'ai choisi d'utiliser Prettier. Pour des raisons simples, j'ai choisi ceci car j'ai simplement utilisé ses fonctionnalités de base auparavant et j'ai l'intention d'en apprendre davantage.

Techniquement, j'ai déjà configuré mon IDE pour qu'il soit plus joli par défaut, j'avais donc déjà mon formateur depuis le début. Cependant, désormais, avec une configuration plus jolie dans le projet lui-même, cela permettra aux contributeurs d'utiliser également le formateur, gardant ainsi le code du projet cohérent en termes de formatage.

J'ai simplement ajouté les règles sur la façon dont je souhaite que le code soit formaté dans mon fichier .prettierrc, ainsi que certains paramètres dans settings.json sous .vscode/ pour des options telles que le formatage lors de l'enregistrement.

Linter

Pour mon linter, j'ai choisi d'utiliser ESLint. Depuis que j'utilise JavaScript, j'ai utilisé l'un des linters populaires, que j'ai également déjà utilisé auparavant, mais que je n'ai pas vraiment configuré moi-même. C'est pour cette raison que j'ai opté pour ESLinter.

La mise en place d'ESLinter n'a pas été vraiment compliquée. Une simple installation et la configuration des règles dans eslint.config.js suffisent pour faire fonctionner le linter. Cependant, comme j'utilise à la fois un formateur et un linter, je dois m'assurer que les deux peuvent fonctionner correctement ensemble. Ce qui inclut essentiellement des règles supplémentaires pour garantir qu'il n'y aura pas de conflits avec le linter et le formateur.

Comment utiliser les outils

Il existe de nombreuses façons d'utiliser les outils dans le projet, et je préfère personnellement ces configurations spécifiques : formater lors de la sauvegarde pour plus joli et exécuter sur type pour eslint. De cette façon, le linter vérifiera toujours les problèmes de peluchage au fur et à mesure que le développeur tape, puis le formateur formatera automatiquement les modifications lorsqu'une sauvegarde est déclenchée.

Cependant, pour la tâche de cette semaine, j'ai également ajouté des scripts pour permettre à l'utilisateur d'exécuter le formateur et le linter manuellement via la CLI. Un hook de pré-validation est également implémenté pour garantir que tout code validé dans le référentiel répond aux normes de formatage et de peluchage du projet. En ajoutant ce hook, je peux exécuter automatiquement Prettier et ESLint avant chaque validation, détecter rapidement tout problème et maintenir la cohérence du code entre les contributions. Cette configuration permet de réduire les risques de problèmes de formatage mineurs et d'améliorer la lisibilité du code pour toute personne travaillant sur le projet.

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!