TidySmith

Dlaczego TidySmith

Funkcje

• Porządkowanie składowych klasy, pliku lub plików zaznaczonych w Eksploratorze rozwiązań — z podglądem tego, co się przesunie.
• Wskazówki w edytorze: szare kropki tam, gdzie można coś uporządkować, poprawka w żarówce (Ctrl+.).
• Regiony według Twoich reguł: według grupy składowych, dostępu lub obu, z Twoimi nazwami regionów; albo bez regionów w ogóle.
• Komentarze, które się mieszczą: komentarze // i /// zawinięte do długości wiersza, krótkie wiersze połączone.
• Porządkowanie przy zapisie: wybrane kroki działają przy zapisywaniu pliku C#; domyślnie wyłączone.
• Okno struktury: składowe pliku, rozmiar i złożoność metod, zmiana kolejności przeciąganiem.
• Małe pomocniki: przejście do powiązanego pliku, sortowanie i łączenie wierszy, znajdowanie pliku w Eksploratorze rozwiązań, zwijanie lub rozwijanie samych regionów.

Każde polecenie jest w menu Edytuj › TidySmith i w menu kontekstowym edytora kodu (prawy przycisk › TidySmith); Order Members także w menu kontekstowym plików, folderów i projektów w Eksploratorze rozwiązań.

Porządkowanie składowych

Order Members… sortuje składowe klasy według rodzaju (stałe, pola, konstruktory, właściwości, metody…), potem według dostępu (najpierw publiczne), statyczne przed składowymi wystąpień i, jeśli chcesz, według nazwy — w kolejności ustawionej na stronie opcji lub w .editorconfig.

• Najpierw podgląd: różnice pokazujące, co się przesunie; Zastosuj to jedna edycja, więc jedno cofnięcie wycofuje wszystko. „Nie pytaj ponownie” wyłącza podgląd.
• Gdzie: klasa przy kursorze lub cały plik (wybierane w podglądzie) albo każdy plik C# zaznaczony w Eksploratorze rozwiązań — pliki, foldery, projekty.
• Co przenosi się razem ze składową: jej komentarze, dokumentacja i atrybuty. Puste wiersze pozostają takie, jakie były; między grupami wstawiany jest jeden pusty wiersz.
• Czego nigdy nie rusza: składowe wewnątrz #if lub #region są porządkowane tylko w obrębie swojego bloku; klasy ze składową w wierszu nawiasu klamrowego, dwiema składowymi w jednym wierszu lub błędami składni pozostają bez zmian; pliki generowane (*.g.cs, *.Designer.cs) są pomijane.

Ustawienia wstępne na początek: TidySmith (przeciążenia i implementacje interfejsów razem), StyleCop (SA1201, SA1202, SA1204 — ściśle według dostępu) i CodeMaid (domyślna kolejność CodeMaid, dla zespołów, które z niego przechodzą).

Wskazówki w edytorze

Tam, gdzie TidySmith może pomóc, pod nazwą pojawiają się trzy szare kropki — tak, jak Visual Studio oznacza własne sugestie. Wskaźnik na nich mówi, o co chodzi; Ctrl+. proponuje poprawkę z podglądem zmiany.

Kropki pojawiają się przy klasie o zaburzonej kolejności, komentarzu dłuższym niż długość wiersza i regionach różniących się od Twoich reguł — i nigdzie więcej. Kropki i akcje w żarówce mają osobne przełączniki; „Tylko w plikach, które zmieniłem” zostawia stary kod w spokoju.

Regiony według Twoich reguł

Add Regions to This File… wstawia wiersze #region tam, gdzie mówią Twoje reguły, po podglądzie. Regiony to decyzja zespołu, dlatego domyślnie jest bez regionów: dopóki nie wybierzesz, polecenie otwiera ustawienia.

