TidySmith

Proč TidySmith

Funkce

• Seřazení členů třídy, souboru nebo souborů vybraných v Průzkumníku řešení — s náhledem toho, co se přesune.
• Nápovědy v editoru: šedé tečky tam, kde se dá něco uklidit, oprava v žárovce (Ctrl+.).
• Oblasti podle vašich pravidel: podle skupiny členů, podle přístupu nebo obojího, s vašimi názvy oblastí; nebo vůbec bez oblastí.
• Komentáře, které se vejdou: komentáře // a /// zalomené na délku řádku, krátké řádky spojené.
• Úklid při uložení: zvolené kroky se spustí při uložení souboru C#; ve výchozím nastavení vypnuto.
• Okno struktury: členy souboru, velikost a složitost metod, změna pořadí přetažením.
• Drobní pomocníci: přepnutí na související soubor, řazení a spojování řádků, vyhledání souboru v Průzkumníku řešení, sbalení či rozbalení jen oblastí.

Všechny příkazy jsou v nabídce Upravit › TidySmith a v místní nabídce editoru kódu (pravé tlačítko › TidySmith); Order Members také v místní nabídce souborů, složek a projektů v Průzkumníku řešení.

Seřazení členů

Order Members… seřadí členy třídy podle druhu (konstanty, pole, konstruktory, vlastnosti, metody…), pak podle přístupu (nejdřív veřejné), statické před členy instance a, pokud chcete, podle názvu — v pořadí nastaveném na stránce možností nebo v .editorconfig.

• Nejdřív náhled: rozdíly ukazující, co se přesune; Použít je jedna úprava, takže jedno vrácení zpět vrátí vše. „Znovu se neptat“ náhled vypne.
• Kde: třída pod kurzorem nebo celý soubor (volí se v náhledu), nebo každý soubor C# vybraný v Průzkumníku řešení — soubory, složky, projekty.
• Co se přesouvá spolu se členem: jeho komentáře, dokumentace a atributy. Prázdné řádky zůstanou, jak byly; mezi skupiny se vloží jeden prázdný řádek.
• Na co se nikdy nesáhne: členy uvnitř #if nebo #region se řadí jen v rámci svého bloku; třídy se členem na řádku se složenou závorkou, se dvěma členy na jednom řádku nebo se syntaktickými chybami zůstanou, jak jsou; generované soubory (*.g.cs, *.Designer.cs) se přeskakují.

Předvolby, od kterých lze začít: TidySmith (přetížení a implementace rozhraní pohromadě), StyleCop (SA1201, SA1202, SA1204 — přísně podle přístupu) a CodeMaid (výchozí pořadí CodeMaid, pro týmy, které z něj přecházejí).

Nápovědy v editoru

Tam, kde TidySmith může pomoci, se pod názvem objeví tři šedé tečky — stejně jako Visual Studio označuje vlastní návrhy. Ukazatel na nich řekne, o co jde; Ctrl+. nabídne opravu s náhledem změny.

Tečky se objeví u třídy, která není seřazená, u komentáře delšího než délka řádku a u oblastí, které se liší od vašich pravidel — a nikde jinde. Tečky a akce v žárovce mají samostatné přepínače; „Jen v souborech, které jsem změnil“ nechá starý kód na pokoji.

Oblasti podle vašich pravidel

Add Regions to This File… po náhledu vloží řádky #region tam, kde to říkají vaše pravidla. Oblasti jsou rozhodnutím týmu, proto je výchozí volba bez oblastí: dokud nevyberete, příkaz otevře nastavení.

