rustdoc-prettier

使用prettier格式化//!和///注释

安装

cargo install rustdoc-prettier

rustdoc-prettier需要独立安装prettier，例如。

npm install -g prettier

用法

rustdoc-prettier [ARGS]

以.rs结尾的参数被视为源文件并格式化。所有其他参数都转发到prettier，只有一个例外。形式为

---max-width <N>

的选项转换为形式为

--prose-wrap always --print-width <M>

的选项，其中M是N减去缩进宽度、//!或///语法以及可能跟随该语法的空格的总和。如果当前目录中包含具有max_width键的rustfmt.toml文件，则自动应用--max-width选项。

rustdoc-prettier支持glob模式。示例

rustdoc-prettier '**/*.rs'

参考

• https://prettier.node.org.cn/docs/en/options.html
• https://rust-lang.github.io/rustfmt/?version=master&search=

备注

rustdoc-prettier手动解析源代码。它不使用rustdoc-json。这样做有两个原因

1. rustdoc-json提供了注释代码的span，但没有提供注释本身的span。据我所知，没有简单的方法可以使用rustdoc-json的输出提取rustdoc注释。
2. rustdoc-json不输出来自宏展开或内联汇编的项的span。然而，有合法的理由想要格式化这样的注释。