@webto-id/variant-check 0.1.0

package/README.md

@@ -0,0 +1,38 @@
+# @webto-id/variant-check
+
+Lint, compile, and preview a **Webto Variant Format (WVF)** section variant — an `.astro` subset — with the exact compiler that [webto.id](https://webto.id)'s marketplace runs when you upload or submit a variant. If it passes here, it passes there.
+
+```bash
+npx @webto-id/variant-check hero-split.astro --type hero
+npx @webto-id/variant-check hero-split.astro --type hero --strict --content sample.json --out preview.html --theme dark
+```
+
+| Flag | Meaning |
+|---|---|
+| `--type <sectionType>` | Section type the variant targets (`hero`, `features-grid`, `testimonials`, `cta`, `faq`, …). Required. |
+| `--strict` | Warnings become errors — the mode the marketplace uses when you **submit for review**. |
+| `--content sample.json` | Sample content for the preview (keys = your `interface Props`). |
+| `--out preview.html` | Self-contained HTML preview (written whenever the compile succeeds). |
+| `--theme light\|dark\|warm` | Demo theme for the preview. |
+| `--json` | Print the full compile result (lint, schema, hidden fields, IR) as JSON. |
+
+Exit codes: `0` clean · `1` lint errors · `2` usage.
+
+## Programmatic use
+
+```ts
+import { compile, buildPreviewDoc } from "@webto-id/variant-check";
+
+const result = await compile(source, { sectionType: "hero", strict: true });
+if (result.ok) {
+  const html = buildPreviewDoc(result.ir!, { headline: "Halo" }, "light");
+}
+```
+
+## Writing a variant
+
+- Format spec, theme tokens, inline-edit contract, JavaScript rules and the submit checklist: <https://docs.webto.id/marketplace/format-variant/>
+- Section schema reference (which `Props` fields each section type accepts): <https://docs.webto.id/marketplace/referensi-schema/>
+- AI skill that converts raw HTML into a WVF variant: <https://docs.webto.id/downloads/html-to-webto-variant.zip>
+
+Sell it on the marketplace: <https://app.webto.id/marketplace/mine>.