Commands to convert between .ipynb and .qmd

[seeM]

Closes #6.

This PR adds two commands to convert between .ipynb and .qmd using the quarto convert CLI. The motivation is to ease the onboarding process for Positron users coming from Jupyter Notebooks who are interested in trying out Quarto, and vice versa (posit-dev/positron#11865).

Both commands are available in the command palette and in the UI:

• quarto.convertToIpynb: available in source and visual editor overflow menus, under a new group at the bottom
• quarto.convertToQmd: available in notebook editor overflow menu (both VS Code notebook editor and Positron notebook editor), under a new group at the bottom

The commands follow the same process:

1. Save the document
2. Check if converting would overwrite a file and prompt the user with a modal dialogue
3. Convert the document
4. Show any tidied up CLI errors
5. Open the converted document

Tests are included.

In future, I plan to add a command to Positron tentatively named quarto.initializeFromIpynb that the quarto.convertToQmd calls before opening the created .qmd file to set the kernel binding and fill the output cache using the original .ipynb file for a more seamless transition.

[juliasilge]

This is looking great! I have three questions/thoughts:

• Can we improve how error messages get surfaced to the user in terms of escaping? For example, if I have a Quarto file like this:

---
title: "unclosed
format: html
---

content

And I run the new command, I get this popup, which is not ideal:

• When I convert a .qmd to an .ipynb, it always opens up the new file in a regular text editor for the JSON, not a notebook editor:

Can we open the new .ipynb files in the default notebook editor the user has configured? Either the legacy one or the new Positron notebook editor?

• Can you update the CHANGELOG with info on this new feature?

[seeM]

Thanks, great catches.

1. The error message now shows only the initial message, and the user can click the Show Output button to see the full error with stack trace (375790c)

   

2. Now uses the vscode.open command so it uses the default editor for the file extension, tested with positron.notebook.enabled on and off (7a3cd5a)

3. Updated the changelog (b24fdb2)

[juliasilge]

This is looking good and is ready to merge! 🙌

I want to highlight that if we start sticking a button for this on files in Positron, we are going to come up hard against some of what doesn't work well with quarto convert. There are a bunch of situations where it doesn't work well, but here is one example.

Make an R notebook:

Convert and you get this:

---
jupyter: python3
---

Here is my great notebook! It will use janitor 🧼🧹

```{python}
library(tidyverse)
library(janitor)

gapminder::gapminder |> 
  clean_names() |> 
  drop_na()
```

This isn't a problem with this PR but with quarto convert but we will want to be very careful about where we surface this functionality with a button. We want to only put it somewhere that we think it will work well. Maybe no R? And maybe no .qmd files, as the conversion from .qmd to .ipynb is worse than the other way IMO.

[seeM]

@juliasilge interesting. What do you think about us fixing those sorts of issues if they come up?

[juliasilge]

@seeM Those would need to be fixed in the core of the Quarto CLI, not the extension:

https://github.com/quarto-dev/quarto-cli/issues?q=is%3Aissue%20state%3Aopen%20%22quarto%20convert%22

You are advocating we fix them in the Quarto CLI?

quarto convert is broken enough in enough situations that I don't think we can put a button on, say, a .qmd file with R code. Please try it out and see what I mean! I think we'll do better contributing a button in a situation where we think it will work (like an .ipynb that uses a Python kernel).

[juliasilge]

You can read some more background here: https://github.com/orgs/quarto-dev/discussions/9463

[cscheid]

(Just for everyone's awareness, we definitely want to fix these issues; Wasim and I are meeting early next week about this.)