Comment indiquer à git d'ignorer des lignes individuelles, c'est-à-dire gitignore pour des lignes de code spécifiques ?

Question

.gitignore peut ignorer des fichiers entiers, mais existe-t-il un moyen d'ignorer des lignes de code spécifiques pendant le codage ?

J'ajoute fréquemment et à plusieurs reprises les mêmes lignes de débogage dans un projet, pour ensuite devoir me rappeler de les supprimer avant de valider le projet. J'aimerais simplement garder les lignes dans le code et que git n'en tienne pas compte.

Answer 1

C'est comme ça que vous pouvez le faire avec filtres git :

1. Créer/ouvrir le fichier gitattributes :
   • <project root>/.gitattributes (sera intégré dans le repo)
     OU
   • <project root>/.git/info/attributes (ne sera pas commise dans le repo)
2. Ajouter une ligne définissant les fichiers à filtrer :
   • *.rb filter=gitignore c'est-à-dire exécuter un filtre nommé gitignore sur tous les *.rb fichiers
3. Définir le gitignore dans votre gitconfig :
   • $ git config --global filter.gitignore.clean "sed '/#gitignore$/d'" c'est-à-dire supprimer ces lignes
   • $ git config --global filter.gitignore.smudge cat c.-à-d. ne rien faire lorsque le fichier est extrait du dépôt.

Notes :
Bien sûr, ceci est pour les fichiers ruby, appliqué quand une ligne se termine par #gitignore appliqué à l'échelle mondiale dans ~/.gitconfig . Modifiez-le comme vous le souhaitez pour vos besoins.

Attention !
Cela laisse votre fichier de travail différent du repo (bien sûr). Tout check out ou rebase signifie que ces lignes seront perdues ! Cette astuce peut sembler inutile puisque ces lignes sont perdues à plusieurs reprises lors d'un check out, d'un rebasement ou d'un pull, mais j'ai un cas d'utilisation spécifique pour m'en servir.

Juste git stash save "proj1-debug" pendant que le filtre est inactif (il suffit de le désactiver temporairement dans gitconfig ou autre). De cette façon, mon code de débogage peut toujours être git stash apply à mon code à tout moment sans craindre que ces lignes ne soient accidentellement validées.

J'ai une idée possible pour résoudre ces problèmes, mais j'essaierai de la mettre en œuvre une autre fois.

Merci à Rudi et à jw013 pour avoir mentionné les filtres git et les gitattributs.

Answer 2

J'ai eu un problème similaire en écrivant du code java. Ma solution était de marquer le code que je ne voulais pas valider et d'ajouter un hook pre-commit qui chercherait mon marquage :

#!/bin/bash
#
# This hook will look for code comments marked '//no-commit'
#    - case-insensitive
#    - dash is optional
#    - there may be a space after the //
#
noCommitCount=$(git diff --no-ext-diff --cached | egrep -i --count "(@No|\/\/\s?no[ -]?)commit")
if [ "$noCommitCount" -ne "0" ]; then
   echo "WARNING: You are attempting to commit changes which include a 'no-commit'."
   echo "Please check the following files:"
   git diff --no-ext-diff --cached --name-only -i -G"(@no|\/\/s?no-?)commit" | sed 's/^/   - /'
   echo
   echo "You can ignore this warning by running the commit command with '--no-verify'"
   exit 1
fi