让Git在提交前自动移除尾随空白

我正在和我的团队一起使用Git，并希望从我的差异、日志、合并等中删除空白更改。我假设做到这一点最简单的方法是Git在应用所有提交时自动删除尾随空白(和其他空白错误)。

我已经尝试将以下内容添加到~/。gitconfig文件，但是当我提交时它什么也不做。也许它是为别的东西设计的。解决方案是什么?

[core]
    whitespace = trailing-space,space-before-tab
[apply]
    whitespace = fix

我使用Ruby，以防有人对Ruby有任何具体的想法。在提交之前自动格式化代码将是下一步，但这是一个困难的问题，并不是真正造成大问题。

当前回答

您可以欺骗Git将您的更改视为补丁，从而让Git为您修复空白。与“预提交钩子”解决方案相比，这些解决方案向Git添加了空格修复命令。

是的，这些都是黑客。

健壮的解决方案

以下Git别名取自我的~ / .gitconfig。

我所说的“健壮”是指这些别名运行时没有错误正确的事情，不管树或索引是否脏。然而，如果交互式git rebase -i已经在进行中，它们就不起作用;看我的~/。如果您关心这种极端情况，可以使用Gitconfig进行额外检查，在这种情况下，最后描述的git add -e技巧应该可以工作。

如果您想直接在shell中运行它们，而不创建Git 别名，复制粘贴双引号之间的所有内容 (假设您的shell类似Bash)。

修正索引，但不修正树

以下修复Git别名修复索引中的所有空白错误，如果有，但不碰树:

# Logic:
#
# The 'git stash save' fails if the tree is clean (instead of
# creating an empty stash :P). So, we only 'stash' and 'pop' if
# the tree is dirty.
#
# The 'git rebase --whitespace=fix HEAD~' throws away the commit
# if it's empty, and adding '--keep-empty' prevents the whitespace
# from being fixed. So, we first check that the index is dirty.
#
# Also:
# - '(! git diff-index --quiet --cached HEAD)' is true (zero) if
#   the index is dirty
# - '(! git diff-files --quiet .)' is true if the tree is dirty
#
# The 'rebase --whitespace=fix' trick is from here:
# https://stackoverflow.com/a/19156679/470844
fixws = !"\
  if (! git diff-files --quiet .) && \
     (! git diff-index --quiet --cached HEAD) ; then \
    git commit -m FIXWS_SAVE_INDEX && \
    git stash save FIXWS_SAVE_TREE && \
    git rebase --whitespace=fix HEAD~ && \
    git stash pop && \
    git reset --soft HEAD~ ; \
  elif (! git diff-index --quiet --cached HEAD) ; then \
    git commit -m FIXWS_SAVE_INDEX && \
    git rebase --whitespace=fix HEAD~ && \
    git reset --soft HEAD~ ; \
  fi"

这个想法是在git提交之前运行git fixws 索引中的空白错误。

修正索引和树

下面的fixws-global-tree-and-index Git别名修复所有空白索引和树中的错误(如果有的话):

# The different cases are:
# - dirty tree and dirty index
# - dirty tree and clean index
# - clean tree and dirty index
#
# We have to consider separate cases because the 'git rebase
# --whitespace=fix' is not compatible with empty commits (adding
# '--keep-empty' makes Git not fix the whitespace :P).
fixws-global-tree-and-index = !"\
  if (! git diff-files --quiet .) && \
     (! git diff-index --quiet --cached HEAD) ; then \
    git commit -m FIXWS_SAVE_INDEX && \
    git add -u :/ && \
    git commit -m FIXWS_SAVE_TREE && \
    git rebase --whitespace=fix HEAD~2 && \
    git reset HEAD~ && \
    git reset --soft HEAD~ ; \
  elif (! git diff-files --quiet .) ; then \
    git add -u :/ && \
    git commit -m FIXWS_SAVE_TREE && \
    git rebase --whitespace=fix HEAD~ && \
    git reset HEAD~ ; \
  elif (! git diff-index --quiet --cached HEAD) ; then \
    git commit -m FIXWS_SAVE_INDEX && \
    git rebase --whitespace=fix HEAD~ && \
    git reset --soft HEAD~ ; \
  fi"

若要修复未版本控制文件中的空白，请执行

git add --intent-to-add <unversioned files> && git fixws-global-tree-and-index

简单但不健壮的解决方案

