annotate-snippets

annotate-snippets 是一个用于注释编程代码片段的 Rust 库。

该库有助于可视化注释源代码片段的元信息。它接收一个名为 Snippet 的数据结构作为输入，并生成一个类似于以下的 String 输出

本地开发

cargo build
cargo test

在提交 PR 时，请使用 cargo fmt (nightly)。

lib.rs:

一个用于格式化文本或编程代码片段的库。

其主要目的是构建带有注释的代码片段的 ASCII 图形表示。

示例

该 crate 使用三个阶段的过程，其中包含两次状态之间的转换

Message --> Renderer --> impl Display

输入类型 - [Message] 是一个结构，旨在与任何要注释的代码片段的解析器可能输出的内容相匹配。

中间结构 - [Renderer] 是一个结构，旨在将片段转换为内部结构，该结构旨在以易于格式化的方式存储片段数据。[Renderer] 还处理用户可配置的格式化选项，如颜色或边距。

最后，将 impl Display 转换为最终的 String 输出。

功能

• testing-colors - 使 Renderer::styled 颜色与操作系统无关，这使得在测试彩色输出时更容易测试。它应作为功能添加到 [dev-dependencies] 中，可以使用以下命令完成

cargo add annotate-snippets --dev --feature testing-colors