Swift 中的命令行应用

通往开源库 Terminus 的曲折路径。

在生物学中，像鳄鱼这样的动物有时被称为活化石，因为它们似乎与过去地质层中发现的标本几乎没有什么不同。计算机技术有一些自己的活化石。终端，或更可能的终端仿真器，就是一个这样的例子。 70 年代的终端（如 VT100）是具有键盘、屏幕和有限逻辑的物理设备，可以使用共享计算机发送和接收命令。快进到 2022 年。终端仍然有大量使用。基于云的服务、Web 服务、远程工作和脚本编写是我想到的几个例子。今天我想讲一个开发者的故事，它涉及在 swift 中寻求命令行工具，与 ncurses 的史诗般的战斗，以及最终开发 Terminus，一个开源包，我希望你们中的一些读者，将考虑给予尝试。

用于 Swift 中的命令行应用程序开发的包

在完成了生物医学信息学方面的培训后，我大量使用了 shell 和 R 和 Python/ target=_blank class=infotextkey>Python 等语言，然后通过学习 Swift 回到了 Apple 设备编程。我很快意识到 Swift 是一门了不起的语言，我希望看到它成长为我可以在所有编程任务中使用的东西，而不仅仅是用于编写 IOS 和 mac 应用程序。遗憾的是，在 Swift 中做其他事情的基础设施还有很多成熟的工作要做。

我喜欢在数据科学领域做的很多事情（探索性数据分析、数据处理、机器学习等）都在命令行上进行。 当我的屏幕左侧有一个脚本而右侧有 iPython 时，我有宾至如归的感觉。

对于那些不熟悉的人，iPython 是一个交互式 Python shell，或在终端中运行的 REPL（读取-评估-打印-循环）。它提供了语法高亮、代码完成和一大堆其他漂亮的功能。我心想……你可以在 iPython 中用着色和编辑文本做这么多巧妙的事情，而且自动完成菜单系统真的很酷。我们在 Swift 中有什么可以让我们在终端中做一些引人注目的事情？

经过一番谷歌搜索后，我确实设法找到了一些用于命令行工具的有趣包。请随意阅读以下列表：

• Rainbow— 一个漂亮的文本着色和样式包
• ANSITerminal— 提供文本颜色和样式、光标功能（移动、隐藏/显示、保存/恢复）、屏幕功能（清除屏幕、清除行等）和键盘捕获（一次一个字符，没有内置行编辑器)。
• Swift CommandLineKit— 来自 google 的 Matthias Zenger。包括用于处理命令行参数、文本颜色和样式、单行和多行输入、文本完成和提示的系统。
• ConsolKit— 来自 Vapor（Swift 中的后端 Web 框架）的制造商。一个强大的包，提供活动指示、参数处理（标志、选项等）、文本样式和着色、日志记录等。

所有这些包都提供了对文本颜色和样式的基本支持，ConsolKit 和 CommandLineKit 具有大量高级功能。我遇到的问题是我想要菜单，对在屏幕上移动光标的细粒度支持，以及更好地控制选择颜色。这让我想到了著名的 ncurses C 库。

我与 ncurses 的史诗般的战斗

对于那些不熟悉的人，ncurses 是一个 C 包，最初是在 80 年代初编写的，旨在在各种终端上创建用户界面。成百上千的程序使用 ncurses 来创建文本用户界面 (TUI)。由于 Swift 与 C 的配合非常好，我认为围绕 ncurses 编写一个 Swift 包装器是一个好主意，它具有一些感兴趣的功能，例如菜单。

在大多数情况下，将 C 库合并到 Swift 中是一个相对轻松的过程。 您提供一个模块映射，告诉编译器您的 C 库位于何处（在本地项目或系统中）以及在包装文件中使用 import 时模块的名称应该是什么。 从那里您可以开始以您喜欢的任何方式围绕 C 库编写包装器。 我的计划是在我的包清单中使用 Homebrew（linux 上的 apt），并将我的包与系统安装的 ncurses 库链接，如下所示：

// swift-tools-version:5.5// The swift-tools-version declares the minimum version of Swift required to build this package.import PackageDescriptionlet package = Package(name: "SwiftNCurses",products: [,targets: [.systemLibrary(name: "Cncurses", pkgConfig: pkgConfig, providers: [.apt(["ncurses"]), .brew(["ncurses"])]),

如果你在 Linux 系统上，每一个都很好。 事实上，我是从 TheCoderMerlin 的这个项目开始的，它就是这样做的。 但这是我从 Mac 上的编译器收到的令人讨厌的消息：

