Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cpg314/cargo-group-imports
Group imports in Rust workspaces
https://github.com/cpg314/cargo-group-imports
cargo formatter linter rust
Last synced: 1 day ago
JSON representation
Group imports in Rust workspaces
- Host: GitHub
- URL: https://github.com/cpg314/cargo-group-imports
- Owner: cpg314
- License: apache-2.0
- Created: 2023-10-15T09:50:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T13:06:08.000Z (7 months ago)
- Last Synced: 2024-05-05T10:36:33.019Z (7 months ago)
- Topics: cargo, formatter, linter, rust
- Language: Rust
- Homepage:
- Size: 87.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cargo-group-imports
Group imports in workspace source files as:
1. Module imports and declarations
2. Standard library
3. External crates
4. Workspace crates
5. Crate modules
For example (see also the before/after files in `test-data`):
```rust
mod module;
use module::Client;
use std::sync::Arc;
use tokio::sync::Mutex;
use other_crate::Flags;
use crate::Options;
```
This roughly corresponds to the [`group_imports` unstable rustfmt option](https://rust-lang.github.io/rustfmt/?version=v1.4.38&search=#group_imports), with the difference
that `rustfmt` does not distinguish workspace crates from external ones.
### Tests and binaries
For the purpose of grouping imports, test and binaries are considered to be in the same crate, although they technically are different crates. This can for example result in the following grouping:
```rust
use anyhow::Context;
use mycrate::**; // the binary belongs to `mycrate`.
use crate::test_utils;
```
This is driven by implementation simplicity rather than a true design choice.
## Installation
```console
$ cargo install --git https://github.com/cpg314/cargo-group-imports
```
Alternatively, see the binaries on the [Releases](https://github.com/cpg314/cargo-group-imports/releases) page.
## Usage
```
cargo group-imports [OPTIONS] [WORKSPACE]
Arguments:
[WORKSPACE] [default: current folder]
Options:
--fix Apply changes
--color [default: auto] [possible values: auto, always, never]
-h, --help Print help
-V, --version Print version
```
By default, the tool checks that the imports are correctly grouped and displays a diff otherwise. The `--fix` flag applies the necessary changes, if any. This matches the behaviour of `cargo clippy`.
```console
$ cargo group-imports
$ cargo group-imports --fix
```
The return code is `0` when no changes are necessary, `1` otherwise. This can be used in CI checks.