Official solution for custom links (regexp)

[afska]

Hi. Thanks for this great project. I wanted to ask if we could get an official solution to register links with any format.

Like https://github.com/LabhanshAgrawal/xterm-link-provider but... official 😅 The problem with that project is that it's not updated anymore, it uses an old Xtermjs version and it has some issues when handling line breaks & emojis (which I attempt to solve in that PR) but also incompatibilities with addon-fit (like links not formatting well if they end in the last character of a line).

I ask primarily because maybe you have a more generic solution working and it'd be a matter of just exposing it. I think a lot of users will find it useful!

[jerch]

Isn't that basically the same as the web-links addon? Would the addon's API do for you?

Edit: Regarding your index issues in your PR - the index buffer mapping got reworked in the addon, as the old code (also partially used by xterm-link-provider) contained wrong assumptions about char progression on the terminal buffer.

[Tyriar]

Specifically this part of the API that lets you give your own regex:

xterm.js/addons/addon-web-links/typings/addon-web-links.d.ts

Lines 48 to 51 in 41e8ae3

	/**
	* A callback to use instead of the default one.
	*/
	urlRegex?: RegExp;

[afska]

Oh, cool, thanks for the help! I've used WebLinkProvider directly and it worked, and fixed the issues I was having with link parsing. I picked the provider and not the addon because I need to add different link providers and be able to dispose them.

The only issue I had was that this provider assumes the regex has to be an URL. It makes sense, I guess that's why it's called web link provider, heh. But:

In my use case, users are able to create custom links like file paths or even words/phrases that point to a dictionary. Removing that if made it possible. Since it was an easy solution, maybe that could be configurable? It would allow more flexible usages of the library like mine.

[Tyriar]

I'm not opposed to making that callback configurable, maybe by passing a custom callback to do the validation instead?

[afska]

Yeah, I think that'd be great!

[afska]

Can addons be added/disabled at any time? If not, would it be a good idea to also export WebLinkProvider in the library to allow this? (so users can call the dispose() method)