Keep node.data in hast-util-raw because it's a standard unist node property

[JounQin]

syntax-tree/hast-util-raw#13 (comment)

[wooorm]

And what about the afterhand? Non raw nodes are also affected.

All nodes are affected. They all loose everything. Exception positional info. It’s like doing fromString(toString(x)), but positional info is kept.

[wooorm]

Why do you need it? Why not use it as the first? data is added by plugins: so you can also handle it somehow in plugins

[JounQin]

The plugins order is a bit out of control, there are built-in plugins vs 3rd-party plugins in the rspress ecosystem, both of them can register rehypePlugins.

Take @rspress/plugin-shiki as example, it requires node.data to be present, but we want to enable rehype-raw in the built-in step, so if rehype-raw runs before rehype-shiki, then node.data is missing which causes unexpected behavior.

That's why we're adding rehype-raw as the last rehype plugin always now, but this introduced another issue, some rehype plugins want to reparsed nodes via rehype-raw, and listing as the last one won't work of course, will it?

[SoonIter]

For example:

```js title=foo.js

rehype-raw -> rehype-shiki, node.data is removed in rehype-raw, and shiki cannot consume the title=foo.js in rehype-shiki

If rehype-raw can preserve node.data, users won't need to consider the execution order of rehype plugins.

At present, the execution order concerns is is not friendly to users.

[wooorm]

There is a difference between markdown and HTML, remark and rehype.
rehype-shiki is for HTML. It should support HTML. It should not only support markdown. It is nice if it supports markdown. But it should also support someone writing actual HTML and passing things as HTML attributes.

Such as https://github.com/rehypejs/rehype-twoslash/blob/19c933630ebb3abcce32e0dea123bb6bb2511e2b/lib/index.js#L110-L114

but we want to enable rehype-raw in the built-in step

Why? It is a complex operation that slows people down who do not need it.
You should probably not default to it.

But if you must have it, and rehype-shiki supports HTML too, then you can use a plugin before rehype-raw to turn data into a format rehype-shiki supports.

Such as https://github.com/mdx-js/mdx/blob/b3351fadcb6f78833a72757b7135dcfb8ab646fe/website/mdx-loader.js#L319-L321

[JounQin]

https://github.com/shikijs/shiki/blob/4b8e6331aca7f8cd77e280120e67933525550c36/packages/rehype/src/handlers.ts#L59C46-L59C56

It seems head.properties.metastring is also supported, I'll give it a try.

---

Done: web-infra-dev/rspress#2222

Thanks! @wooorm