inmarelibero/gitignore-checker

一个用于检查路径是否被Git忽略的PHP库

维护者

详细信息

github.com/inmarelibero/gitignore-checker

源代码

问题

安装次数: 20,712

依赖项: 1

建议者: 0

安全性: 0

星标: 4

关注者: 3

分支: 4

开放问题: 3

1.0.4 2024-05-03 16:17 UTC

Requires

  • php: >=7.1

Requires (Dev)

MIT 57cdaa05ceaadaabdb671162ad46e58a133ed9dd

  • Emanuele Gaspari <inmarelibero.woop@gmail.com>

gitvcsgitignore

This package is auto-updated.

Last update: 2024-09-03 17:14:51 UTC

README

GitignoreChecker 是一个用于检查给定路径是否被Git忽略的PHP库。

使用方法

初始化对象，提供Git仓库根目录

$gitIgnoreChecker = new GitIgnoreChecker(__DIR__);

您现在可以轻松地检查给定路径是否被某些 .gitignore 规则忽略，使用

 $gitIgnoreChecker->isPathIgnored('/foo');  // true|false
 $gitIgnoreChecker->isPathIgnored('/README');
 $gitIgnoreChecker->isPathIgnored('/foo/bar');
 $gitIgnoreChecker->isPathIgnored('/foo/bar/baz');
 $gitIgnoreChecker->isPathIgnored('/.foo');
 ...

运行测试

在确保您已使用命令 composer install 安装了依赖项后，您可以通过执行以下操作来运行测试

php bin/phpunit

或执行

composer test

待办事项

  • 进行更多测试：找出更多案例和边缘案例，并将它们添加到当前测试套件中

完成

  • 处理了大多数常见的 gitignore，包括以下情况
    • 包括子文件夹，例如foo/bar
    • 包括 *，例如foo/*/bar
    • 包括 **，例如foo/**/bar
    • 以 ! 开头
    • 以 # 开头
    • 以 \# 开头