kdlfmt

用于 kdl 文档的格式化工具。

kdlfmt 是一个基于官方 kdl 解析器（kdl-rs）构建的轻量级 CLI 包装器，因此任何格式化/解析问题都应该在那里报告。

A code formatter for kdl documents.

Usage: kdlfmt <COMMAND>

Commands:
  format       Format kdl files
  check        Validate files are formatted
  completions  Generate shell completions
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

安装

可以使用 Cargo（Rust 的包管理器）安装 kdlfmt（crates.io）。

cargo install kdlfmt

如果您没有在您的设备上安装/不需要 Rust，您可以在 发布页面 上找到预编译的二进制文件。

使用方法

安装后，可以通过运行 kdlfmt format 来调用格式化。

kdlfmt format PATH

Format kdl files

Usage: kdlfmt format [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Path to file OR directory. Use "-" to read from stdin

Options:
      --log-level <LOG_LEVEL>  [possible values: trace, debug, info, warn, error, off]
  -h, --help                   Print help
  -V, --version                Print version

验证文件格式

kdlfmt 还支持使用 kdlfmt check 命令验证文件是否已格式化。

kdlfmt check PATH

Validate files are formatted

Usage: kdlfmt check [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Path to file OR directory. Use "-" to read from stdin

Options:
      --log-level <LOG_LEVEL>  [possible values: trace, debug, info, warn, error, off]
  -h, --help                   Print help
  -V, --version                Print version

忽略文件

使用 .kdlfmtignore 文件来忽略文件/目录。

它使用与 .gitignore 文件相同的语法。

Shell 完成功能

可以使用 kdl completions 命令生成 Shell 完成功能。

Generate shell completions

Usage: kdlfmt completions <SHELL>

Arguments:
  <SHELL>  [possible values: bash, elvish, fish, powershell, zsh]

Options:
  -h, --help     Print help
  -V, --version  Print version

Bash

将以下内容添加到您的 .bashrc 文件中。

eval "$(kdlfmt completions bash)"

Bash

将以下内容添加到您的 .zshrc 文件中。

eval "$(kdlfmt completions zsh)"

Fish

将以下内容添加到 ~/.config/fish/config.fish 文件中。

kdlfmt completions fish | source

PowerShell

将以下内容添加到您的 PowerShell 配置文件中（可以通过运行 $PROFILE 来找到）。

Invoke-Expression (&kdlfmt completions powershell)

Elvish

将以下内容添加到 ~/.elvish/rc.elv 文件中。

eval (kdlfmt completions elvish)