Définir des styles de codage cohérents avec EditorConfig

Pour appliquer des styles de codage cohérents pour tout le monde qui fonctionne dans une base de code, vous pouvez ajouter un fichier .editorconfig à votre solution ou projet. Les paramètres de fichier EditorConfig adhèrent à une spécification de format de fichier conservée par EditorConfig.org. De nombreux éditeurs de code et applications prennent en charge les fichiers EditorConfig, notamment Visual Studio. Vous pouvez utiliser plusieurs .editorconfig fichiers et les inclure dans le cadre d’une base de code.

Vous pouvez remplir manuellement un fichier EditorConfig ou le générer automatiquement en fonction des paramètres de style de code que vous avez choisis dans Visual Studio. Pour plus d’informations, consultez Ajouter et supprimer des fichiers EditorConfig.

Lorsque vous ajoutez un fichier EditorConfig à votre projet dans Visual Studio, seules les nouvelles lignes de code sont mises en forme en fonction des paramètres EditorConfig. La mise en forme du code existant n’est pas modifiée, sauf si vous exécutez les commandes Nettoyage du code ou Format de document . Pour plus d’informations, consultez Appliquer des styles de code.

Pour .NET, Visual Studio affiche une version mise en forme du .editorconfig fichier au lieu du fichier texte brut.

EditorConfig et préférences de style de code

