Ich habe kürzlich ein paar Stunden in JavaScript investiert, weil ich von der massiven Nutzerbasis profitieren wollte. Dabei ist mir ein Muster aufgefallen, das die meisten Menschen dynamischen Sprachen zuschreiben. Sie bekommen Dinge sehr schnell zum Laufen, aber sobald Ihr Code eine bestimmte Größe erreicht, verschwenden Sie viel Zeit mit Typ-, Rechtschreib- und Refactoring-Fehlern im Allgemeinen. Fehler, die mir ein Compiler normalerweise ersparen würde. Und ich muss nicht nach Fehlern in der Logik suchen, wenn ich gerade in einem anderen Modul einen Tippfehler gemacht habe.
Angesichts der unglaublichen Folge von JavaScript und anderen dynamisch typisierten Sprachen bin ich zu der Annahme gelangt, dass mit meinem Ansatz etwas nicht in Ordnung ist. Oder ist das nur der Preis, den Sie zahlen müssen?
Um es kurz zu machen:
- Wie nähern Sie sich einem JavaScript-Projekt (oder einer anderen dynamischen Sprache) mit ~ 2000 LOC?
- Gibt es Tools, die verhindern, dass ich diese Fehler mache? Ich habe versucht, durch Facebook und JSHint fließen, die etwas helfen, aber keine Tippfehler fangen.
Antworten:
Insbesondere in Bezug auf JavaScript könnten Sie stattdessen TypeScript verwenden. Es bietet einige der Dinge, auf die Sie sich beziehen. Zitieren der Website:
Und es ist nur eine Obermenge von JS, was bedeutet, dass ein Teil Ihres vorhandenen Codes mit TS problemlos funktioniert:
quelle
foo(x) { return x.bar;}oder so etwas. Da es keine Typinformationen gibt und die Funktion öffentlich ist (daher können Sie nicht alle Anrufer kennen), können Sie nicht herausfinden, ob die Leiste in baz umbenannt werden soll, wenn Sie eine Klasse umbenennen.Es gibt einige Ansätze, die helfen können:
Unit-Test
Schreiben Sie nach Möglichkeit Komponententests. Sich nur auf manuelle Tests oder das Auffinden von Fehlern in der Natur zu verlassen, ist ein Glücksfall.
Verwenden Sie Frameworks
Verwenden Sie nach Möglichkeit etablierte Frameworks, anstatt Ihre eigenen zu erstellen und die Einführung von Fehlern zu riskieren.
Bevorzugen Sie CSS / Hochsprachen
Wo Sie Funktionalität an CSS oder eine andere Hochsprache abgeben können, in der Sie schreiben.
Refactor
Refactor zur Reduzierung der Codemenge. Weniger Code = weniger Orte, an denen etwas schief gehen kann.
Wiederverwendung
Bestehenden Code weiterverwenden, wo Sie können. Auch wenn der Code nicht exakt übereinstimmt, kann es besser sein, ihn zu kopieren, einzufügen und zu ändern, als ihn neu zu schreiben.
IDEs
Moderne IDEs unterstützen in der Regel mindestens etwas Javascript. Einige Texteditoren sind auch Javascript-fähig.
quelle
Ein noch nicht erwähntes Tool ist die einfache, dateilokale oder projektweite Textsuche .
Es klingt einfach, aber wenn Sie einige reguläre Ausdrücke einfügen, können Sie grundlegende bis erweiterte Filterungen durchführen, z. B. nach Wörtern in der Dokumentation oder im Quellcode suchen.
Es war ein effektives Tool für mich (neben statischen Analysatoren) und angesichts Ihrer Projektgröße von 2k LOC, die meiner Meinung nach nicht besonders groß ist, sollte es hoffentlich Wunder wirken.
quelle
grepgeht ein langer Weg. Wenn Sie nicht zu seltsame dynamische Dinge tun, macht es den Trick. Es fühlt sich jedoch sehr manuell an, wenn Sie an IDEs für statisch typisierte Sprachen gewöhnt sind.Derzeit überarbeite ich mehrere tausend Codezeilen in einem großen AngularJS-Projekt. Eine der größten Schwierigkeiten ist es, den genauen Vertrag einer bestimmten Funktion herauszufinden. Manchmal habe ich die API-Dokumentation gelesen, weil Elemente der API-Rohantwort Variablen zugewiesen wurden, die 6 Codeebenen durchliefen, bevor sie geändert und durch 6 weitere Codeebenen zurückgegeben wurden.
Mein erster Rat ist, nach Vertrag zu entwerfen . Nehmen Sie bestimmte Eingaben vor, erzeugen Sie bestimmte Ausgaben, vermeiden Sie Nebenwirkungen und dokumentieren Sie diese Erwartungen mit TypeScript oder mindestens JSDoc.
Mein zweiter Rat ist, so viele Prüfungen wie möglich durchzuführen. Wir folgen dem AirBnB-Standard und verwenden eslint für unsere gesamte Codebasis. Commit Hooks stellen sicher, dass wir uns immer an den Standard halten. Wir haben natürlich eine Reihe von Einheits- und Abnahmetests, und alle Festschreibungen müssen von einem Kollegen überprüft werden.
Der Wechsel von einem Texteditor (Sublime Text) zu einer geeigneten IDE (WebStorm) erleichterte die Arbeit mit Code im Allgemeinen erheblich. WebStorm verwendet JSDoc, um Hinweise zu den erwarteten Parametertypen zu geben und einen Fehler auszulösen, wenn Sie den falschen Typ angeben oder den Rückgabewert falsch verwenden.
In JavaScript können neue Funktionen wie Symbole und Getter / Setter dazu beitragen, ein bestimmtes Qualitätsniveau durch das Hinzufügen von Zusicherungen zur Variablenzuweisung durchzusetzen (z. B. stellen Sie sicher, dass die Ganzzahl innerhalb des Bereichs liegt oder dass das Datenobjekt bestimmte Attribute aufweist).
Leider glaube ich nicht, dass es eine echte Lösung gibt, um dynamische Sprachfehler zu vermeiden, sondern nur eine Reihe von Maßnahmen, mit deren Hilfe die Häufigkeit verringert werden kann.
quelle
Meine Antwort auf die Frage "Wie nähern Sie sich einem JavaScript-Projekt (oder einer anderen dynamischen Sprache) mit ~ 2000 LOC?"
Ich entwickle PDF-Formularanwendungen. Ich nähere mich meinem JavaScript-Softwareentwicklungsprojekt (unabhängig von der Größe des Quellcodes) mit Petris Netzelementen und Anmerkungen. Die Methode ist nicht an eine bestimmte Programmiersprachentechnologie gebunden. Somit kann es für andere „Programmiersprachen“ verwendet werden.
Ich erstelle ein Diagramm der Anwendungslogik. Um das Diagramm übersichtlich zu halten, füge ich die meisten meiner Anmerkungen einem Formular hinzu, das ich mit dem Diagramm verwende. Die Einträge im Formular enthalten Verweise auf Eigenschaften oder Funktionen. Dann schreibe ich den Quellcode basierend auf den Informationen im Diagramm und den Einträgen im Formular aus. Die Methode ist systematisch, da jeder geschriebene Quellcode direkt aus dem Diagramm und den Einträgen im Formular abgebildet wird. Der Quellcode kann einfach überprüft werden, da ich beim Schreiben des Codes auch die Namens- und Codierungskonventionen befolge.
Ich habe zum Beispiel eine Konvention gewählt, nach der alle Funktionen Prototypen sind. Wenn die Leistung zum Problem wird, kann sie durch Deklarieren der Funktionen im Konstruktor verbessert werden. Für einige Eigenschaften verwende ich Arrays. Auch hier kann die Leistung durch direkte Verweise verbessert werden, wenn sie zu einem Problem wird.
Ich benutze auch eval. Dies kann die Größe des Quellcodes erheblich reduzieren. Aufgrund von Leistungsproblemen verwende ich eval am Anfang oder am Anfang der Initialisierung meiner Anwendung. Ich verwende es nie in der „Laufzeitlogik“ - dies ist eine andere Kodierungskonvention, der ich folge.
quelle