WildPath 0.0.6

WildPath

WildPath is a powerful and extensible library for resolving and evaluating file system paths based on dynamic expressions. It supports advanced path traversal and pattern matching, making it suitable for applications like file searches, build systems, and custom path resolvers.

Features

• Advanced Wildcard Matching:
  • Supports wildcards (* and **) for flexible directory and file searches. (e.g., a\**\).
• Parent Traversal:
  • Use .. to navigate to the parent directory and ... to recursively traverse all parent directories.
• Exact Matching:
  • Match specific directories by name.
• Tagged Search:
  • Identify directories containing a marker file or subdirectory. (e.g., a\:tagged(.marker)\b).
• Composable Expressions:
  • Combine strategies for complex path resolutions, such as ...\\**\\kxd.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/WildPath.git
   

2. Build the project using your favorite IDE or CLI:

   dotnet build
   

Usage

Basic Path Matching

using WildPath;

var result = PathResolver.Resolve("SubDir1\\SubSubDir1");
Console.WriteLine(result); 
// Output (assuming current directory = "C:\\Test"): "C:\\Test\\SubDir1\\SubSubDir1"

Wildcard Search

Find a directory named kxd:

var result = PathResolver.Resolve("...\\**\\kxd");
// Output: "C:\\Test\\SubDir1\\SubSubDir1\\bin\\Debug\\kxd"

Tagged Search

Find a directory containing .marker and a specific subpath:

var result = PathResolver.Resolve("**\\:tagged(.marker):\\bin\\Debug");
// Output: "C:\\Test\\SubDir2\\SubSubDir1\\bin\\Debug"

Customized Path Resolution

To use a custom current directory, separator or even a different file system, you can new up a PathResolver and use the same API:

using WildPath;

var currentDir = "C:\\Test";
var expression = "SubDir1\\SubSubDir1";

var resolver = new PathResolver(currentDir);
var result = resolver.Resolve(expression);
Console.WriteLine(result); // Output: "C:\\Test\\SubDir1\\SubSubDir1"

Expression Syntax

Testing

Run the test suite to validate functionality:

dotnet test

Example tests include:

1. Wildcard and parent traversal.
2. Directory matching with markers.

Contributing

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name
   

3. Commit your changes and push to your fork:

   git commit -m "Description of feature"
   git push origin feature-name
   

4. Submit a pull request.

Todo

Limit recursive search depth:

• ...{1,3}\\**{1,3}\\:tagged(testhost.exe):\\fr should only search 1-3 directories deep.
• ...{4}\\**{4}\\:tagged(testhost.exe):\\fr should only search 4 directories deep.

Add cancellation token support

Like seriously, this libaray begs for being ddosed.

Not as serious todos:

Search by file content:

Be a little cray cray

• ...\\**\\:content(test.json, test): should search for files containing the string "test".

Seach within zip files:

• ...\\**\\:zip(test.zip):\\fr should search for files within a zip file named "test.zip".

License

This project is licensed under the MIT License.