• Jak rozdělit: jedna oblast na skupinu členů (Fields, Methods…), na úroveň přístupu (Public, Private…) nebo obojí (Public methods).
• Vaše názvy: každá skupina má svůj název oblasti; skupiny se stejným názvem sdílejí oblast, vypnutá skupina zůstane mimo oblasti. Implementace rozhraní mohou dostat oblast pojmenovanou podle rozhraní (IDisposable).
• Bez šumu: méně členů, než je minimum (výchozí 2), oblast nedostane; oblast kolem jednoho konstruktoru nikomu nepomůže.
• Spusťte znovu kdykoli: oblasti uvnitř tříd se znovu sestaví, nevnořují se. Členy se nejdřív seřadí, takže každá skupina je v jednom kuse.
• Ručně: Add Region Around Selection (kurzor čeká za #region na název), Remove Region at Caret, Remove Regions in This File — zmizí jen řádky #region a #endregion, kód zůstane.

Pravidlo StyleCop SA1124 oblasti zakazuje; proto je výchozí volba bez oblastí — a proto je úklid při uložení s tímto nastavením odstraňuje.

Komentáře, které se vejdou

Format Comment zalomí komentář // nebo /// pod kurzorem (nebo všechny komentáře souboru) na délku řádku — max_line_length z .editorconfig, nebo 120. Dlouhé řádky se rozdělí, krátké spojí, dlouhý <summary> dostane vlastní řádky. Ukázky kódu (<code>), seznamy, oddělovací řádky a zakomentovaný kód zůstanou, jak jsou.

Úklid při uložení

Při uložení souboru C# může TidySmith seřadit jeho členy, vložit oblasti podle pravidel, zalomit komentáře a odstranit mezery na konci řádků a nadbytečné prázdné řádky — každý krok má vlastní přepínač. Jen ukládaný soubor, nikdy generované soubory; stavový řádek řekne, co se změnilo, a Ctrl+Z to vrátí zpět. Tidy This File spustí stejné kroky na požádání.

Ve výchozím nastavení vypnuto. Zapněte to, až Order Members dává výsledek, jaký váš tým chce — jinak první uložení starého souboru přeskládá úplně všechno.

Okno struktury

Zobrazit › Další okna › TidySmith Structure: typy a členy aktivního souboru C#. Okno sleduje kurzor, kliknutí přejde na člen, hledání filtruje a člen přetažený na jiný se tam přesune — stejně bezpečně jako v Order Members. Metody ukazují svou délku a cyklomatickou složitost; po překročení limitů ze stránky možností zoranžoví.

Drobní pomocníci

Příkazy, které lidem po CodeMaid chyběly, v nabídce Upravit › TidySmith a v místní nabídce editoru.

Switch File

Otevře soubor, který patří k aktuálnímu — značky a jejich kód, soubor prostředků a jeho návrhář, kód a jeho testy — bez hledání v Průzkumníku řešení.

Nabídka uvádí cíl („Switch to OrderServiceTests.cs“) a je vypnutá, když není kam přejít. Nejlépe funguje s vlastní klávesou — viz níže.

Sort Selected Lines

Seřadí direktivy using, členy enum nebo položky seznamu; čárky zůstanou tam, kde je seznam potřebuje. Řadí se jen plochý seznam — jedna položka na řádek, stejné odsazení, bez prázdných řádků a příkazů — takže omylem vybraná metoda nebo celý soubor se nikdy nepromíchá; stavový řádek řekne proč.

Join Lines

Spojí vybrané řádky do jednoho, nebo řádek pod kurzorem s následujícím.

Find This File in Solution Explorer

Vybere soubor z editoru v Průzkumníku řešení.

Collapse a Expand All Regions

Sbalí nebo rozbalí jen bloky #region; metody zůstanou, jak jsou. Na rozdíl od Ctrl+M, Ctrl+O (sbalí i metody) a Ctrl+M, Ctrl+L (všechno).

Ve výchozím nastavení není obsazená žádná klávesová zkratka — klávesy Visual Studia zůstanou, jak jsou. Libovolný příkaz přiřaďte v Nástroje › Možnosti › Prostředí › Klávesnice: do pole „Zobrazit příkazy obsahující“ napište TidySmith..

Nastavení

Nástroje → Možnosti → SmithWorks → TidySmith. Každá možnost má popis.

Možnost	Výchozí
Akce TidySmith v žárovce (Ctrl+.)	zapnuto
Šedé tečky tam, kde se dá něco uklidit	zapnuto
Pořadí členů	předvolba TidySmith
Náhled před seřazením	zapnuto
Oblasti	bez oblastí
Délka řádku komentářů	120
Úklid při uložení	vypnuto
Dlouhá metoda (řádky) · složitá metoda	60 · 10
Požádat o hodnocení na Marketplace	zapnuto

Nastavení se ukládá do %LocalAppData%\TidySmith; přednost má .editorconfig, pokud v něm hodnota je.

Pro repozitář: .editorconfig

Uložte pravidla vedle kódu a celý tým dostane stejný výsledek; hodnota v .editorconfig má přednost před stránkou možností (pokud není vypnutá možnost „Použít pořadí z .editorconfig“).

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

Časté dotazy

Historie změn

1.0.2

• Jednorázová žádost o hodnocení na Marketplace, až bude rozšíření užitečné — s možnostmi Později a Už se neptat a s volbou, jak ji vypnout.

1.0.1

• Order Members a okno Structure na panelu nástrojů SmithWorks, společném s ostatními rozšířeními SmithWorks (Zobrazit › Panely nástrojů › SmithWorks).

1.0.0

• První veřejné vydání.