GitHub - microsoft/edit 编辑器介绍与安装使用指南

技术背景

GitHub - microsoft/edit 是一款简单的编辑器，旨在满足基本的编辑需求。它致敬经典的 MS - DOS 编辑器，同时拥有现代的界面以及类似于 VS Code 的输入控件。其目标是提供一款易于使用的编辑器，即使是不太熟悉终端的用户也能轻松上手。

实现步骤

安装

1. 下载二进制文件：可以从 Releases 页面下载二进制文件。
2. Windows 系统安装：可以使用 WinGet 安装最新版本：

winget install Microsoft.Edit

构建说明

1. 安装 Rust：安装 nightly 工具链：

rustup install nightly

也可以设置环境变量 RUSTC_BOOTSTRAP = 1。
2. 克隆仓库：

git clone <仓库地址>

3. 发布版本构建：

cargo build --config .cargo/release.toml --release

核心代码

以下是使用 WinGet 安装的代码示例：

winget install Microsoft.Edit

构建发布版本的代码：

cargo build --config .cargo/release.toml --release

最佳实践

包维护者注意事项

1. 包命名：规范的可执行文件名为 “edit”，替代名称为 “msedit”。由于 “edit” 可能与现有命令冲突，建议将包和可执行文件命名为 “msedit”，避免使用 “ms - edit” 等名称。如果可能，推荐分配 “edit” 别名。
2. ICU 库名称（SONAME）：该项目的搜索和替换功能可选依赖于 ICU 库。默认情况下，项目会查找无版本后缀的 SONAME：
   • Windows：icuuc.dll
   • macOS：libicuuc.dylib
   • UNIX 及其他操作系统：libicuuc.so
     如果安装使用不同的 SONAME，请在构建时设置以下环境变量：

EDIT_CFG_ICUUC_SONAME: 例如，libicuuc.so.76
EDIT_CFG_ICUI18N_SONAME: 例如，libicui18n.so.76

此外，如果安装使用带版本的导出，请设置：

EDIT_CFG_ICU_CPP_EXPORTS: 如果设置为 true，将查找 C++ 符号，如 _u_errorName。macOS 上默认启用。
EDIT_CFG_ICU_RENAMING_VERSION: 如果设置为版本号，如 76，将查找符号，如 u_errorName_76。

最后，可以设置以下环境变量：

EDIT_CFG_ICU_RENAMING_AUTO_DETECT: 如果设置为 true，可执行文件将在运行时尝试检测 EDIT_CFG_ICU_RENAMING_VERSION 值。不建议依赖此方法，因为它未得到 ICU 的官方支持。如果没有设置其他选项，UNIX（不包括 macOS）上默认启用。

测试设置

要测试设置，使用 --ignored 标志再次运行 cargo test：

cargo test -- --ignored

常见问题

1. 命名冲突：”edit” 可能与现有命令冲突，可按建议将包和可执行文件命名为 “msedit”。
2. ICU 库问题：如果安装使用不同的 ICU 库 SONAME 或带版本的导出，需要按上述说明设置相应的环境变量。