TidySmith

Warum TidySmith

Funktionen

• Member sortieren – in einer Klasse, einer Datei oder den im Projektmappen-Explorer ausgewählten Dateien, mit einer Vorschau dessen, was verschoben wird.
• Hinweise im Editor: graue Punkte, wo sich etwas aufräumen lässt, die Korrektur in der Glühbirne (Ctrl+.).
• Regionen nach Ihren Regeln: nach Membergruppe, nach Zugriff oder beidem, mit Ihren Regionsnamen; oder gar keine Regionen.
• Kommentare, die passen: //- und ///-Kommentare auf Ihre Zeilenlänge umbrochen, kurze Zeilen zusammengeführt.
• Aufräumen beim Speichern: Die gewählten Schritte laufen beim Speichern einer C#-Datei; standardmäßig aus.
• Strukturfenster: die Member der Datei, Größe und Komplexität der Methoden, Umsortieren per Ziehen.
• Kleine Helfer: zur zugehörigen Datei wechseln, Zeilen sortieren und verbinden, die Datei im Projektmappen-Explorer finden, nur die Regionen reduzieren oder erweitern.

Alle Befehle stehen unter Bearbeiten › TidySmith und im Kontextmenü des Code-Editors (Rechtsklick › TidySmith); Order Members zusätzlich im Kontextmenü von Dateien, Ordnern und Projekten im Projektmappen-Explorer.

Member sortieren

Order Members… sortiert die Member einer Klasse nach Art (Konstanten, Felder, Konstruktoren, Eigenschaften, Methoden…), dann nach Zugriff (öffentliche zuerst), statische vor Instanzmembern und auf Wunsch nach Name – in der Reihenfolge, die auf der Optionsseite oder in .editorconfig festgelegt ist.

• Zuerst eine Vorschau: der Diff dessen, was verschoben wird; Übernehmen ist eine einzige Bearbeitung, ein Rückgängig nimmt also alles zurück. „Nicht mehr fragen“ schaltet die Vorschau aus.
• Wo: die Klasse am Cursor oder die ganze Datei (in der Vorschau gewählt) oder jede im Projektmappen-Explorer ausgewählte C#-Datei – Dateien, Ordner, Projekte.
• Was mit einem Member wandert: seine Kommentare, seine Dokumentation und seine Attribute. Leerzeilen bleiben, wie sie waren; zwischen Gruppen steht eine Leerzeile.
• Was nie angefasst wird: Member innerhalb von #if oder #region werden nur innerhalb ihres Blocks sortiert; Klassen mit einem Member auf der Zeile einer Klammer, zwei Membern in einer Zeile oder Syntaxfehlern bleiben, wie sie sind; generierte Dateien (*.g.cs, *.Designer.cs) werden übersprungen.

Voreinstellungen als Ausgangspunkt: TidySmith (Überladungen und Schnittstellenimplementierungen bleiben zusammen), StyleCop (SA1201, SA1202, SA1204 – streng nach Zugriff) und CodeMaid (der CodeMaid-Standard, für Teams, die davon umsteigen).

Hinweise im Editor

Wo TidySmith helfen kann, erhält der Name drei graue Punkte – so, wie Visual Studio seine eigenen Vorschläge markiert. Der Mauszeiger darauf zeigt, worum es geht; Ctrl+. bietet die Korrektur an, mit einer Vorschau der Änderung.

Punkte erscheinen bei einer nicht sortierten Klasse, einem Kommentar, der länger als die Zeilenlänge ist, und bei Regionen, die von Ihren Regeln abweichen – sonst nirgends. Punkte und Glühbirnenaktionen haben getrennte Schalter; „Nur in Dateien, die ich geändert habe“ lässt alten Code in Ruhe.

Regionen nach Ihren Regeln

Add Regions to This File… setzt #region-Zeilen dorthin, wo Ihre Regeln es vorsehen, nach einer Vorschau. Regionen sind eine Teamentscheidung, daher ist der Standard keine Regionen: Der Befehl öffnet die Einstellungen, bis Sie gewählt haben.

