feat: hyperlink support in engine + hyperlink for path segment #307

lnu · 2021-01-02T10:57:49Z

Prerequisites

I have read and understand the CONTRIBUTING guide
The commit message follows the conventional commits guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Description

Hyperlink in git and path segment. Supported in windows terminal 1.5(in preview now and available this month for the stable one)

lnu · 2021-01-02T11:01:58Z

Work in progress. First draft to see how it works. I have to check how to integrate this cleanly.

JanDeDobbeleer · 2021-01-02T11:07:12Z

The goal is that you can click the branch/tag/commit and link to the repo?

lnu · 2021-01-02T11:48:10Z

The goal is that you can click the branch/tag/commit and link to the repo?

Yes it's a first draft to see how it looks like.
Right now the ansi sequence is embedded in the segment for testing purpose. I was thinking of using the markdown syntax for url to decouple the ansi rendering from the segment. I have a more or less working regex but it's not easy to cover all scenarios.

src/segment_git.go

tradiff · 2021-01-02T15:23:26Z

Supported in windows terminal 1.5(in preview now and available this month for the stable one)

BTW I'm using windows terminal 1.4.3243.0 and the clickable link works for me ¯\_(ツ)_/¯

src/segment_git.go

lnu · 2021-01-05T12:41:48Z

I still have an issue for path not rendered correctly when mapped_locations is used and a unicode character is set.
Example:

{
          "type": "path",
          "style": "powerline",
          "powerline_symbol": "\uE0B0",
          "foreground": "#ffffff",
          "background": "#ff479c",
          "properties": {
            "prefix": " \uE5FF ",
            "style": "full",
            "mapped_locations": [
              ["D:\\dev", "\uf962 "]
            ],
            "mapped_locations_enabled": true,
            "enable_hyperlink": true
          }
}

rendering:

With something else:

I think it can be related to that windows terminal issue: microsoft/terminal#3546

lnu · 2021-01-05T12:46:27Z

and support for opening uri is coming:microsoft/terminal#7526
we're going too fast 🤣

to track hyperlink progress: microsoft/terminal#5001

lnu · 2021-01-05T12:55:40Z

And to test hyperlink in the terminal:
printf '\e]8;;https://github.com/lnu/oh-my-posh3.git\e\\main\e]8;;\e\\'

JanDeDobbeleer · 2021-01-05T13:31:44Z

@lnu I was looking for that unicode bug the other day. Sometimes I think this whole repo is "too soon" for MS as we're constantly battling with incomplete features whereas users expect all of this to "just work". Or, we're right on time and will provide appropriate focus 😅

lnu · 2021-01-06T14:35:48Z

tested in gnome terminal and everything works(uri + http), and no glitch:

src/segment_git.go

JanDeDobbeleer · 2021-01-09T14:31:12Z

@lnu I would then maybe, for the sake of simplicity, only limit to the engine and path segment for 1. Leave git on a separate track.

src/ansi_formats.go

src/engine.go

src/settings.go

lnu · 2021-01-09T21:51:41Z

Still have to change the call in engine.go to generateHyperlink. Calling through color is a bit strange.

JanDeDobbeleer · 2021-01-10T11:27:08Z

Calling through color is a bit strange

I agree, but ansi_formats.go makes sense.

JanDeDobbeleer

What I'm missing is an addition to the docs about this like colors. Because I can create a text segment/prefix/postfix, that contains a link which will be rendered when hyperlinks are enabled.

lnu · 2021-01-10T17:03:23Z

What I'm missing is an addition to the docs about this like colors. Because I can create a text segment/prefix/postfix, that contains a link which will be rendered when hyperlinks are enabled.

Yes but be careful that right now the engine replaces only hyperlink in segment text, not prefix or postfix.

JanDeDobbeleer · 2021-01-10T17:08:40Z

Yes but be careful that right now the engine replaces only hyperlink in segment text, not prefix or postfix.

True. Which is fine I guess, this needs to be more contextual anyways. It's not because we can that we should.

An hyperlink can be added using markdown syntax and will be detected by the engine. Initial implementation for path segments.

JanDeDobbeleer · 2021-01-12T18:00:05Z

docs/docs/segment-path.md

@@ -37,6 +37,7 @@ Display the current path.
 is set to `true`)
 - mapped_locations_enabled: `boolean` - replace known locations in the path with the replacements before applying the
 style. defaults to `true`
+- enable_hyperlink: `boolean` - displays an hyperlink for the path - defaults to `false`


Can't believe I missed this, do we want to keep it at this level or higher up at Settings?

Now, the engine detects url from any segments. Hyperlink can be enabled/disabled for each segment and it takes care of rendering the text or the url markdown.
On the other side, it could be enabled at global level and implying that all segments supporting url will render them.
Both have their pros and cons.
It’s a matter of taste :).

I believe both can be an option, but let's keep it like this for now. Amazing work.

imba-tjd · 2021-01-13T03:38:40Z

docs/docs/configuration.md

+
+#### Supported terminals
+
+- [Terminal list](thttps://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)


fixed, thx.

lnu force-pushed the feat/hyperlink branch 2 times, most recently from 5e00ed6 to 455d5fa Compare January 2, 2021 11:00

lnu force-pushed the feat/hyperlink branch from 455d5fa to a9ece8b Compare January 2, 2021 11:14

lnu force-pushed the feat/hyperlink branch from effc79d to 2000249 Compare January 2, 2021 12:13

tradiff reviewed Jan 2, 2021

View reviewed changes