How to run cargo fmt on save in vscode?

Question

Is it possible to make Visual Studio Code run cargo fmt on file save?

score 52 · Answer 1 · answered May 18 '22 at 01:02

52

Install the extension rust-analyzer (the officially recommended vscode extension), and add the following to settings.json:

"[rust]": {
    "editor.defaultFormatter": "rust-lang.rust-analyzer",
    "editor.formatOnSave": true
}

answered May 18 '22 at 01:02

Delta Kapp

677
1
4
7

score 24 · Accepted Answer · answered Jun 06 '21 at 16:57

24

Install rust-analyzer, if you have not already.
In Visual Studio Code's settings, enable Editor: Format On Save (editor.formatOnSave).

answered Jun 06 '21 at 16:57

Kevin Reid

37,492
13
80
108

4

I'll also add that you should ensure you don't have "editor.defaultFormatter" set globally. If you have, say, "editor.defaultFormatter": "esbenp.prettier-vscode" (or some other formatter) enabled globally rather than on a per-language basis, VSCode will attempt to use that formatter in lieu of rust-analyzer's on Rust code. I've seen a few JS devs lost 10 or 15 minutes to this when transitioning to a Rust project. – Parker Ziegler Feb 06 '22 at 04:01

score 18 · Answer 3 · edited Oct 03 '22 at 20:32

18

This is what worked for me. In the file settings.json somewhere inside the curly braces insert the following :

    "editor.formatOnSave": true,
    "editor.formatOnType": true,
    "rust-analyzer.rustfmt.enableRangeFormatting": true,
    "[rust]": {
        "editor.defaultFormatter": "rust-lang.rust-analyzer", 
        "editor.formatOnSave": true 
    },

edited Oct 03 '22 at 20:32

James Williams

724
6
20

answered Dec 22 '21 at 12:21

Ilya Tegmark

289
2
3

score 9 · Answer 4 · edited Apr 25 '22 at 01:41

9

Current version of the Rust extension > 0.7.8 requires nothing else to be installed. Enable formatOnSave in VS Code settings.json file:

  "[rust]": {
        "editor.formatOnSave": true
    }

edited Apr 25 '22 at 01:41

German Khokhlov

1,724
16
15

answered Dec 30 '21 at 03:54

Todd

5,017
1
25
16

atilkan · Answer 5 · 2023-01-28T21:06:39.983

8

If you have formatOnSaveMode is set to modifications or modificationsIfAvailable, you may need to change it like below.

"[rust]": {
    "editor.defaultFormatter": "rust-lang.rust-analyzer",
    "editor.formatOnSave": true,
    "editor.formatOnSaveMode": "file"
  },

edited Jan 28 '23 at 21:06

answered Dec 11 '22 at 18:57

atilkan

4,527
1
30
35

3

i just need to add: "editor.formatOnSaveMode": "file" it's the working answer! thank you! – FatihAziz Mar 22 '23 at 00:19
1

This was it for me, thanks! With modifications set it silently did nothing. – Viktor Hedefalk May 11 '23 at 16:31

score -1 · Answer 6 · edited Oct 08 '22 at 05:08

-1

Install rust-analyzer and add this to your settings.json

"[rust]": {
    "editor.defaultFormatter": "rust-lang.rust-analyzer",
    "editor.formatOnSave": true
}

edited Oct 08 '22 at 05:08

kelsny

23,009
3
19
48

answered Oct 04 '22 at 07:34

TheHolyTachanka

7
3

2

This is a duplicate of Delta Kapp's answer above. – Jk Jensen Oct 11 '22 at 21:45

How to run cargo fmt on save in vscode?

6 Answers6