Testng: Definieren / Verwenden einer Codekonvention für neuen / aktualisierten Code

Erstellt am 4. März 2017  ·  8Kommentare  ·  Quelle: cbeust/testng

Ich denke, wir sollten eine Codekonvention für neuen und aktualisierten Code definieren, um überall die gleiche IDE-Konfiguration zu haben und Syntaxfehler bei Pull-Anforderungen zu vermeiden.

Normalerweise verwende ich die Google-Konvention, da sie die Idee und die Eclipse-Konfigurationsdatei bereitstellen.

@ testng-team WDYT?

Question perenhancement

Alle 8 Kommentare

Genau. Wir könnten vielleicht auch eine editorConfig -Datei einfügen. Im Falle des Formatierers müsste der Benutzer es dennoch in seine IDE importieren, damit es wirksam wird. Im Fall von editorConfig wird es jedoch mit IntelliJ geliefert. Die vollständige Liste finden Sie hier
Sie haben auch ein Plugin für Eclipse, das heruntergeladen werden kann. Ich versuche nicht, dies mit dem zu vergleichen, sondern nur Optionen wegzuwerfen.

Ja, EditorConfig ist eine weitere Option. Aber wir müssen die Regeln vorher festlegen. Und ich denke, wir sollten es nicht schnell auf den aktuellen Code anwenden, da der Unterschied zu groß sein wird.

Wir können über Regeln diskutieren, aber ich möchte nicht zu viel Zeit verbringen, weil es mir egal ist, Regeln zu befolgen, die ich nicht mag (sobald sie definiert sind).
Die Google-Konvention könnte ein guter Anfang sein und wir können sie gemäß der Meinung von @ testng-team anpassen

Einverstanden wäre es schön, Formatierungsregeln für IDEA und Eclipse in das Projekt aufzunehmen, aber meiner Erfahrung nach ist es nicht immer einfach, ohne Einstellungen für viele andere Dinge in der IDE anzugeben (nicht sicher, ob dies noch zutrifft). Wenn es möglich ist, eine Datei festzuschreiben, die nur die Codeformatierung und sonst nichts angibt, ist das großartig.

Außerdem sollte diese Datei idealerweise Importaufträge definieren, damit Importe in den PRs nie gemischt werden.

@cbeust Und WDYT über den Google-Stil?

Ich bin mit dem Google-Stil einverstanden.

Einverstanden wäre es schön, Formatierungsregeln für IDEA und Eclipse in das Projekt aufzunehmen, aber meiner Erfahrung nach ist es nicht immer einfach, ohne Einstellungen für viele andere Dinge in der IDE anzugeben (nicht sicher, ob dies noch zutrifft).

Dies ist auch heute noch zum Kotzen, für die Importreihenfolge hat Eclipse eine separate Präferenz und kann exportiert werden.
Im Moment verwendet unser Team sowohl Eclipse als auch Intellij. Wir verwenden die Eclipse-Präferenz als Quelle der Wahrheit. Für Intellij gibt es ein Eclipse Code Formatter-Plugin, mit dem die Eclipse-Einstellungsdateien (einschließlich der Importreihenfolge) importiert werden können.

@missedone Wie von @krmahadevan vorgeschlagen, soll editorConfig Konfigurationsprobleme beheben. Hast du schlechte Erfahrungen damit?

Übrigens, wenn wir dem Google-Stil folgen, stellen sie bereits Eclipse- und Intellij-Konfigurationsdateien bereit.

Ich habe editorConfig vorher nicht verwendet, es könnte Spaß machen, etwas Neues auszuprobieren, aber es sieht so aus, als müsste das editorConfig-Profil von Grund auf neu definiert werden, damit es zu TestNG passt ...

Ich würde sagen, beginnen wir zuerst mit dem Google-Stil.
Für die Importreihenfolge muss eine separate Profildatei vorhanden sein.

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen