Format on save for a notebook

[rchiodo]

Formatting with 'Format Cell' and 'Format Notebook' works but saving a notebook does not apply the formatters to each cell like a normal file would.

Example notebook cell that would be formatted if it was python:

\





print("hello, world")

# output


print("hello, world")

[vscodebot]

(Experimental duplicate detection)
Thanks for submitting this issue. Please also check if it is already covered by an existing one, like:

• Also save before format on save. (#112585)
• Code is always formatted on save, even with option explicitly disabled (#119893)

[rebornix]

I'm wondering if it's something we can benefit from the file/workingCopy service.

[jucor]

If that makes it easier, black now supports formatting .ipynb files natively, like it supports .py files.

[NickCrews]

I'd also love format on save for notebooks. As mentioned above, I can use black **/*.ipynb and it works great (you need to install black with the jupyter extra, eg as python -m pip install black[jupyter]), but I'm now just banging my head against the wall trying to get this to run automatically...

[janosh]

@NickCrews There is "editor.codeActionsOnSave" but it doesn't allow running arbitrary shell commands (for security reasons?) so you'd need to install an extension like Run On Save and get it call to black path/to/file.ipynb on save events.

Sadly even that doesn't work atm since VS Code does not yet expose lifecycle events for notebooks. The issues to upvote for that are

• Feature request: Support actions on saving Jupyter Notebooks emeraldwalk/vscode-runonsave#57
• Improve workspace API for Notebook lifecycle to support (at least) saving events #130799

If both get implemented, you should be able to add this to your settings to auto-format Jupyter notebooks:

"emeraldwalk.runonsave": {
  "commands": [
    {
      "match": "\\.ipynb$",
      "cmd": "black ${file}"
    }
  ]
}

[jrieken]

same/related to #130799

[rebornix]

This can now be turned on by setting "notebook.formatOnSave.enabled": true.