fast_html2md 0.0.61

A fast html2md crate for rust
Documentation 
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

#[cfg(feature = "scraper")]
pub mod test {
    use html2md::{parse_html, rewrite_html};
    use pretty_assertions::assert_eq;

    #[test]
    fn test_dumb() {
        let md = parse_html("<p>CARTHAPHILUS</p>", false);
        assert_eq!(md, "CARTHAPHILUS");
        let md = rewrite_html("<p>CARTHAPHILUS</p>", false);
        assert_eq!(md, "CARTHAPHILUS")
    }

    #[test]
    // fixme
    fn test_space() {
        let s = r#"<p><a href="http://ya.ru">APOSIMZ</a></p>\n"#;
        let md = parse_html(s, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)\n\\\\n");
        let md = rewrite_html(s, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)\n\\n");
    }

    #[test]
    fn test_anchor() {
        let md = parse_html(r#"<p><a href="http://ya.ru">APOSIMZ</a></p>"#, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)");
        let md = rewrite_html(r#"<p><a href="http://ya.ru">APOSIMZ</a></p>"#, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)");
    }

    #[test]
    fn test_anchor2() {
        let s =
            r#"<p><a href="http://ya.ru">APOSIMZ</a><a href="http://yandex.ru">SIDONIA</a></p>"#;

        let md = parse_html(s, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)[SIDONIA](http://yandex.ru)");
        let md = rewrite_html(s, false);
        assert_eq!(md, "[APOSIMZ](http://ya.ru)[SIDONIA](http://yandex.ru)");
    }

    #[test]
    fn test_anchor3() {
        let s = r#"<p><a href="http://ya.ru">APOSIMZ</a><p/><a href="http://yandex.ru">SIDONIA</a></p>"#;
        let m = "[APOSIMZ](http://ya.ru)\n[SIDONIA](http://yandex.ru)";
        let md = parse_html(s, false);
        assert_eq!(md, m);
        let md = rewrite_html(s, false);
        assert_eq!(md, m)
    }

    #[test]
    /// The destination can only contain spaces if it is enclosed in pointy brackets:  
    /// [Commonmark: Example 489](https://spec.commonmark.org/0.31.2/#example-489)
    fn test_anchor4() {
        let s = r#"<p><a href="/my%20uri">link</a></p>"#;
        let m = "\
[link](</my uri>)";

        let md = parse_html(s, false);

        assert_eq!(md, m);

        let md = rewrite_html(s, false);

        assert_eq!(md, m);
    }

    #[test]
    fn test_image() {
        let md = parse_html(
            r#"<p><a href="https://gitter.im/MARC-FS/Lobby?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://img.shields.io/gitter/room/MARC-FS/MARC-FS.svg" alt="Gitter"></a><br>"#,
            false,
        );
        assert_eq!(md, "[![Gitter](https://img.shields.io/gitter/room/MARC-FS/MARC-FS.svg)](https://gitter.im/MARC-FS/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)")
    }

    #[test]
    fn test_escaping() {
        let s = r#"<p>*god*'s in his **heaven** - all is right with the __world__</p>"#;
        let m = "\\*god\\*\'s in his \\*\\*heaven\\*\\* - all is right with the \\_\\_world\\_\\_";

        let md = parse_html(s, false);
        assert_eq!(md, m);

        let md = rewrite_html(s, false);
        assert_eq!(md, m);
    }

    #[test]
    fn test_escaping_mid_hyphens() {
        let md = parse_html(r#"<h1>This is a header with-hyphen!</h1>"#, false);
        assert_eq!(md, "# This is a header with-hyphen!")
    }

    #[test]
    fn test_escaping_start_hyphens() {
        let md = parse_html(
            r#"<h1>- This is a header with starting hyphen!</h1>"#,
            false,
        );
        assert_eq!(md, "# - This is a header with starting hyphen!")
    }

    #[test]
    fn test_escaping_start_sharp() {
        let md = parse_html("<html># nothing to worry about</html>", false);
        assert_eq!(md, "\\# nothing to worry about")
    }

    /// Note: Also strips multiple spaces
    #[test]
    fn test_escaping_start_hyphens_space() {
        let md = parse_html(
            r#"<h1>   - This is a header with starting hyphen!</h1>"#,
            false,
        );
        assert_eq!(md, "# - This is a header with starting hyphen!")
    }

    #[test]
    fn test_escaping_html_tags() {
        let md = parse_html(
            r#"xxxxxxx xx xxxxxxxxxxx: &lt;iframe src="xxxxxx_xx_xxxxxxxxxxx/embed/" allowfullscreen="" height="725" width="450"&gt;&lt;/iframe&gt;"#,
            false,
        );
        assert_eq!(
            md,
            r#"xxxxxxx xx xxxxxxxxxxx: \<iframe src="xxxxxx\_xx\_xxxxxxxxxxx/embed/" allowfullscreen="" height="725" width="450"\>\</iframe\>"#
        )
    }

    #[test]
    fn test_headers() {
        let md = parse_html(
            r#"<h1 id="marc-fs">MARC-FS</h1><p><a href="http://Mail.ru">Mail.ru</a> Cloud filesystem written for FUSE</p><h2 id="synopsis">Synopsis</h2>"#,
            false,
        );
        assert_eq!(
            md,
            "# MARC-FS\n[Mail.ru](http://Mail.ru) Cloud filesystem written for FUSE\n## Synopsis"
        )
    }

    #[test]
    fn test_escaping_start_equal() {
        let md = parse_html(r#"<p>This is NOT a header!<br/>===========</p>"#, false);
        assert_eq!(md, "This is NOT a header!\n\\===========")
    }

    /// Note: Also strips multiple spaces
    #[test]
    fn test_escaping_start_equal_space() {
        let md = parse_html(r#"<p>This is NOT a header!<br/>  ===========</p>"#, false);
        assert_eq!(md, "This is NOT a header!\n\\===========")
    }

    #[test]
    fn test_escaping_start_hyphen() {
        let md = parse_html(r#"<p>This is NOT a header!<br/>-------</p>"#, false);
        assert_eq!(md, "This is NOT a header!\n\\-------")
    }

    /// Note: Also strips multiple spaces
    #[test]
    fn test_escaping_start_hyphen_space() {
        let md = parse_html(r#"<p>This is NOT a header!<br/>     -------</p>"#, false);
        assert_eq!(md, "This is NOT a header!\n\\-------")
    }

    /// Note: Also strips multiple spaces
    #[test]
    fn test_escaping_sup_tags() {
        let md = parse_html(
            r#"<p>This is NOT a header!<br/><sup>something</sup>     -------</p>"#,
            false,
        );
        assert_eq!(md, "This is NOT a header!\nsomething -------")
    }

    #[test]
    fn test_html_entity_decoding() {
        // Common HTML entities should be decoded in text content
        let html = r#"<p>Tom &amp; Jerry</p>"#;
        let md = rewrite_html(html, false);
        assert_eq!(md, "Tom & Jerry");

        let html = r#"<p>1 &lt; 2 &gt; 0</p>"#;
        let md = rewrite_html(html, false);
        assert_eq!(md, "1 \\< 2 \\> 0");

        let html = r#"<p>He said &quot;hello&quot;</p>"#;
        let md = rewrite_html(html, false);
        assert_eq!(md, r#"He said "hello""#);

        let html = r#"<p>It&#39;s fine</p>"#;
        let md = rewrite_html(html, false);
        assert_eq!(md, "It's fine");

        let html = r#"<p>non&nbsp;breaking</p>"#;
        let md = rewrite_html(html, false);
        assert_eq!(md, "nonbreaking");
    }
}