Pure, simple and elegant HTML parser and editor.

Lomirus

Last update: Nov 8, 2022

Related tags

Overview

HTML Editor

Pure, simple and elegant HTML parser and editor.

Examples

Parse HTML segment/document

let document = parse("<!doctype html><html><head></head><body></body></html>");
println!("{:#?}", document);

Output:

[
    Doctype,
    Element {
        name: "html",
        attrs: {},
        children: [
            Element {
                name: "head",
                attrs: {},
                children: [],
            },
            Element {
                name: "body",
                attrs: {},
                children: [],
            },
        ],
    },
]

Query an element by classname

// let html = r#"..."#
let nodes = parse(html);
let selector: Selector = Selector::from(".last");
let element: Element = nodes.query(&selector).unwrap();

Query all elements by tag

// let html = r#"..."#
let nodes = parse(html);
let selector: Selector = Selector::from("span");
let elements: Vec<Element> = nodes.query_all(&selector);

Edit the HTML

// let html = r#"..."#
let a: String = parse(html).trim().html();
let b: String = parse(html).insert_to(&selector, node).html();
let c: String = parse(html).remove_by(&selector).html();

You can find more examples in the documentation.

Changelog

See in CHANGELOG.md

Comments

query with numerous selectors at once

Hello, I would like to query_all all the headers (regardless of size) present, as the order matters. If I individually search for each header (h1, h2, h3 etc.) I will get them ordered based on their size, h1 first, h2 second and so on. I've looked through the docs and cannot seem to find a way to do this, so if one is indeed not present I suggest the following syntax.

fn query_all(&self, selector: Vec<&Selector>) -> Vec<Element> so usage would be something like: dom.query_all(vec![&Selector::from("h1"), &Selector::from("h2"), ...]);
enhancement

opened by liabri 9

Add pase html with some err

It woild be great if add html with some err. Like this

 <!doctype html>
        <html lang="en">
            <head>
                <meta charset="utf-8">
                <title>Html parser</title>
            </head>
            <body>
                <h1 id="a" class="b c">Hello world</h1>
                <!-- comments & dangling elements are ignored -->
                <a class="trait" href="next/next2/">Queryable 

            </body>
        </html>

