feat: complete MDX migration, stabilize routing and lead capture

Former-commit-id: ab5cc38c97e5f73d6e821465b90d199fb6e6edc9
This commit is contained in:
2026-05-03 21:06:47 +02:00
parent b13f628b55
commit f2fdea96ec
7175 changed files with 371649 additions and 1078689 deletions

View File

@@ -0,0 +1 @@
../../../@types+estree@1.0.8/node_modules/@types/estree

View File

@@ -0,0 +1 @@
../../estree-util-to-js@2.0.0/node_modules/estree-util-to-js

View File

@@ -0,0 +1,37 @@
import type {Options as ToJsOptions} from 'estree-util-to-js'
import type {Program} from 'estree'
import type {Plugin} from 'unified'
export interface Options extends ToJsOptions {
/**
* Automatically handled;
* not needed to pass in `recma-stringify`
*/
filePath?: never
}
// Note: we have to use manual types here,
// instead of getting them from `lib/index.js`,
// because TS generates wrong types for functions that use `this`.
// TS makes them into classes which is incorrect.
/**
* Plugin to add support for serializing as JavaScript.
*
* @this
* Unified processor.
* @param
* Configuration (optional).
* @returns
* Nothing.
*/
declare const recmaStringify: Plugin<
[(Readonly<Options> | null | undefined)?],
Program,
string
>
export default recmaStringify
// Add custom settings supported when `recma-stringify` is added.
declare module 'unified' {
interface Settings extends Options {}
}

View File

@@ -0,0 +1,2 @@
// Note: types exposed from `index.d.ts`.
export {default} from './lib/index.js'

View File

@@ -0,0 +1,30 @@
/**
* Plugin to add support for serializing as JavaScript.
*
* @this {Processor<undefined, undefined, undefined, Program, string>}
* Processor instance.
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @returns {undefined}
* Nothing.
*/
export default function recmaStringify(this: Processor<undefined, undefined, undefined, Program, string>, options?: Readonly<Options> | null | undefined): undefined;
export default class recmaStringify {
/**
* Plugin to add support for serializing as JavaScript.
*
* @this {Processor<undefined, undefined, undefined, Program, string>}
* Processor instance.
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @returns {undefined}
* Nothing.
*/
constructor(this: Processor<undefined, undefined, undefined, Program, string>, options?: Readonly<Options> | null | undefined);
compiler: (tree: Program, file: VFile) => string;
}
import type { Options } from 'recma-stringify';
import type { Program } from 'estree';
import type { Processor } from 'unified';
import type { VFile } from 'vfile';
//# sourceMappingURL=index.d.ts.map

View File

@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AASA;;;;;;;;;GASG;AACH,oHALW,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAElC,SAAS,CA4BrB;;IAnCD;;;;;;;;;OASG;IACH,yFALW,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EA8B9C;IAtBC,iBAGW,OAAO,QAEP,KAAK,KAEH,MAAM,CAPK;;6BApBA,iBAAiB;6BADjB,QAAQ;+BAEN,SAAS;2BACb,OAAO"}

View File

@@ -0,0 +1,45 @@
/**
* @import {Program} from 'estree'
* @import {Options} from 'recma-stringify'
* @import {Processor} from 'unified'
* @import {VFile} from 'vfile'
*/
import {toJs} from 'estree-util-to-js'
/**
* Plugin to add support for serializing as JavaScript.
*
* @this {Processor<undefined, undefined, undefined, Program, string>}
* Processor instance.
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @returns {undefined}
* Nothing.
*/
export default function recmaStringify(options) {
const self = this
this.compiler = compiler
/**
* @param {Program} tree
* Tree.
* @param {VFile} file
* File.
* @returns {string}
* JavaScript.
*/
function compiler(tree, file) {
const settings = {...self.data('settings'), ...options}
const result = toJs(tree, {
SourceMapGenerator: settings.SourceMapGenerator,
filePath: file.path || 'unknown.js',
handlers: settings.handlers
})
file.map = result.map
return result.value
}
}

View File

@@ -0,0 +1,21 @@
(The MIT License)
Copyright (c) Titus Wormer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

View File

@@ -0,0 +1,52 @@
{
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"bugs": "https://github.com/mdx-js/recma/issues",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
],
"description": "recma plugin to serialize JavaScript",
"dependencies": {
"@types/estree": "^1.0.0",
"estree-util-to-js": "^2.0.0",
"unified": "^11.0.0",
"vfile": "^6.0.0"
},
"exports": "./index.js",
"files": [
"lib/",
"index.d.ts",
"index.js"
],
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"homepage": "https://github.com/mdx-js/recma",
"keywords": [
"abstract",
"ast",
"compile",
"javascript",
"plugin",
"recma-plugin",
"recma",
"serialize",
"stringify",
"syntax",
"tree",
"unified"
],
"license": "MIT",
"name": "recma-stringify",
"repository": "https://github.com/mdx-js/recma/tree/main/packages/recma-stringify",
"scripts": {},
"sideEffects": false,
"typeCoverage": {
"atLeast": 100,
"detail": true,
"strict": true,
"ignoreCatch": true
},
"type": "module",
"version": "1.0.0"
}

View File

