TOML 格式化工具
使用 Prettier TOML 插件格式化 TOML 配置文件,例如 Cargo.toml、pyproject.toml 和其他应用设置。该格式化工具会规范等号周围的空格、行内表和数组的排版,用空行分隔各个表,保留所有注释,并在语法错误时报告行和列,方便开发者在提交前安全地整理配置。
常见问题
哪个引擎会格式化 TOML?
该工具在服务器上使用 Prettier 3 和 prettier-plugin-toml 4.1。它会读取 TOML 1.0 文档,并以统一的样式输出。
输出会有哪些变化?
键和值的等号两侧会各保留一个空格,行内表和数组也会均匀排版。多余的空行会合并,每个表头与前一节之间都会用空行分隔。
注释会保留吗?
会。整行注释和值后面的尾随注释都会留在原处,因此带注释的配置文件仍会保留原有说明。
键或表会排序吗?
不会。键、表和表数组会保持原有顺序,这对于人们从上到下阅读文件很重要。
字符串引号会改变吗?
如果单引号字面字符串的值不包含反斜杠或双引号,可能会改写为双引号,值则保持不变。需要保留字面引号的字符串仍使用单引号。
长数组会如何处理?
未超出打印宽度的数组会保留在一行。带尾随逗号或超出宽度的数组会按每行一个元素的形式输出。
TOML 无效时会怎样?
格式化会停止,工具会显示解析器提供的错误信息以及行和列,例如等号后缺少值。重复键和其他无效的 TOML 也会以同样方式报告。
可以更改缩进吗?
可以。嵌套数组可选择使用 2 个或 4 个空格或制表符,并可将打印宽度设为 40 到 200 个字符,默认值为 80。
文件大小上限是多少?
每次请求最多可处理 1 MB 文本,远超常见配置文件的大小。格式化会在 10 秒后停止。
我的配置会被保存吗?
不会。配置文件可能包含机密信息,因此内容只会在内存中处理,绝不会保存或记录。