C#读取Git .ignore文件 C#如何解析.gitignore规则来过滤文件

5次阅读

git ignore规则使用git专属glob语法而非正则表达式,需用microsoft.git.cli的pathspec解析以准确匹配路径、支持**、!取反及目录语义。

C#读取Git .ignore文件 C#如何解析.gitignore规则来过滤文件

Git ignore 规则不是正则,别直接用 Regex 匹配

很多人第一反应是把 .gitignore 每行当正则写进 Regex,结果发现 **/build/!src/*.cslog?.txt 全都匹配错——因为 Git 的 glob 语义和 .NET 的 RegexFileSystemEnumerable 完全不同。它支持路径层级通配(**)、取反(!)、斜杠敏感、前导空格/注释忽略等,必须按 Git 规范解析。

LibGit2Sharp 不行,它不暴露 ignore 规则解析逻辑

LibGit2Sharp 能判断某个路径是否被忽略(如 Repository.Index.IsPathIgnored()),但它不提供规则加载、编译或调试能力。你无法知道是哪条规则生效、为什么某文件没被过滤、如何复现本地 git check-ignore -v 的行为。真要调试规则链或做构建工具级过滤(比如 MSBuild 前扫描源码),必须自己解析。

手动解析的关键三步:读取 → 编译 → 匹配

核心是把每行规则转成可执行的谓词(Func<string bool></string>),再按顺序应用(注意:后出现的规则可覆盖前面的同路径规则,! 取反优先级高):

  • 逐行读取 .gitignore,跳过空行、以 # 开头的注释行
  • 对非空行:去掉首尾空白,识别是否以 ! 开头;然后将剩余部分转为路径匹配逻辑(例如 **/obj/ → “路径中任意深度包含 /obj/”;*.tmp → “文件名后缀为 .tmp”,且只作用于当前目录层级)
  • 构建匹配器时,注意 Git 的“目录标记”语义:末尾带 /(如 bin/)只匹配目录,不带则既匹配文件也匹配目录;** 只在路径中间有效,开头的 **/ 表示递归,结尾的 /** 表示该目录下所有内容

简单示例(仅处理常见情况):

// 简化版规则编译(实际需更完整) string pattern = line.TrimStart('!', ' '); bool isNegation = line.StartsWith("!"); bool isDirectoryOnly = pattern.EndsWith("/"); pattern = pattern.TrimEnd('/'); <p>Func<string, bool> matcher = path => { if (isDirectoryOnly && !path.EndsWith("/")) return false; if (pattern.Contains("<strong>")) { // 处理 </strong>/src/<strong>.cs 这类 var parts = pattern.Split(new[] { "</strong>" }, StringSplitOptions.None); return parts.All(p => string.IsNullOrEmpty(p) || path.Contains(p)); } // 实际应使用类似 Microsoft.Git.Cli 的 PathSpec.Match };

推荐直接用 Microsoft.Git.CliPathSpec

微软官方开源的 Microsoft.Git.Cli(NuGet 包)里有生产级 PathSpec 实现,完全兼容 Git CLI 行为,支持 **!、括号扩展、大小写敏感控制等。它不依赖 libgit2,纯 C# 实现,可直接引用:

  • 安装:dotnet add package Microsoft.Git.Cli
  • 加载规则:var spec = new PathSpec(File.ReadAllLines(".gitignore"));
  • 判断路径:bool ignored = spec.Matches("src/Program.cs").IsExcluded;(返回 MatchResult,含详细匹配信息)
  • 注意:它默认按 unix 路径分隔符 / 解析,windows 下传入路径建议先 .Replace('', '/')

这个库的 PathSpec 是目前 .NET 生态中最接近 Git 原生行为的实现,比手写健壮得多,但文档极少——关键点藏在单元测试里,比如 PathSpecTests 中的 ShouldMatchWithDoubleAsterisk 用例。

text=ZqhQzanResources