Vytvoření a úprava vlastního souboru EditorConfig

  • Článek
  • 2 min ke čtení

V Visual Studio pro Mac můžete do projektu nebo řešení přidat soubor EditorConfig, abyste vynucovat konzistentní styly kódování pro všechny, kteří v kódu fungují. Nastavení deklarovaná v souboru EditorConfig mají přednost před globálním nastavením Visual Studio pro Mac textového editoru. Pomocí souboru EditorConfig v rámci projektu nebo kódu můžete nastavit styl kódování, předvolby a upozornění pro váš projekt. Vzhledem k tomu, že je soubor součástí vašeho kódu, usnadňuje všem uživatelům dodržování postupů psaní kódu projektu bez ohledu na to, které integrované vývojové prostředí nebo editor kódu používají.

Soubory EditorConfig jsou podporovány v mnoha prostředích ID a editorech kódu, včetně Visual Studio.

Podporovaná nastavení

Editor v Visual Studio pro Mac podporuje základní sadu vlastností EditorConfig:

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • charset
  • trim_trailing_whitespace
  • insert_final_newline
  • root

EditorConfig také podporuje konvence kódování v jazyce C#.

Přidání souboru EditorConfig do projektu

Přidání nového souboru EditorConfig

  1. Otevřete projekt v Visual Studio pro Mac. Vyberte uzel řešení nebo projektu, do které chcete přidat soubor EditorConfig. Přidání souboru do adresáře řešení aplikuje nastavení .editorconfig na všechny projekty v řešení.

  2. Klikněte pravým tlačítkem na uzel a vyberte Add > New File (Přidat nový soubor). Otevře se dialogové okno Nový soubor:

    Položky nabídky obsah

  3. Zvolte Misc > Empty Text File (Chybně > prázdný textový soubor) a pojmete ho Name (Název). .editorconfig Stisknutím new (Nový) soubor vytvořte a otevřete ho v editoru:

    Dialogové okno Nový soubor

    Přidání položky na úrovni řešení ji automaticky vytvoří a vnořuje do složky Položky řešení:

    Položka řešení zobrazená v okně Řešení

  4. Upravte soubor. Příklad:

    # This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 8
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

  5. Nastavení ze souboru se použijí pro jakýkoli nový kód, který napíšete, ale stávající kód může být potřeba přeformátovat tak, aby byl konzistentní s novým .editorconfig nastavením. Pokud chcete použít nastavení ze souboru na existující zdrojový soubor, otevřete soubor a v řádku nabídek zvolte Upravit .editorconfig > Formát > Formátovat dokument::

    Položka nabídky Formátovat dokument

Přidání existujícího souboru EditorConfig

Pokud pracujete s projektem nebo řešením, které už soubor obsahuje, není k použití nastavení potřeba .editorconfig nic dělat. Všechny nové řádky kódu jsou formátovány podle nastavení EditorConfig.

Můžete chtít znovu použít existující .editorconfig soubor ve vašem projektu. Pokud chcete přidat existující soubor, proveďte následující:

  1. Klikněte pravým tlačítkem na složku, do které ji chcete přidat, a vyberte Add > Add Files (Přidat soubory).

  2. Přejděte do adresáře požadovaného souboru.

  3. Soubory začínající na (například ) jsou skryté . soubory v systému .editorconfig macOS, proto stiskněte klávesy Command + Shift + . aby byl .editorconfig soubor viditelný.

  4. Vyberte soubor .editorconfig a klikněte na Otevřít:

    přidání nového okna souboru

  5. Po zobrazení následujícího dialogového okna vyberte možnost Zkopírovat soubor do adresáře a vyberte OK:

    Možnosti dialogového okna Přidat soubor do složky

Promítání nastavení .editorconfig

Po přidání souboru EditorConfig do kódu se každý přidaný kód automaticky naformátuje podle zadaného nastavení. Stávající kód nebude automaticky odrážet nastavení, pokud kód nenaformátíte.

Pokud chcete zobrazit nastavení ze souboru, vyberte uzel řešení a na řádku nabídek zvolte Upravit .editorconfig > Formát > Formátovat dokument:

Formátování dokumentu z řádku nabídek

Úprava souboru EditorConfig

Soubory EditorConfig používají jednoduché rozložení souboru k určení nastavení, které je vysvětleno níže pomocí předchozího příkladu:

# This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 4
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

Nastavení příznaku tohoto souboru jako nejvyššího souboru základního kódu a všech vyšších souborů v projektu se ignoruje, jak je vysvětleno v části Override root true .editorconfig EditorConfig Nastavení.

Každý oddíl je označen hranatými závorkami ([ ]) a určuje informace o typech souborů, kterých by se měly následující vlastnosti týká.

V příkladu výše jsou některá nastavení použita pro všechny soubory v projektu a jiná se přidávají pouze do souborů jazyka C#. Snímky obrazovky níže ukazují před a po .editorconfig použití nastavení:

Před :

Před použitím nastavení editorconfig

Po:

po použití nastavení editorconfig

Další informace o dostupných nastaveních EditorConfig najdete v článku Nastavení konvence psaní kódu .NET pro EditorConfig a v části Podporované vlastnosti v oficiální dokumentaci.

Přepsání nastavení EditorConfig Nastavení

V každém řešení je možné mít .editorconfig více než jeden soubor. Visual Studio pro Mac řešení čte soubory shora dolů a přidává a .editorconfig přepisuje nastavení tak, jak to jde. To znamená, že nastavení v souboru, který je nejblíže upravování, .editorconfig bude mít přednost. Nastavení ze souboru se vezměme do stejné složky (pokud existuje), pak v nadřazené složce .editorconfig .editorconfig (pokud existuje) atd. dokud nenajde root=true .

Pokud chcete zajistit, aby se na tuto část základního kódu nebyla použita žádná nastavení ze souborů vyšší .editorconfig úrovně, přidejte do horní části souboru root=true nižší .editorconfig úrovně vlastnost :

# top-most EditorConfig file
root = true

Viz také