VsEditorConfig

Visual Studio EditorConfig

À propos

La plupart des sources sur Internet recommandent d'archiver un fichier .editorconfig dans chaque référentiel, un peu comme un fichier package.json ou Nuget.config . Ceci est tout à fait valable pour les projets d'équipe ou open source, dans lesquels plusieurs développeurs collaborent avec différents styles de codage personnels. Cependant, vous utiliserez probablement les mêmes préférences de qualité/style pour tous vos projets/dépôts personnels/privés. Par conséquent, pour éviter de dupliquer ces préférences dans chaque nouveau référentiel (un cauchemar à mettre à jour si vos préférences de qualité/style changent), vous pouvez créer un seul fichier .editorconfig dans son propre référentiel et demander à vos différents dépôts d'utiliser celui-ci. Essentiellement, ce .editorconfig devient l'un des nombreux "fichiers dot" qui définissent votre propre environnement de codage personnel.

Ce référentiel contient un tel .editorconfig . Je l'ai développé pour mes propres projets, mais j'espère que mes préférences de style sont suffisamment générales pour être utiles à n'importe quel projet Visual Studio, dans n'importe quel référentiel. Sinon, peut-être que ce dépôt vous servira de point de référence pour créer votre propre .editorconfig !

Usage

Supposons que vous ayez la structure de répertoires suivante :

root-directory
    VisualStudioEditorConfig
        .editorconfig
    Repo1
    Repo2
    RepoGroup
        Repo3
        Repo4
    ...

Si vous souhaitez utiliser les mêmes préférences de style dans tous vos dépôts (Repo1, Repo2, Repo3, Repo4, etc.), vous devez alors placer le fichier .editorconfig dans le dossier "root-directory". Malheureusement, le fichier .editorconfig a été cloné dans le sous-dossier « VsEditorConfig ». Vous pouvez copier le fichier dans le répertoire racine, mais vous devrez le recopier à chaque fois que vos préférences de style changent. La solution consiste à créer un lien symbolique dans le répertoire racine vers le .editorconfig versionné.

Sous Windows, exécutez la commande suivante à une invite de commande élevée. Si vous n'utilisez pas une invite de commande élevée (c'est-à-dire une invite de commande ouverte avec « Exécuter en tant qu'administrateur »), vous obtiendrez l'erreur : You do not have sufficient privilege to perform this operation.

 MKLINK " root-directory.editorconfig " " root-directoryVsEditorConfig.editorconfig "

Sous MacOS/Linux, exécutez la commande suivante :

ln -s " root-directory/VsEditorConfig/.editorconfig " " root-directory/.editorconfig "

Remplacez les chemins ci-dessus par ceux nécessaires à votre structure de répertoires particulière (les chemins absolus fonctionnent mieux). Une fois le lien créé, vous pourrez mettre à jour le .editorconfig avec git pull comme d'habitude, et les dernières préférences de style seront alors disponibles pour tous vos référentiels (après le redémarrage de Visual Studio).

Si vous n'aimez aucune de mes préférences de style/formatage, vous pouvez soit créer mon .editorconfig pour l'utiliser comme point de départ et le modifier pour l'adapter à vos conventions particulières, soit ajouter un .editorconfig distinct avec vos remplacements à l'individu. les dépôts qui ont besoin de ces remplacements.