• Wie aufgeteilt wird: eine Region pro Membergruppe (Fields, Methods…), pro Zugriff (Public, Private…) oder beides (Public methods).
• Ihre Namen: Jede Gruppe hat ihren Regionsnamen; Gruppen mit demselben Namen teilen sich eine Region, eine ausgeschaltete Gruppe bleibt außerhalb von Regionen. Schnittstellenimplementierungen können eine Region erhalten, die nach der Schnittstelle benannt ist (IDisposable).
• Kein Rauschen: Weniger Member als das Minimum (standardmäßig 2) erhalten keine Region; eine Region um einen einzelnen Konstruktor hilft niemandem.
• Jederzeit erneut ausführen: Die Regionen innerhalb von Klassen werden neu aufgebaut, nicht verschachtelt. Die Member werden zuerst sortiert, sodass jede Gruppe an einem Stück ist.
• Von Hand: Add Region Around Selection (der Cursor wartet nach #region auf den Namen), Remove Region at Caret, Remove Regions in This File – nur die Zeilen #region und #endregion verschwinden, der Code bleibt.

Die StyleCop-Regel SA1124 verbietet Regionen; deshalb ist der Standard „keine Regionen“ – und deshalb entfernt das Aufräumen beim Speichern sie mit dieser Einstellung.

Kommentare, die passen

Format Comment umbricht den //- oder ///-Kommentar am Cursor (oder jeden Kommentar der Datei) auf Ihre Zeilenlänge – max_line_length aus .editorconfig oder 120. Lange Zeilen werden umbrochen, kurze zusammengeführt, ein langes <summary> erhält eigene Zeilen. Codebeispiele (<code>), Listen, Trennlinien und auskommentierter Code bleiben unverändert.

Aufräumen beim Speichern

Beim Speichern einer C#-Datei kann TidySmith ihre Member sortieren, Regionen nach den Regeln setzen, Kommentare umbrechen sowie nachgestellte Leerzeichen und überzählige Leerzeilen entfernen – jeder Schritt hat seinen eigenen Schalter. Nur die gespeicherte Datei, nie generierte Dateien; die Statusleiste zeigt, was sich geändert hat, und Ctrl+Z nimmt es zurück. Tidy This File führt dieselben Schritte auf Anforderung aus.

Standardmäßig aus. Schalten Sie es ein, sobald Order Members das Ergebnis liefert, das Ihr Team möchte – sonst sortiert das erste Speichern einer alten Datei sie komplett um.

Strukturfenster

Ansicht › Weitere Fenster › TidySmith Structure: die Typen und Member der aktiven C#-Datei. Es folgt dem Cursor, ein Klick springt zum Member, die Suche filtert, und ein auf einen anderen gezogener Member wandert dorthin – dieselbe sichere Verschiebung wie bei Order Members. Methoden zeigen ihre Länge und zyklomatische Komplexität; über den Grenzwerten der Optionsseite werden sie orange.

Kleine Helfer

Die Befehle, die an CodeMaid vermisst wurden, unter Bearbeiten › TidySmith und im Kontextmenü des Editors.

Switch File

Öffnet die Datei, die zur aktuellen gehört – Markup und sein Code, eine Ressourcendatei und ihr Designer, Code und seine Tests –, ohne sie im Projektmappen-Explorer suchen zu müssen.

Der Menüpunkt nennt das Ziel („Switch to OrderServiceTests.cs“) und ist deaktiviert, wenn es kein Ziel gibt. Am besten mit einer eigenen Tastenkombination – siehe unten.

Sort Selected Lines

Sortiert usings, Enum-Member oder die Einträge einer Liste; die Kommas bleiben dort, wo die Liste sie braucht. Sortiert wird nur eine flache Liste – ein Eintrag pro Zeile, gleicher Einzug, keine Leerzeilen, keine Anweisungen –, sodass eine versehentlich markierte Methode oder ganze Datei nie durcheinandergerät; die Statusleiste sagt, warum.

Join Lines

Verbindet die ausgewählten Zeilen zu einer oder die Zeile am Cursor mit der nächsten.

Find This File in Solution Explorer

Wählt die Datei des Editors im Projektmappen-Explorer aus.

Collapse und Expand All Regions

Reduziert oder erweitert nur die #region-Blöcke; Methoden bleiben, wie sie sind. Anders als Ctrl+M, Ctrl+O (reduziert auch Methoden) und Ctrl+M, Ctrl+L (alles).

Standardmäßig ist keine Tastenkombination belegt – die Tasten von Visual Studio bleiben, wie sie sind. Weisen Sie jedem Befehl eine zu unter Extras › Optionen › Umgebung › Tastatur: Geben Sie TidySmith. in „Befehle mit folgendem Inhalt anzeigen“ ein.

Einstellungen

Extras → Optionen → SmithWorks → TidySmith. Jede Option hat eine Beschreibung.

Option	Standard
TidySmith-Aktionen in der Glühbirne (Ctrl+.)	ein
Graue Punkte, wo sich etwas aufräumen lässt	ein
Reihenfolge der Member	Voreinstellung TidySmith
Vorschau vor dem Sortieren	ein
Regionen	keine Regionen
Zeilenlänge für Kommentare	120
Aufräumen beim Speichern	aus
Lange Methode (Zeilen) · komplexe Methode	60 · 10
Um eine Bewertung im Marketplace bitten	ein

Die Einstellungen werden in %LocalAppData%\TidySmith gespeichert; .editorconfig hat Vorrang, wo es einen Wert enthält.

Pro Repository: .editorconfig

Legen Sie die Regeln neben den Code, und das ganze Team erhält dasselbe Ergebnis; ein Wert in .editorconfig hat Vorrang vor der Optionsseite (außer wenn „Reihenfolge aus .editorconfig verwenden“ ausgeschaltet ist).

[*.cs]
tidysmith_member_order = stylecop
tidysmith_regions = kind
tidysmith_region_min = 2
max_line_length = 120

FAQ

Änderungsprotokoll

1.0.2

• Eine einmalige Bitte um eine Bewertung im Marketplace, nachdem die Erweiterung nützlich war – mit Später und Nicht mehr fragen sowie einer Option zum Abschalten.

1.0.1

• Order Members und das Fenster Structure auf der Symbolleiste SmithWorks, die alle SmithWorks-Erweiterungen teilen (Ansicht › Symbolleisten › SmithWorks).

1.0.0

• Erste öffentliche Version.