Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stoically/syn-rsx
syn-powered parser for JSX-like TokenStreams
https://github.com/stoically/syn-rsx
html jsx macros rsx syn
Last synced: 1 day ago
JSON representation
syn-powered parser for JSX-like TokenStreams
- Host: GitHub
- URL: https://github.com/stoically/syn-rsx
- Owner: stoically
- License: mit
- Created: 2020-05-29T10:15:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-24T15:51:33.000Z (over 1 year ago)
- Last Synced: 2024-12-13T19:14:20.683Z (9 days ago)
- Topics: html, jsx, macros, rsx, syn
- Language: Rust
- Homepage: https://crates.io/crates/syn-rsx
- Size: 226 KB
- Stars: 183
- Watchers: 7
- Forks: 25
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# syn-rsx
[](https://crates.io/crates/syn-rsx)
[](https://docs.rs/syn-rsx/)
[](https://codecov.io/gh/stoically/syn-rsx)
[`syn`]-powered parser for JSX-like [`TokenStream`]s, aka RSX. The parsed result is a nested `Node` structure, similar to the browser DOM, where node name and value are syn expressions to support building proc macros.
```rust
use std::convert::TryFrom;
use eyre::bail;
use quote::quote;
use syn_rsx::{parse2, Node, NodeAttribute, NodeElement, NodeText};
// Create HTML `TokenStream`.
let tokens = quote! { "hi" };
// Parse the tokens into a tree of `Node`s.
let nodes = parse2(tokens)?;
// Extract some specific nodes from the tree.
let Node::Element(element) = &nodes[0] else { bail!("element") };
let Node::Attribute(attribute) = &element.attributes[0] else { bail!("attribute") };
let Node::Text(text) = &element.children[0] else { bail!("text") };
// Work with the nodes.
assert_eq!(element.name.to_string(), "hello");
assert_eq!(attribute.key.to_string(), "world");
assert_eq!(String::try_from(&text.value)?, "hi");
```
You might want to check out the [html-to-string-macro example] as well.
## Features
- **Not opinionated**
Every tag or attribute name is valid
```html
```
- **Text nodes**
Support for [unquoted text is planned].
```html
"String literal"
```
- **Node names separated by dash, colon or double colon**
```html
```
- **Node names with reserved keywords**
```html
```
- **Doctypes, Comments and Fragments**
```html
<>>
```
- **Braced blocks are parsed as arbitrary Rust code**
```html
<{ let block = "in node name position"; } />
{ let block = "in node position"; }
```
- **Attribute values can be any valid syn expression without requiring braces**
```html
```
- **Helpful error reporting out of the box**
```rust,no-run
error: open tag has no corresponding close tag and is not self-closing
--> examples/html-to-string-macro/tests/lib.rs:5:24
|
5 | html_to_string! {
};
| ^^^
```
- **Possibility to get the span for a whole node**
This can be used to improve error reporting, e.g.
```rust,no-run
error: Invalid element
--> examples/src/main.rs:14:13
|
14 | /
15 | | "invalid node for some consumer specific reason"
16 | |
| |__________________^
```
- **Customization**
A `ParserConfig` to customize parsing behavior is available, so if you have
slightly different requirements for parsing and it's not yet customizable
feel free to open an issue or pull request to extend the configuration.
One highlight with regards to customization is the `transform_block`
configuration, which takes a closure that receives raw block content as
`ParseStream` and lets you optionally convert it to a `TokenStream`. That makes it
possible to have custom syntax in blocks. More details in [#9]
[`syn`]: https://github.com/dtolnay/syn
[`tokenstream`]: https://doc.rust-lang.org/proc_macro/struct.TokenStream.html
[html-to-string-macro example]: https://github.com/stoically/syn-rsx/tree/main/examples/html-to-string-macro
[unquoted text is planned]: https://github.com/stoically/syn-rsx/issues/2
[#9]: https://github.com/stoically/syn-rsx/issues/9