Render image text and link with purple colour

Make image links stand out and yet be different from regular links. Closes GH-140
swsnr · Jun 22, 2020 · d25f5fb · d25f5fb
1 parent 341708f
commit d25f5fb
Show file tree

Hide file tree

Showing 70 changed files with 164 additions and 140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,10 +12,13 @@ To publish a new release run `scripts/release` from the project directory.
 
 ### Changed
 - `mdcat::push_tty` now returns an error if `base_dir` is a relative path.
+- Image links now use purple foreground text (see [GH-140]).
 
 ### Fixed
 - Always treat links targets as URLs, never as paths.
 
+[GH-140]: https://github.com/lunaryorn/mdcat/issues/140
+
 ## [0.19.0] – 2020-06-19
 ### Added
 - Release packages now include generated shell completions for Bash, Zsh and Fish.

diff --git a/src/render/data.rs b/src/render/data.rs
@@ -4,13 +4,15 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
+use ansi_term::Colour;
 use pulldown_cmark::CowStr;
 
 #[derive(Debug, PartialEq)]
 pub struct Link<'a> {
     pub(crate) index: u16,
     pub(crate) target: CowStr<'a>,
     pub(crate) title: CowStr<'a>,
+    pub(crate) colour: Colour,
 }
 
 /// Data associated with rendering state.
