sveld 0.35.0 → 0.35.2

package/lib/writer/markdown-format-utils.d.ts

@@ -6,99 +6,15 @@ export declare const PROP_TABLE_HEADER = "| Prop name | Required | Kind | Reacti
 export declare const SLOT_TABLE_HEADER = "| Slot name | Default | Props | Fallback | Description |\n| :- | :- | :- | :- | :- |\n";
 export declare const EVENT_TABLE_HEADER = "| Event name | Type | Detail | Description |\n| :- | :- | :- | :- |\n";
 export declare const EXPORT_TABLE_HEADER = "| Name | Kind | Type | Description |\n| :- | :- | :- | :- |\n";
-/**
- * Escape `|` and wrap a prop type for markdown table cells.
- *
- * @example
- * ```ts
- * formatPropType("string | number") // Returns: "<code>string &#124; number</code>"
- * formatPropType(undefined)         // Returns: "--"
- * ```
- */
 export declare function formatPropType(type?: string): string;
-/**
- * Escape `<` and `>` for markdown output.
- *
- * @example
- * ```ts
- * escapeHtml("<div>") // Returns: "&lt;div&gt;"
- * ```
- */
 export declare function escapeHtml(text: string): string;
-/**
- * Format a default value for markdown table cells.
- *
- * @example
- * ```ts
- * formatPropValue("'hello'")  // Returns: "<code>'hello'</code>"
- * formatPropValue("`test`")   // Returns: "<code>\\`test\\`</code>"
- * ```
- */
 export declare function formatPropValue(value: string | undefined): string;
-/**
- * Strike through deprecated prop, slot, and event names in markdown tables.
- *
- * @example
- * ```ts
- * formatNameWithDeprecation("size", "use width")
- * // Returns: "<s>size</s><br />**Deprecated**: use width"
- * ```
- */
 export declare function formatNameWithDeprecation(name: string, deprecated: DeprecatedValue | undefined): string;
-/**
- * Format a prop description; newlines become `<br />`.
- *
- * @example
- * ```ts
- * formatPropDescription("Line 1\nLine 2")
- * // Returns: "Line 1<br />Line 2"
- * ```
- */
 export declare function formatPropDescription(description: string | undefined): string;
-/**
- * Format slot props for markdown table cells.
- *
- * @example
- * ```ts
- * formatSlotProps("{ title: string }") // Returns: "<code>{ title: string }</code>"
- * formatSlotProps("{}")                 // Returns: "--"
- * ```
- */
 export declare function formatSlotProps(props?: string): string;
-/**
- * Format slot fallback content for markdown table cells.
- *
- * @example
- * ```ts
- * formatSlotFallback("<p>Default</p>")
- * // Returns: "<code>&lt;p&gt;Default&lt;/p&gt;</code>"
- * ```
- */
 export declare function formatSlotFallback(fallback?: string): string;
-/**
- * Format a slot/snippet description plus pass-through JSDoc tags for markdown
- * table cells. Newlines become `<br />` and `<`, `>`, `|` are escaped so the
- * content stays inside a single table cell.
- *
- * @example
- * ```ts
- * formatSlotDescription("Header content.", [{ name: "since", body: "1.0.0" }])
- * // Returns: "Header content.<br />@since 1.0.0"
- * formatSlotDescription(undefined, [])
- * // Returns: "--"
- * ```
- */
 export declare function formatSlotDescription(description?: string, tags?: Array<{
     name: string;
     body: string;
 }>): string;
-/**
- * Format event detail types for markdown table cells.
- *
- * @example
- * ```ts
- * formatEventDetail("{ value: string }")
- * // Returns: "<code>{ value: string }</code>"
- * ```
- */
 export declare function formatEventDetail(detail?: string): string;

package/lib/writer/writer-json.d.ts

