<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/hyperlink_rules.md - fork/wezterm @ termwiz-0.23.0</title>
<meta name="description" content="docs/config/lua/config/hyperlink_rules.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:title" content="docs/config/lua/config/hyperlink_rules.md - fork/wezterm @ termwiz-0.23.0">
<meta property="og:description" content="docs/config/lua/config/hyperlink_rules.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.0" data-tip="958804c8ac16b750954b3bcaaf847e7498cd2205">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="11c4b11669d9ce23d51afaf286b5383fbdc9794f">s,wez/wezterm,wezterm/wezterm,</span><span class="snapshot-sha sha" data-commit="11c4b11669d9ce23d51afaf286b5383fbdc9794f">11c4b1166</span><time datetime="2025-02-07T13:08:01-07:00" title="2025-02-07 13:08:01 -0700">2025-02-07</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.0</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/config/">config</a> / <span class="cur">hyperlink_rules.md</span></nav>
<span class="view-stats"><span>4.1 KiB</span><span>120 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/3689e0f687df8c53316cfe10e561182e71585d61/docs/config/lua/config/hyperlink_rules.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><hr />
<p>tags:</p>
<ul>
<li>hyperlink</li>
</ul>
<hr />
<h1><code>hyperlink_rules</code></h1>
<p>Defines rules to match text from the terminal output and generate
clickable links.</p>
<p>The value is a list of rule entries. Each entry has the following fields:</p>
<ul>
<li><code>regex</code> - the regular expression to match (see supported <a href="https://docs.rs/regex/latest/regex/#syntax">Regex syntax</a>)</li>
<li><code>format</code> - Controls which parts of the regex match will be used to form the link.
Must have a <code>prefix:</code> signaling the protocol type (e.g., <code>https:</code>/<code>mailto:</code>),
which can either come from the regex match or needs to be explicitly added.
The format string can use placeholders like <code>$0</code>, <code>$1</code>, <code>$2</code> etc. that will be replaced
with that numbered capture group.  So, <code>$0</code> will take the entire
region of text matched by the whole regex, while <code>$1</code> matches out
the first capture group.  In the example below, <code>mailto:$0</code> is
used to prefix a protocol to the text to make it into an URL.</li>
</ul>
<p>{{since('20230320-124340-559cb7b0', outline=True)}}
* <code>highlight</code> - specifies the range of the matched text that should be
highlighted/underlined when the mouse hovers over the link.  The value is
a number that corresponds to a capture group in the regex.  The default
is <code>0</code>, highlighting the entire region of text matched by the regex.  <code>1</code>
would be the first capture group, and so on.</p>
<p>{{since('20230408-112425-69ae8472', outline=True)}}
The regex syntax now supports backreferences and look around assertions.
See <a href="https://docs.rs/fancy-regex/latest/fancy_regex/#syntax">Fancy Regex Syntax</a>
for the extended syntax, which builds atop the underlying
<a href="https://docs.rs/regex/latest/regex/#syntax">Regex syntax</a>.
In prior versions, only the base
<a href="https://docs.rs/regex/latest/regex/#syntax">Regex syntax</a> was supported.</p>
<p>Assigning <code>hyperlink_rules</code> overrides the built-in default rules.</p>
<p>The default value for <code>hyperlink_rules</code> can be retrieved using
<a href="/fork/wezterm/ref/termwiz-0.23.0/blob/docs/config/lua/wezterm/default_hyperlink_rules.md">wezterm.default_hyperlink_rules()</a>,
and is shown below:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v> = <a-cr>{</a-cr>
  <a-c>-- Matches: a URL in parens: (URL)</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;\\((\\w+://\\S+)\\)&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;$1&#39;</a-s><a-p>,</a-p>
    <a-v>highlight</a-v> = <a-n>1</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Matches: a URL in brackets: [URL]</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;\\[(\\w+://\\S+)\\]&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;$1&#39;</a-s><a-p>,</a-p>
    <a-v>highlight</a-v> = <a-n>1</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Matches: a URL in curly braces: {URL}</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;\\{(\\w+://\\S+)\\}&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;$1&#39;</a-s><a-p>,</a-p>
    <a-v>highlight</a-v> = <a-n>1</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Matches: a URL in angle brackets: &lt;URL&gt;</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;&lt;(\\w+://\\S+)&gt;&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;$1&#39;</a-s><a-p>,</a-p>
    <a-v>highlight</a-v> = <a-n>1</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Then handle URLs not wrapped in brackets</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;\\b\\w+://\\S+[)/a-zA-Z0-9-]+&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;$0&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- implicit mailto link</a-c>
  <a-cr>{</a-cr>
    <a-v>regex</a-v> = <a-s>&#39;\\b\\w+@[\\w-]+(\\.[\\w-]+)+\\b&#39;</a-s><a-p>,</a-p>
    <a-v>format</a-v> = <a-s>&#39;mailto:$0&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>!!! note
In quoted Lua string literals the backslash character must be
quoted even if the following character isn't meaningful to Lua
when quoted by a backslash. That means that you'll always want to
double it up as <code>\\</code> when using it in a regex string.</p>
<pre><code>Alternatively, you can use the alternative string literal
syntax; the following two examples are equivalent:

```lua
regex = [[\b[tT](\d+)\b]]
```

```lua
regex = '\\b[tT](\\d+)\\b'
```
</code></pre>
<p>Some other examples include:</p>
<pre class="language-lua"><a-c>-- Use the defaults as a base</a-c>
<a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>default_hyperlink_rules</a-f><a-p>()</a-p>

<a-c>-- make task numbers clickable</a-c>
<a-c>-- the first matched regex group is captured in $1.</a-c>
<a-v>table</a-v><a-p>.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v><a-p>,</a-p> <a-cr>{</a-cr>
  <a-v>regex</a-v> = <a-s>[[\b[tt](\d+)\b]]</a-s><a-p>,</a-p>
  <a-v>format</a-v> = <a-s>&#39;https://example.com/tasks/?t=$1&#39;</a-s><a-p>,</a-p>
<a-cr>}</a-cr><a-p>)</a-p>

<a-c>-- make username/project paths clickable. this implies paths like the following are for github.</a-c>
<a-c>-- ( &quot;nvim-treesitter/nvim-treesitter&quot; | wbthomason/packer.nvim | wezterm/wezterm | &quot;wezterm/wezterm.git&quot; )</a-c>
<a-c>-- as long as a full url hyperlink regex exists above this it should not match a full url to</a-c>
<a-c>-- github or gitlab / bitbucket (i.e. https://gitlab.com/user/project.git is still a whole clickable url)</a-c>
<a-v>table</a-v><a-p>.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v><a-p>,</a-p> <a-cr>{</a-cr>
  <a-v>regex</a-v> = <a-s>[[[&quot;]?([\w\d]{1}[-\w\d]+)(/){1}([-\w\d\.]+)[&quot;]?]]</a-s><a-p>,</a-p>
  <a-v>format</a-v> = <a-s>&#39;https://www.github.com/$1/$3&#39;</a-s><a-p>,</a-p>
<a-cr>}</a-cr><a-p>)</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">  <a-p>-</a-p> <a-s>hyperlink</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>#</a-p> <a-tt>`hyperlink_rules`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Defines rules to match text from the terminal output and generate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">clickable links.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">The value is a list of rule entries. Each entry has the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`regex` - the regular expression to match (see supported [Regex syntax](https://docs.rs/regex/latest/regex/#syntax))</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>* </a-p>`format` - Controls which parts of the regex match will be used to form the link.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>  </a-p>Must have a `prefix:` signaling the protocol type (e.g., `https:`/`mailto:`),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>  </a-p>which can either come from the regex match or needs to be explicitly added.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>  </a-p>The format string can use placeholders like `$0`, `$1`, `$2` etc. that will be replaced</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  </a-p>with that numbered capture group.  So, `$0` will take the entire</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>  </a-p>region of text matched by the whole regex, while `$1` matches out</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  </a-p>the first capture group.  In the example below, `mailto:$0` is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>  </a-p>used to prefix a protocol to the text to make it into an URL.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>{{since(&#39;20230320-124340-559cb7b0&#39;, outline=True)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-tl>    * `highlight` - specifies the range of the matched text that should be</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-tl>  highlighted/underlined when the mouse hovers over the link.  The value is</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>    </a-p><a-tl>  a number that corresponds to a capture group in the regex.  The default</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>    </a-p><a-tl>  is `0`, highlighting the entire region of text matched by the regex.  `1`</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>    </a-p><a-tl>  would be the first capture group, and so on.</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>{{since(&#39;20230408-112425-69ae8472&#39;, outline=True)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>    The regex syntax now supports backreferences and look around assertions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>    See [Fancy Regex Syntax](https://docs.rs/fancy-regex/latest/fancy_regex/#syntax)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>    for the extended syntax, which builds atop the underlying</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>    [Regex syntax](https://docs.rs/regex/latest/regex/#syntax).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>    In prior versions, only the base</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>    [Regex syntax](https://docs.rs/regex/latest/regex/#syntax) was supported.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>Assigning `hyperlink_rules` overrides the built-in default rules.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>The default value for `hyperlink_rules` can be retrieved using</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>[wezterm.default_hyperlink_rules()](../wezterm/default_hyperlink_rules.md),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>and is shown below:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>config.</a-p><a-v>hyperlink_rules</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>  </a-p><a-c>-- Matches: a URL in parens: (URL)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;\\((\\w+://\\S+)\\)&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;$1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>    </a-p><a-v>highlight</a-v><a-p> = </a-p><a-n>1</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>  </a-p><a-c>-- Matches: a URL in brackets: [URL]</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;\\[(\\w+://\\S+)\\]&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;$1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>    </a-p><a-v>highlight</a-v><a-p> = </a-p><a-n>1</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>  </a-p><a-c>-- Matches: a URL in curly braces: {URL}</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;\\{(\\w+://\\S+)\\}&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;$1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    </a-p><a-v>highlight</a-v><a-p> = </a-p><a-n>1</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>  </a-p><a-c>-- Matches: a URL in angle brackets: &lt;URL&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;&lt;(\\w+://\\S+)&gt;&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;$1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>    </a-p><a-v>highlight</a-v><a-p> = </a-p><a-n>1</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>  </a-p><a-c>-- Then handle URLs not wrapped in brackets</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;\\b\\w+://\\S+[)/a-zA-Z0-9-]+&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;$0&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>  </a-p><a-c>-- implicit mailto link</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>    </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>&#39;\\b\\w+@[\\w-]+(\\.[\\w-]+)+\\b&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;mailto:$0&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>!!! note</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    In quoted Lua string literals the backslash character must be</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>    quoted even if the following character isn&#39;t meaningful to Lua</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>    when quoted by a backslash. That means that you&#39;ll always want to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>    double it up as `\\` when using it in a regex string.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-tl>    Alternatively, you can use the alternative string literal</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>    </a-p><a-tl>syntax; the following two examples are equivalent:</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-tl>    ```lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>    </a-p><a-tl>regex = [[\b[tT](\d+)\b]]</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-tl>```</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-tl>    ```lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>    </a-p><a-tl>regex = &#39;\\b[tT](\\d+)\\b&#39;</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>    </a-p><a-tl>```</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>Some other examples include:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>-- Use the defaults as a base</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>config.</a-p><a-v>hyperlink_rules</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>default_hyperlink_rules</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>-- make task numbers clickable</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>-- the first matched regex group is captured in $1.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>table.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v><a-p>, </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>  </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>[[\b[tt](\d+)\b]]</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>  </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;https://example.com/tasks/?t=$1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>})</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>-- make username/project paths clickable. this implies paths like the following are for github.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>-- ( &quot;nvim-treesitter/nvim-treesitter&quot; | wbthomason/packer.nvim | wezterm/wezterm | &quot;wezterm/wezterm.git&quot; )</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>-- as long as a full url hyperlink regex exists above this it should not match a full url to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>-- github or gitlab / bitbucket (i.e. https://gitlab.com/user/project.git is still a whole clickable url)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>table.</a-p><a-f>insert</a-f><a-p>(</a-p><a-v>config</a-v><a-p>.</a-p><a-v>hyperlink_rules</a-v><a-p>, </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>  </a-p><a-v>regex</a-v><a-p> = </a-p><a-s>[[[&quot;]?([\w\d]{1}[-\w\d]+)(/){1}([-\w\d\.]+)[&quot;]?]]</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>  </a-p><a-v>format</a-v><a-p> = </a-p><a-s>&#39;https://www.github.com/$1/$3&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>})</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
