Add hyperlink support to fd #1571

tmccombs · 2024-06-08T21:34:52Z

Fixes: #1295
Fixes: #1563

sharkdp · 2024-06-09T06:42:28Z

Thank you! Should we maybe make this an option instead of a flag, to avoid future breaking changes in case we see the need for e.g. --color=never --hyperlink=always or potentially other ways of printing hyperlinks?

097115 · 2024-06-09T10:25:18Z

Something wrong happens if a filename contains non-latin characters.

The problem, is I based the code on the implementation in ripgrep. But while ripgrep is writing directly to the stream, I am using a Formatter, which means I have to write characters, not raw bytes. Thus we need to percent encode all non-ascii bytes (or we could switch to writing bytes directly, but that would be more complicated, and I think percent encoding is safer anyway).

097115 · 2024-06-10T05:16:18Z

@tmccombs This latest commit seems to fix the bug with non-latin chars, thanks :)

BuonOmo · 2024-06-20T06:39:38Z

doc/fd.1

+The value can be auto, always, or never.
+
+Currently, the default is "never", and if the option is used without an argument "auto" is
+used. In the future this may be changed to "auto" and "always".


Although I love OSC8 as well (thank you for the PR ❤️ ), I'm not sure they're so mainstream that we should go in that direction :/

My question is how do terminals that don't support it handle the sequence? If most terminals silently ignore unrecognized OSC sequences, then it probably doesn't hurt to emit it even if it isn't supported. We'll need to test that.

weston-terminal at least simply ignores the OSC 8 sequence.

BuonOmo

FWIW, LGTM!

The print separator change is quite nice as well, I hope it won't make too noise for the PR to be unchecked though :/ (please add links!)

tavianator · 2024-06-20T19:26:17Z

src/hyperlink.rs

