Merge pull request #195 from jugglerchris/rich_no_decorate

Add config::rich_no_decorate()

.github/workflows/ci.yml

@@ -25,6 +25,6 @@ jobs:
           override: true
 
       - name: Check semver
-        uses: obi1kenobi/cargo-semver-checks-action@v1
+        uses: obi1kenobi/cargo-semver-checks-action@v2
         with:
           version-tag-prefix: ''

CHANGELOG.md

@@ -11,6 +11,12 @@ Possible log types:
 
 ### Latest
 
+### 0.14.0
+
+- [changed] Various small refactors (thanks sftse)
+- [added] New `config::rich_no_decorate`, to use annotations without '\*' markers around 
+  bold text etc.
+
 ### 0.13.6
 
 - [fixed] Fixed issue parsing CSS rules with known rules but unknown values,

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "html2text"
-version = "0.13.6"
+version = "0.14.0"
 authors = ["Chris Emerson <[email protected]>"]
 description = "Render HTML as plain text."
 repository = "https://github.com/jugglerchris/rust-html2text/"

examples/html2text.rs

@@ -109,7 +109,11 @@ where
     #[cfg(unix)]
     {
         if flags.use_colour {
-            let conf = config::rich();
+            let conf = if flags.no_decorate {
+                config::rich_no_decorate()
+            } else {
+                config::rich()
+            };
             let conf = update_config(conf, &flags);
             #[cfg(feature = "css")]
             let use_css_colours = !flags.ignore_css_colours;
@@ -163,6 +167,8 @@ struct Flags {
     wrap_width: Option<usize>,
     #[allow(unused)]
     use_colour: bool,
+    #[allow(unused)]
+    no_decorate: bool,
     #[cfg(feature = "css")]
     use_css: bool,
     #[cfg(feature = "css")]
@@ -185,6 +191,7 @@ fn main() {
         width: 80,
         wrap_width: None,
         use_colour: false,
+        no_decorate: false,
         #[cfg(feature = "css")]
         use_css: false,
         #[cfg(feature = "css")]
@@ -231,6 +238,12 @@ fn main() {
             StoreTrue,
             "Use ANSI terminal colours",
         );
+        #[cfg(unix)]
+        ap.refer(&mut flags.no_decorate).add_option(
+            &["--no-decorate"],
+            StoreTrue,
+            "Skip decorations (with --colour)",
+        );
         #[cfg(feature = "css")]
         ap.refer(&mut flags.use_css)
             .add_option(&["--css"], StoreTrue, "Enable CSS");

src/lib.rs

@@ -2590,6 +2590,11 @@ pub mod config {
         with_decorator(RichDecorator::new())
     }
 
+    /// Return a Config initialized with a `RichDecorator` and decoration disabled.
+    pub fn rich_no_decorate() -> Config<RichDecorator> {
+        with_decorator(RichDecorator::new_undecorated())
+    }
+
     /// Return a Config initialized with a `PlainDecorator`.
     pub fn plain() -> Config<PlainDecorator> {
         with_decorator(PlainDecorator::new())

src/render/text_renderer.rs

@@ -1865,7 +1865,10 @@ impl TextDecorator for TrivialDecorator {
 /// A decorator to generate rich text (styled) rather than
 /// pure text output.
 #[derive(Clone, Debug)]
-pub struct RichDecorator {}
+pub struct RichDecorator {
+    // Don't output decorations around '*bold*' text.
+    skip_decorations: bool,
+}
 
 /// Annotation type for "rich" text.  Text is associated with a set of
 /// these.
@@ -1896,10 +1899,20 @@ pub enum RichAnnotation {
 }
 
 impl RichDecorator {
-    /// Create a new `RichDecorator`.
+    /// Create a new `RichDecorator` with the default settings.
     #[allow(clippy::new_without_default)]
     pub fn new() -> RichDecorator {
-        RichDecorator {}
+        RichDecorator {
+            skip_decorations: false,
+        }
+    }
+
+    /// Create a new `RichDecorator` which doesn't add decorations
+    /// when terminal formatting can be used.
+    pub fn new_undecorated() -> RichDecorator {
+        RichDecorator {
+            skip_decorations: true,
+        }
     }
 }
 
@@ -1923,11 +1936,19 @@ impl TextDecorator for RichDecorator {
     }
 
     fn decorate_strong_start(&self) -> (String, Self::Annotation) {
-        ("*".to_string(), RichAnnotation::Strong)
+        if self.skip_decorations {
+            ("".to_string(), RichAnnotation::Strong)
+        } else {
+            ("*".to_string(), RichAnnotation::Strong)
+        }
     }
 
     fn decorate_strong_end(&self) -> String {
-        "*".to_string()
+        if self.skip_decorations {
+            "".to_string()
+        } else {
+            "*".to_string()
+        }
     }
 
     fn decorate_strikeout_start(&self) -> (String, Self::Annotation) {
@@ -1939,11 +1960,19 @@ impl TextDecorator for RichDecorator {
     }
 
     fn decorate_code_start(&self) -> (String, Self::Annotation) {
-        ("`".to_string(), RichAnnotation::Code)
+        if self.skip_decorations {
+            ("".to_string(), RichAnnotation::Code)
+        } else {
+            ("`".to_string(), RichAnnotation::Code)
+        }
     }
 
     fn decorate_code_end(&self) -> String {
-        "`".to_string()
+        if self.skip_decorations {
+            "".to_string()
+        } else {
+            "`".to_string()
+        }
     }
 
     fn decorate_preformat_first(&self) -> Self::Annotation {
@@ -1979,7 +2008,7 @@ impl TextDecorator for RichDecorator {
     }
 
     fn make_subblock_decorator(&self) -> Self {
-        RichDecorator::new()
+        self.clone()
     }
 
     fn push_colour(&mut self, colour: Colour) -> Option<Self::Annotation> {

src/tests.rs

@@ -1393,6 +1393,17 @@ fn test_read_rich() {
     assert_eq!(vec![line], lines);
 }
 
+#[test]
+fn test_read_rich_nodecorate() {
+    let html: &[u8] = b"<strong>bold</strong>";
+    let lines = config::rich_no_decorate()
+        .render_to_lines(parse(html).unwrap(), 80)
+        .unwrap();
+    let tag = vec![RichAnnotation::Strong];
+    let line = TaggedLine::from_string("bold".to_owned(), &tag);
+    assert_eq!(vec![line], lines);
+}
+
 #[test]
 fn test_read_custom() {
     let html: &[u8] = b"<strong>bold</strong>";