ruff/crates/ruff_server/tests at ff3bf583b28c455a19571a54cd4a4e2bc024b5b8 - mirrors/ruff

mirror of https://github.com/astral-sh/ruff.git synced 2025-08-31 07:37:38 +00:00

History

Jane Lewis b0731ef9cb `ruff server`: Support Jupyter Notebook (`.ipynb`) files (#11206 ) ## Summary Closes https://github.com/astral-sh/ruff/issues/10858. `ruff server` now supports `.ipynb` (aka Jupyter Notebook) files. Extensive internal changes have been made to facilitate this, which I've done some work to contextualize with documentation and an pre-review that highlights notable sections of the code. `.ipynb` cells should behave similarly to `.py` documents, with one major exception. The format command `ruff.applyFormat` will only apply to the currently selected notebook cell - if you want to format an entire notebook document, use `Format Notebook` from the VS Code context menu. ## Test Plan The VS Code extension does not yet have Jupyter Notebook support enabled, so you'll first need to enable it manually. To do this, checkout the `pre-release` branch and modify `src/common/server.ts` as follows: Before: ![Screenshot 2024-05-13 at 10 59 06 PM](`c6a3c604`-c405-4968-b8a2-5d670de89172) After: ![Screenshot 2024-05-13 at 10 58 24 PM](`94ab2e3d`-0609-448d-9c8c-cd07c69a513b) I recommend testing this PR with large, complicated notebook files. I used notebook files from [this popular repository](https://github.com/jakevdp/PythonDataScienceHandbook/tree/master/notebooks) in my preliminary testing. The main thing to test is ensuring that notebook cells behave the same as Python documents, besides the aforementioned issue with `ruff.applyFormat`. You should also test adding and deleting cells (in particular, deleting all the code cells and ensure that doesn't break anything), changing the kind of a cell (i.e. from markup -> code or vice versa), and creating a new notebook file from scratch. Finally, you should also test that source actions work as expected (and across the entire notebook). Note: `ruff.applyAutofix` and `ruff.applyOrganizeImports` are currently broken for notebook files, and I suspect it has something to do with https://github.com/astral-sh/ruff/issues/11248. Once this is fixed, I will update the test plan accordingly. --------- Co-authored-by: nolan <nolan.king90@gmail.com>	2024-05-21 22:29:30 +00:00
..
snapshots	`ruff server` - A new built-in LSP for Ruff, written in Rust (#10158 )	2024-03-08 20:57:23 -08:00
document.rs	`ruff server`: Support Jupyter Notebook (`*.ipynb`) files (#11206 )	2024-05-21 22:29:30 +00:00

ruff server: Support Jupyter Notebook (*.ipynb) files (#11206 )

## Summary

Closes https://github.com/astral-sh/ruff/issues/10858.

`ruff server` now supports `*.ipynb` (aka Jupyter Notebook) files.
Extensive internal changes have been made to facilitate this, which I've
done some work to contextualize with documentation and an pre-review
that highlights notable sections of the code.

`*.ipynb` cells should behave similarly to `*.py` documents, with one
major exception. The format command `ruff.applyFormat` will only apply
to the currently selected notebook cell - if you want to format an
entire notebook document, use `Format Notebook` from the VS Code context
menu.

## Test Plan

The VS Code extension does not yet have Jupyter Notebook support
enabled, so you'll first need to enable it manually. To do this,
checkout the `pre-release` branch and modify `src/common/server.ts` as
follows:

Before:
![Screenshot 2024-05-13 at 10 59
06 PM](c6a3c604-c405-4968-b8a2-5d670de89172)

After:
![Screenshot 2024-05-13 at 10 58
24 PM](94ab2e3d-0609-448d-9c8c-cd07c69a513b)

I recommend testing this PR with large, complicated notebook files. I
used notebook files from [this popular
repository](https://github.com/jakevdp/PythonDataScienceHandbook/tree/master/notebooks)
in my preliminary testing.

The main thing to test is ensuring that notebook cells behave the same
as Python documents, besides the aforementioned issue with
`ruff.applyFormat`. You should also test adding and deleting cells (in
particular, deleting all the code cells and ensure that doesn't break
anything), changing the kind of a cell (i.e. from markup -> code or vice
versa), and creating a new notebook file from scratch. Finally, you
should also test that source actions work as expected (and across the
entire notebook).

Note: `ruff.applyAutofix` and `ruff.applyOrganizeImports` are currently
broken for notebook files, and I suspect it has something to do with
https://github.com/astral-sh/ruff/issues/11248. Once this is fixed, I
will update the test plan accordingly.

---------

Co-authored-by: nolan <nolan.king90@gmail.com>

2024-05-21 22:29:30 +00:00

snapshots ruff server - A new built-in LSP for Ruff, written in Rust (#10158 ) 2024-03-08 20:57:23 -08:00

document.rs ruff server: Support Jupyter Notebook (*.ipynb) files (#11206 ) 2024-05-21 22:29:30 +00:00