Formatting CLI for KDL (v1 & v2).
A small formatting utility around the awesome kdl-rs crate for formatting
KDL files. It is also capable of converting KDL v1 to v2 documents and vice versa.
kdl-fmt will try to detect the input KDL version, in case it is not specified. It will also use the input KDL version as the target version, if there's no target version specified.
- cargo/Rust
development dependencies
- just (for development)
- cargo nextest
Download the binary for your platform from the GitHub Releases or lone the repository and run cargo build -r. Then copy the binary somewhere into your $PATH (e.g. /usr/local/bin on Linux).
As an alternative, you can simply run cargo install kdl-fmt.
Afterwards you can use kdl-fmt in your terminal:
# format the content of file and print the result
$ kdl-fmt ./path/to/file.kdl
# format the content of file and write it back into the file
$ kdl-fmt --in-place ./path/to/file.kdl
# format content from STDIN
$ echo "some { kdl; }" | kdl-fmt -
# convert to v1
$ kdl-fmt --to-v1 ./path/to/file.kdl
# convert to v2
$ kdl-fmt --to-v2 ./path/to/file.kdl
# remove comments
$ kdl-fmt --strip-comments ./path/to/file.kdl
# validate kdl v1
$ kdl-fmt --from-v1 --no-format ./path/to/file.kdl
# validate kdl v2
$ kdl-fmt --from-v2 --no-format ./path/to/file.kdl
# print help
$ kdl-fmt --helpBesides configuring certain formatting options with arguments of the CLI, kdl-fmt also respects a configuration file within the directory where kdl-fmt is executed, to configure project specific formatting options. Please bear in mind, that CLI arguments will override options from the configuration file.
To start with the configuration file, add a .kdl-fmt.kdl to to the directory you run kdl-fmt in, with the following content:
// Assume the input version
// Available values: "auto", "v1", "v2"
assume_version "v1"
// Configure whether to ensure a specific version on the output or not
// Available values: "off", "v1", "v2"
ensure_version "v2"
// Remove all comments
strip_comments #false
// Count of spaces to use for indentation
indent_level 4If you are missing features or find some annoying bugs please feel free to submit an issue or a bugfix within a pull request :)
© 2024 Daniel Jankowski
This project is licensed under the MIT license.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.