Ramstack.Globbing 1.0.0

Ramstack.Globbing

Fast and zero-allocation .NET globbing library for matching file paths using glob patterns. No external dependencies.

Getting Started

To install the Ramstack.Globbing NuGet package to your project, run the following command:

dotnet add package Ramstack.Globbing

Usage

bool result = Matcher.IsMatch("wiki/**/*.md", "wiki/section-1/start.md");

The IsMatch method attempts to match the specified path against the provided wildcard pattern.

By default, the system's default path separators are used. You can override this behavior by specifying one of the following flags:

Example with a specific flag:

bool result = Matcher.IsMatch(@"wiki\**\*.md", "wiki/section-1/start.md", MatchFlags.Windows);

Patterns

From Wikipedia

Pattern specific for directories

Brace patterns

Brace patterns allow for matching multiple alternatives in a single pattern. Here are some key features:

• Empty alternatives are valid, e.g., {src,test,} will also match paths without the listed prefixes.
• Brace patterns can be nested, allowing for complex matching scenarios.
• Full glob patterns can be used within braces, providing powerful and flexible matching capabilities.

Escaping characters

The meta characters ?, *, [, \ can be escaped by using the [], which means match one character listed in the bracket.

• [[] matches the literal [
• [*] matches the literal *

This works when using any MatchFlags (Windows or Unix). When using MatchFlags.Unix, an additional escape character (\) is available:

• \[ matches the literal [
• \* matches the literal *

Notes

• Leading and trailing path separators are ignored.
• Consecutive path separators are counted as one separator.

Special cases

• At the root level, an empty path segment is valid, which can be represented by patterns like "*".
• At any deeper level, an empty segment indicates that a required directory or file is missing, making the path invalid for patterns expecting something at that level.

💡 This means that the patterns */{} and */{,} cannot match any path due to the rule: an empty segment is not allowed beyond the root level.

Optimizations

We use optimizations that prevent quadratic behavior in scenarios like the pattern a*a*a*a*a*a*a*a*a*c matching against the text aaaaaaaaaaaaaaa...aaaa...aaa. Similarly, for the a/**/a/**/a/**/.../a/**/a/**/a/**/b pattern matching against a/a/a/a/.../a/.../a.

Supported versions

Contributions

Bug reports and contributions are welcome.

License

This package is released as open source under the MIT License. See the LICENSE file for more details.