A formatter for kdl documents.
kdlfmt is a thin cli wrapper built on-top of the official kdl parser for Rust (kdl-rs), so any formatting/parsing issues should be reported there.
kdlfmt 0.1.1
A code formatter for kdl documents.
Mads Hougesen <mads@mhouge.dk>
Usag
E7FF
e: kdlfmt [OPTIONS] <COMMAND>
Commands:
format Format kdl files
check Validate files are formatted
init Initialize formatter config
completions Generate shell completions
help Print this message or the help of the given subcommand(s)
Options:
--log-level <LOG_LEVEL> [possible values: trace, debug, info, warn, error, off]
-h, --help Print help
-V, --version Print version
kdlfmt can be installed using Cargo, the package manager for Rust (crates.io).
cargo install kdlfmtIf you're on macOS or Linux, you can install kdlfmt using Homebrew:
# Tap and install
brew tap hougesen/tap
brew install kdlfmt
# Or install directly in one command
brew install hougesen/tap/kdlfmtYou can install kdlfmt using npm:
npm install -g kdlfmt
kdlfmt format .Or run it directly using npx:
npx kdlfmt format .If you do not have/want Rust or Homebrew installed on your device, you can find precompiled binaries on the release page or run one of the installers below.
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/hougesen/kdlfmt/releases/latest/download/kdlfmt-installer.sh | shpowershell -ExecutionPolicy ByPass -c "irm https://github.com/hougesen/kdlfmt/releases/latest/download/kdlfmt-installer.ps1 | iex"A non-complete list of other package managers with support for installing kdlfmt can be found at Repology.
Once installed the formatted can be invoked by running kdlfmt format.
kdlfmt format PATHOr reading from stdin and printing the formatted output to stdout.
cat somefile.kdl | kdlfmt format -Format kdl files
Usage: kdlfmt format [OPTIONS] [INPUT]...
Arguments:
[INPUT]...
Path to file OR directory.
Use "-" to read from stdin and print to stdout.
Options:
--kdl-version <KDL_VERSION>
kdl specification to use.
By default all versions are tried
[possible values: v1, v2]
--stdin
Read from stdin and print to stdout
--config <CONFIG>
Path to config file
--log-level <LOG_LEVEL>
[possible values: trace, debug, info, warn, error, off]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
kdlfmt also support validating if files are formatted using the kdlfmt check command.
kdlfmt check PATHOr reading from stdin.
cat somefile.kdl | kdlfmt check -Validate files are formatted
Usage: kdlfmt check [OPTIONS] [INPUT]...
Arguments:
[INPUT]...
Path to file OR directory.
Use "-" to read from stdin and print to stdout.
Options:
--kdl-version <KDL_VERSION>
kdl specification to use.
By default all versions are tried
[possible values: v1, v2]
--stdin
Read from stdin and print to stdout
--config <CONFIG>
Path to config file
--log-level <LOG_LEVEL>
[possible values: trace, debug, info, warn, error, off]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
.kdlfmtignore files are used to ignore files/directories.
It uses the same syntax as .gitignore files.
There are a lot of different ways to run kdlfmt using GitHub actions.
The easiest way, in my opinion, is to use the official GitHub action to install kdlfmt.
After that you can run the binary like you would in your terminal.
name: kdlfmt
on:
- push
jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install kdlfmt
uses: hougesen/kdlfmt@main
- name: Run kdlfmt format
run: kdlfmt format .
- name: Commit changes
uses: EndBug/add-and-commit@v9
with:
message: "style: formatted kdl"Shell completion can be generated using the kdlfmt completions command.
Generate shell completions
Usage: kdlfmt completions [OPTIONS] <SHELL>
Arguments:
<SHELL> [possible values: bash, elvish, fish, nushell, powershell, zsh]
Options:
--log-level <LOG_LEVEL> [possible values: trace, debug, info, warn, error, off]
-h, --help Print help
-V, --version Print version
Add the following to your .bashrc.
eval "$(kdlfmt completions bash)"Add the following to your .zshrc:
eval "$(kdlfmt completions zsh)"Add the following to ~/.config/fish/config.fish.
kdlfmt completions fish | sourceAdd the following to your PowerShell configuration (Can be found by running $PROFILE).
Invoke-Expression (&kdlfmt completions powershell)Add the following to ~/.elvish/rc.elv.
eval (kdlfmt completions elvish)Generate completions for nushell.
kdlfmt completions nushell