Vytvoření přenosného nastavení vlastního editoru pomocí řešení EditorConfig

Můžete přidat soubor EditorConfig do projektu nebo základ kódu k prosazování konzistentních stylů kódování pro všechny, které fungují v základu kódu. nastavení EditorConfig mají přednost před globálním nastavením Visual Studio textový editor. To znamená, že můžete každý základ kódu přizpůsobit tak, aby se používala nastavení textového editoru, která jsou specifická pro daný projekt. vlastní předvolby osobního editoru můžete nastavit i v dialogovém okně možnosti Visual Studio. Tato nastavení platí vždy, když pracujete v základu kódu bez souboru . editorconfig nebo když soubor . editorconfig nepřepíše konkrétní nastavení. Příkladem takové předvolby je odsazení — tabulátorů nebo mezer.

Nastavení EditorConfig jsou podporovaná mnoha editory kódu a prostředími IDEs, včetně Visual Studio. Je to přenosná komponenta, která se používá s vaším kódem a může vymáhat styly kódování i mimo Visual Studio.

Konzistence kódu

Nastavení v souborech EditorConfig vám umožní zachovat konzistentní styly a nastavení kódování v základu kódu, jako je styl odsazení, šířka tabulátoru, konec znaků řádku, kódování a další, bez ohledu na editor nebo IDE, které používáte. Například při psaní kódu v jazyce C# má vaše základová konvence přednost před tím, že se vždy skládají jenom z pěti znaků mezery, dokumenty používají kódování UTF-8 a každý řádek vždycky končí znakem CR/LF, můžete nakonfigurovat soubor . editorconfig tak, aby to provedl.

Konvence kódování, které použijete v osobních projektech, se můžou lišit od těch, které se používají v projektech týmu. Můžete například chtít, aby při kódování a odsazení přidal znak tabulátoru. Váš tým však může preferovat, že odsazení přičítá místo znaku tabulátoru znaky mezer. Soubory EditorConfig tento problém řeší tím, že vám umožní mít konfiguraci pro každý scénář.

Vzhledem k tomu, že nastavení jsou obsažena v souboru v základu kódu, cestují spolu s tímto základem kódu. Pokud otevřete soubor kódu v editoru kompatibilním s EditorConfig, nastavení textového editoru jsou implementovaná. Další informace o souborech EditorConfig najdete na webu EditorConfig.org .

Podporovaná nastavení

editor v Visual Studio podporuje základní sadu vlastností EditorConfig:

• indent_style
• indent_size
• tab_width
• ukončit _ of_line
• charset
• trailing_whitespace střihu _
• vložit _ final_newline
• kořen

nastavení editoru EditorConfig jsou podporovaná ve všech jazycích podporovaných s Visual Studio s výjimkou XML. Kromě toho EditorConfig podporuje konvence stylu kódu , včetně jazyků, formátovánía konvencí pojmenování pro C# a Visual Basic.

Přidání a odebrání souborů EditorConfig

Když do projektu nebo základu kódu přidáte soubor EditorConfig, všechny nové řádky kódu, které zapíšete, jsou formátovány podle souboru EditorConfig. Přidání souboru EditorConfig však nepřevede existující styly na nové, dokud neformátujete dokument nebo nespustíte Vyčištění kódu. Pokud jste například v souboru naformátovali znaky, které jsou naformátované pomocí karet, a přidáte soubor EditorConfig, který se odsadí s mezerami, znaky odsazení se nebudou automaticky převádět na mezery. Při formátování dokumentu (Úprava > rozšířeného > formátu dokumentu nebo CTRL + K, CTRL + D) se nastavení prázdného místa v souboru EditorConfig použije na existující řádky kódu.

Pokud odeberete soubor EditorConfig z projektu nebo základu kódu a chcete, aby byly nové řádky kódu formátovány podle nastavení globálního editoru, je nutné zavřít a znovu otevřít všechny otevřené soubory kódu.

Přidat soubor EditorConfig do projektu

1. Otevřete projekt nebo řešení v Visual Studio. Vyberte buď projekt nebo uzel řešení v závislosti na tom, zda má být nastavení . editorconfig použito pro všechny projekty v řešení nebo pouze jeden. Můžete také vybrat složku v projektu nebo řešení, do které chcete přidat soubor . editorconfig .

2. z panelu nabídek zvolte možnost Project > přidat novou položku nebo stiskněte klávesy Ctrl + Shift + A.

   Otevře se dialogové okno Přidat novou položku .

3. Do vyhledávacího pole vyhledejte editorconfig.

   Ve výsledcích hledání se zobrazí dvě šablony položek souboru editorconfig .

   

4. Vyberte šablonu soubor editorconfig (výchozí) a přidejte soubor editorconfig, který se předběžně vyplnil dvěma základními možnostmi editorconfig pro odsazení stylu a velikost. Případně můžete vybrat šablonu soubor editorconfig (.NET) a přidat soubor editorconfig, který byl předem vyplněný výchozím stylem kódu .NET, formátováním a zásadami vytváření názvů.

   V Průzkumník řešení se zobrazí soubor . editorconfig a otevře se v editoru.

   

5. Upravte soubor podle potřeby.

Další způsoby, jak přidat soubor EditorConfig

