Format on auto-saving doesn't work

[djc]

I have formatOnSave enabled and autoSave set. Yet automatic saving does not seem to trigger formatting as manual saving does. Is this a rust-analyzer issue?

[Veetaha]

This is interesting, I don't know where this formatting comes at all... @matklad do you know where the Rust formatter comes from?

[zshift]

I just really started getting into rust, so excuse my ignorance. Same for vscode plugins.

I ran into rustfmt just a few min ago. It's installed with rustup component add rustfmt.

Usage is rustfmt [options] <file>.

[blitzerr]

This isn't working for me either. I have the latest version.

[tbmreza]

@blitzerr running rustfmt from the command line works for me. Have you tried overriding the default formatter?

1. Install https://marketplace.visualstudio.com/items?itemName=statiolake.vscode-rustfmt
2. Ctrl+Shift+P, Format Document With... Configure Default Formatter...
3. Format on save now works on single rs file.

[matthiaskrgr]

Had the same problem, had
"editor.formatOnSave": true,
and
"files.autoSave": "afterDelay", but files did not get formatted.

I looked into my settings.json and found this

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

and removing this fixed the auto-formatting for me :)

[lnicola]

@djc, @blitzerr is this working for you now?

(Marking S-actionable, if you look at this in the future and the OP hasn't answered, ping me so we can close it.)

[djc]

No, this is still not working for me. I have formatOnSave set to true, files.autoSave set to afterDelay (300ms) but files are not getting formatted automatically. I don't have the defaultFormatter config that Matthias found.

[Veykril]

Actually, it seems that this is a vscode specific problem... microsoft/vscode#45997
The docs for formatOnSave state:

  // Format a file on save. A formatter must be available, the file must not be saved after delay, and the editor must not be shutting down.
  "editor.formatOnSave": false,

https://code.visualstudio.com/docs/getstarted/settings
So autosaving after a delay does not trigger the formatter.

[mukundbhudia]

Maybe it should be this:

"[rust]": {
  "editor.defaultFormatter": "matklad.rust-analyzer"
}

with

"editor.formatOnSave": true,

all of which go in settings.json

[Oyami-Srk]

Perhaps "editor.formatOnSaveMode": "modificationsIfAvailable" or "editor.formatOnSaveMode": "modifications" has a conflict with auto-format of rust-analyzer. Setting it to file on rust specified settings solved this problem for me.

[bjorn3]

"editor.formatOnSaveMode": "modifications"

That one will definitively not work. Only nightly rustfmt supports range formatting and rust-analyzer doesn't implement support for using this mode.

[Oyami-Srk]

But `modificationsIfAvailable` won't fall to `file` if rustfmt is not available for modifications. You have to manually point out in rust settings to override the global which I assume that would format at least in `file` way. bjorn3 ***@***.***> 于 2021年10月14日周四 01:31写道：

…

"editor.formatOnSaveMode": "modifications" That one will definitively not work. Only nightly rustfmt supports range formatting and rust-analyzer doesn't implement support for using this mode. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#3256 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABU6KCIZ7HTUIU44GHPHZADUGW66VANCNFSM4KY6FOHQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[zydxhs]

"formatOnSave" also does not work when VSCode opens symlinked project. The "Rust Analyzer Client" output error info is:

INFO [3/3/2022, 9:26:04 AM]: Using server binary at /home/zhuyadong/.vscode-server/extensions/matklad.rust-analyzer-0.2.956/server/rust-analyzer
ERROR [3/3/2022, 9:26:04 AM]: Bootstrap error [Error: Failed to execute /home/zhuyadong/.vscode-server/extensions/matklad.rust-analyzer-0.2.956/server/rust-analyzer --version
	at Xb (/home/zhuyadong/.vscode-server/extensions/matklad.rust-analyzer-0.2.956/out/main.js:85:2121)
	at async Bb (/home/zhuyadong/.vscode-server/extensions/matklad.rust-analyzer-0.2.956/out/main.js:84:3252)
	at async Vm (/home/zhuyadong/.vscode-server/extensions/matklad.rust-analyzer-0.2.956/out/main.js:84:3083)
	at async Promise.all (index 0)]

[lnicola]

@zydxhs that's probably #11558

[pinkponk]

I have had problems when the auto format simply stops working and for me it was because I was using too long module statements e.g I was using a function without importing it:
egui::collapsing_header::CollapsingState::load_with_default_open()
but had to instead do:

use egui::collapsing_header;
CollapsingState::load_with_default_open()

in order for the auto formater to come alive again. Might be similar issues for some of you so I thought I might write it here.

[lnicola]

@pinkponk when this happens, try cargo fmt. If it doesn't work, it's a rustfmt bug.

[MolotovCherry]

This wasn't working for me. After going through my settings, I found
"editor.formatOnSaveMode": "modifications",

I changed it to
"editor.formatOnSaveMode": "file",
And everything started working

Can definitely confirm the other comment about this solution

[Rendez]

For me it was this setting that made it work:

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

[Veykril]

There seem to be working workarounds here and as this i a client issue in the first place I'll go ahead and close this