feat: add hyperlink rendering

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

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`
 
 ## Style
 

src/ansi_formats.go

@@ -21,6 +21,7 @@ type ansiFormats struct {
 	colorTransparent      string
 	escapeLeft            string
 	escapeRight           string
+	hyperlink             string
 }
 
 func (a *ansiFormats) init(shell string) {
@@ -69,6 +70,7 @@ func (a *ansiFormats) init(shell string) {
 		a.escapeLeft = ""
 		a.escapeRight = ""
 	}
+	a.hyperlink = "\x1b]8;;%s\x1b\\%s\x1b]8;;\x1b\\"
 }
 
 func (a *ansiFormats) lenWithoutANSI(text string) int {

src/engine.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"strings"
 	"sync"
 	"time"
 )
@@ -82,6 +83,16 @@ func (e *engine) renderText(text string) {
 	if e.activeSegment.Background != "" {
 		defaultValue = fmt.Sprintf("<%s>\u2588</>", e.activeSegment.Background)
 	}
+
+	// hyperlink matching
+	results := findNamedRegexMatch("(?P<all>(?:\\[(?P<name>.+)\\])(?:\\((?P<url>.*)\\)))", text)
+	if len(results) > 0 {
+		// build hyperlink ansi
+		hyperlink := fmt.Sprintf(e.color.formats.hyperlink, results["url"], results["name"])
+		// replace original text by the new one
+		text = strings.Replace(text, results["all"], hyperlink, 1)
+	}
+
 	prefix := e.activeSegment.getValue(Prefix, defaultValue)
 	postfix := e.activeSegment.getValue(Postfix, defaultValue)
 	e.color.write(e.activeSegment.Background, e.activeSegment.Foreground, fmt.Sprintf("%s%s%s", prefix, text, postfix))
@@ -109,10 +120,9 @@ func (e *engine) renderBlockSegments(block *Block) string {
 		}
 		e.activeSegment = segment
 		e.endPowerline()
-		text := segment.stringValue
 		e.activeSegment.Background = segment.props.background
 		e.activeSegment.Foreground = segment.props.foreground
-		e.renderSegmentText(text)
+		e.renderSegmentText(segment.stringValue)
 	}
 	if e.previousActiveSegment != nil && e.previousActiveSegment.Style == Powerline {
 		e.writePowerLineSeparator(Transparent, e.previousActiveSegment.Background, true)
@@ -166,7 +176,7 @@ func (e *engine) render() {
 	e.write()
 }
 
-// debug will lool through your config file and output the timings for each segments
+// debug will loop through your config file and output the timings for each segments
 func (e *engine) debug() {
 	var segmentTimings []SegmentTiming
 	largestSegmentNameLength := 0
@@ -217,6 +227,7 @@ func (e *engine) debug() {
 		segmentName := fmt.Sprintf("%s(%t)", segment.name, segment.enabled)
 		e.renderer.print(fmt.Sprintf("%-*s - %3d ms - %s\n", largestSegmentNameLength, segmentName, duration, segment.stringValue))
 	}
+
 	fmt.Print(e.renderer.string())
 }
 

src/segment_path.go

@@ -44,23 +44,31 @@ func (pt *path) enabled() bool {
 }
 
 func (pt *path) string() string {
+	cwd := pt.env.getcwd()
+	var formattedPath string
 	switch style := pt.props.getString(Style, Agnoster); style {
 	case Agnoster:
-		return pt.getAgnosterPath()
+		formattedPath = pt.getAgnosterPath()
 	case AgnosterFull:
-		return pt.getAgnosterFullPath()
+		formattedPath = pt.getAgnosterFullPath()
 	case AgnosterShort:
-		return pt.getAgnosterShortPath()
+		formattedPath = pt.getAgnosterShortPath()
 	case Short:
 		// "short" is a duplicate of "full", just here for backwards compatibility
 		fallthrough
 	case Full:
-		return pt.getFullPath()
+		formattedPath = pt.getFullPath()
 	case Folder:
-		return pt.getFolderPath()
+		formattedPath = pt.getFolderPath()
 	default:
 		return fmt.Sprintf("Path style: %s is not available", style)
 	}
+
+	if pt.props.getBool(EnableHyperlink, false) {
+		return fmt.Sprintf("[%s](file://%s)", formattedPath, cwd)
+	}
+
+	return formattedPath
 }
 
 func (pt *path) init(props *properties, env environmentInfo) {

src/settings.go

@@ -14,6 +14,7 @@ type Settings struct {
 	ConsoleTitle         bool              `json:"console_title"`
 	ConsoleTitleStyle    ConsoleTitleStyle `json:"console_title_style"`
 	ConsoleTitleTemplate string            `json:"console_title_template"`
+	EnableHyperlink      bool              `json:"enable_hyperlink"`
 	Blocks               []*Block          `json:"blocks"`
 }
 
@@ -34,6 +35,8 @@ const (
 	Left BlockAlignment = "left"
 	// Right aligns right
 	Right BlockAlignment = "right"
+	// EnableHyperlink enable hyperlink
+	EnableHyperlink Property = "enable_hyperlink"
 )
 
 // Block defines a part of the prompt with optional segments

themes/schema.json

@@ -944,6 +944,12 @@
                     "title": "Enable the Mapped Locations feature",
                     "description": "Replace known locations in the path with the replacements before applying the style.",
                     "default": true
+                  },
+                  "enable_hyperlink": {
+                    "type": "string",
+                    "title": "Enable hyperlink",
+                    "description": "Displays an hyperlink for the current path",
+                    "default": false
                   }
                 }
               }