@kubb/renderer-jsx 5.0.0-beta.61 → 5.0.0-beta.63

package/dist/index.cjs

@@ -12,8 +12,7 @@ const CALLOUT_LABEL = {
 	caution: "CAUTION"
 };
 /**
-* Renders a GitHub-style alert callout, portable across GitHub, GitLab,
-* VitePress, Obsidian, and MDX.
+* Renders a GitHub-style alert callout using the `> [!TYPE]` blockquote syntax.
 *
 * Emits a `<File.Source>` block containing `> [!TYPE] Title` followed by the
 * body with every line prefixed by `> `.
@@ -99,8 +98,8 @@ File.displayName = "File";
 /**
 * Marks a block of source text to be associated with the enclosing {@link File}.
 *
-* Children are treated as the source string. When `isExportable` is `true` the
-* `name` is used for deduplication and barrel generation.
+* Children are treated as the source string. `isExportable` prepends the `export` keyword,
+* `isIndexable` includes the source in barrel/index generation, and `name` keys deduplication.
 *
 * @example Exportable, indexable source block
 * ```tsx
@@ -198,8 +197,7 @@ File.Source = FileSource;
 *
 * Renders a `<File.Source>` block containing `---\n<yaml>\n---`. Place it as
 * the first child of `<File>` so it appears at the top of the output. Pair with
-* `parserMd` to write `.md` files that downstream tooling (VitePress, MDX,
-* static-site generators) treats as frontmatter.
+* `parserMd` to write `.md` files whose frontmatter downstream tooling can read.
 *
 * @example Page frontmatter at the top of a generated markdown file
 * ```tsx
@@ -304,10 +302,10 @@ Heading.displayName = "Heading";
 /**
 * Embeds a raw JSX string verbatim in the generated source code.
 *
-* Use this component when you need to include JSX markup (including fragments
-* `<>…</>`) in the body of a generated function or component. The `children`
-* prop must be a plain string, expression attributes that reference runtime
-* values should be written as template literals.
+* Use this component to include JSX markup (including fragments `<>…</>`) in the
+* body of a generated function or component. The `children` prop must be a plain
+* string. Write expression attributes that reference runtime values as template
+* literals.
 *
 * @example
 * ```tsx
@@ -404,10 +402,10 @@ Type.displayName = "Type";
 //#endregion
 //#region src/SyncRuntime.tsx
 /**
-* Walks `element`, resolving arrays, Fragments, and function components
-* transparently, then calls `onText` for primitive values and `onHost` for
-* every host element encountered. Pure function components are called
-* synchronously. Hooks and class components are not supported.
+* Walks `element`, resolving arrays, Fragments, and function components, then
+* calls `onText` for primitive values and `onHost` for each host element.
+* Function components are called synchronously. Hooks and class components are
+* not supported.
 */
 function walkElement(element, onText, onHost) {
 	if (element == null || typeof element === "boolean") return;
@@ -597,8 +595,7 @@ function* walkFiles(element) {
 * DOM. No React fiber, scheduler, or work loop is involved.
 *
 * All components must be pure functions. Hooks and class components are not
-* supported. Produces identical output to the React-backed {@link Runtime} at
-* approximately 2, 4× the speed and a fraction of the allocations.
+* supported.
 */
 var SyncRuntime = class {
 	/**
@@ -632,14 +629,14 @@ var SyncRuntime = class {
 //#endregion
 //#region src/createRenderer.tsx
 /**
-* Renderer that walks the JSX tree in a single recursive pass, with no React
-* reconciler or scheduler. Pass as the `renderer` property on
-* `defineGenerator`. Kubb core stays generic, with no hard dependency on
-* `@kubb/renderer-jsx`.
+* Factory for a renderer that walks the JSX tree in a single recursive pass,
+* with no React reconciler or scheduler. Pass it as the `renderer` property on
+* `defineGenerator`. Kubb core calls the factory once per render cycle and stays
+* generic, with no hard dependency on `@kubb/renderer-jsx`.
 *
 * Every component must be a pure function. Hooks, suspense, and class
-* components are not supported. It also exposes `stream()` for incremental
-* file emission.
+* components are not supported. The returned renderer also exposes `stream()`
+* for incremental file emission.
 *
 * @example Wire up a JSX generator
 * ```tsx

package/dist/index.d.ts

@@ -28,8 +28,7 @@ type Props$7 = {
   children: string;
 };
 /**
- * Renders a GitHub-style alert callout, portable across GitHub, GitLab,
- * VitePress, Obsidian, and MDX.
+ * Renders a GitHub-style alert callout using the `> [!TYPE]` blockquote syntax.
  *
  * Emits a `<File.Source>` block containing `> [!TYPE] Title` followed by the
  * body with every line prefixed by `> `.
@@ -68,7 +67,6 @@ type ConstProps = {
    * Emit the `export` keyword before the `const` declaration.
    * - `true` generates `export const name = …`
    * - `false` generates `const name = …`
-   * @default false
    */
   export?: boolean | null;
   /**
@@ -84,14 +82,13 @@ type ConstProps = {
    */
   JSDoc?: JSDoc | null;
   /**
-   * Append `as const` after the initialiser, enabling TypeScript const assertions.
+   * Append `as const` after the initializer, enabling TypeScript const assertions.
    * - `true` generates `const name = … as const`
    * - `false` generates `const name = …`
-   * @default false
    */
   asConst?: boolean | null;
   /**
-   * Child nodes rendered as the initialiser expression of the constant.
+   * Child nodes rendered as the initializer expression of the constant.
    */
   children?: KubbReactNode;
 };
@@ -153,8 +150,7 @@ type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName;
 type Props$6<TMeta> = BaseProps & {
   key?: Key;
   /**
-   * Arbitrary metadata attached to the file node.
-   * Used by plugins for barrel generation and custom post-processing.
+   * Arbitrary metadata attached to the file node for plugins to read.
    */
   meta?: TMeta | null;
   /**
@@ -208,8 +204,8 @@ type FileSourceProps = Omit<SourceNode, 'kind' | 'value'> & {
 /**
  * Marks a block of source text to be associated with the enclosing {@link File}.
  *
- * Children are treated as the source string. When `isExportable` is `true` the
- * `name` is used for deduplication and barrel generation.
+ * Children are treated as the source string. `isExportable` prepends the `export` keyword,
+ * `isIndexable` includes the source in barrel/index generation, and `name` keys deduplication.
  *
  * @example Exportable, indexable source block
  * ```tsx
@@ -294,7 +290,7 @@ type Props$5 = {
    * Plain object serialized as YAML between `---` fences.
    *
    * @example
-   * `data: { title: 'Pets', layout: 'doc' }`
+   * `{ title: 'Pets', layout: 'doc' }`
    */
   data: Record<string, unknown>;
 };
@@ -303,8 +299,7 @@ type Props$5 = {
  *
  * Renders a `<File.Source>` block containing `---\n<yaml>\n---`. Place it as
  * the first child of `<File>` so it appears at the top of the output. Pair with
- * `parserMd` to write `.md` files that downstream tooling (VitePress, MDX,
- * static-site generators) treats as frontmatter.
+ * `parserMd` to write `.md` files whose frontmatter downstream tooling can read.
  *
  * @example Page frontmatter at the top of a generated markdown file
  * ```tsx
@@ -336,7 +331,6 @@ type Props$4 = {
   /**
    * Emit `default` after the `export` keyword, making this the module's default export.
    * Requires `export` to also be `true`.
-   * @default false
    */
   default?: boolean | null;
   /**
@@ -350,14 +344,12 @@ type Props$4 = {
    * Emit the `export` keyword before the function declaration.
    * - `true` generates `export function name(…) { … }`
    * - `false` generates `function name(…) { … }`
-   * @default false
    */
   export?: boolean | null;
   /**
    * Emit the `async` keyword, making this an async function.
    * The return type is automatically wrapped in `Promise<returnType>` when both
    * `async` and `returnType` are set.
-   * @default false
    */
   async?: boolean | null;
   /**
@@ -415,7 +407,6 @@ type ArrowFunctionProps = Props$4 & {
    * Render the arrow function as a single-line expression (no braces around the body).
    * - `true` generates `const name = (…) => expression`
    * - `false` generates `const name = (…) => { … }`
-   * @default false
    */
   singleLine?: boolean | null;
 };
@@ -477,8 +468,9 @@ declare namespace Heading {
 //#region src/components/Jsx.d.ts
 type Props$2 = {
   /**
-   * Raw JSX string to embed verbatim in the generated code.
-   * Supports JSX fragments (`<>…</>`), elements, and any valid JSX syntax.
+   * Raw JSX string embedded verbatim in the generated code, including
+   * fragments (`<>…</>`).
+   *
    * @example
    * ```tsx
    * <Jsx>{'<>\n  <a href={href}>Open</a>\n</>'}</Jsx>
@@ -489,10 +481,10 @@ type Props$2 = {
 /**
  * Embeds a raw JSX string verbatim in the generated source code.
  *
- * Use this component when you need to include JSX markup (including fragments
- * `<>…</>`) in the body of a generated function or component. The `children`
- * prop must be a plain string, expression attributes that reference runtime
- * values should be written as template literals.
+ * Use this component to include JSX markup (including fragments `<>…</>`) in the
+ * body of a generated function or component. The `children` prop must be a plain
+ * string. Write expression attributes that reference runtime values as template
+ * literals.
  *
  * @example
  * ```tsx
@@ -591,7 +583,6 @@ type TypeProps = {
    * Emit the `export` keyword before the type alias declaration.
    * - `true` generates `export type Name = …`
    * - `false` generates `type Name = …`
-   * @default false
    */
   export?: boolean | null;
   /**
@@ -635,14 +626,14 @@ declare namespace Type {
 //#endregion
 //#region src/createRenderer.d.ts
 /**
- * Renderer that walks the JSX tree in a single recursive pass, with no React
- * reconciler or scheduler. Pass as the `renderer` property on
- * `defineGenerator`. Kubb core stays generic, with no hard dependency on
- * `@kubb/renderer-jsx`.
+ * Factory for a renderer that walks the JSX tree in a single recursive pass,
+ * with no React reconciler or scheduler. Pass it as the `renderer` property on
+ * `defineGenerator`. Kubb core calls the factory once per render cycle and stays
+ * generic, with no hard dependency on `@kubb/renderer-jsx`.
  *
  * Every component must be a pure function. Hooks, suspense, and class
- * components are not supported. It also exposes `stream()` for incremental
- * file emission.
+ * components are not supported. The returned renderer also exposes `stream()`
+ * for incremental file emission.
  *
  * @example Wire up a JSX generator
  * ```tsx

package/dist/index.js

@@ -11,8 +11,7 @@ const CALLOUT_LABEL = {
 	caution: "CAUTION"
 };
 /**
-* Renders a GitHub-style alert callout, portable across GitHub, GitLab,
-* VitePress, Obsidian, and MDX.
+* Renders a GitHub-style alert callout using the `> [!TYPE]` blockquote syntax.
 *
 * Emits a `<File.Source>` block containing `> [!TYPE] Title` followed by the
 * body with every line prefixed by `> `.
@@ -98,8 +97,8 @@ File.displayName = "File";
 /**
 * Marks a block of source text to be associated with the enclosing {@link File}.
 *
-* Children are treated as the source string. When `isExportable` is `true` the
-* `name` is used for deduplication and barrel generation.
+* Children are treated as the source string. `isExportable` prepends the `export` keyword,
+* `isIndexable` includes the source in barrel/index generation, and `name` keys deduplication.
 *
 * @example Exportable, indexable source block
 * ```tsx
@@ -197,8 +196,7 @@ File.Source = FileSource;
 *
 * Renders a `<File.Source>` block containing `---\n<yaml>\n---`. Place it as
 * the first child of `<File>` so it appears at the top of the output. Pair with
-* `parserMd` to write `.md` files that downstream tooling (VitePress, MDX,
-* static-site generators) treats as frontmatter.
+* `parserMd` to write `.md` files whose frontmatter downstream tooling can read.
 *
 * @example Page frontmatter at the top of a generated markdown file
 * ```tsx
@@ -303,10 +301,10 @@ Heading.displayName = "Heading";
 /**
 * Embeds a raw JSX string verbatim in the generated source code.
 *
-* Use this component when you need to include JSX markup (including fragments
-* `<>…</>`) in the body of a generated function or component. The `children`
-* prop must be a plain string, expression attributes that reference runtime
-* values should be written as template literals.
+* Use this component to include JSX markup (including fragments `<>…</>`) in the
+* body of a generated function or component. The `children` prop must be a plain
+* string. Write expression attributes that reference runtime values as template
+* literals.
 *
 * @example
 * ```tsx
@@ -403,10 +401,10 @@ Type.displayName = "Type";
 //#endregion
 //#region src/SyncRuntime.tsx
 /**
-* Walks `element`, resolving arrays, Fragments, and function components
-* transparently, then calls `onText` for primitive values and `onHost` for
-* every host element encountered. Pure function components are called
-* synchronously. Hooks and class components are not supported.
+* Walks `element`, resolving arrays, Fragments, and function components, then
+* calls `onText` for primitive values and `onHost` for each host element.
+* Function components are called synchronously. Hooks and class components are
+* not supported.
 */
 function walkElement(element, onText, onHost) {
 	if (element == null || typeof element === "boolean") return;
@@ -596,8 +594,7 @@ function* walkFiles(element) {
 * DOM. No React fiber, scheduler, or work loop is involved.
 *
 * All components must be pure functions. Hooks and class components are not
-* supported. Produces identical output to the React-backed {@link Runtime} at
-* approximately 2, 4× the speed and a fraction of the allocations.
+* supported.
 */
 var SyncRuntime = class {
 	/**
@@ -631,14 +628,14 @@ var SyncRuntime = class {
 //#endregion
 //#region src/createRenderer.tsx
 /**
-* Renderer that walks the JSX tree in a single recursive pass, with no React
-* reconciler or scheduler. Pass as the `renderer` property on
-* `defineGenerator`. Kubb core stays generic, with no hard dependency on
-* `@kubb/renderer-jsx`.
+* Factory for a renderer that walks the JSX tree in a single recursive pass,
+* with no React reconciler or scheduler. Pass it as the `renderer` property on
+* `defineGenerator`. Kubb core calls the factory once per render cycle and stays
+* generic, with no hard dependency on `@kubb/renderer-jsx`.
 *
 * Every component must be a pure function. Hooks, suspense, and class
-* components are not supported. It also exposes `stream()` for incremental
-* file emission.
+* components are not supported. The returned renderer also exposes `stream()`
+* for incremental file emission.
 *
 * @example Wire up a JSX generator
 * ```tsx

package/dist/jsx-runtime.d.ts

@@ -6,9 +6,8 @@ import { a as KubbExportProps, c as KubbImportProps, d as KubbReactNode, f as Ku
  * JSX contract for `@kubb/renderer-jsx`, resolved through `jsxImportSource`.
  *
  * It is self-contained and does not extend `React.JSX`. The renderer only emits
- * the custom `kubb-*` hosts plus `br`, `indent`, and `dedent`, and supports
- * pure function components, so the HTML element and class-component machinery
- * from `@types/react` is not needed.
+ * the custom `kubb-*` hosts plus `br`, and supports pure function components, so
+ * the HTML element and class-component machinery from `@types/react` is not needed.
  */
 declare namespace JSX {
   type ElementType = string | ((props: any) => KubbReactNode);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/renderer-jsx",
-  "version": "5.0.0-beta.61",
+  "version": "5.0.0-beta.63",
   "description": "Self-contained synchronous JSX renderer for Kubb. Turns JSX into FileNodes with built-in components (File, Function, Type, Const) for component-based, type-safe code generation. No React dependency.",
   "keywords": [
     "codegen",
@@ -75,7 +75,7 @@
   },
   "dependencies": {
     "yaml": "^2.9.0",
-    "@kubb/ast": "5.0.0-beta.61"
+    "@kubb/ast": "5.0.0-beta.63"
   },
   "devDependencies": {
     "@internals/utils": "0.0.0"

package/src/SyncRuntime.tsx

@@ -8,10 +8,10 @@ type OnText = (text: string) => void
 type OnHost = (type: string, props: Record<string, unknown>) => void
 
 /**
- * Walks `element`, resolving arrays, Fragments, and function components
- * transparently, then calls `onText` for primitive values and `onHost` for
- * every host element encountered. Pure function components are called
- * synchronously. Hooks and class components are not supported.
+ * Walks `element`, resolving arrays, Fragments, and function components, then
+ * calls `onText` for primitive values and `onHost` for each host element.
+ * Function components are called synchronously. Hooks and class components are
+ * not supported.
  */
 function walkElement(element: unknown, onText: OnText, onHost: OnHost): void {
   if (element == null || typeof element === 'boolean') return
@@ -260,8 +260,7 @@ function* walkFiles(element: unknown): Generator<FileNode> {
  * DOM. No React fiber, scheduler, or work loop is involved.
  *
  * All components must be pure functions. Hooks and class components are not
- * supported. Produces identical output to the React-backed {@link Runtime} at
- * approximately 2, 4× the speed and a fraction of the allocations.
+ * supported.
  */
 export class SyncRuntime {
   /**

package/src/components/Callout.tsx

@@ -28,8 +28,7 @@ type Props = {
 }
 
 /**
- * Renders a GitHub-style alert callout, portable across GitHub, GitLab,
- * VitePress, Obsidian, and MDX.
+ * Renders a GitHub-style alert callout using the `> [!TYPE]` blockquote syntax.
  *
  * Emits a `<File.Source>` block containing `> [!TYPE] Title` followed by the
  * body with every line prefixed by `> `.

package/src/components/Const.tsx

@@ -13,7 +13,6 @@ type ConstProps = {
    * Emit the `export` keyword before the `const` declaration.
    * - `true` generates `export const name = …`
    * - `false` generates `const name = …`
-   * @default false
    */
   export?: boolean | null
   /**
@@ -29,14 +28,13 @@ type ConstProps = {
    */
   JSDoc?: JSDoc | null
   /**
-   * Append `as const` after the initialiser, enabling TypeScript const assertions.
+   * Append `as const` after the initializer, enabling TypeScript const assertions.
    * - `true` generates `const name = … as const`
    * - `false` generates `const name = …`
-   * @default false
    */
   asConst?: boolean | null
   /**
-   * Child nodes rendered as the initialiser expression of the constant.
+   * Child nodes rendered as the initializer expression of the constant.
    */
   children?: KubbReactNode
 }

package/src/components/File.tsx

@@ -35,8 +35,7 @@ type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName
 type Props<TMeta> = BaseProps & {
   key?: Key
   /**
-   * Arbitrary metadata attached to the file node.
-   * Used by plugins for barrel generation and custom post-processing.
+   * Arbitrary metadata attached to the file node for plugins to read.
    */
   meta?: TMeta | null
   /**
@@ -94,8 +93,8 @@ type FileSourceProps = Omit<SourceNode, 'kind' | 'value'> & {
 /**
  * Marks a block of source text to be associated with the enclosing {@link File}.
  *
- * Children are treated as the source string. When `isExportable` is `true` the
- * `name` is used for deduplication and barrel generation.
+ * Children are treated as the source string. `isExportable` prepends the `export` keyword,
+ * `isIndexable` includes the source in barrel/index generation, and `name` keys deduplication.
  *
  * @example Exportable, indexable source block
  * ```tsx

package/src/components/Frontmatter.tsx

@@ -7,7 +7,7 @@ type Props = {
    * Plain object serialized as YAML between `---` fences.
    *
    * @example
-   * `data: { title: 'Pets', layout: 'doc' }`
+   * `{ title: 'Pets', layout: 'doc' }`
    */
   data: Record<string, unknown>
 }
@@ -17,8 +17,7 @@ type Props = {
  *
  * Renders a `<File.Source>` block containing `---\n<yaml>\n---`. Place it as
  * the first child of `<File>` so it appears at the top of the output. Pair with
- * `parserMd` to write `.md` files that downstream tooling (VitePress, MDX,
- * static-site generators) treats as frontmatter.
+ * `parserMd` to write `.md` files whose frontmatter downstream tooling can read.
  *
  * @example Page frontmatter at the top of a generated markdown file
  * ```tsx

package/src/components/Function.tsx

@@ -12,7 +12,6 @@ type Props = {
   /**
    * Emit `default` after the `export` keyword, making this the module's default export.
    * Requires `export` to also be `true`.
-   * @default false
    */
   default?: boolean | null
   /**
@@ -26,14 +25,12 @@ type Props = {
    * Emit the `export` keyword before the function declaration.
    * - `true` generates `export function name(…) { … }`
    * - `false` generates `function name(…) { … }`
-   * @default false
    */
   export?: boolean | null
   /**
    * Emit the `async` keyword, making this an async function.
    * The return type is automatically wrapped in `Promise<returnType>` when both
    * `async` and `returnType` are set.
-   * @default false
    */
   async?: boolean | null
   /**
@@ -108,7 +105,6 @@ type ArrowFunctionProps = Props & {
    * Render the arrow function as a single-line expression (no braces around the body).
    * - `true` generates `const name = (…) => expression`
    * - `false` generates `const name = (…) => { … }`
-   * @default false
    */
   singleLine?: boolean | null
 }

package/src/components/Jsx.tsx

@@ -2,8 +2,9 @@ import type { KubbReactElement } from '../types.ts'
 
 type Props = {
   /**
-   * Raw JSX string to embed verbatim in the generated code.
-   * Supports JSX fragments (`<>…</>`), elements, and any valid JSX syntax.
+   * Raw JSX string embedded verbatim in the generated code, including
+   * fragments (`<>…</>`).
+   *
    * @example
    * ```tsx
    * <Jsx>{'<>\n  <a href={href}>Open</a>\n</>'}</Jsx>
@@ -15,10 +16,10 @@ type Props = {
 /**
  * Embeds a raw JSX string verbatim in the generated source code.
  *
- * Use this component when you need to include JSX markup (including fragments
- * `<>…</>`) in the body of a generated function or component. The `children`
- * prop must be a plain string, expression attributes that reference runtime
- * values should be written as template literals.
+ * Use this component to include JSX markup (including fragments `<>…</>`) in the
+ * body of a generated function or component. The `children` prop must be a plain
+ * string. Write expression attributes that reference runtime values as template
+ * literals.
  *
  * @example
  * ```tsx

package/src/components/Type.tsx

@@ -14,7 +14,6 @@ type TypeProps = {
    * Emit the `export` keyword before the type alias declaration.
    * - `true` generates `export type Name = …`
    * - `false` generates `type Name = …`
-   * @default false
    */
   export?: boolean | null
   /**

package/src/createRenderer.tsx

@@ -3,14 +3,14 @@ import { SyncRuntime } from './SyncRuntime.tsx'
 import type { KubbReactElement } from './types.ts'
 
 /**
- * Renderer that walks the JSX tree in a single recursive pass, with no React
- * reconciler or scheduler. Pass as the `renderer` property on
- * `defineGenerator`. Kubb core stays generic, with no hard dependency on
- * `@kubb/renderer-jsx`.
+ * Factory for a renderer that walks the JSX tree in a single recursive pass,
+ * with no React reconciler or scheduler. Pass it as the `renderer` property on
+ * `defineGenerator`. Kubb core calls the factory once per render cycle and stays
+ * generic, with no hard dependency on `@kubb/renderer-jsx`.
  *
  * Every component must be a pure function. Hooks, suspense, and class
- * components are not supported. It also exposes `stream()` for incremental
- * file emission.
+ * components are not supported. The returned renderer also exposes `stream()`
+ * for incremental file emission.
  *
  * @example Wire up a JSX generator
  * ```tsx

package/src/jsx-namespace.d.ts

@@ -18,9 +18,8 @@ import type {
  * JSX contract for `@kubb/renderer-jsx`, resolved through `jsxImportSource`.
  *
  * It is self-contained and does not extend `React.JSX`. The renderer only emits
- * the custom `kubb-*` hosts plus `br`, `indent`, and `dedent`, and supports
- * pure function components, so the HTML element and class-component machinery
- * from `@types/react` is not needed.
+ * the custom `kubb-*` hosts plus `br`, and supports pure function components, so
+ * the HTML element and class-component machinery from `@types/react` is not needed.
  */
 export namespace JSX {
   type ElementType = string | ((props: any) => KubbReactNode)