Existuje několik dalších způsobů, jak můžete přidat soubor EditorConfig do projektu:

• funkce odvození kódu IntelliCode pro Visual Studio odvodí styly kódu z existujícího kódu. Pak vytvoří neprázdný soubor EditorConfig s předem definovanými preferencemi stylu kódu.

• počínaje Visual Studio 2019 můžete vygenerovat soubor EditorConfig v závislosti na nastavení stylu kódu v > možnostech nástrojů.

Hierarchie souborů a Priorita

Když přidáte soubor . editorconfig do složky ve vaší hierarchii souborů, bude jeho nastavení platit pro všechny příslušné soubory na této úrovni a níže. Můžete také přepsat nastavení EditorConfig pro konkrétní projekt, základ kódu nebo část základu kódu, aby používaly různé konvence než jiné části základu kódu. To může být užitečné, když zařadíte kód z někde jinde a nechcete měnit jeho konvence.

Pokud chcete přepsat některá nebo všechna nastavení EditorConfig, přidejte soubor . EditorConfig na úrovni hierarchie souborů, který chcete použít pro přepsané nastavení. Nové nastavení souboru EditorConfig se týká souborů na stejné úrovni a všech podadresářích.

Pokud chcete přepsat některá, ale ne všechna nastavení, určete pouze tato nastavení v souboru . editorconfig . Přepsány jsou pouze vlastnosti, které jsou explicitně uvedeny v souboru nižší úrovně. Další nastavení ze souborů vyšších úrovní . editorconfig budou nadále platit. Pokud chcete zajistit, aby se v této části základu kódu nepoužívala žádná nastavení ze všech souborů editorconfig na vyšší úrovni, přidejte root=true vlastnost do souboru . editorconfig na nižší úrovni:

# top-most EditorConfig file
root = true

Soubory EditorConfig jsou čteny shora dolů. Pokud existuje více vlastností se stejným názvem, má přednost vlastnost naposledy Nalezeno s tímto názvem.

Upravit soubory EditorConfig

Visual Studio pomáhá upravovat soubory . editorconfig zadáním seznamů dokončení IntelliSense.

Po úpravě souboru EditorConfig je nutné znovu načíst soubory kódu, aby se nové nastavení projevilo.

Pokud upravíte spoustu souborů . editorconfig , můžete najít užitečné rozšíření služby editorconfig Language . Některé funkce tohoto rozšíření zahrnují zvýrazňování syntaxe, vylepšenou technologii IntelliSense, ověřování a formátování kódu.

Příklad

Následující příklad ukazuje stav odsazení fragmentu kódu v jazyce C# před a po přidání souboru . editorconfig do projektu. nastavení tabulátorů v dialogovém okně možnosti pro Visual Studio textový editor je nastaveno tak, aby při stisknutí klávesy tabulátoru vytvořilo znaky mezery.

Podle očekávání se po stisknutí klávesy TAB na dalším řádku Odsadí řádek přidáním čtyř dalších prázdných znaků.

Přidejte do projektu nový soubor s názvem . editorconfig s následujícím obsahem. [*.cs]Nastavení znamená, že tato změna se vztahuje pouze na soubory kódu jazyka C# v projektu.

# Top-most EditorConfig file
root = true

# Tab indentation
[*.cs]
indent_style = tab

Když teď stisknete klávesu TAB , místo mezer se zobrazí znaky tabulátoru.

Řešení potíží s nastavením EditorConfig

Pokud se soubor EditorConfig nachází kdekoli v adresářové struktuře v umístění projektu nebo nad jeho umístěním, Visual Studio použije nastavení editoru v tomto souboru na váš editor. V takovém případě se na stavovém řádku může zobrazit následující zpráva:

"Předvolby uživatelů pro tento typ souboru se přepíše konvencemi psaní kódu tohoto projektu."

To znamená, že pokud jsou v souboru EditorConfig v souboru EditorConfig v adresářové struktuře nebo vyšším v projektu zadána nějaká nastavení editoru v textovém editoru (například velikost a styl odsazení, velikost tabulátoru nebo konvence kódování), konvence v souboru EditorConfig přepíší nastavení v > > části Možnosti. Toto chování můžete řídit přepínáním možnosti Sledovat konvence psaní kódu projektu v nabídce Nástroje > Možnosti > Textový editor. Zrušením zaškrtnutí této možnosti vypnete podporu EditorConfig pro Visual Studio.

Všechny soubory .editorconfig v nadřazených adresářích najdete tak, že otevřete příkazový řádek a v kořenovém adresáři disku, který obsahuje váš projekt, se otevře následující příkaz:

dir .editorconfig /s

Obor konvencí EditorConfig můžete řídit nastavením vlastnosti v souboru .editorconfig v kořenovém adresáři vašeho repo nebo v adresáři, ve kterém se nachází root=true váš projekt. Visual Studio soubor s názvem .editorconfig v adresáři otevřeného souboru a v každém nadřazeném adresáři. Hledání skončí, když dosáhne cesty ke kořenovému souboru, nebo pokud je nalezen soubor .editorconfig root=true s .

Viz také

• Konvence stylu kódu .NET
• Podpora EditorConfig pro službu jazyka
• EditorConfig.org
• Funkce editoru kódu
• EditorConfig (Visual Studio pro Mac)