• Jak dzielić: jeden region na grupę składowych (Fields, Methods…), na poziom dostępu (Public, Private…) lub jedno i drugie (Public methods).
• Twoje nazwy: każda grupa ma swoją nazwę regionu; grupy o tej samej nazwie dzielą region, wyłączona grupa pozostaje poza regionami. Implementacje interfejsów mogą dostać region nazwany tak jak interfejs (IDisposable).
• Bez szumu: mniej składowych niż minimum (domyślnie 2) nie dostaje regionu; region wokół jednego konstruktora nikomu nie pomaga.
• Uruchamiaj ponownie kiedy chcesz: regiony wewnątrz klas są odbudowywane, a nie zagnieżdżane. Składowe są najpierw porządkowane, więc każda grupa jest w jednym kawałku.
• Ręcznie: Add Region Around Selection (kursor czeka po #region na nazwę), Remove Region at Caret, Remove Regions in This File — znikają tylko wiersze #region i #endregion, kod zostaje.

Reguła StyleCop SA1124 zabrania regionów; dlatego domyślnie regionów nie ma — i dlatego porządkowanie przy zapisie z tym ustawieniem je usuwa.

Komentarze, które się mieszczą

Format Comment zawija komentarz // lub /// przy kursorze (albo każdy komentarz pliku) do długości wiersza — max_line_length z .editorconfig lub 120. Długie wiersze są łamane, krótkie łączone, długi <summary> dostaje własne wiersze. Przykłady kodu (<code>), listy, wiersze separatorów i zakomentowany kod pozostają bez zmian.

Porządkowanie przy zapisie

Gdy plik C# jest zapisywany, TidySmith może uporządkować jego składowe, ustawić regiony zgodnie z regułami, zawinąć komentarze i usunąć spacje na końcu wierszy oraz nadmiarowe puste wiersze — każdy krok ma własny przełącznik. Tylko zapisywany plik, nigdy pliki generowane; pasek stanu informuje, co się zmieniło, a Ctrl+Z to cofa. Tidy This File wykonuje te same kroki na żądanie.

Domyślnie wyłączone. Włącz, gdy Order Members daje wynik, jakiego chce Twój zespół — inaczej pierwszy zapis starego pliku przestawi w nim wszystko.

Okno struktury

Widok › Inne okna › TidySmith Structure: typy i składowe aktywnego pliku C#. Okno podąża za kursorem, kliknięcie przechodzi do składowej, wyszukiwanie filtruje, a składowa przeciągnięta na inną przenosi się tam — tym samym bezpiecznym ruchem co w Order Members. Metody pokazują swoją długość i złożoność cyklomatyczną; po przekroczeniu limitów ze strony opcji zmieniają kolor na pomarańczowy.

Małe pomocniki

Polecenia, których brakowało po CodeMaid, w menu Edytuj › TidySmith i w menu kontekstowym edytora.

Switch File

Otwiera plik, który należy do bieżącego — znaczniki i ich kod, plik zasobów i jego projektanta, kod i jego testy — bez szukania go w Eksploratorze rozwiązań.

Menu podaje cel („Switch to OrderServiceTests.cs”) i jest wyłączone, gdy nie ma dokąd przejść. Najlepiej sprawdza się z własnym skrótem — patrz niżej.

Sort Selected Lines

Sortuje dyrektywy using, składowe enum lub elementy listy; przecinki zostają tam, gdzie lista ich potrzebuje. Sortowana jest tylko płaska lista — jeden element na wiersz, to samo wcięcie, bez pustych wierszy i instrukcji — więc przypadkowo zaznaczona metoda lub cały plik nigdy nie zostaną pomieszane; pasek stanu mówi dlaczego.

Join Lines

Łączy zaznaczone wiersze w jeden albo wiersz przy kursorze z następnym.

Find This File in Solution Explorer

Zaznacza plik z edytora w Eksploratorze rozwiązań.

Collapse i Expand All Regions

Zwija lub rozwija tylko bloki #region; metody pozostają bez zmian. W odróżnieniu od Ctrl+M, Ctrl+O (zwija też metody) i Ctrl+M, Ctrl+L (wszystko).

Domyślnie żaden skrót nie jest zajęty — klawisze Visual Studio pozostają bez zmian. Przypisz dowolne polecenie w Narzędzia › Opcje › Środowisko › Klawiatura: wpisz TidySmith. w polu „Pokaż polecenia zawierające”.

Ustawienia

Narzędzia → Opcje → SmithWorks → TidySmith. Każda opcja ma opis.

Opcja	Domyślnie
Akcje TidySmith w żarówce (Ctrl+.)	wł.
Szare kropki tam, gdzie można coś uporządkować	wł.
Kolejność składowych	ustawienie wstępne TidySmith
Podgląd przed porządkowaniem	wł.
Regiony	bez regionów
Długość wiersza komentarzy	120
Porządkowanie przy zapisie	wył.
Długa metoda (wiersze) · złożona metoda	60 · 10
Proś o ocenę w Marketplace	wł.

Ustawienia są przechowywane w %LocalAppData%\TidySmith; pierwszeństwo ma .editorconfig, jeśli zawiera wartość.

Dla repozytorium: .editorconfig

Umieść reguły obok kodu, a cały zespół dostanie ten sam wynik; wartość w .editorconfig ma pierwszeństwo przed stroną opcji (chyba że opcja „Użyj kolejności z .editorconfig” jest wyłączona).

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

FAQ

Historia zmian

1.0.2

• Jednorazowa prośba o ocenę w Marketplace, gdy rozszerzenie okaże się przydatne — z opcjami Później i Nie pytaj więcej oraz ustawieniem, które ją wyłącza.

1.0.1

• Order Members i okno Structure na pasku narzędzi SmithWorks, wspólnym z innymi rozszerzeniami SmithWorks (Widok › Paski narzędzi › SmithWorks).

1.0.0

• Pierwsze publiczne wydanie.