A .NET library for filtering text using glob patterns, regular expressions, and fuzzy matching
ktsu.TextFilter is a .NET library that provides methods for filtering text based on different filter types and match options. It supports glob patterns, regular expressions, and fuzzy matching to help you efficiently filter and search through collections of strings.
- Glob Pattern Matching: Filter text using glob patterns with optional, required, and excluded tokens.
- Regular Expression Matching: Filter text using regular expressions.
- Fuzzy Matching: Rank text based on how well it matches a fuzzy pattern.
- Customizable Match Options: Match by whole string, all words, or any word.
Install-Package ktsu.TextFilterdotnet add package ktsu.TextFilter<PackageReference Include="ktsu.TextFilter" Version="x.y.z" />using ktsu.TextFilter;
string text = "Hello, World!";
string pattern = "Hello*";
bool isMatch = TextFilter.Match(text, pattern);using ktsu.TextFilter;
string[] texts = new string[] { "Hello, World!", "Goodbye, World!" };
string pattern = "Hello*";
IEnumerable<string> matches = TextFilter.Filter(texts, pattern);using ktsu.TextFilter;
string[] texts = new string[] { "Hello, World!", "Goodbye, World!" };
string pattern = "Hello";
IEnumerable<string> ranked = TextFilter.Rank(texts, pattern);You can customize how matching is performed using the MatchOptions enum:
using ktsu.TextFilter;
string text = "Hello beautiful world";
string pattern = "hello world";
// Match by any word in the pattern
bool anyWordMatch = TextFilter.Match(text, pattern, MatchOptions.AnyWord);
// Match by all words in the pattern
bool allWordsMatch = TextFilter.Match(text, pattern, MatchOptions.AllWords);
// Match the entire string
bool wholeStringMatch = TextFilter.Match(text, pattern, MatchOptions.WholeString);TextFilter supports different filter types:
using ktsu.TextFilter;
string text = "Hello, World!";
string globPattern = "Hello*";
string regexPattern = "^Hello";
// Glob pattern matching
bool globMatch = TextFilter.Match(text, globPattern, filterType: FilterType.Glob);
// Regular expression matching
bool regexMatch = TextFilter.Match(text, regexPattern, filterType: FilterType.Regex);
// Fuzzy matching
bool fuzzyMatch = TextFilter.Match(text, "Helo", filterType: FilterType.Fuzzy);The primary class for text filtering operations.
| Name | Return Type | Description |
|---|---|---|
Match(string text, string pattern, MatchOptions options = MatchOptions.WholeString, FilterType filterType = FilterType.Glob) |
bool |
Tests if the input text matches the specified pattern |
Filter(IEnumerable<string> texts, string pattern, MatchOptions options = MatchOptions.WholeString, FilterType filterType = FilterType.Glob) |
IEnumerable<string> |
Returns all texts that match the pattern |
Rank(IEnumerable<string> texts, string pattern, MatchOptions options = MatchOptions.WholeString) |
IEnumerable<string> |
Returns texts ranked by how well they match the pattern |
| Value | Description |
|---|---|
WholeString |
Match the entire string against the pattern |
AllWords |
Match all words in the pattern against the string |
AnyWord |
Match any word in the pattern against the string |
| Value | Description |
|---|---|
Glob |
Use glob pattern matching |
Regex |
Use regular expression matching |
Fuzzy |
Use fuzzy matching |
Contributions are welcome! For feature requests, bug reports, or questions, please open an issue on GitHub. If you would like to contribute code, please open a pull request with your changes.
This project is licensed under the MIT License - see the LICENSE file for details.
- DotNet.Glob for glob pattern matching.
- ktsu.FuzzySearch for fuzzy matching.