JScent

JScent

Video: https://youtu.be/_fauq98qely

JScent ist ein Programmanalysator, der Codegerüche erkennt. Code -Gerüche sind potenzielle Probleme mit Quellcode, die einem tieferen Problem im Programm entsprechen können. Beispielsweise kann JSCent Probleme wie lange Methoden, zu viele Kommentare, Neid, Nachrichtenketten, toten Code und mehr erkennen. JScent erstellt einen Bericht, in dem alle Codegerüche in prägnanter und verwendbarer Weise zusammengefasst sind - leicht zugänglich in der Konsole. Die JScent-Analyse kann sowohl als wertunagnostische statische Analyse als auch als Meta-Properties-Analyse klassifiziert werden, da einige Code-Gerüche eher nach Syntax und anderen in Richtung Semantik und hochrangigen Software-Engineering-Prinzipien stützen.

Beispielbericht:

JScent richtet sich an Entwickler und Teams, die versuchen, Code zu erstellen, der wartbar, erweiterbar und gut strukturiert ist. Die generierten Berichte sind nicht als vorgeschrieben, sondern weisen auf Bereiche hin, die Anlass zur Sorge sein können, wenn ein Projekt an Größe und Umfang wächst.

JScent ist so strukturiert, dass es leicht erweiterbar ist, in Zukunft neue Codegerüche hinzuzufügen. Zu den nächsten Schritten für das Team gehört das Hinzufügen von mehr nuancierteren, schwer zu erkennensgerüften Gerüchen in den Analysebericht.

Anweisungen

Setzen Sie alle JS -Dateien, die Sie analysieren möchten, im Ordner /Eingangsordner und führen Sie Main.js aus, um zu starten.

Beispielcode -Gerüche von JScent nachweisbar

• Lange Nachrichtenkette-In Code sehen Sie eine Reihe von Aufrufen, die a-> b ()-> c ()-> d () ähneln
• Feature Envy - Eine Methode greift mehr auf die Daten eines anderen Objekts als auf eigene Daten zu.
• Lange Parameterliste - eine Methode mit mehr als 3 Parametern
• Große Objekte - eine Klasse/ein Objekt, das zu viel tut
• Totcode - Eine Variable, ein Parameter, ein Feld, eine Methode oder eine Klasse wird nicht mehr verwendet (normalerweise weil er veraltet ist).
• Lange Methoden - Eine Methode enthält zu viele Codezeilen
• Switch -Anweisung - eine Switch -Anweisung mit zu vielen Fällen
• Methodenkommentare - Eine Methode ist mit erklärenden Kommentaren gefüllt

Kredit und Referenzen

• Erstes Programm Parsing mithilfe der Esprima Node Library (Esprima.org)
• JSNose: JavaScript -Codegerüche erkennen - https://www.ece.ubc.ca/~amesbah/docs/scam13.pdf
• Code -Geruchsgeruch Defns: https://sourcemaking.com/refactoring/smells