Dans Visual Studio, les paramètres de fichier EditorConfig sont prioritaires sur les différents paramètres globaux de l’éditeur de texte disponibles sous Outils>Options>Éditeur de texte>[C# | C/C++ | Visual Basic]>Style de code. Vous pouvez utiliser un fichier EditorConfig pour personnaliser chaque codebase afin d’utiliser les paramètres de l’éditeur de texte spécifiques à ce projet.

Lorsque vous utilisez un fichier EditorConfig, vous pouvez continuer à définir vos propres préférences d’éditeur personnel dans l’éditeur de texte Visual Studio. Ces paramètres d’éditeur de texte s’appliquent chaque fois que vous travaillez dans une base de code sans fichier EditorConfig, ou lorsque le fichier EditorConfig ne remplace pas un paramètre particulier. Par exemple, une telle préférence consiste à utiliser des onglets ou des espaces pour le style d'indentation du code.

Cohérence du code

Les paramètres de fichier EditorConfig vous permettent de conserver des styles et des conventions de codage cohérents dans une base de code, quel que soit l’éditeur ou l’IDE que vous utilisez. Certains styles de codage que vous pouvez contrôler sont le style de retrait, la largeur de tabulation, les caractères de fin de ligne et l’encodage. Par exemple, si votre codebase C# a une convention qui met en retrait cinq caractères d’espace, les documents utilisent l’encodage UTF-8 et les lignes se terminent par CR/LF, vous pouvez configurer un fichier EditorConfig pour utiliser cette convention. Pour plus d’informations sur les conventions prises en charge, consultez Paramètres pris en charge.

Les fichiers EditorConfig sont utiles lorsque les conventions de codage que vous utilisez sur vos projets personnels diffèrent de celles utilisées sur les projets de votre équipe. Par exemple, vous préférez qu’une indentation ajoute un caractère de tabulation dans votre code. Toutefois, votre équipe peut préférer qu’un retrait ajoute quatre espaces à la place. Les fichiers EditorConfig résolvent ce problème en vous permettant d’avoir une configuration pour chaque scénario.

Étant donné qu’un fichier .editorconfig dans la base de code contient les paramètres EditorConfig, ils se déplacent avec ce codebase. Tant que vous ouvrez le fichier de code dans un éditeur conforme à EditorConfig, les paramètres de l’éditeur de texte sont activés.

Paramètres pris en charge

EditorConfig prend en charge tous les langages pris en charge par Visual Studio, à l’exception de XML.

Pour chaque langage, l’éditeur de Visual Studio prend en charge l’ensemble principal de propriétés EditorConfig :

• indent_style
• indent_size
• tab_width
• fin de ligne
• charset
• trim_trailing_whitespace
• insérer_nouvelle_ligne_finale
• racine

Pour C# et Visual Basic, EditorConfig prend également en charge les règles de style code , notamment le langage, la mise en forme et le nommage. Par exemple, vous pouvez spécifier une règle de langage C# concernant l’utilisation de var lors de la définition de variables. Vous pouvez également spécifier une règle de dénomination selon laquelle les noms de méthodes asynchrones doivent inclure un suffixe « Async ».

Ajouter et supprimer des fichiers EditorConfig

Lorsque vous ajoutez un fichier EditorConfig à votre projet ou codebase, Visual Studio met en forme toutes les nouvelles lignes de code que vous écrivez en fonction des paramètres du fichier EditorConfig. Toutefois, Visual Studio ne convertit pas les styles existants en styles nouveaux tant que vous n’avez pas mis en forme le document ou exécuté nettoyage du code. Par exemple, si les retraits de votre fichier sont mis en forme avec des onglets et que vous ajoutez un fichier EditorConfig qui met en forme les retraits avec des espaces, les caractères de retrait ne sont pas automatiquement convertis en espaces. Lorsque vous mettez en forme le document (sélectionnez Modifier>>Format de document ou appuyez sur Ctrl+K, Ctrl+D), les paramètres d’espace blanc dans le fichier EditorConfig sont appliqués aux lignes de code existantes.

Si vous supprimez un fichier EditorConfig de votre projet ou codebase, vous devez fermer et rouvrir tous les fichiers de code ouverts pour les paramètres d’éditeur globaux afin d’affecter les nouvelles lignes de code.

Visual Studio utilise automatiquement les fichiers EditorConfig présents dans une base de code, en fonction de la hiérarchie des dossiers.

S’il n’existe aucun fichier EditorConfig, vous pouvez en ajouter un au projet à l’aide de l’une des méthodes suivantes :

• générer automatiquement un fichier EditorConfig en fonction de vos paramètres de style code.

• Ajoutez manuellement le fichier EditorConfig.

• Utilisez IntelliCode pour Visual Studio pour générer un fichier .editorconfig dans votre solution. Cliquez avec le bouton droit dans l’Explorateur de solutions et choisissez Ajouter>un nouveau EditorConfig (IntelliCode) dans le menu contextuel. IntelliCode pour Visual Studio déduit vos styles de code à partir du code existant, puis crée un fichier EditorConfig avec vos préférences de style de code prédéfinies.

Générer un EditorConfig à partir de paramètres de style de code

Ajouter un fichier EditorConfig à un projet

Pour ajouter un fichier EditorConfig à votre projet ou solution, procédez comme suit :

1. Ouvrez un projet ou une solution dans Visual Studio. Sélectionnez la solution ou le nœud de projet, selon que vos paramètres EditorConfig doivent s’appliquer à tous les projets de la solution ou à un seul. Vous pouvez également sélectionner un dossier dans votre projet ou solution pour ajouter le fichier .editorconfig.

2. Dans le menu, choisissez Projet>Ajouter un nouvel élément, ou appuyez sur Ctrl+Maj+A.

   La boîte de dialogue Ajouter un nouvel élément s’ouvre.

3. Dans la zone de recherche, entrez editorconfig.

   Deux modèles d’élément editorconfig file sont affichés dans les résultats de recherche.

   

   Si vous ne voyez pas le modèle d’élément, vous devez ajouter le fichier manuellement ou ajouter la version Intellicode de .editorconfig, puis la modifier pour votre langue.

4. Sélectionnez le fichier modèle EditorConfig (vide) pour ajouter un fichier EditorConfig prérempli avec les options EditorConfig par défaut pour les espaces blancs, le style de code et les conventions de nommage. Ou, sélectionnez le modèle Fichier editorconfig (.NET) pour ajouter un fichier EditorConfig prérempli avec les conventions .NET d’espacement, de style de code et de nommage par défaut.

   Un nouveau fichier .editorconfig s’affiche dans l’Explorateur de solutions et s’ouvre dans l’éditeur sous la forme d’un nouvel onglet.

   Pour .NET, Visual Studio fournit une version mise en forme du fichier, comme suit.

   

5. Modifiez éventuellement le fichier, puis enregistrez-le.

Hiérarchie et précédence des fichiers

Lorsque vous ajoutez un fichier .editorconfig à un dossier de votre hiérarchie de fichiers, ses paramètres s’appliquent à tous les fichiers applicables à ce niveau et à un niveau inférieur. Vous pouvez également remplacer les paramètres EditorConfig d’un projet, d’une base de code ou d’une partie d’une base de code, de sorte qu’il utilise des conventions différentes des autres parties du codebase. Cela peut être utile lorsque vous incorporez du code à partir d’un autre endroit et que vous ne souhaitez pas modifier ses conventions.

Suivez ces instructions :

• Pour remplacer certains ou tous les paramètres EditorConfig, ajoutez un fichier .editorconfig au niveau de la hiérarchie de fichiers que vous souhaitez que ces paramètres substitués s’appliquent. Les nouveaux paramètres de fichier EditorConfig s’appliquent aux fichiers au même niveau et aux fichiers des sous-répertoires.

  

• Si vous souhaitez remplacer certains paramètres, mais pas tous les paramètres, spécifiez uniquement ces paramètres dans le fichier .editorconfig. Seules les propriétés que vous avez explicitement énumérées dans le fichier .editorconfig de niveau inférieur sont remplacées. D’autres paramètres de tous les fichiers .editorconfig de niveau supérieur continuent à s’appliquer.

• Si vous souhaitez vous assurer qu’aucun paramètre des fichiers .editorconfig de niveau supérieur n’est appliqué à cette partie du codebase, ajoutez la propriété root=true au fichier .editorconfig de niveau inférieur.

  # top-most EditorConfig file for this level
  root = true
  

Les fichiers EditorConfig sont lus de haut en bas. S’il existe plusieurs propriétés portant le même nom, la propriété la plus récemment trouvée portant le même nom est prioritaire.

Modifier les fichiers EditorConfig

Exemple

L’exemple suivant montre l’état de retrait d’un extrait de code C# avant et après l’ajout d’un fichier EditorConfig au projet :

1. Dans la boîte de dialogue Outils>Options, définissez les paramètres de Éditeur de texte>C#>Tabulations pour l’éditeur de texte Visual Studio afin de produire quatre caractères d’espace lors de l’appui sur la touche Tab.

   

2. Comme prévu, lorsque vous appuyez sur la touche Tab sur la ligne suivante, elle indente la ligne en ajoutant quatre caractères d’espace blanc.

   

3. Utilisez EditorConfig pour changer le paramètre onglets pour utiliser des onglets.

   Sélectionnez Utiliser des onglets dans le fichier EditorConfig.

   

4. Lorsque vous appuyez sur la touche Tab, les caractères de tabulation apparaissent maintenant au lieu d’espaces.

   

Résoudre les problèmes liés aux paramètres d’EditorConfig

Si un fichier EditorConfig existe n’importe où dans la structure de répertoires à l’emplacement de votre projet, Visual Studio applique les paramètres de l’éditeur dans ce fichier à votre éditeur. Dans ce cas, vous pouvez voir le message suivant dans la barre d’état :

User preferences for this file type are overridden by this project's coding conventions.

Cela signifie que si des paramètres d’éditeur dans Tools>Options>Éditeur de texte (telles que la taille et le style de retrait, la taille de tabulation ou les conventions de codage) sont spécifiés dans un fichier EditorConfig au niveau ou au-dessus du projet dans la structure de répertoires, les conventions du fichier EditorConfig remplacent les paramètres dans Éditeur de texte.

Pour résoudre les problèmes EditorConfig, procédez comme suit :

1. Pour désactiver la prise en charge de EditorConfig pour Visual Studio, désactivez l’option Suivre les conventions de codage de projet dans Outils>Options>Éditeur de texte.

   

2. Pour rechercher des fichiers EditorConfig dans les répertoires parents de votre projet, ouvrez une invite de commandes et exécutez la commande suivante à partir de la racine du disque qui contient votre projet.

   dir .editorconfig /s
   

3. Pour contrôler l’étendue de vos conventions EditorConfig, définissez la propriété root=true dans le fichier .editorconfig à la racine de votre dépôt ou dans le répertoire où réside votre projet.

   Visual Studio recherche un fichier nommé .editorconfig dans le répertoire du fichier ouvert et dans chaque répertoire parent. La recherche se termine lorsqu’elle atteint le chemin de fichier racine, ou si un fichier .editorconfig avec root=true est trouvé.

Contenu connexe

• Options de règles de style de code pour .NET
• Prise en charge d’EditorConfig pour votre service de langage
• EditorConfig.org
• Fonctionnalités de l’éditeur de code
• fichiers de configuration pour les règles d’analyse du code