A tool to check that your Cargo.toml dependencies are sorted alphabetically. Project created as a solution to @dtolnay's request for implementation #29. Cross platform implementation, windows compatible. Terminal coloring works on both cmd.exe and powershell. Checks/sorts by key in tables and also nested table headers (does not sort the items in a nested header, sorts the table itself). cargo sort uses toml-edit to parse the toml file into something useful.
The --format option may result in improperly formatted toml; please file an issue.
There are three modes cargo-sort can be used in:
* default
- No flags set cargo-sort will write the sorted result over the input Cargo.toml file.
* -c or --check
- Will fail with a non-zero exit code if the file is unsorted.
* -n or --no-format
- Will NOT format the sorted toml. This option only has an effect if writing or printing out.
* -g or --grouped
- When sorting keep table key value spacing. If you have dependency groups they will stick but be sorted within the grouping.
The key_value_newlines config option needs to be true for this to have any effect.
* -p or --print
- Write the sorted toml file to stdout.
* -w or --workspace
- Checks every crate in the workspace based on flags. Only one root may be given.
* -o or --order
- Specify an ordering of tables. All nested tables will be sorted and appear after the specified table. Any unspecified table will be after specified.
cargo sort uses a config file when formatting called tomlfmt.toml. This is optional and defaults will
be used if not found in the current working dir.
Here are the defaults when no tomlfmt.toml is found
```toml
alwaystrailingcomma = false
multilinetrailingcomma = true spacearoundeq = true
compact_arrays = false
compactinlinetables = false trailing_newline = true
keyvaluenewlines = true allowedblanklines = 1
crlf = false
table_order = [] ```
included in sort check is:
toml
["dependencies"]
["dev-dependencies"]
["build-dependencies"]
["workspace.members"]
["workspace.exclude"]
If you have a header to add open a PR, they are welcome.
bash
cargo install cargo-sort
If you use pre-commit in your project, you can add cargo-sort as hook by
adding the following entry to your .pre-commit0-config.yaml configuration:
yaml
repos:
- repo: https://github.com/DevinR528/cargo-sort
rev: v1.0.4
hooks:
- id: cargo-sort
Please make sure to set rev to the latest tag of this repo as the tag shown here might not always
be updated to the latest version.
Thanks to dspicher for issue #4 you can now invoke cargo sort check as a cargo subcommand
bash
cargo sort [FLAGS] [path]
Wildcard expansion is supported so you can do this
bash
cargo-sort [FLAGS] [path/to/*/Cargo.toml | path/to/*]
or any other pattern that is supported by your terminal. This also means multiple
paths work.
bash
cargo-sort [FLAGS] path/to/a path/to/b path/to/c/Cargo.toml
Finally cargo sort has the --workspace flag and will sort each Cargo.toml file in a workspace
bash
cargo-sort -w/--workspace
These are all valid. File names and extensions can be used on some of the paths but not others, if left off the tool will default to Cargo.toml.
```bash cargo sort 1.0.0 Devin R devin.ragotzy@gmail.com Ensure Cargo.toml dependency tables are sorted.
USAGE: cargo-sort [FLAGS] [CWD]
FLAGS: -c, --check exit with non-zero if Cargo.toml is unsorted, overrides default behavior -f, --format formats the given Cargo.toml according to tomlfmt.toml -g, --grouped when sorting groups of key value pairs blank lines are kept -h, --help Prints help information -p, --print prints Cargo.toml, lexically sorted, to stdout -V, --version Prints version information -w, --workspace checks every crate in a workspace
ARGS:
Build the image:
sh
docker build -t cargo-sort .
Run the container:
sh
docker run -it --rm -v "$(pwd)/Cargo.toml":/app/Cargo.toml cargo-sort
```toml [dependencies] a="0.1.1"
c="0.1.1"
b="0.1.1"
[dependencies.alpha] version="0"
[build-dependencies] foo="0" bar="0"
[dependencies.zed] version="0"
[dependencies.beta] version="0"
[dev-dependencies] bar="0" foo="0"
Will sort to, or fail until organized like so
toml
[dependencies]
a="0.1.1"
b="0.1.1"
c="0.1.1"
[dependencies.alpha] version="0"
[dependencies.beta] version="0"
[dependencies.zed] version="0"
[build-dependencies] bar="0" foo="0"
[dev-dependencies] bar="0" foo="0"
```
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.