Ipe as a VS Code extension, enabling collaborative editing of Ipe documents

[hildogjr]

Nowadays there is a online version of Ipe https://ipe-web.otfried.org/index.html

Is it possible to use this compilation to create a VSCode / VSCodium extension of IPE and publish at https://open-vsx.org/?

DrawIO madethis in past: from a standalone executable to webpage (https://www.drawio.com/) and to offline extension (https://open-vsx.org/extension/hediet/vscode-drawio).

[otfried]

Actually I have already built Ipe as an Electron app - that is exactly the same technology used by VSCode extensions (because VSCode itself is an Electron app): https://github.com/otfried/ipe/blob/master/.github/workflows/electron.yml

Unfortunately right now building Ipe Electron is broken, but the errors seem to be minor - I'll try to look into this when I have a bit more time.

I hope to really release Ipe 7.3.1 with the Web Edition and the Electron Edition before the end of the year.

Do you see any advantage creating a VSCode extension instead of a stand-alone Electron version?

[otfried]

I have looked at this briefly, and it is indeed not hard to build a VS Code extension that shows Ipe inside a webview. Ipe is fully functional, what is missing is only the integration with VS Code - that is, opening files from VS Code, saving, and of course running latex.

It looks weird seeing the Ipe menu bar inside a VS Code window, while the VS Code menu bar remains on the top - but in fact draw.io does it exactly the same way. Another issue is that Ipe's keyboard shortcuts will only work while focus is inside the Ipe window (not a real problem) - but that VS Code globally intercepts several keys. In particular F1 and F5 will not be usable in Ipe, so we'll have to find a different way of activating the different snapping modes.

What is very exciting about Ipe as a VS Code extension, however, is that VS Code has Live sharing, and it should not be too hard to implement the hooks needed to make this work in Ipe as well. As far as I can see, right now this is the easiest way to get to a version of Ipe that allows users to collaborate on a common document.

The implementation would be quite similar to draw.io's:

• https://github.com/hediet/vscode-drawio

Documentation about VS Code extensions:

• The extension API: https://code.visualstudio.com/api

[hildogjr]

Do you see any advantage creating a VSCode extension instead of a stand-alone Electron version?

Having used Ipe for about a decade, I'm familiar with the compilation and installation process in Linux. But for new users, removing the need to compile from source would make it way easier to jump in.

Plus, even in (my own) setup—where I develop software/code/simulation and already compile academic LaTeX articles directly in VSCode/VSCodium—it’d be super convenient to have Draw.io, Ipe, and LaTeX all working together in one place. Since both approaches essentially rely on the same Electron framework, having a VSCode/VSCOdium extension seems like a help do get more users.

[otfried]

Here is a beta-version of a VS Code extension:

Ipe-7.3.1-beta1.zip

[hildogjr]

I got this error log when tried to install:

Installing extensions...
Error: Unable to install extension 'otfried.ipe' as it is not compatible with VSCodium '1.135.06055'.
    at Ll.install (file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:60:40066)
    at process.processTicksAndRejections (node:internal/process/task_queues:104:5)
    at async or.installVSIX (file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:53:1097)
    at async file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:52:2260
    at async Promise.all (index 0)
    at async or.installExtensions (file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:52:2197)
    at async file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:89:62479
    at async Module.K6 (file:///usr/share/codium/resources/app/out/vs/code/node/cliProcessMain.js:89:66526)
    at async Vn (file:///usr/share/codium/resources/app/out/cli.js:29:17861)
Failed Installing Extensions: file:///home/h/Downloads/Ipe-7.3.1-beta1.vsix

I am also adding the verbose log.

verbose_trace.log

[otfried]

I had set the minimum version to 1.137, so it doesn't want to install on 1.135. I guess I should change that.

[hildogjr]

VSCodium, Antigravity... other IDEs based on VSCode OSS part usually are few (2) subversion behind and, due Microsoft restrictions, just allow extensions publish on open market (https://open-vsx.org/) instead of Microsoft official repository (https://marketplace.visualstudio.com/VSCode).

[otfried]

Here's a new version that's set to a minimum requirement of 1.130:

Ipe-7.3.1-beta2.zip

[hildogjr]

Installation successful

codium --install-extension Ipe-7.3.1-beta2.vsix 
Installing extensions...
Extension 'Ipe-7.3.1-beta2.vsix' was successfully installed.
(node:12171) [DEP0169] DeprecationWarning: `url.parse()` behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for `url.parse()` vulnerabilities.
(Use `codium --trace-deprecation ...` to show where the warning was created)

I miss some shortcut / list of action in the menu

As Draw.IO have

Because, I usually save my Ipe drawings in PDF format and I could not open them direct using the developed extension.

Also some integration with the settings dialog:

[otfried]

I had no difficulty opening Ipe PDF-Documents: Just open them normally (Ctrl+O), and they will appear as text documents. But at the top right there is a selector where you can switch between "text editor" and "Ipe". You can also set the default to Ipe, so then the next time you open a PDF file, it will appear with the Ipe UI immediately.

[hildogjr]

Thanks. It is working as expected, I am trying just with local Latex compilation. Questions:

1. Is it possible to follow the local theme (in my case dark, as the standalone Ipe does)?
2. Where is locate the configs.lua file?

[otfried]

Help ➤ Show configuration will tell you the location of the customization file: it's the first line under "Ipelets". It's normally ~/.config/ipe/customization.lua.

Dark mode is not yet implemented, but that will come.

[hildogjr]

Help ➤ Show configuration will tell you the location of the customization file: it's the first line under "Ipelets". It's normally ~/.config/ipe/customization.lua.

Dark mode is not yet implemented, but that will come.

Prefect!

Ipe preferences are changed by creating a Lua source file.

You can find the available options in ['prefs.lua'](https://github.com/otfried/ipe/tree/master/src/ipe/lua/prefs.lua), ['shortcuts.lua'](https://github.com/otfried/ipe/tree/master/src/ipe/lua/shortcuts.lua), and ['mouse.lua'](https://github.com/otfried/ipe/tree/master/src/ipe/lua/mouse.lua).

Create or edit the file '$HOME/.config/ipe/customization.lua' and place your changes in this file.

More details are in the [Manual](https://otfried.github.io/ipe/80_advanced.html#customizing-ipe).

I just copied my personal configuration lines of prefs.lua to the indicated customization.lua.

As far I tested, the VSCodium extension have same behavior of the standalone Ipe.

About the menu style, it something of the Electron library or can we make the visual more like the standalone Ipe? (menu spacers, button margin, ...)

Ipe VSCode extension

Ipe standalone

Draw.IO VSCode extension (as example keep the button design more smooth)