Jeninnet.FileQuery.CommandLine 1.2.1

Jeninnet.FileQuery.CommandLine

Command-line argument binding for Jeninnet.FileQuery.

✨ Repo Stats

This package integrates Jeninnet.FileQuery with the standard System.CommandLine parser. It automatically maps command-line arguments and flags to structured file-query patterns.

The command-line package produces pattern inputs for the core engine. Runtime observability features such as IProgress<FileQueryProgress>, FileQueryDiagnostic, and FileQueryErrorRecoveryOptions are configured on the resulting core query or execution call.

🚀 Installation

Install the CLI integration package via NuGet:

dotnet add package Jeninnet.FileQuery.CommandLine

🛠️ Usage Example

Because CommandLinePatternOptions uses a protected constructor to encourage customization, you must subclass it in your application.

1. Define CLI Options

using System.CommandLine;
using Jeninnet.FileQuery;
using Jeninnet.FileQuery.CommandLine;

// Define a custom class inheriting from CommandLinePatternOptions
public sealed class AppCliOptions : CommandLinePatternOptions
{
    // You can add additional options here if needed
}

2. Configure Command Routing

using System.CommandLine;
using Jeninnet.FileQuery;
using Jeninnet.FileQuery.CommandLine;

var cliOptions  = new AppCliOptions();
var rootCommand = new RootCommand("My custom file analysis tool");

// Register the pattern matching options onto the root command
foreach (var option in cliOptions.GetCommandOptions())
{
    rootCommand.Add(option);
}

rootCommand.SetAction(parseResult =>
{
    // 1. Build pattern dictionaries from the command-line arguments
    var patterns = PatternBuilder.Build(parseResult, cliOptions);
    
    // 2. Pass patterns directly into the fluent builder
    var query = FileQuery.From(@"C:\repo-root")
                         .Where(patterns)
                         .Build();

    var engine = FileQueryRuntime.Create();
    foreach (var file in engine.Execute(query))
    {
        Console.WriteLine(file);
    }
});

await rootCommand.InvokeAsync(args);

⚙️ Supported Command-Line Flags

The following options are exposed by CommandLinePatternOptions:

🧠 Pattern Splitting and Fallback

• Semicolon Splitting: Delimited values (e.g., -p "*.txt;*.md;!temp.txt") are split and trimmed by PatternSplitter.
• Default Fallback: If no pattern arguments are supplied by the user, the builder defaults to !** (GitIgnore syntax: include all files recursively).
• Core Observability: After CLI parsing, call ExecuteAsync(query, progress, cancellationToken) or configure FileQueryBuilder.WithDiagnostics(...) to inspect runtime traversal and match decisions.

🚫 Limitations & Notes

• System.CommandLine Requirement: This package depends directly on System.CommandLine.
• Option Delimiters: Ensure pattern strings containing semicolons are properly quoted in terminal environments (e.g., --patterns "*.cs;!bin/").