sxd_html_table

Coverage

Provide features related to HTML tables

There are some complexities to deal with when dealing with HTML tables.

There are colspans and rowspans, and the number of rows and columns is indeterminate.
There are th and td, and the type of cell requires attention.

This library hides these complexities and makes it easy to deal with the structure of the table. For example, you can convert an HTML table tag to a CSV file.

Usage

use sxd_html_table::{extract_table_nodes_to_table, Error, Table};

let html = r#"
<table>
  <tr>
    <th>header1</th>
    <th>header2</th>
  </tr>
  <tr>
    <td>data1</td>
    <td>data2</td>
  </tr>
</table>
"#;

fn extract_table_texts_from_document(html: &str) -> Result<Vec<Table<String>>, Error> {
    let package = sxd_html::parse_html(html);
    let document = package.as_document();
    let tables = extract_table_nodes_to_table(document.root())?;
    let tables = tables
        .into_iter()
        .map(|table| table.to_string_table())
        .collect();
    Ok(tables)
}

let tables = extract_table_texts_from_document(html).unwrap();
let table = tables.first().unwrap();
let csv = table.to_csv().unwrap();
assert_eq!(csv, "header1,header2\ndata1,data2\n");

Development

This repository uses lefthook to run the same checks as CI locally, so problems surface before they reach CI.

# Install the Git hooks (once; requires lefthook on your PATH)
lefthook install

Once installed, the hooks run automatically:

pre-commit: cargo fmt --all -- --check and cargo clippy --all-targets --all-features -- -D warnings
pre-push: the above plus cargo test

CI still runs the full suite (see .github/workflows/); the hooks only bring that feedback earlier on your machine.

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution