1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
use std::borrow::Cow;
use std::str::FromStr;
use lazy_static::lazy_static;
use regex::{Captures, Regex};
use crate::config::Config;
use crate::features::OptionValueFunction;
use crate::git_config::{GitConfig, GitConfigEntry, GitRemoteRepo};
pub fn make_feature() -> Vec<(String, OptionValueFunction)> {
builtin_feature!([
(
"hyperlinks",
bool,
None,
_opt => true
)
])
}
pub fn format_commit_line_with_osc8_commit_hyperlink<'a>(
line: &'a str,
config: &Config,
) -> Cow<'a, str> {
if let Some(commit_link_format) = &config.hyperlinks_commit_link_format {
COMMIT_LINE_REGEX.replace(line, |captures: &Captures| {
let commit = captures.get(2).unwrap().as_str();
format_osc8_hyperlink(&commit_link_format.replace("{commit}", commit), commit)
})
} else if let Some(GitConfigEntry::GitRemote(GitRemoteRepo::GitHubRepo(repo))) =
config.git_config.as_ref().and_then(get_remote_url)
{
COMMIT_LINE_REGEX.replace(line, |captures: &Captures| {
format_commit_line_captures_with_osc8_commit_hyperlink(captures, &repo)
})
} else {
Cow::from(line)
}
}
fn get_remote_url(git_config: &GitConfig) -> Option<GitConfigEntry> {
git_config
.repo
.as_ref()?
.find_remote("origin")
.ok()?
.url()
.and_then(|url| {
GitRemoteRepo::from_str(url)
.ok()
.map(GitConfigEntry::GitRemote)
})
}
/// Create a file hyperlink to `path`, displaying `text`.
pub fn format_osc8_file_hyperlink<'a>(
relative_path: &'a str,
line_number: Option<usize>,
text: &str,
config: &Config,
) -> Cow<'a, str> {
if let Some(cwd) = &config.cwd_of_user_shell_process {
let absolute_path = cwd.join(relative_path);
let mut url = config
.hyperlinks_file_link_format
.replace("{path}", &absolute_path.to_string_lossy());
if let Some(n) = line_number {
url = url.replace("{line}", &format!("{}", n))
} else {
url = url.replace("{line}", "")
};
Cow::from(format_osc8_hyperlink(&url, text))
} else {
Cow::from(relative_path)
}
}
fn format_osc8_hyperlink(url: &str, text: &str) -> String {
format!(
"{osc}8;;{url}{st}{text}{osc}8;;{st}",
url = url,
text = text,
osc = "\x1b]",
st = "\x1b\\"
)
}
lazy_static! {
static ref COMMIT_LINE_REGEX: Regex = Regex::new("(.* )?([0-9a-f]{8,40})(.*)").unwrap();
}
fn format_commit_line_captures_with_osc8_commit_hyperlink(
captures: &Captures,
github_repo: &str,
) -> String {
let commit = captures.get(2).unwrap().as_str();
format!(
"{prefix}{osc}8;;{url}{st}{commit}{osc}8;;{st}{suffix}",
url = format_github_commit_url(commit, github_repo),
commit = commit,
prefix = captures.get(1).map(|m| m.as_str()).unwrap_or(""),
suffix = captures.get(3).unwrap().as_str(),
osc = "\x1b]",
st = "\x1b\\"
)
}
fn format_github_commit_url(commit: &str, github_repo: &str) -> String {
format!("https://github.com/{}/commit/{}", github_repo, commit)
}
#[cfg(test)]
pub mod tests {
#[cfg(not(target_os = "windows"))]
pub mod unix {
use std::path::PathBuf;
use super::super::*;
use crate::tests::integration_test_utils;
fn assert_file_hyperlink_matches(
relative_path: &str,
expected_hyperlink_path: &str,
config: &Config,
) {
let link_text = "link text";
assert_eq!(
format_osc8_hyperlink(
&PathBuf::from(expected_hyperlink_path).to_string_lossy(),
link_text
),
format_osc8_file_hyperlink(relative_path, None, link_text, config)
)
}
#[test]
fn test_relative_path_file_hyperlink_when_not_child_process_of_git() {
// The current process is not a child process of git.
// Delta receives a file path 'a'.
// The hyperlink should be $cwd/a.
let mut config = integration_test_utils::make_config_from_args(&[
"--hyperlinks",
"--hyperlinks-file-link-format",
"{path}",
]);
config.cwd_of_user_shell_process = Some(PathBuf::from("/some/cwd"));
assert_file_hyperlink_matches("a", "/some/cwd/a", &config)
}
#[test]
fn test_relative_path_file_hyperlink_when_child_process_of_git() {
// The current process is a child process of git.
// Delta receives a file path 'a'.
// We are in directory b/ relative to the repo root.
// The hyperlink should be $repo_root/b/a.
let mut config = integration_test_utils::make_config_from_args(&[
"--hyperlinks",
"--hyperlinks-file-link-format",
"{path}",
]);
config.cwd_of_user_shell_process = Some(PathBuf::from("/some/repo-root/b"));
assert_file_hyperlink_matches("a", "/some/repo-root/b/a", &config)
}
}
}
|
