ReadLine 2.0.1

ReadLine

ReadLine 是一个使用纯 C# 编写的类似于 GNU Readline 的库。它可以作为内置 Console.ReadLine() 的替代品，并带来了来自 UNIX shell 的一些终端优点，如命令历史记录导航和自动完成。

它是跨平台的，在 .NET 支持的任何地方运行，针对 netstandard1.3 的目标意味着它可以与 .NET Core 以及完整的 .NET Framework 一起使用。

快捷方式指南

安装

在 NuGet 上可用

Visual Studio

PM> Install-Package ReadLine

.NET Core 命令行工具

dotnet add package ReadLine

用法

从控制台读取输入

string input = ReadLine.Read("(prompt)> ");

从控制台读取密码

string password = ReadLine.ReadPassword("(prompt)> ");

注意：(prompt>) 是可选的

历史记录管理

// Get command history
ReadLine.GetHistory();

// Add command to history
ReadLine.AddHistory("dotnet run");

// Clear history
ReadLine.ClearHistory();

// Disable history
ReadLine.HistoryEnabled = false;

注意：历史信息在整个应用程序会话中保持持久。此外，对 ReadLine.Read() 的调用会自动将控制台输入添加到历史记录中

自动完成

class AutoCompletionHandler : IAutoCompleteHandler
{
    // characters to start completion from
    public char[] Separators { get; set; } = new char[] { ' ', '.', '/' };

    // text - The current text entered in the console
    // index - The index of the terminal cursor within {text}
    public string[] GetSuggestions(string text, int index)
    {
        if (text.StartsWith("git "))
            return new string[] { "init", "clone", "pull", "push" };
        else
            return null;
    }
}

ReadLine.AutoCompletionHandler = new AutoCompletionHandler();

注意：如果没有设置 "AutoCompletionHandler"，则禁用TAB自动完成

贡献

我们非常欢迎贡献。如果您发现了一个错误或有一个功能请求，请在此存储库问题部分报告它们。

您可以帮忙的事情

• 实现与 GNU Readline 相等的命令兼容性。
• 添加更多的测试用例。

许可

本项目遵守 MIT 许可协议。有关更多信息，请参阅 LICENSE 文件。