cargo-xfmt 0.0.16

Safely use nightly fmt options without using unstable Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# cargo-xfmt

This project enables the use of unstable Rust formatting options without using nightly Rust

### Installation

```bash
cargo install cargo-xfmt
```

### Usage

The same as `cargo fmt`

```bash
cargo xfmt
cargo xfmt --config ./path/to/rustfmt.toml
```

### VSCode

And add this to `.vscode/settings.json`

```json
{
  "rust-analyzer.rustfmt.overrideCommand": [
    "cargo", "xfmt",
  ]
}
```

And for format on save
```json
{
  "rust-analyzer.rustfmt.overrideCommand": [
    "cargo", "xfmt",
  ],
  "editor.formatOnSave": true,
  "[rust]": {
    "editor.defaultFormatter": "rust-lang.rust-analyzer",
    "editor.formatOnSave": true
  }
}
```

### How it works and why it's relatively safe

While unstable formatting rules do change between versions of Rust, the unstable formatting rules
are built into the stable version of Rust you are using and don't change unless the version of Rust
is updated.

Conventionally you would use

```
cargo +nightly fmt
```

However this will download/use the nightly toolchain which is a moving target. If you use this and
return to a repo after some time - formatting may fail due to a newer version of nightly Rust being installed.

That said, Cargo can be forced to use the current stable version of Rust to run the unstable formatting commands.
This ensures that CI tasks that use unstable formatting _always_ work when run against the same stable toolchain.

This is done by passing rules to `cargo fmt` directly. This cannot be done with a config file.

```
cargo fmt -- --config imports_granularity=Item --config group_imports=StdExternalCrate
```

This CLI tool simply wraps `cargo fmt`. It reads a `rustfmt.toml` and generates the equivalent `cargo fmt` command.