Qu’est-ce qu’un fichier .gitignore ?

Un fichier .gitignore indique à Git quels fichiers exclure du contrôle de version : les dépendances que vous pouvez réinstaller (comme node_modules), les fichiers générés lors de la compilation, les journaux, les caches, les paramètres de l’éditeur et les fichiers laissés par votre système d’exploitation, comme .DS_Store sur macOS ou Thumbs.db sur Windows. Placez-le dans le dossier racine de votre dépôt. Ses motifs s’appliquent à ce dossier et à tous ses sous-dossiers.

D’où viennent les modèles

Les modèles proviennent de la collection officielle de GitHub, le dépôt github/gitignore. Ce sont les mêmes modèles que GitHub propose lors de la création d’un dépôt. L’outil charge une copie mise à jour chaque jour. Ils sont répartis en trois groupes :

  • Modèles principaux pour les langages, les frameworks et les outils, comme Node, Python, Java, Go, Rust, Unity et WordPress.
  • Modèles globaux pour les éditeurs, les systèmes d’exploitation et d’autres outils, comme macOS, Windows, Linux, VisualStudioCode, JetBrains et Vim. Ils conviennent au fichier .gitignore d’un projet, ainsi qu’au fichier global que Git peut appliquer à tous vos dépôts.
  • Modèles communautaires pour des frameworks et des outils plus spécialisés, maintenus par la communauté, comme JavaScript/Vue ou Python/JupyterNotebooks.

Comment l’utiliser

  1. Commencez par une sélection rapide correspondant à un type de projet populaire. Elle choisit les modèles adaptés à la pile technologique, ainsi que macOS, Windows et l’éditeur généralement utilisé avec celle-ci.
  2. Vous pouvez aussi rechercher dans le champ Modèles et sélectionner tous les langages, frameworks, éditeurs et systèmes d’exploitation utilisés par votre projet. Décochez un modèle ou appuyez sur Retour arrière dans le champ pour le supprimer.
  3. Le fichier .gitignore se construit au fur et à mesure de vos sélections, chaque modèle étant placé sous son propre commentaire d’en-tête, dans l’ordre où vous l’avez choisi.
  4. Copiez le fichier ou téléchargez-le et enregistrez-le dans le dossier racine de votre dépôt sous le nom .gitignore. Les navigateurs n’enregistrent pas les fichiers dont le nom commence par un point : le fichier téléchargé s’appelle donc gitignore.txt ou gitignore. Renommez-le en .gitignore.

Conseils

  • Deux modèles peuvent contenir le même motif, comme node_modules/ dans Node et Nextjs. La répétition d’un motif ne pose aucun problème.
  • Un motif ne cesse pas le suivi d’un fichier déjà suivi par Git. Pour arrêter de le suivre tout en le conservant sur le disque, exécutez git rm --cached suivi du chemin du fichier, puis validez les modifications.
  • Une ligne commençant par ! réintègre les fichiers ignorés par un motif précédent. Le modèle VisualStudioCode l’utilise pour conserver dans le dépôt les paramètres partagés, comme .vscode/settings.json.

Fonctionnalités

  • Modèles .gitignore officiels de GitHub, mis à jour chaque jour
  • Langages, frameworks, éditeurs et systèmes d’exploitation dans une seule liste consultable
  • Sélections rapides pour les types de projets populaires
  • Chaque modèle sous son propre en-tête
  • Copie ou téléchargement du fichier