@@ -9,25 +9,15 @@ export interface WriteJsonOptions {
     entryExports?: EntryExports;
 }
 /**
- * Writes component documentation to JSON format.
- *
- * Can write either:
- * - Individual JSON files per component (when `outDir` is specified)
- * - A single combined JSON file (when only `outFile` is specified)
- *
- * @param components - Map of component documentation to write
- * @param options - Write options including output directory or file
- * @returns A promise that resolves when all files have been written
- *
  * @example
  * ```ts
- * // Write individual files:
+ * // Per-component files:
  * await writeJson(components, {
  *   inputDir: "./src",
  *   outDir: "./dist"
  * });
  *
- * // Write single file:
+ * // Single combined file:
  * await writeJson(components, {
  *   inputDir: "./src",
  *   outFile: "components.api.json"

package/lib/writer/writer-markdown.d.ts

@@ -9,8 +9,6 @@ export interface WriteMarkdownOptions {
     onAppend?: (type: AppendType, document: WriterMarkdown, components: ComponentDocs) => void;
 }
 /**
- * Renders component docs to markdown and optionally writes `outFile`.
- *
  * @example
  * ```ts
  * const markdown = await writeMarkdown(components, {

package/lib/writer/writer-ts-definitions-core.d.ts

@@ -2,23 +2,15 @@ import type { ComponentDocApi } from "../plugin";
 export declare function formatTsProps(props?: string): string;
 export declare function getTypeDefs(def: Pick<ComponentDocApi, "typedefs">): string;
 /**
- * Generates TypeScript type definitions for component contexts.
- *
- * Creates exported type definitions for each context, including generic
- * type parameters when contexts reference component generics. Handles
- * empty context objects by using `Record<string, never>`.
+ * Exported context type definitions for a component.
  *
  * @param def - Component documentation containing contexts and generics
  * @returns TypeScript type definition string, or empty string if no contexts
  *
  * @example
  * ```ts
- * // Input: contexts with generic reference
- * // Output:
  * // export type ModalContext<T> = {
- * //   /** Open the modal *\/
  * //   open: () => void;
- * //   /** Close the modal *\/
  * //   close: () => void;
  * // };
  * ```

package/lib/writer/writer-ts-definitions.d.ts

@@ -12,14 +12,6 @@ import { type WriteTsDefinitionOptions } from "./writer-ts-definitions-core";
  */
 export { formatTsProps, getContextDefs, getTypeDefs, type WriteTsDefinitionOptions, writeTsDefinition, } from "./writer-ts-definitions-core";
 /**
- * Options for writing TypeScript definition files.
- *
- * @property outDir - The output directory where `.d.ts` files will be written
- * @property inputDir - The input directory containing source components
- * @property preamble - Text to prepend to the main `index.d.ts` file
- * @property exports - Parsed export information for generating the index file
- * @property format - `"class"` (default) or `"component"`; see {@link WriteTsDefinitionOptions}
- *
  * @example
  * ```ts
  * const options: WriteTsDefinitionsOptions = {
@@ -37,34 +29,15 @@ export interface WriteTsDefinitionsOptions extends WriteTsDefinitionOptions {
     exports: ParsedExports;
 }
 /**
- * Writes TypeScript definition files for all parsed Svelte components.
- *
- * Generates individual `.d.ts` files for each component and a main `index.d.ts`
- * file that exports all components. Uses a TypeScript writer to handle file
- * I/O operations efficiently.
- *
- * @param components - Map of component module names to their parsed documentation
- * @param options - Configuration options for writing definitions
- * @returns A promise that resolves when all files have been written
- *
  * @example
  * ```ts
- * const components = new Map([
- *   ["Button", { filePath: "Button.svelte", props: [...], ... }],
- *   ["Input", { filePath: "Input.svelte", props: [...], ... }]
- * ]);
- *
  * await writeTsDefinitions(components, {
  *   outDir: "./dist",
  *   inputDir: "./src",
  *   preamble: "// Generated\n",
  *   exports: { ... }
  * });
- *
- * // Creates:
- * // - dist/Button.d.ts
- * // - dist/Input.d.ts
- * // - dist/index.d.ts
+ * // Creates dist/Button.d.ts, dist/Input.d.ts, dist/index.d.ts
  * ```
  */
 export default function writeTsDefinitions(components: ComponentDocs, options: WriteTsDefinitionsOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sveld",
-  "version": "0.35.0",
+  "version": "0.35.2",
   "license": "Apache-2.0",
   "description": "Generate TypeScript definitions and component documentation for your Svelte components.",
   "type": "module",
@@ -11,6 +11,11 @@
       "types": "./lib/index.d.ts",
       "import": "./lib/index.js",
       "default": "./lib/index.js"
+    },
+    "./browser": {
+      "types": "./lib/browser.d.ts",
+      "import": "./lib/browser.js",
+      "default": "./lib/browser.js"
     }
   },
   "bin": {