Because browser handle it. I`m trying write crawler and use you parser, but got err on parse.. =-(

enhancement

opened by olehbozhok 4

On XML and Node spans
I'm looking to replace the current HTML parser that's being used in a project of mine and I came across this one. It looks like it would be a nice replacement, and by my estimates, would bring the final binary size down by about 16%.

There's two things stopping me from trying it out:

The ability to parse simple XML (from an EPUB) which would require the the ability to parse the XML doc type and possible namespace attributes.

The tracking of Node spans, as in the offset the where Node starts and stops at in.

Would these be something you'd consider adding or accepting a pull request for?
enhancement
opened by Txuritan 3

$wrong parse of <div\n$

wrong parse of

Hi,

I like to report a bug in html_editor. Running this program:

use html_editor::parse;
fn main() {
    let s = r#"
<div
> </div>
"#;

   let dom = parse(&s);
   println!("wrong: {:?}",dom);

    let s = r#"
<div> </div>
"#;
   let dom = parse(&s);
   println!("good: {:?}",dom);
}

I get:

wrong: Err("<div\n> does not match the </div>")
good: Ok([Text("\n"), Element { name: "div", attrs: [], children: [Text(" ")] }, Text("\n")])

So, it seems that html_editor does not handle a newline as a space or tab where it should. The example is with <div>, but the bug affects also other tags like <a>.

Regards, and thanks for the package,

Willem

bug

opened by wvermin 2

Multiple classes on the same html element are parsed as a single class

An html snippet like

<div class="a b"> </div>

gets parsed into an Element like

Element { name: "div", attrs: [("class", "a b")], children: [] }

There is only one classs attribute which contains both classes seperated by whitespace. This leads to queries for a only one of the two classes to fail.

This test fails.

#[test] fn html_editor_multiple_class_parsing() { let test_snippet = r#"<div class="a b"></div>"#; let result = parser::parse(test_snippet).unwrap(); print!("{:?}", result); // This selector fails let selector = Selector::from(".a"); // This selector works // let selector = Selector::from(".a b"); result.query(&selector).unwrap(); assert!(true); }

My expected behaviour would be a seperate class attribute for each class inside the html. In this case:

Element { name: "div", attrs: [("class", "a"),("class", "b")], children: [] }
bug

opened by lasse16 2
Fails to parse if closing tag is seperated by new-line
I came across this issue while working with version 0.3.0.

On a website, there was an <a> that was closed by <\a\n>. The parser failed with the error message "<a> does not match the </a\n>".

To reproduce, attempt to parse the following segment

<a> example </a >

Firefox can parse the website regardless of that formatting error. Quick workaround could be to just delete all newlines in the string?
bug good first issue
opened by lasse16 2

Releases(v0.5.2)

v0.5.2(Aug 21, 2022)
Fix

Failed to parse tags with whitespaces inside (exclude space), like <div\n></div> and <div\t></div>. Fixed by @lomirus. Closes #5.

Source code(tar.gz)
Source code(zip)
v0.5.1(Apr 27, 2022)
Fix

Fixed that the selector doesn't work for multiple class element by @lomirus in #4;

Source code(tar.gz)
Source code(zip)
v0.5.0(Apr 15, 2022)
Features

Add try_parse method for the html with tolerable errors by @lomirus in #2;

Add support for parsing xml doctype by @lomirus in #3;

Add associated Doctype variant to Node::Doctype to distinguish between html and xml by @lomirus.

Refactor

Remove prelude module, and replace it with operation module by @lomirus, which also moves the Selector struct out of the original module to top of this package.

Chore

Add benchmarking for the parse method by @lomirus, using an 87.0kB html file from wikipedia;

Documentation

Readme and other documentation improvements by @lomirus.

Source code(tar.gz)
Source code(zip)
v0.4.0(Mar 19, 2022)
v0.4.0 (2022-03-19)

Fix

Fails to parse if closing tag is seperated by new-line, like<a></a\n>. Closes #1.

Refactor

Add the prelude module. Now you can simply import Editable, Htmlifiable and Queryable all just by use html_editor::prelude::*;;

trim() method becomes (&mut self) -> &mut Self from (self) -> Self.

Replace the try_into_element() with into_element(), which simplifies the common use: try_into_element().unwrap()

Documentation

Add more examples.

Source code(tar.gz)
Source code(zip)
v0.3.0(Jan 29, 2022)
Refactor

Now parse() returns a Result<Vec<Node>, String> instead of Vec<Node> for better error handling.

Fix

In previous version, parse sometimes may return an unexpected result but without any error message. And now any currently known error will be delivered.

Tag string in <script> or <style> cannot be parsed correctly. For example, <script>"<div></div>"</script> would be parsed as a <div> element in the <script> instead of the plain string.

Source code(tar.gz)
Source code(zip)

v0.2.0(Jan 19, 2022)

Fix

Fail to parse the attributes if the the last key of it doesn't have the value, like <script src="index.js" type="module" defer></script>

Enhancements

Omit the attribute if its value is empty. For example:

<!--Old-->
<script src="index.js" type="module" defer=""></script>

<!--New-->
<script src="index.js" type="module" defer></script>

Use vector to store the attributes instead of hashmap, which can make its order stable. For example:

<!--Old. Maybe-->
<script src="index.js" type="module"></script>
<!--But it is also a possible result-->
<script type="module" src="index.js"></script>

<!--New. The result would be unique, and just the same as its input-->
<script src="index.js" type="module"></script>

Source code(tar.gz)
Source code(zip)

v0.1.0(Jan 19, 2022)

Source code(tar.gz)
Source code(zip)

Owner

Lomirus

Rookie Web Dev | Using TS/JS/RS | Wanna be an Indie Game Dev | Now just being slacking 😪

GitHub

tiny md parser - md to html

tiny md parser md to html covered features lexer h1 h2 h3 list ( also numbered list ) code images links blockquote parser h1 h2 h3 list ( also numbere