+
+impl fmt::Display for PathUrl {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        write!(f, "file://{}", host())?;


Why do we need the hostname? Does file:///home/user/... not work?

It does. As long as fd is running on the same host as the terminal. Including the hostname is useful if you run the command over ssh or in a container or VM.

See https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#file-uris-and-the-hostname

tavianator · 2024-06-20T19:43:38Z

src/hyperlink.rs

+        #[cfg(windows)]
+        b'\\' => f.write_char('/'),
+        _ => {
+            write!(f, "%{:X}", byte)


RFC 3986 says that the byte 1 should become %01 not %1. But to avoid having to know that, maybe we could just use https://crates.io/crates/urlencoding?

Unfortanetely, I don't think that urlencoding would work, because it would percent encode "/", which isn't what we want.

When the first digit is 0

sharkdp

Thank you very much. Looks great.

dandavison · 2024-07-22T16:02:31Z

Hi, this is a great development, but I think that it would be very valuable to allow more customization of the format of the hyperlink. For example, in my case I'd like to be able to specify the protocol (e.g. vscode://file/... instead of file://). I think that we could re-use a lot of the design work (and some code maybe?) that was done for ripgrep in BurntSushi/ripgrep#2483.

Here's the current full text of the entry for --hyperlink-format=FORMAT in rg --help:

`rg --help` output

    --hyperlink-format=FORMAT
        Set the format of hyperlinks to use when printing results. Hyperlinks
        make certain elements of ripgrep's output, such as file paths,
        clickable. This generally only works in terminal emulators that support
        OSC-8 hyperlinks. For example, the format file://{host}{path} will emit
        an RFC 8089 hyperlink. To see the format that ripgrep is using, pass
        the --debug flag.
    Alternatively, a format string may correspond to one of the following
    aliases: default, none, file, grep+, kitty, macvim, textmate, vscode,
    vscode-insiders, vscodium. The alias will be replaced with a format
    string that is intended to work for the corresponding application.

    The following variables are available in the format string:

    {path}: Required. This is replaced with a path to a matching file. The
    path is guaranteed to be absolute and percent encoded such that it is
    valid to put into a URI. Note that a path is guaranteed to start with a
    /.

    {host}: Optional. This is replaced with your system's hostname. On
    Unix, this corresponds to calling gethostname. On Windows, this
    corresponds to calling GetComputerNameExW to fetch the system's
    "physical DNS hostname." Alternatively, if --hostname-bin was provided,
    then the hostname returned from the output of that program will be
    returned. If no hostname could be found, then this variable is replaced
    with the empty string.

    {line}: Optional. If appropriate, this is replaced with the line number
    of a match. If no line number is available (for example, if
    --no-line-number was given), then it is automatically replaced with the
    value 1.

    {column}: Optional, but requires the presence of {line}. If
    appropriate, this is replaced with the column number of a match. If no
    column number is available (for example, if --no-column was given),
    then it is automatically replaced with the value 1.

    {wslprefix}: Optional. This is a special value that is set to
    wsl$/WSL_DISTRO_NAME, where WSL_DISTRO_NAME corresponds to the value of
    the equivalent environment variable. If the system is not Unix or if
    the WSL_DISTRO_NAME environment variable is not set, then this is
    replaced with the empty string.

    A format string may be empty. An empty format string is equivalent to
    the none alias. In this case, hyperlinks will be disabled.

    At present, ripgrep does not enable hyperlinks by default. Users must
    opt into them. If you aren't sure what format to use, try default.

    Like colors, when ripgrep detects that stdout is not connected to a
    tty, then hyperlinks are automatically disabled, regardless of the
    value of this flag. Users can pass --color=always to forcefully emit
    hyperlinks.

    Note that hyperlinks are only written when a path is also in the output                                                                                                                    11:55:48 [409/3626]
    and colors are enabled. To write hyperlinks without colors, you'll need
    to configure ripgrep to not colorize anything without actually
    disabling all ANSI escape codes completely:

        --colors 'path:none' \
        --colors 'line:none' \
        --colors 'column:none' \
        --colors 'match:none'

    ripgrep works this way because it treats the --color flag as a proxy
    for whether ANSI escape codes should be used at all. This means that
    environment variables like NO_COLOR=1 and TERM=dumb not only disable
    colors, but hyperlinks as well. Similarly, colors and hyperlinks are
    disabled when ripgrep is not writing to a tty. (Unless one forces the
    issue by setting --color=always.)

    If you're searching a file directly, for example:

        rg foo path/to/file

    then hyperlinks will not be emitted since the path given does not
    appear in the output. To make the path appear, and thus also a
    hyperlink, use the -H/--with-filename flag.

    For more information on hyperlinks in terminal emulators, see:
    https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda

tmccombs · 2024-07-30T07:31:29Z

It's sort of possible to do that today using the --format option. That is, you could do something like:

fd --absolute-path --format $'\e]8;;vscode://file/{}\e\\{}\e]8;;\e\\' ...

I'm not completely opposed to implement multiple formats, but I didn't want to add that level of complexity in the initial implementation.

dandavison · 2024-07-30T12:12:37Z

Thanks @tmccombs, I've moved this discussion to the issue: #1563

tmccombs force-pushed the hyperlink branch from 9c40c25 to e9bd086 Compare June 8, 2024 21:36

This was referenced Jun 8, 2024

Show found files as hyperlinks just as ls does? #1295

Closed

Allow clicking on results in terminal to open folder or file viewer #1563

Closed

tmccombs force-pushed the hyperlink branch from e9bd086 to b49df1f Compare June 8, 2024 22:32

Add hyperlink support to fd

bd649e2

Fixes: sharkdp#1295 Fixes: sharkdp#1563

tmccombs force-pushed the hyperlink branch from b49df1f to bd649e2 Compare June 9, 2024 05:39

tmccombs added 2 commits June 10, 2024 00:55

Fix test on windows

d8d2c37

Change --hyperlink to be an option instead of a flag

b1f7aef

tmccombs force-pushed the hyperlink branch from 0c36e52 to b1f7aef Compare June 11, 2024 06:38

BuonOmo reviewed Jun 20, 2024

View reviewed changes

BuonOmo approved these changes Jun 20, 2024

View reviewed changes

tavianator reviewed Jun 20, 2024

View reviewed changes

Fix percent encoding

45d6fbb

When the first digit is 0

sharkdp approved these changes Jul 16, 2024

View reviewed changes

tmccombs merged commit cfced97 into sharkdp:master Jul 16, 2024
18 checks passed

tmccombs deleted the hyperlink branch July 16, 2024 21:57

dandavison mentioned this pull request Jul 30, 2024

Format results as hyperlinks using common editor protocols and custom protocols #1597

Open

dandavison mentioned this pull request Sep 4, 2024

Add ripgrep, fd, and fzf Alhadis/OSC8-Adoption#15

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hyperlink support to fd #1571

Add hyperlink support to fd #1571

tmccombs commented Jun 8, 2024

sharkdp commented Jun 9, 2024

097115 commented Jun 9, 2024

097115 commented Jun 10, 2024

BuonOmo Jun 20, 2024

tmccombs Jun 20, 2024

tmccombs Jun 24, 2024

BuonOmo left a comment

tavianator Jun 20, 2024

tmccombs Jun 20, 2024

tavianator Jun 20, 2024

tmccombs Jun 24, 2024

sharkdp left a comment

dandavison commented Jul 22, 2024 •

edited

Loading

tmccombs commented Jul 30, 2024

dandavison commented Jul 30, 2024

Add hyperlink support to fd #1571

Add hyperlink support to fd #1571

Conversation

tmccombs commented Jun 8, 2024

sharkdp commented Jun 9, 2024

097115 commented Jun 9, 2024

097115 commented Jun 10, 2024

BuonOmo Jun 20, 2024

Choose a reason for hiding this comment

tmccombs Jun 20, 2024

Choose a reason for hiding this comment

tmccombs Jun 24, 2024

Choose a reason for hiding this comment

BuonOmo left a comment

Choose a reason for hiding this comment

tavianator Jun 20, 2024

Choose a reason for hiding this comment

tmccombs Jun 20, 2024

Choose a reason for hiding this comment

tavianator Jun 20, 2024

Choose a reason for hiding this comment

tmccombs Jun 24, 2024

Choose a reason for hiding this comment

sharkdp left a comment

Choose a reason for hiding this comment

dandavison commented Jul 22, 2024 • edited Loading

tmccombs commented Jul 30, 2024

dandavison commented Jul 30, 2024

dandavison commented Jul 22, 2024 •

edited

Loading