@@ -0,0 +1,251 @@
# recma-stringify
[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
[![Sponsors][badge-sponsors-image]][badge-collective-url]
[![Backers][badge-backers-image]][badge-collective-url]
[![Chat][badge-chat-image]][badge-chat-url]
**[recma][github-recma]** plugin to add support for serializing JavaScript.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(recmaStringify[, options])`](#unifieduserecmastringify-options)
* [`Options`](#options)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a [unified][github-unified] ([recma][github-recma]) plugin that
defines how to take a syntax tree as input and turn it into JavaScript.
When its used,
JavaScript is serialized as the final result.
See [the monorepo readme][github-recma] for info on what the recma ecosystem is.
## When should I use this?
This plugin adds support to unified for serializing JavaScript.
If you also need to parse JavaScript,
you can alternatively use [`recma`][github-recma-core],
which combines unified,
this plugin,
and [`recma-parse`][github-recma-parse].
If you dont use plugins and have access to the syntax tree,
you can directly use [`estree-util-to-js`][github-estree-util-to-js],
which is used inside this plugin.
recma focusses on making it easier to transform code by abstracting such
internals away.
## Install
This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:
```sh
npm install recma-stringify
```
In Deno with [`esm.sh`][esmsh]:
```js
import recmaStringify from 'https://esm.sh/recma-stringify@1'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import recmaStringify from 'https://esm.sh/recma-stringify@1?bundle'
</script>
```
## Use
Say we have the following module `example.js`:
```js
import recmaJsx from 'recma-jsx'
import recmaStringify from 'recma-stringify'
import rehypeParse from 'rehype-parse'
import rehypeRecma from 'rehype-recma'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse, {fragment: true})
.use(rehypeRecma)
.use(recmaJsx)
.use(recmaStringify)
.process('<p>Hi!<h1>Hello!')
console.log(String(file))
```
…running that with `node example.js` yields:
```jsx
<><p>{"Hi!"}</p><h1>{"Hello!"}</h1></>;
```
## API
This package exports no identifiers.
The default export is [`recmaStringify`][api-recma-stringify].
### `unified().use(recmaStringify[, options])`
Plugin to add support for serializing to JavaScript.
###### Parameters
* `options` ([`Options`][api-options], optional)
— configuration
###### Returns
Nothing (`undefined`).
### `Options`
Configuration (TypeScript type).
Same as [`Options`][github-estree-util-to-js-options]
from [`estree-util-to-js`][github-estree-util-to-js].
Passing `filePath` is not supported as it is handled for you.
## Syntax
JS is serialized according to [ECMA-262][tc39-ecma-262],
which is also followed by all browsers and engines such as Node.js.
## Syntax tree
The syntax tree format used in recma is [esast][github-esast] and
[estree][github-estree].
## Types
This package is fully typed with [TypeScript][].
It exports the additional type
[`Options`][api-options].
## Compatibility
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release,
we drop support for unmaintained versions of Node.
This means we try to keep the current release line,
`recma-strignify@1`,
compatible with Node.js 16.
## Security
As **recma** works on JS and evaluating JS is unsafe,
use of recma can also be unsafe.
Do not evaluate unsafe code.
Use of recma plugins could also open you up to other attacks.
Carefully assess each plugin and the risks involved in using them.
For info on how to submit a report, see our [security policy][health-security].
## Contribute
See [§ Contribute][mdxjs-contribute] on our site for ways to get started.
See [§ Support][mdxjs-support] for ways to get help.
This project has a [code of conduct][health-coc].
By interacting with this repository,
organization,
or community you agree to abide by its terms.
## License
[MIT][file-license] © [Titus Wormer][wooorm]
<!-- Definitions -->
[api-options]: #options
[api-recma-stringify]: #unifieduserecmastringify-options
[badge-backers-image]: https://opencollective.com/unified/backers/badge.svg
[badge-build-image]: https://github.com/mdx-js/recma/actions/workflows/main.yml/badge.svg
[badge-build-url]: https://github.com/mdx-js/recma/actions
[badge-collective-url]: https://opencollective.com/unified
[badge-coverage-image]: https://img.shields.io/codecov/c/github/mdx-js/recma.svg
[badge-coverage-url]: https://codecov.io/github/mdx-js/recma
[badge-downloads-image]: https://img.shields.io/npm/dm/recma-stringify.svg
[badge-downloads-url]: https://www.npmjs.com/package/recma-stringify
[badge-size-image]: https://img.shields.io/bundlejs/size/recma-stringify
[badge-size-url]: https://bundlejs.com/?q=recma-stringify
[badge-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg
[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg
[badge-chat-url]: https://github.com/mdx-js/mdx/discussions
[esmsh]: https://esm.sh
[file-license]: license
[github-esast]: https://github.com/syntax-tree/esast
[github-estree-util-to-js]: https://github.com/syntax-tree/estree-util-to-js
[github-estree-util-to-js-options]: https://github.com/syntax-tree/estree-util-to-js#options
[github-estree]: https://github.com/estree/estree
[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[github-recma-core]: https://github.com/mdx-js/recma/tree/main/packages/recma
[github-recma-parse]: https://github.com/mdx-js/recma/tree/main/packages/recma-parse
[github-recma]: https://github.com/mdx-js/recma
[github-unified]: https://github.com/unifiedjs/unified
[health-coc]: https://github.com/mdx-js/.github/blob/main/code-of-conduct.md
[health-security]: https://github.com/mdx-js/.github/blob/main/security.md
[mdxjs-contribute]: https://mdxjs.com/community/contribute/
[mdxjs-support]: https://mdxjs.com/community/support/
[npm-install]: https://docs.npmjs.com/cli/install
[tc39-ecma-262]: https://tc39.es/ecma262/multipage/
[typescript]: https://www.typescriptlang.org
[wooorm]: https://wooorm.com

View File

@@ -0,0 +1 @@
../../unified@11.0.5/node_modules/unified

View File

@@ -0,0 +1 @@
../../vfile@6.0.3/node_modules/vfile