Add 'indent_str' option to Config to change the indent type (#24)

Two spaces remains the default. To make the builder more intuitive this
adds a depedency on the TypedBuilder crate.
6 files changed
tree: 6f2b27d44898171182d490dda1c7e84953ad2df1
  1. .github/
  2. scripts/
  3. src/
  4. tests/
  5. .gitignore
  6. .gitmodules
  7. build.rs
  8. Cargo.lock
  9. Cargo.toml
  10. LICENSE
  11. README.md
  12. rustfmt.toml
README.md

dtsfmt

Auto formatter for device tree files.

Installation

You can install dtsfmt by running the install script which will download the latest release.

curl -LSfs https://go.mskelton.dev/dtsfmt/install | sh

Or you can build from source.

git clone --recurse-submodules https://github.com/mskelton/dtsfmt.git
cd dtsfmt
cargo install --path .

Usage

To run dtsfmt, simply provide a file/directory path to the dtsfmt command.

dtsfmt .

Config

The following configuration options are available for dtsfmt. Configuration should be added to a .dtsfmtrc.toml file at the root of your project.

layout = "kinesis:adv360" # Required
# Available options are ["kinesis:adv360", "sweep", "moergo:glove80"]

Ignoring code

You can add a .dtsfmtignore file at the root of your project to exclude files and paths from formatting. This file follows the same rules as .gitignore.

Flags

--check

When you want to check if your files are formatted, you can run dtsfmt with the --check flag (or -c). This will output a human-friendly message and a list of unformatted files, if any.

dtsfmt --check .

--emit

You can change the way dtsfmt emits the changes with the --emit flag.

dtsfmt --emit=stdout