sveld 0.26.1 → 0.27.0

package/README.md

@@ -1,7 +1,6 @@
 # sveld
 
 [![NPM][npm]][npm-url]
-![GitHub](https://img.shields.io/github/license/carbon-design-system/sveld?color=262626&style=for-the-badge)
 ![npm downloads to date](https://img.shields.io/npm/dt/sveld?color=262626&style=for-the-badge)
 
 `sveld` is a TypeScript definition generator for Svelte components. It analyzes props, events, slots, and other component features through static analysis. Types and signatures can be defined using [JSDoc notation](https://jsdoc.app/). The tool can also generate component documentation in Markdown and JSON formats.
@@ -50,7 +49,7 @@ type $Props = {
    */
   primary?: boolean;
 
-  [key: `data-${string}`]: any;
+  [key: `data-${string}`]: unknown;
 };
 
 export type ButtonProps = Omit<$RestProps, keyof $Props> & $Props;
@@ -222,13 +221,13 @@ npx sveld --json --markdown
 
 ### Node.js
 
-You can also use `sveld` programmatically in Node.js.
+You can also use `sveld` programmatically in Node.js. The package is **ESM-only**; `require("sveld")` is not supported. Use `import` or dynamic `import()`.
 
 If no `input` is specified, `sveld` will infer the entry point based on the `package.json#svelte` field.
 
 ```js
-const { sveld } = require("sveld");
-const pkg = require("./package.json");
+import { sveld } from "sveld";
+import pkg from "./package.json" with { type: "json" };
 
 sveld({
   input: "./src/index.js",
@@ -946,9 +945,16 @@ There are several ways to provide type information for contexts:
 
 - Context keys must be string literals (dynamic keys are not supported)
 - Variables passed to `setContext` should have JSDoc `@type` annotations for accurate types
-- The generated type name follows the pattern: `{PascalCase}Context`
-  - `"simple-modal"` → `SimpleModalContext`
-  - `"Tabs"` → `TabsContext`
+- The generated type name follows the pattern: `{PascalCase}Context`. Separators (hyphens, underscores, dots, colons, slashes, spaces) are stripped and each segment is capitalized:
+  | Context Key | Generated Type Name |
+  | --- | --- |
+  | `"simple-modal"` | `SimpleModalContext` |
+  | `"user_settings"` | `UserSettingsContext` |
+  | `"Carbon.Modal"` | `CarbonModalContext` |
+  | `"Carbon:Modal"` | `CarbonModalContext` |
+  | `"app/modal"` | `AppModalContext` |
+  | `"My Context"` | `MyContextContext` |
+  | `"Tabs"` | `TabsContext` |
 - If no type annotation is found, the type defaults to `any` with a warning
 
 ### `@restProps`

package/cli.js

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