这些版本更容易复制和粘贴，但他们不做如果他们的条件不满足，这是正确的。

修复当前目录下的子树(但如果不为空则重置索引)

使用git add -e使用身份编辑器“编辑”补丁::

(export GIT_EDITOR=: && git -c apply.whitespace=fix add -ue .) && git checkout . && git reset

修复并保存索引(但如果树是脏的或索引为空则失败)

git commit -m TEMP && git rebase --whitespace=fix HEAD~ && git reset --soft HEAD~

修复树和索引(但如果索引不为空则重置索引)

git add -u :/ && git commit -m TEMP && git rebase --whitespace=fix HEAD~ && git reset HEAD~

export GIT_EDITOR=: && git -c apply的解释。空格=fix add -ue。技巧

在我从这个答案中了解git rebase -whitespace=fix技巧之前，我在任何地方都使用更复杂的git添加技巧。

如果我们手动操作:

Set apply.whitespace to fix (you only have to do this once): git config apply.whitespace fix This tells Git to fix whitespace in patches. Convince Git to treat your changes as a patch: git add -up . Hit a+enterto select all changes for each file. You'll get a warning about Git fixing your whitespace errors. (git -c color.ui=auto diff at this point reveals that your non-indexed changes are exactly the whitespace errors). Remove the whitespace errors from your working copy: git checkout . Bring back your changes (if you aren't ready to commit them): git reset

GIT_EDITOR=:表示使用:作为编辑器和命令 :是恒等式。

2013-03-13 23:30:18

其他回答

要删除文件中行尾的空格，使用ed:

test -s file &&
   printf '%s\n' H ',g/[[:space:]]*$/s///' 'wq' | ed -s file

2014-12-02 13:50:00

在macOS(或者可能是任何BSD)上，sed命令参数必须略有不同。试试这个:

#!/bin/sh

if git-rev-parse --verify HEAD >/dev/null 2>&1 ; then
   against=HEAD
else
   # Initial commit: diff against an empty tree object
   against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

# Find files with trailing whitespace
for FILE in `exec git diff-index --check --cached $against -- | sed '/^[+-]/d' | sed -E 's/:[0-9]+:.*//' | uniq` ; do
    # Fix them!
    sed -i '' -E 's/[[:space:]]*$//' "$FILE"
    git add "$FILE"
done

将该文件保存为.git/hooks/pre-commit——或者寻找已经存在的文件，并将底部块粘贴到其中的某个地方。还有chmod (a+x)

或者为了全局使用(通过将git post-commit钩子应用到所有当前和未来的回购中)，你可以把它放在$GIT_PREFIX/git-core/templates/hooks中(其中GIT_PREFIX是/usr或/usr/local或/usr/share或/opt/local/share)，并在你现有的回购中运行git init。

根据git帮助init:

在现有的存储库中运行git init是安全的。它不会覆盖已经存在的东西。重新运行git init的主要原因是获取新添加的模板。

2011-01-04 18:31:48

同样的结果。

import subprocess                                                                 
                                                                              
def get_trailing_lines():                                                         
                                                                              
    result = subprocess.run([                                                     
                            'git',                                            
                            'diff',                                           
                            '--check'                                         
                        ], capture_output=True)                               
                                                                              
    return result.stdout.decode().split('\n')                                     
                                                                              
                                                                              
def modify_line(file_path, l_num):                                                
                                                                              
    f_lines = open(file_path).readlines()                                         
    f_lines[l_num] = f_lines[l_num].rstrip()+'\n'\                                
                     if '\n' in f_lines[l_num] else f_lines[l_num].rstrip()    
                                                                              
    with open(file_path, "w") as w_fp:                                            
        w_fp.writelines(f_lines)                                                  
                                                                              
                                                                              
if __name__ == '__main__':                                                        
                                                                              
    l = get_trailing_lines()                                                      
    for m, d in zip(l[::2], l[1::2]):                                             
        f_path, l_no, *_ = m.split(":")                                           
        modify_line(f_path, int(l_no)-1)

2021-11-01 10:01:11

这可能不会直接解决您的问题，但您可能希望在实际的项目空间中通过git-config设置这些，它编辑文件./。Git /config相对于~/.gitconfig文件。在所有项目成员之间保持设置一致是很好的。

git config core.whitespace "trailing-space,space-before-tab"
git config apply.whitespace "trailing-space,space-before-tab"

2009-02-26 19:12:18