Résumer d'autres réponses
La recommandation consiste à exclure généralement le .vscodedossier, mais laissez certains fichiers JSON qui permettent aux autres développeurs de recréer les paramètres partagés.
Exemples de paramètres à inclure:
- Configurations de test spécifiques à la langue pour exécuter la ou les suites de tests (
settings.json)
- Paramètres d'extension pour les linters et les outils de formatage de code pour appliquer les règles de langue utilisées dans ce repo (
settings.json)
- Exécuter et déboguer les configurations (
launch.json)
- Tâches partagées - si gérées avec VS Code (
tasks.json)
Notez que certains paramètres peuvent être stockés dans le fichier de l'espace de travail ou transférés dans celui-ci à partir du dossier .vscode. Voir ci-dessous.
Exemple de .gitignorecode à utiliser (et où l'obtenir)
Voici les paramètres, comme suggéré sur https://gitignore.io . Vous pouvez y rechercher "VisualStudioCode" pour obtenir le dernier .gitignorefichier recommandé . J'utilise ce site Web comme point de départ .gitignorepour la plupart de mes nouveaux dépôts:
# Created by https://www.gitignore.io/api/visualstudiocode
# Edit at https://www.gitignore.io/?templates=visualstudiocode
### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
### VisualStudioCode Patch ###
# Ignore all local history of files
**/.history
# End of https://www.gitignore.io/api/visualstudiocode
Dans ce qui précède .gitignorefichier, la .vscode/*ligne dit d'exclure tout dans le .vscodedossier, mais les !.vscode/a_specific_filelignes tell git à « pas » ignorer certains fichiers spécifiques dans ce dossier ( settings.json, launch.json, etc.). Le résultat final est que tout est exclu dans le.vscode dossier, à l'exception des fichiers spécifiquement nommés dans l'une de ces autres lignes.
Autres facteurs et comment comprendre par vous-même ...
Inclure le .vscodedossier dans votre référentiel ne fait pas de mal personne qui utilise un IDE différent (ou un éditeur de texte / code).
Cependant, cela peut blesser d'autres personnes utilisant VS Code, si ces fichiers incluent des paramètres génériques qui nécessitent quelque chose de spécifique à votre environnement, qui est différent dans leur environnement - comme le chemin absolu dans lequel le dépôt est installé (dans lequel VS Code Python met systématiquement le pythonpathdans.vscode/settings.json ). L'essentiel est d'éviter d'enregistrer des paramètres personnalisés dans votre environnement local, de ne partager que ceux qui peuvent être utilisés par tout le monde.
Par exemple, si les fichiers de paramètres IDE ont des chemins absolus vers le référentiel ou des fichiers / bibliothèques, etc., alors c'est mauvais, ne partagez pas. Mais si toutes les références sont relatives, elles devraient fonctionner pour toute personne utilisant le référentiel (bien que soyez prudent avec les différences de spécification de chemin entre Windows / Unix ..).
À propos des paramètres d'utilisateur, d'espace de travail et de dossier
Remarque: les fichiers de paramètres du .vscodedossier ne sont généralement mis à jour que lorsque vous apportez des modifications à la version du dossier des paramètres (il semble cependant y avoir de nombreuses exceptions).
- Si vous apportez des modifications à l' utilisateur paramètres , ils sont généralement stockés ailleurs.
- Si vous apportez des modifications aux paramètres de l' espace de travail , ils sont normalement stockés dans le
*.code-workspacedossier que vous utilisez actuellement (ils vont toujours souvent dans les fichiers de paramètres du dossier - mais vous pouvez les déplacer manuellement!).
Cela signifie que vous devez placer les paramètres personnalisés de votre PC personnel dans les paramètres utilisateur et les placer génériques pour un projet / package particulier dans les autres, dans la mesure du possible.
- J'ai remarqué que lorsque vous utilisez l'extension Python, le
.vscode/settings.jsonfichier (qui enregistre les paramètres du dossier ) enregistre toujours le chemin absolu sous le pythonpathparamètre, j'ai donc supprimé son exclusion de mes .gitignorefichiers et ne l'enregistre plus dans mes dépôts Python. Même si je l'enregistre avec un chemin relatif, VS Code le réinitialise simplement au chemin absolu.
- Au lieu de cela, je sauvegarde simplement tout dossier que je dois utiliser dans Code comme espace de travail (par exemple, créez un
myproject.code-workspacefichier avec Fichier -> Enregistrer l'espace de travail sous . De cette façon, vous pouvez contrôler ce qui va dans le fichier de l'espace de travail et l'enregistrer dans le référentiel, tout en excluant le fichier de paramètres de dossier ( .vscode/settings.json). Vous pouvez à peu près déplacer n'importe quel paramètre entre l'espace de travail et les fichiers de paramètres de dossier pour contrôler ce qui est enregistré et ce qui ne l'est pas. N'oubliez pas que le fichier de l'espace de travail remplacera tout ce qui se trouve dans le fichier de paramètres de dossier.
Le plus long et le plus court est que vous pouvez simplement utiliser un fichier d'espace de travail et y mettre les paramètres les plus courants, tout en plaçant les paramètres locaux dans le fichier de paramètres de dossier, bien que cela semble dépendre des extensions / langues que vous utilisez.
Bien sûr, vous pouvez avoir d'autres raisons d'enregistrer le .vscode/settings.jsonfichier, ou une partie de celui-ci. Ou cela peut ne pas être un problème pour les paramètres dans votre langue actuelle.
Votre kilométrage peut varier...