JScent

Jscent

Vidéo: https://youtu.be/_fauq98qely

JScent est un analyseur de programme qui détecte les odeurs de code. Les odeurs de code sont des problèmes potentiels avec le code source qui peuvent correspondre à un problème plus profond du programme. Par exemple, JSCENT peut détecter des problèmes tels que les méthodes longues, trop de commentaires, l'envie des fonctionnalités, les chaînes de messages, le code mort et plus encore. JScent produit un rapport qui résume toutes les odeurs de code trouvées de manière concise et utilisable - facilement accessible dans la console. L'analyse JSCENT peut être classée à la fois comme une analyse statique agnostique de valeur et une analyse de méta-propriétés, car certains codes sentent davantage vers la syntaxe et d'autres plus vers la sémantique et les principes d'ingénierie logicielle de haut niveau.

Exemple de rapport:

JScent s'adresse aux développeurs et aux équipes qui essaient de créer du code maintenable, extensible et bien structuré. Les rapports générés ne sont pas destinés à être normatifs mais soulignent plutôt des domaines qui peuvent être préoccupants à mesure qu'un projet augmente en taille et en portée.

JScent est structuré d'une manière qu'il est facilement extensible d'ajouter de nouvelles odeurs de code à l'avenir. Les prochaines étapes de l'équipe comprennent l'ajout de l'odeur plus nuancée et difficile à repérer au rapport d'analyse.

Instructions

Mettez tous les fichiers JS que vous souhaitez analyser dans le dossier / entrée et exécutez main.js pour démarrer.

Exemple de code odeurs détectable par jscent

• Chaîne de messages longue - Dans le code, vous voyez une série d'appels ressemblant à a-> b () -> c () -> d ()
• Envie de fonctionnalités - Une méthode accède plus aux données d'un autre objet que ses propres données.
• Liste des paramètres longs - une méthode avec plus de 3 paramètres
• Grand objets - une classe / un objet qui fait trop
• Code mort - Une variable, un paramètre, un champ, une méthode ou une classe ne sont plus utilisés (généralement parce qu'il est obsolète).
• Méthodes longues - Une méthode contient trop de lignes de code
• Instruction Switch - Une instruction Switch avec trop de cas
• Commentaires de la méthode - Une méthode est remplie de commentaires explicatifs

Crédit et références

• Analyse initiale du programme réalisée à l'aide de la bibliothèque de nœuds Esprima (Esprima.org)
• JSNOSE: Détection des odeurs de code JavaScript - https://www.ece.ubc.ca/~amesbah/docs/scam13.pdf
• Code odeur defn's: https://sourcemaking.com/refactoring/smells