好粗鲁。事实证明，Darwin 模块引入了它自己的 ncurses 版本，该版本包含在 MacOS 开发人员 SDK 中！这意味着头文件已经被导入，我们正在尝试重新定义之前声明的东西。此外，MacOS SDK 中的 ncurses 版本在 5.8 版上已经过时了……据我所知，这大约是 2011 年。为什么？！我花了几个小时在 StackOverflow 上寻找修复程序，就在我准备在我的电脑上邮寄时，我遇到了一个解决方案。简而言之，您可以在运行 swift build 时传递 -Xcc -D__NCURSES_H ，这会告诉编译器忽略所有 ncurses 头文件。这样做的问题是，同样的问题也出现在 brew 安装的 ncurses 版本中......并且要解决这个问题，您必须在本地复制所有 ncurses 标头并用其他东西替换 __NCURSES_H 的实例。

为了使这个冗长的故事简短，我终于得到了在 Mac 和 Linux 上编译和工作的东西，但是所有的头文件混合都会让维护变得非常痛苦，而且仍然有一个交易破坏者。任何对使用 wrapper 包感兴趣的用户都必须在他们自己的项目中包含 -Xcc -D__NCURSES_H C 编译器标志。这不会给开发人员带来愉快的体验……所以我存档了项目并继续前进。安息吧 SwiftNCurses。

终点站

从那时起，我编写了一个纯粹基于 ANSI 的 Swift 包，名为 Terminus，现在我想与您分享。

这是演示如何使用样式和颜色写入终端的示例代码：

import Terminuslet Terminal = Terminal.sharedterminal.write("I am bold and underlined.n", attributes: [.bold, .underline])let greenColor = Color(r:0, g:255, b:0)terminal.write("Grass is green.n", attributes: [.color(greenColor)])let palette = XTermPalette()let blueOneYellow = ColorPair(foreground: palette.Blue1, background: palette.Yellow1)terminal.write("Blue on yellow", attributes: [.colorPair(blueOneYellow)])

请注意，您可以为文本添加任意数量的样式和/或颜色。 可以使用 RGB 或使用来自内置调色板之一的命名颜色来指定颜色，例如我在此处使用的 XTerm 调色板。 该文档为每个调色板提供了一个可视化图表。

Terminus 还支持 AttributedStrings。

import Foundationimport Terminuslet terminal = Terminal.sharedvar attributedString = AttributedString("Hello, bold, underlined, world.")if let boldRange = attributedString.range(of: "bold") {attributedString[boldRange].terminalTextAttributes = [.bold]if let underlinedRange = attributedString.range(of: "underlined") {attributedString[underlinedRange].terminalTextAttributes = [.underline]terminal.write(attributedString: attributedString)

现在来看一些更有趣的东西。 这是制作菜单的一些代码。

import Foundationimport Terminuslet terminal = Terminal.sharedterminal.clearScreen()terminal.cursor.moveToHome()let palette = XTermPalette()let itemColor = palette.Aquamarine2let selectionColor = palette.Green5let menuItems = ["Life", "Death", "Taxes"]let menu = Menu(items: menuItems, maxColumns: 1, scrollDirection: .vertical, itemAttributes: [.color(itemColor)], selectionAttributes: [.reverse, .color(selectionColor)])let selection = menu.getSelection()

最后但并非最不重要的......使用采用文本突出显示的行编辑器。

import Terminuslet terminal = Terminal.sharedlet lineEditor = LineEditor()lineEditor.bufferHandler = {var shouldWriteBuffer = falseif let greenRange = lineEditor.buffer.range(of: "green") {lineEditor.buffer[greenRange].terminalTextAttributes = [.color(Color(r: 0, g: 255, b: 0))]shouldWriteBuffer = trueif let yellowRange = lineEditor.buffer.range(of: "yellow") {lineEditor.buffer[yellowRange].terminalTextAttributes = [.color(Color(r: 255, g: 255, b: 0))]shouldWriteBuffer = trueif let redRange = lineEditor.buffer.range(of: "red") {lineEditor.buffer[redRange].terminalTextAttributes = [.color(Color(r: 255, g: 0, b: 0))]shouldWriteBuffer = truereturn shouldWriteBufferlet input = lineEditor.getInput()

结论

对于那些坚持到最后的人，感谢您的阅读！ Terminus 是一个新的软件包，绝不是完整的。 我正在积极寻找合作者来添加功能、修复错误等。