sxd_html_table 0.2.0

A HTML table parser based on sxd_html.
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

# sxd_html_table

[![crates.io](https://img.shields.io/crates/d/sxd_html_table)](https://crates.io/crates/sxd_html_table)
[![tests](https://github.com/kitsuyui/sxd_html_table/actions/workflows/test.yml/badge.svg)](https://github.com/kitsuyui/sxd_html_table/actions/workflows/test.yml)
![Coverage](https://raw.githubusercontent.com/kitsuyui/octocov-central/main/badges/kitsuyui/sxd_html_table/coverage.svg)
[![license](https://img.shields.io/crates/l/sxd_html_table)](https://github.com/kitsuyui/sxd_html_table#license)

# 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

```rust
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](https://lefthook.dev/) to run the same checks as CI
locally, so problems surface before they reach CI.

```sh
# 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](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.