ktsu.TextFilter 1.5.5-pre.4
ktsu.TextFilter
A .NET library for filtering text using glob patterns, regular expressions, and fuzzy matching
Introduction
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.
Features
- 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.
Installation
Package Manager Console
Install-Package ktsu.TextFilter
.NET CLI
dotnet add package ktsu.TextFilter
Package Reference
<PackageReference Include="ktsu.TextFilter" Version="x.y.z" />
Usage Examples
Basic Example
using ktsu.TextFilter;
string text = "Hello, World!";
string pattern = "Hello*";
bool isMatch = TextFilter.Match(text, pattern);
Filtering Collections
using ktsu.TextFilter;
string[] texts = new string[] { "Hello, World!", "Goodbye, World!" };
string pattern = "Hello*";
IEnumerable<string> matches = TextFilter.Filter(texts, pattern);
Ranking Results
using ktsu.TextFilter;
string[] texts = new string[] { "Hello, World!", "Goodbye, World!" };
string pattern = "Hello";
IEnumerable<string> ranked = TextFilter.Rank(texts, pattern);
Advanced Usage
Match Options
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);
Filter Types
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);
API Reference
TextFilter Class
The primary class for text filtering operations.
Methods
| 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 |
Enums
MatchOptions
| 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 |
FilterType
| Value | Description |
|---|---|
Glob |
Use glob pattern matching |
Regex |
Use regular expression matching |
Fuzzy |
Use fuzzy matching |
Contributing
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.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgements
- DotNet.Glob for glob pattern matching.
- ktsu.FuzzySearch for fuzzy matching.
Showing the top 20 packages that depend on ktsu.TextFilter.
| Packages | Downloads |
|---|---|
|
ktsu.ImGui.Popups
Package Description
|
19 |
|
ktsu.ImGui.Widgets
Package Description
|
18 |
|
ktsu.ImGui.Popups
Package Description
|
18 |
|
ktsu.ImGui.Popups
Package Description
|
17 |
|
ktsu.ImGui.Widgets
Package Description
|
17 |
|
ktsu.ImGui.Widgets
Package Description
|
16 |
|
ktsu.ImGui.Popups
Package Description
|
16 |
|
ktsu.ImGui.Widgets
Package Description
|
15 |
|
ktsu.ImGui.Popups
Package Description
|
14 |
|
ktsu.ImGui.Widgets
Package Description
|
13 |
.NET 5.0
- DotNet.Glob (>= 3.1.3)
- ktsu.Extensions (>= 1.5.7)
- ktsu.FuzzySearch (>= 1.2.2)
.NET Standard 2.1
- ktsu.FuzzySearch (>= 1.2.2)
- ktsu.Extensions (>= 1.5.7)
- System.Memory (>= 4.6.3)
- DotNet.Glob (>= 3.1.3)
.NET Standard 2.0
- ktsu.FuzzySearch (>= 1.2.2)
- ktsu.Extensions (>= 1.5.7)
- System.Threading.Tasks.Extensions (>= 4.6.3)
- System.Memory (>= 4.6.3)
- DotNet.Glob (>= 3.1.3)
.NET 9.0
- ktsu.FuzzySearch (>= 1.2.2)
- ktsu.Extensions (>= 1.5.7)
- DotNet.Glob (>= 3.1.3)
.NET 8.0
- ktsu.Extensions (>= 1.5.7)
- ktsu.FuzzySearch (>= 1.2.2)
- DotNet.Glob (>= 3.1.3)
.NET 6.0
- DotNet.Glob (>= 3.1.3)
- ktsu.Extensions (>= 1.5.7)
- ktsu.FuzzySearch (>= 1.2.2)
.NET 7.0
- ktsu.Extensions (>= 1.5.7)
- ktsu.FuzzySearch (>= 1.2.2)
- DotNet.Glob (>= 3.1.3)
| Version | Downloads | Last updated |
|---|---|---|
| 1.5.5-pre.4 | 16 | 11/24/2025 |
| 1.5.5-pre.3 | 18 | 11/23/2025 |
| 1.5.5-pre.2 | 15 | 11/23/2025 |
| 1.5.5-pre.1 | 17 | 11/23/2025 |
| 1.5.4 | 20 | 08/26/2025 |