@gcornut/cli-valibot-to-json-schema

CLI wrapper for @valibot/to-json-schema to convert JS/TS files containing Valibot schemas into a JSON schema (draft 07).

1# Convert valibot schemas to JSON schema
2npx @gcornut/cli-valibot-to-json-schema ./schemas.js

This outputs a conversion of the Valibot schemas into JSON schema. If the default export is a Valibot schemas, it is used as the root definition. Other exported Valibot schemas are converted in the JSON schema $defs section.

1import * as v from "valibot";
2
3export const AString = v.string();
4const AnObject = v.object({ aString: AString });
5export default AnObject;

1{
2    "$schema": "http://json-schema.org/draft-07/schema#",
3    "$defs": {
4        "AString": {
5            "type": "string"
6        }
7    },
8    "properties": {
9        "aString": {
10            "$ref": "#/$defs/AString"
11        }
12    },
13    "required": ["aString"],
14    "type": "object"
15}

See @valibot/to-json-schema README for details on the limited compatibility when converting Valibot schema.

ESM and TypeScript input module

This CLI loads the input JS module using standard NodeJS CommonJS require. This means you will have issues with ESM or TypeScript modules.

To remedy that, you will either have to preinstall ebuild-runner and esbuild (so that the program can use them) or use a Node-compatible runtime that support these modules (ex: bun, replacing npx with bunx).

Example:

1# Convert from TS/ESM module using bunx
2bunx @gcornut/cli-valibot-to-json-schema ./schemas.ts
3
4# Convert from TS/ESM module with esbuild-runner preinstalled
5npm install esbuild esbuild-runner
6npx @gcornut/cli-valibot-to-json-schema ./schemas.ts
7
8# Convert from TS/ESM module using `yarn dlx` multi-package feature
9yarn dlx -p esbuild -p esbuild-runner -p @gcornut/cli-valibot-to-json-schema valibot-json-schema ./schemas.ts

Parameters

Use -o <file> option to output the JSON schema to a file instead of stdout.

Use -t <type> option to select the root definitions from the module exports (defaults to the "default" export). Example: -t foo.bar will get the property bar on the foo export of the input module.

Use -d <type> option to select the definitions from the module exports (instead of using all non-default export). Example: -d foo.bar will get the property bar on the foo export of the input module.

Use --force to ignore unsupported schemas and validations and still provide an output.

Use --definitionsKey to replace the default $defs definitions key with a custom one (ex: definitions like in previous version of JSONSchema).