Prettier - Code formatter (Rust) 0.1.9

# .prettierrc.toml
<p>useTabs = false
tabWidth = 4
printWidth = 100
endOfLine = "lf"</p><h1>-- 目前不支持 --</h1><h1>trailingComma = "es5"</h1><h1>embeddedLanguageFormatting = "auto"</h1><h1>示例覆盖</h1><p>overrides = [
{ files = ["tests/*.rs"], options = { printWidth = 80 } }
]</p><pre><code>&lt;/details&gt;

**如何忽略某些内容：**

- 在代码上方添加`// prettier-ignore`或`#\[rustfmt::skip\]`
- 在代码块或文件内添加`#!\[rustfmt::skip\]`
- 创建`.prettierignore`文件来匹配忽略的文件，类似`.gitignore`

**宏的格式化规则：**

- 花括号`!{}`格式化为代码块，`!\[\]`和`!()`格式化为逗号分隔的表达式
- 宏调用内部的格式化更加保守，因为宏可能对令牌敏感
- 流行的内置宏具有原始语法规则的定制格式化（例如`matches!`, `if_chains!`...）*\[目前尚未实现\]*
- 宏声明仅部分格式化（转换部分尚未格式化，但未来可能会实现）
- 无法格式化的宏会被静默忽略

**是否支持夜间功能？**

是的！Prettier Rust格式化大多数夜间功能。支持取决于jinx-rust。

**项目集成：**

- **命令行**

    *需要NodeJS*

    - 全局安装prettier和prettier-plugin-rust
</code></pre><pre><code>    npm install --global prettier-plugin-rust prettier

• 使用prettier CLI格式化Rust文件。例如，运行：

  
    prettier --write **/*.rs
    ```</code></pre><ul><li><p><strong>NodeJS包</strong></p><p><em>需要NodeJS</em></p><ul><li><p>在项目中安装prettier和prettier-plugin-rust</p><pre><code>  npm install --save-dev prettier-plugin-rust prettier</code></pre></li><li><p>在prettier配置中链接到插件的位置：</p><pre><code>  "plugins": ["./node_modules/prettier-plugin-rust"]</code></pre></li><li><p>使用prettier CLI格式化Rust文件。例如，运行：</p><pre><code>  npx prettier --write **/*.rs</code></pre></li></ul></li><li><p><strong>Rust crate</strong></p><p><em>目前没有crate。可使用上述选项。</em></p></li></ul><p><strong>常见问题解答：</strong></p><ul><li><p><strong>为什么我要使用Prettier Rust而不是已有的cargo fmt？</strong></p><p><em>编辑器集成至关重要</em> — 在工作过程中格式化代码的能力真正提升了开发体验，而Rust严格的语法自动完成则极大地节省了时间。一旦你尝试了这个扩展，就再也回不去了。</p><p>总的来说，代码风格的差异很小，因此采用Prettier Rust不会显著改变你的代码库。真正的缺点是与Rust生态系统的整合较为严苛，但这会随着时间的推移得到改善。</p><p>逐点分析：</p><ul><li>扩展在编辑器中简化了你的工作<ul><li>可以格式化无法编译的代码（例如缺少类型注释的代码）</li><li>自动更正语法错误（例如缺少分号、代码块、括号等）</li></ul></li><li>它具有强烈的风格偏好，无需格式选项，因此代码在项目间保持统一</li><li>在某些情况下，它生成的代码更易读（例如条件链、复合表达式、模式）</li><li>它支持一切功能（例如夜间功能、宏）</li><li>它始终以相同的方式打印代码，而Rustfmt在某些地方保留了任意的风格</li><li>它可以用于其他语言（例如markdown、html、typescript、java、python、ruby）</li><li>它格式化语言嵌入。Rust代码块可以在非Rust文件中（例如markdown），以及在Rust文档注释中支持的语言。<em>[注意：后者尚未实现]</em></li></ul></li><li><p><strong>为什么不直接将这些功能添加到rustfmt中？</strong></p><p>不幸的是，rustfmt无法通过设计实现这些功能。</p><p>rustfmt使用rustc解析代码。rustc严格且不宽容，因为它总是假设代码处于“最终版本”，因此任何与接受语法稍有偏差都会使解析器崩溃。此外，rustc在解析器中有许多类似lint的检查。意图是为后续的编译器工作节省时间，不幸的是，这也意味着rustc有时无法解析语法正确的代码。</p><p>然而，Prettier Rust基于jinx-rust。jinx-rust专为Rust工具设计。因此，它设计为能容忍广泛的语法错误，支持缺失的节点，有时甚至能推断用户意图（例如Javascript的<code>!==</code>）</p><p>jinx-rust在其readme中有一个关于Rust工具不应使用官方rustc解析器的小型<em>plaidoyer</em>。</p></li><li><p><strong>Prettier Rust何时会更改代码语法？</strong></p><p>Prettier Rust的语法自动更正功能旨在适应Prettier Typescript如何自动更正缺少分号的javascript代码。</p><p>您可以将Prettier Rust的语法自动更正视为自动应用Rust编译器建议的语法修复（例如“此处缺少分号”、“在此处加括号”或“在此处添加代码块”）。</p><p>否则，如果您的代码库可以编译，那么Prettier Rust只是一个格式化工具，不会更改有效Rust代码的语法。此外，它不会重新组织导入、拆分注释或合并属性。</p></li><li><p><strong>这是一个“有意见的格式化工具”。但它是全新的！这些意见的可靠性如何？</strong></p><p>请放心，Prettier Rust实际上并不自行决定风格。Prettier Rust基本上是Prettier Typescript的1:1改编，因此它实施的意见已被数百万用户实战测试并达成共识。</p></li></ul>