Git预提交钩子搜索带空格的文件名

问题描述

我的问题是关于 git pre-commit hook。
我想弄清楚,并禁止提交包含空格的文件名。

#!/bin/bash
listchange=$(git diff --name-only) 

echo "Check filenames:"

wrongfilenames=$(
                for filename in $listchange 
                do
                    fname=$(basename $filename)
                    if ! [[ $fname =~ ^[0-9abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMnopQRSTUVWXYZ._]+$ ]]; then
                        echo $fname;
                    fi
                    if [[ $fname =~ [[:space:]]* ]]; then 
                        echo $fname;
                        echo "contains space"
                    fi
                done
            );
            
if [ -n "$wrongfilenames" ] ; then
    echo "The following filename contains invalid characters:"
    echo "$wrongfilenames"
    echo "Commit rejected,fix it and try again."
    exit 1
    else
    echo "....OK"

一个 if,将检查文件名是否包含除 0-9,a-z,A-Z and . and _
无法添加包含“-”的文件
对我来说不是很清楚,为什么 whitespace 通过这个过滤器。这就是为什么我尝试创建另一个 if 来检查文件名是否包含 空格。但这并不像预期的那样工作。 \

提前致谢

解决方法

请记住,shell 根据 $IFS 拆分单词,默认设置为 $' \t\n'(空格、制表符和换行符)。我们可以看到:

$ for word in $(echo "foo bar"); do echo "word=$word"; done
word=foo
word=bar

如果我们先改变 IFS 设置,我们会得到一个对我们更有用的行为:

$ IFS=$'\n'
$ for word in $(echo "foo bar"); do echo "word=$word"; done
word=foo bar

当然,任何文件名中带有换行符的文件都会在这里出现问题。理想情况下,我们会在每个文件名之间或之后使用分隔符或终止符,它们不能出现在任何文件名中。只有两个这样的字符:/NUL ($'\0')。当然,斜线出现在路径组成部分的分隔符中,因此如果您允许路径而不仅仅是文件名(在操作系统级别),您必须接受斜线。

并非所有 shell 都可以处理文字 NUL 字节。 (就此而言,并非所有 shell 甚至都具有 $'\n' 语法。)因此,最好在 Python 中编写这样的钩子。

大多数版本的 bash 可以 小心处理它,并且您已经依赖于 bash [[ 测试(当然还明确使用 /bin/bash)。或者,您可以假设虽然人们可能会在文件名中放置空格甚至制表符,但他们不会在其中放置换行符。因此,您只需预先设置 IFS 即可修复脚本。

(另外值得一提的是:使用 --name-status 可能是个好主意,或者至少过滤掉文件删除。否则您将禁止某人删除一个文件其名称中有一个空格。当然,这取决于您是否需要。)