Unicode::DisplayWidth 使用与技术文档

安装指南

安装此Ruby扩展包非常简单。你可以使用以下命令：

$ gem install unicode-display_width

或者，如果你正在使用Gemfile，你可以将它加入到你的Gemfile中：

gem 'unicode-display_width'

之后执行 bundle install 来安装。

使用说明

Unicode::DisplayWidth 库用于确定在Ruby中字符串的单空间显示宽度，这对于各种基于终端的应用程序来说非常有用。它完全用Ruby实现，不依赖于操作系统提供的方法来测量终端中的字符串宽度。

基本使用

require 'unicode/display_width'

Unicode::DisplayWidth.of("⚀") # => 1
Unicode::DisplayWidth.of("一") # => 2

不明确的字符

该库允许你定义不明确宽度字符的显示宽度：

Unicode::DisplayWidth.of("·", 1) # => 1
Unicode::DisplayWidth.of("·", 2) # => 2

自定义覆盖

你可以通过传递一个散列（甚至是一个过程）作为 overwrite: 参数来自定义特定代码点的处理：

Unicode::DisplayWidth.of("a\tb", 1, overwrite: { "\t".ord => 10 })) # => tab计数为10，结果是12

请注意，使用自定义覆盖将禁用此库的一些性能优化。

表情符号

如果你的终端支持，该库能够自动检测表情符号和表情符号序列，并调整测量字符串的宽度。这可以通过传递 emoji: false 作为参数来禁用：

Unicode::DisplayWidth.of "🤾🏽‍♀️", emoji: :all # => 2
Unicode::DisplayWidth.of "🤾🏽‍♀️", emoji: false # => 5

更多关于表情符号宽度的处理和不同终端之间的差异，请参考文档中的详细说明。

字符串扩展

require 'unicode/display_width/string_ext'

"⚀".display_width # => 1
'一'.display_width # => 2

配置对象

你可以使用一个配置对象来保存你的配置，以便以后重用。这需要额外的代码行，但优点是你只需要定义一次字符串宽度选项：

require 'unicode/display_width'

display_width = Unicode::DisplayWidth.new(
  # ambiguous: 1,
  overwrite: { "A".ord => 100 },
  emoji: :all,
)

display_width.of "⚀" # => 1
display_width.of "🤠‍🤢" # => 2
display_width.of "A" # => 100

项目API使用文档

关于项目API的详细使用说明，可以在项目的官方文档中找到。以下是一些基本的使用示例：

• Unicode::DisplayWidth.of(string, [ambiguous], [overwrite], [emoji]) 方法用于计算字符串的显示宽度。
• 可以通过 Unicode::DisplayWidth.new 创建一个新的配置对象，用于保存和重用配置。

项目安装方式

此项目的安装方式已在“安装指南”部分说明，可以通过Ruby的gem包管理器进行安装。如果需要从源代码安装，可以克隆Git仓库并执行 gem build 命令来构建gem包，然后安装它。

以上就是关于Unicode::DisplayWidth项目的使用和技术文档。希望对您有所帮助。