@@ -29,13 +31,24 @@ pub struct StateData<'a> {
 }
 
 impl<'a> StateData<'a> {
-    pub(crate) fn add_link(mut self, target: CowStr<'a>, title: CowStr<'a>) -> (Self, u16) {
+    /// Add a pending link to the state data.
+    ///
+    /// `target` is the link target, and `title` the link title to show after the URL.
+    /// `colour` is the colour to use for foreground text to differentiate between
+    /// different types of links.
+    pub(crate) fn add_link(
+        mut self,
+        target: CowStr<'a>,
+        title: CowStr<'a>,
+        colour: Colour,
+    ) -> (Self, u16) {
         let index = self.next_link;
         self.next_link += 1;
         self.pending_links.push(Link {
             index,
             target,
             title,
+            colour,
         });
         (self, index)
     }

diff --git a/src/render/mod.rs b/src/render/mod.rs
@@ -558,7 +558,7 @@ pub fn write_event<'a, W: Write>(
             (stack.pop(), data)
         }
         (Stacked(stack, Inline(InlineText, attrs)), End(Link(_, target, title))) => {
-            let (data, index) = data.add_link(target, title);
+            let (data, index) = data.add_link(target, title, Colour::Blue);
             write_styled(
                 writer,
                 &settings.terminal_capabilities,
@@ -598,7 +598,15 @@ pub fn write_event<'a, W: Write>(
                 (ImageCapability::NoImages, _) => None,
                 (_, None) => None,
             }
-            .unwrap_or_else(|| Inline(InlineText, InlineAttrs { indent, style }));
+            .unwrap_or_else(|| {
+                Inline(
+                    InlineText,
+                    InlineAttrs {
+                        indent,
+                        style: style.fg(Colour::Purple),
+                    },
+                )
+            });
             stack
                 .push(Inline(state, attrs))
                 .current(image_state)
@@ -607,7 +615,7 @@ pub fn write_event<'a, W: Write>(
         (Stacked(stack, RenderedImage), Text(_)) => (Stacked(stack, RenderedImage), data),
         (Stacked(stack, RenderedImage), End(Image(_, _, _))) => (stack.pop(), data),
         (Stacked(stack, Inline(_, attrs)), End(Image(_, target, title))) => {
-            let (data, index) = data.add_link(target, title);
+            let (data, index) = data.add_link(target, title, Colour::Purple);
             write_styled(
                 writer,
                 &settings.terminal_capabilities,

diff --git a/src/render/write.rs b/src/render/write.rs
@@ -75,7 +75,7 @@ pub fn write_link_refs<W: Write>(
     if !links.is_empty() {
         writeln!(writer)?;
         for link in links {
-            let style = Style::new().fg(Colour::Blue);
+            let style = Style::new().fg(link.colour);
             let link_text = format!("[{}]: {} {}", link.index, link.target, link.title);
             write_styled(writer, capabilities, &style, link_text)?;
             writeln!(writer)?;

diff --git a/tests/render/golden/ansi-only/commonmark-spec/513-links b/tests/render/golden/ansi-only/commonmark-spec/513-links
@@ -1,4 +1,4 @@
-[34mmoon[0m[34m[1][0m[34m[2][0m
+[35mmoon[0m[35m[1][0m[34m[2][0m
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
 [34m[2]: /uri [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/516-links b/tests/render/golden/ansi-only/commonmark-spec/516-links
@@ -1,4 +1,4 @@
-[[34mfoo[0m[34m[1][0m](uri2)[2]
+[35m[[0m[34mfoo[0m[34m[1][0m[35m][0m[35m(uri2)[0m[35m[2][0m
 
 [34m[1]: uri1 [0m
-[34m[2]: uri3 [0m
+[35m[2]: uri3 [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/527-links b/tests/render/golden/ansi-only/commonmark-spec/527-links
@@ -1,4 +1,4 @@
-[34mmoon[0m[34m[1][0m[34m[2][0m
+[35mmoon[0m[35m[1][0m[34m[2][0m
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
 [34m[2]: /uri [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/568-images b/tests/render/golden/ansi-only/commonmark-spec/568-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/569-images b/tests/render/golden/ansi-only/commonmark-spec/569-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/570-images b/tests/render/golden/ansi-only/commonmark-spec/570-images
@@ -1,4 +1,4 @@
-foo bar[1][2]
+[35mfoo [0m[35mbar[0m[35m[1][0m[35m[2][0m
 
-[34m[1]: /url [0m
-[34m[2]: /url2 [0m
+[35m[1]: /url [0m
+[35m[2]: /url2 [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/571-images b/tests/render/golden/ansi-only/commonmark-spec/571-images
@@ -1,4 +1,4 @@
-foo [34mbar[0m[34m[1][0m[2]
+[35mfoo [0m[34mbar[0m[34m[1][0m[35m[2][0m
 
 [34m[1]: /url [0m
-[34m[2]: /url2 [0m
+[35m[2]: /url2 [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/572-images b/tests/render/golden/ansi-only/commonmark-spec/572-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/573-images b/tests/render/golden/ansi-only/commonmark-spec/573-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/574-images b/tests/render/golden/ansi-only/commonmark-spec/574-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: train.jpg [0m
+[35m[1]: train.jpg [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/575-images b/tests/render/golden/ansi-only/commonmark-spec/575-images
@@ -1,3 +1,3 @@
-My foo bar[1]
+My [35mfoo bar[0m[35m[1][0m
 
-[34m[1]: /path/to/train.jpg title[0m
+[35m[1]: /path/to/train.jpg title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/576-images b/tests/render/golden/ansi-only/commonmark-spec/576-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: url [0m
+[35m[1]: url [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/577-images b/tests/render/golden/ansi-only/commonmark-spec/577-images
@@ -1,3 +1,3 @@
-[1]
+[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/578-images b/tests/render/golden/ansi-only/commonmark-spec/578-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/579-images b/tests/render/golden/ansi-only/commonmark-spec/579-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/580-images b/tests/render/golden/ansi-only/commonmark-spec/580-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/581-images b/tests/render/golden/ansi-only/commonmark-spec/581-images
@@ -1,3 +1,3 @@
-[3mfoo[0m bar[1]
+[3;35mfoo[0m[35m bar[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/582-images b/tests/render/golden/ansi-only/commonmark-spec/582-images
@@ -1,3 +1,3 @@
-Foo[1]
+[35mFoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/583-images b/tests/render/golden/ansi-only/commonmark-spec/583-images
@@ -1,4 +1,4 @@
-foo[1] 
+[35mfoo[0m[35m[1][0m 
 []
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/584-images b/tests/render/golden/ansi-only/commonmark-spec/584-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/585-images b/tests/render/golden/ansi-only/commonmark-spec/585-images
@@ -1,3 +1,3 @@
-[3mfoo[0m bar[1]
+[3;35mfoo[0m[35m bar[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/ansi-only/commonmark-spec/587-images b/tests/render/golden/ansi-only/commonmark-spec/587-images
@@ -1,3 +1,3 @@
-Foo[1]
+[35mFoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/513-links b/tests/render/golden/iterm2/commonmark-spec/513-links
@@ -1,3 +1,3 @@
-]8;;file://HOSTNAME/ROOT/uri[34mmoon[0m[34m[1][0m]8;;
+]8;;file://HOSTNAME/ROOT/uri[35mmoon[0m[35m[1][0m]8;;
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/516-links b/tests/render/golden/iterm2/commonmark-spec/516-links
@@ -1,3 +1,3 @@
-[]8;;file://HOSTNAME/WORKING_DIRECTORY/tests/render/md/commonmark-spec/uri1[34mfoo[0m]8;;](uri2)[1]
+[35m[[0m]8;;file://HOSTNAME/WORKING_DIRECTORY/tests/render/md/commonmark-spec/uri1[34mfoo[0m]8;;[35m][0m[35m(uri2)[0m[35m[1][0m
 
-[34m[1]: uri3 [0m
+[35m[1]: uri3 [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/527-links b/tests/render/golden/iterm2/commonmark-spec/527-links
@@ -1,3 +1,3 @@
-]8;;file://HOSTNAME/ROOT/uri[34mmoon[0m[34m[1][0m]8;;
+]8;;file://HOSTNAME/ROOT/uri[35mmoon[0m[35m[1][0m]8;;
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/568-images b/tests/render/golden/iterm2/commonmark-spec/568-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/569-images b/tests/render/golden/iterm2/commonmark-spec/569-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/570-images b/tests/render/golden/iterm2/commonmark-spec/570-images
@@ -1,4 +1,4 @@
-foo bar[1][2]
+[35mfoo [0m[35mbar[0m[35m[1][0m[35m[2][0m
 
-[34m[1]: /url [0m
-[34m[2]: /url2 [0m
+[35m[1]: /url [0m
+[35m[2]: /url2 [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/571-images b/tests/render/golden/iterm2/commonmark-spec/571-images
@@ -1,3 +1,3 @@
-foo ]8;;file://HOSTNAME/ROOT/url[34mbar[0m]8;;[1]
+[35mfoo [0m]8;;file://HOSTNAME/ROOT/url[34mbar[0m]8;;[35m[1][0m
 
-[34m[1]: /url2 [0m
+[35m[1]: /url2 [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/572-images b/tests/render/golden/iterm2/commonmark-spec/572-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/573-images b/tests/render/golden/iterm2/commonmark-spec/573-images
@@ -1,3 +1,3 @@
-foo [3mbar[0m[1]
+[35mfoo [0m[3;35mbar[0m[35m[1][0m
 
-[34m[1]: train.jpg train & tracks[0m
+[35m[1]: train.jpg train & tracks[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/574-images b/tests/render/golden/iterm2/commonmark-spec/574-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: train.jpg [0m
+[35m[1]: train.jpg [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/575-images b/tests/render/golden/iterm2/commonmark-spec/575-images
@@ -1,3 +1,3 @@
-My foo bar[1]
+My [35mfoo bar[0m[35m[1][0m
 
-[34m[1]: /path/to/train.jpg title[0m
+[35m[1]: /path/to/train.jpg title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/576-images b/tests/render/golden/iterm2/commonmark-spec/576-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: url [0m
+[35m[1]: url [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/577-images b/tests/render/golden/iterm2/commonmark-spec/577-images
@@ -1,3 +1,3 @@
-[1]
+[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/578-images b/tests/render/golden/iterm2/commonmark-spec/578-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/579-images b/tests/render/golden/iterm2/commonmark-spec/579-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url [0m
+[35m[1]: /url [0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/580-images b/tests/render/golden/iterm2/commonmark-spec/580-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/581-images b/tests/render/golden/iterm2/commonmark-spec/581-images
@@ -1,3 +1,3 @@
-[3mfoo[0m bar[1]
+[3;35mfoo[0m[35m bar[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/582-images b/tests/render/golden/iterm2/commonmark-spec/582-images
@@ -1,3 +1,3 @@
-Foo[1]
+[35mFoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/583-images b/tests/render/golden/iterm2/commonmark-spec/583-images
@@ -1,4 +1,4 @@
-foo[1] 
+[35mfoo[0m[35m[1][0m 
 []
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/584-images b/tests/render/golden/iterm2/commonmark-spec/584-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/585-images b/tests/render/golden/iterm2/commonmark-spec/585-images
@@ -1,3 +1,3 @@
-[3mfoo[0m bar[1]
+[3;35mfoo[0m[35m bar[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/iterm2/commonmark-spec/587-images b/tests/render/golden/iterm2/commonmark-spec/587-images
@@ -1,3 +1,3 @@
-Foo[1]
+[35mFoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m
diff --git a/tests/render/golden/vte50/commonmark-spec/513-links b/tests/render/golden/vte50/commonmark-spec/513-links
@@ -1,3 +1,3 @@
-]8;;file://HOSTNAME/ROOT/uri[34mmoon[0m[34m[1][0m]8;;
+]8;;file://HOSTNAME/ROOT/uri[35mmoon[0m[35m[1][0m]8;;
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
diff --git a/tests/render/golden/vte50/commonmark-spec/516-links b/tests/render/golden/vte50/commonmark-spec/516-links
@@ -1,3 +1,3 @@
-[]8;;file://HOSTNAME/WORKING_DIRECTORY/tests/render/md/commonmark-spec/uri1[34mfoo[0m]8;;](uri2)[1]
+[35m[[0m]8;;file://HOSTNAME/WORKING_DIRECTORY/tests/render/md/commonmark-spec/uri1[34mfoo[0m]8;;[35m][0m[35m(uri2)[0m[35m[1][0m
 
-[34m[1]: uri3 [0m
+[35m[1]: uri3 [0m
diff --git a/tests/render/golden/vte50/commonmark-spec/527-links b/tests/render/golden/vte50/commonmark-spec/527-links
@@ -1,3 +1,3 @@
-]8;;file://HOSTNAME/ROOT/uri[34mmoon[0m[34m[1][0m]8;;
+]8;;file://HOSTNAME/ROOT/uri[35mmoon[0m[35m[1][0m]8;;
 
-[34m[1]: moon.jpg [0m
+[35m[1]: moon.jpg [0m
diff --git a/tests/render/golden/vte50/commonmark-spec/568-images b/tests/render/golden/vte50/commonmark-spec/568-images
@@ -1,3 +1,3 @@
-foo[1]
+[35mfoo[0m[35m[1][0m
 
-[34m[1]: /url title[0m
+[35m[1]: /url title[0m