sveld 0.35.0 → 0.35.2

package/README.md

@@ -132,6 +132,7 @@ export default class Button extends SvelteComponentTyped<
   - [CLI](#cli)
   - [CI: API-drift checks (`--check`)](#ci-api-drift-checks---check)
   - [Node.js](#nodejs)
+  - [Browser](#browser)
   - [Config File](#config-file)
   - [Publishing to NPM](#publishing-to-npm)
 - [Available Options](#available-options)
@@ -568,6 +569,51 @@ sveld({
 });
 ```
 
+### Browser
+
+`sveld/browser` is a Node-free subpath export for running `sveld` client-side — e.g. an in-browser Svelte playground or REPL that parses whatever `.svelte` source the user typed and renders docs for it live. It bundles with Vite, esbuild, webpack, or Rollup without a `node:fs`/`node:path` polyfill.
+
+It covers parsing one component's source and rendering that result to any output format `sveld` supports (JSON, Markdown, `.d.ts`, Custom Elements Manifest). It does not cover project-wide glob scanning, the config file, or the CLI/Vite plugin (`sveld()`/`pluginSveld()`) — those walk the filesystem and only make sense in Node. Use the main `sveld` entry point for those.
+
+```ts
+import {
+  asNormalizedPath,
+  ComponentParser,
+  buildComponentApiDocument,
+  writeMarkdownCore,
+  writeTsDefinition,
+  buildCustomElementsManifest,
+} from "sveld/browser";
+
+const parser = new ComponentParser();
+const moduleName = "Button";
+const filePath = "Button.svelte";
+const parsed = parser.parseSvelteComponent(source, { moduleName, filePath });
+
+// `parseSvelteComponent` returns component metadata only; add `moduleName`
+// and `filePath` yourself to match the `ComponentDocApi` shape the writers expect.
+const component = { ...parsed, moduleName, filePath: asNormalizedPath(filePath) };
+const components = new Map([[moduleName, component]]);
+
+// JSON
+const jsonDoc = buildComponentApiDocument(components);
+
+// Markdown
+const markdown = writeMarkdownCore(components);
+
+// TypeScript definitions (per component)
+const dts = writeTsDefinition(jsonDoc.components[0]);
+
+// Custom Elements Manifest
+const cem = buildCustomElementsManifest(components, {
+  resolveModulePath: (component) => component.filePath,
+});
+```
+
+`ComponentParser` is stateful but reusable across parses — call `parseSvelteComponent` again on the same instance for the next component instead of constructing a new one each time.
+
+See [`playground/`](playground) in this repo for a working example: it parses Svelte source typed into an editor and renders JSON, Markdown, TypeScript, and Custom Elements Manifest tabs, all client-side.
+
 ### Config File
 
 Put a `sveld.config.js`, `sveld.config.mjs`, or `sveld.config.ts` at your project root to set defaults for the CLI and the programmatic `sveld()` API.
@@ -637,12 +683,8 @@ The `svelte` condition lets bundlers that understand it (Vite, Rollup, webpack v
 - **`glob`** (boolean, optional): Enable glob mode to analyze all `*.svelte` files.
 - **`documentExports`** (boolean, optional): Include consts, functions, and types from the entry barrel in JSON (`exports`) and Markdown ("Exports"). Off by default. See [Documenting Entry Exports](#documenting-entry-exports).
 - **`types`** (boolean, optional, default: `true`): Generate TypeScript definitions.
-<<<<<<< HEAD
 - **`typesOptions`** (object, optional): Options for TypeScript definition generation, including `outDir`, `preamble`, and `format`.
   - **`format`** (`"class"` | `"component"`, optional, default: `"class"`): `.d.ts` output shape. `"class"` extends `SvelteComponentTyped`; `"component"` emits the Svelte 5 `Component` type. Also available as `--types-format`. See [`.d.ts` output format](#dts-output-format-typesoptionsformat).
-=======
-- **`typesOptions`** (object, optional): Options for TypeScript definition generation, including `outDir` and `preamble`.
->>>>>>> 0724225 (feat(writer)!: remove prettier entirely)
 - **`json`** (boolean, optional): Generate component documentation in JSON format.
 - **`jsonOptions`** (object, optional): Options for JSON output.
 - **`markdown`** (boolean, optional): Generate component documentation in Markdown format.

package/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import("./lib/index.js")
+import("./lib/cli-entry.js")
   .then(({ cli }) => cli(process))
   .catch((error) => {
     console.error(error);