Toml Maid - 保持 TOML 文件整洁

此格式化器试图应用一种具有偏见的统一格式化样式。

主要，它将没有通过空白行分隔的行视为块，因此排序仅在各个块内部应用。它符合某些大型 Rust 仓库的实践，在部分中分离依赖关系，而许多其他格式化器没有考虑这一点，导致部分混乱。

安装

cargo install toml-maid

使用方法

运行 toml-maid <my_file.toml> 以格式化文件。可以提供多个文件。使用 --folder <path> 选项来注册一个文件夹，toml-maid 将递归地扫描其中的任何 TOML 文件（不包括 toml-maid.toml 文件）。这两个选项可以一起使用。如果都没有使用，则注册当前文件夹（相当于 toml-maid --folder .)

--check 选项不允许修改任何文件，如果文件格式不正确，则将退出并返回错误代码。--silent 选项允许不输出不重要消息。

配置

可以使用 toml-maid.toml 文件配置 toml-maid 的行为，该文件可以位于当前路径或任何父文件夹中，第一个找到的将被使用，其余将被忽略。选项如下：

• keys：应首先在非内联表中排序的键字符串列表（[section] 和 key = { ... } 条目）。这可以用于将重要条目放在前面。
• inline_keys：与行内表格相同 foo = { key1 = .., key2 = ..}。
• sort-arrays：布尔值，表示是否对数组进行排序。只有在顺序不重要的情况下使用，例如适合保持 Cargo.toml 特性列表的顺序。
• excludes：要忽略的目录扫描时的模式列表

待办事项

• 改进多行数组中的注释格式，主要是在逗号后始终移动注释。
• 允许在递归扫描目录时配置要忽略的文件夹（例如，在本存储库中，tests/output_consistency 文件夹不应格式化，因为它有意包含未格式化的文件）。
• 在 README 中添加可爱的动漫女孩