Au-delà de la vérification orthographique : comment les outils d'analyse statique améliorent la collaboration dans le codage

Cette semaine, j'ai élargi mes connaissances sur l'importance du formatage du code dans le développement logiciel. Tout comme nous nous appuyons sur des logiciels de traitement de texte dotés de fonctionnalités de vérification orthographique pour identifier et corriger les fautes d'orthographe, les développeurs devraient tirer parti des éditeurs de code qui offrent des fonctionnalités de formatage et de peluchage pour maintenir la qualité du code.

Pourquoi utiliser des outils d'analyse statique

Pour améliorer la qualité de notre code et réduire le temps de développement, il est essentiel que les programmeurs utilisent des outils d'analyse statique. Lorsque vous collaborez sur des projets avec plusieurs contributeurs, le respect des normes de codage devient crucial, car cela permet aux autres de lire et de comprendre le code plus facilement. Cette nécessité a conduit à l’émergence de divers outils adaptés aux différents langages de programmation. Pour mon projet de cette semaine, j'ai choisi d'implémenter Prettier pour ma base de code JavaScript. En plus des outils de formatage, un linter est également indispensable. Un linter aide les développeurs à identifier les erreurs négligées qui peuvent ne pas affecter l'exécution du programme mais qui peuvent entraîner des problèmes importants dans le code si rien n'est fait. Pour cela, j'ai sélectionné ESLint.

Plus jolie

Pour utiliser Prettier, je l'ai installé localement dans mon projet avec la commande suivante :

npm install --save-dev --save-exact plus joli

Ensuite, j'ai créé deux fichiers de configuration : .prettierrc et .prettierignore :

• .prettierrc : Ce fichier de configuration contient les règles de formatage.

Je l'ai laissé comme objet vide car je souhaite utiliser la configuration par défaut de Prettier sans écraser aucune règle.

• .prettierignore : Ce fichier répertorie les fichiers ou répertoires que Prettier ne doit pas formater.

J'ai inclus tous les fichiers et dossiers que je ne veux pas que Prettier aborde. La plupart d'entre eux sont des fichiers de configuration et des fichiers auto-générés.

Remarques :

• Les deux fichiers doivent être placés dans le répertoire racine du projet.
• Après l'installation, je peux tester les fonctionnalités de Prettier en exécutant :

npx plus joli. --écrire

• Pour faciliter l'exécution de cette commande, j'ai créé un script qui s'exécutera en ligne de commande. Dans le fichier package.json, j'ai ajouté un nouveau script nommé format.

Pour l'utiliser, il vous suffit de taper cette commande :

format d'exécution npm

En plus de la configuration locale et de l'utilisation en ligne de commande, Prettier peut également être intégré à l'éditeur de code (tel que VSCode) via une extension. Une fois installé, il formate automatiquement le code lors de l'enregistrement d'un fichier.

Linter

ESLint est un outil conçu pour identifier et signaler les modèles dans le code ECMAScript/JavaScript, dans le but d'améliorer la cohérence du code et de minimiser les bogues. Vous pouvez installer et configurer ESLint en utilisant :

npm init @eslint/config@latest

Lors de l'exécution de cette commande, une série de questions vous guidera tout au long de la configuration dans le terminal et un nouveau fichier de configuration nommé .eslint.config.mjs sera créé. Puisque j'utilise ESLint version 9.x, toutes les configurations seront spécifiées dans ce fichier. J'ai également répertorié les fichiers et dossiers inutiles qu'ESLint doit ignorer à l'aide de la propriété ignore.

Pour rationaliser le processus de peluchage, j'ai ajouté un script dans package.json pour une exécution plus facile.

Pour exécuter le script, il vous suffit de taper cette commande :

npm exécuter lint

Intégration de l'éditeur

Bien que la configuration susmentionnée soit suffisante pour des projets individuels, garantir un environnement de développement uniforme pour tous les contributeurs est essentiel dans les environnements collaboratifs. Par conséquent, j'ai créé un dossier .vscode dans le répertoire racine contenant deux fichiers :

• extensions.json : ce fichier répertorie les extensions nécessaires que les développeurs doivent installer lors de l'ouverture du projet, fournissant des invites au lancement du projet.

• settings.json : Cette configuration garantit que :

  • L'éditeur formate le code lors de l'enregistrement en utilisant Prettier.
  • ESLint résout automatiquement les problèmes de peluchage lors de l'enregistrement.
  • ESLint valide les fichiers JavaScript.
  • Prettier nécessite un fichier de configuration pour formater le code.

En établissant le dossier .vscode avec settings.json et extensions.json, je m'assure que tous les contributeurs partagent un environnement de développement cohérent, avec Prettier et ESLint parfaitement intégrés dans Visual Studio Code. Cette configuration facilite le formatage et le peluchage automatiques du code en fonction de la configuration du projet, simplifiant ainsi le maintien de la qualité et de la cohérence du code.

Résoudre les problèmes de formatage

• Après avoir exécuté Prettier, j'ai identifié quelques fichiers qui nécessitaient des ajustements manuels, principalement en ajoutant des virgules aux derniers éléments des objets.

• Suite à l'exécution d'ESLint, j'ai découvert 13 problèmes, dont la plupart étaient dus à l'utilisation du processus objet global, qui ne nécessite pas d'initialisation. Pour résoudre ce problème, j'ai ajouté le commentaire suivant en haut des fichiers concernés :

/* eslint-disable no-undef */

De plus, certaines valeurs importées n'ont pas été utilisées ; pour ces cas, je les ai simplement supprimés.

Conclusion

Grâce à mon exploration des outils d'analyse statique, j'ai acquis une compréhension plus approfondie de leur importance, en particulier dans les projets collaboratifs. L'objectif premier de ces outils est de faciliter le travail d'équipe et de maintenir une haute qualité de code, et j'apprécie désormais comment monter efficacement un projet pour intégrer ces outils essentiels dès le départ.

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!