https://github.com/gcornut/cli-valibot-to-json-schema

CLI wrapper for @valibot/to-json-schema
https://github.com/gcornut/cli-valibot-to-json-schema

cli json-schema valibot

Last synced: 3 months ago
JSON representation

CLI wrapper for @valibot/to-json-schema

• Host: GitHub
• URL: https://github.com/gcornut/cli-valibot-to-json-schema
• Owner: gcornut
• License: mit
• Created: 2024-09-15T21:09:57.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-07T21:17:04.000Z (3 months ago)
• Last Synced: 2024-10-07T21:52:49.668Z (3 months ago)
• Topics: cli, json-schema, valibot
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@gcornut/cli-valibot-to-json-schema
• Size: 202 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

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

CLI wrapper for [@valibot/to-json-schema](https://github.com/fabian-hiller/valibot/tree/main/packages/to-json-schema) to convert JS/TS files containing Valibot schemas into a JSON schema (draft 07).

```shell

# Convert valibot schemas to JSON schema

npx @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.

See detailed input and output:

_Input file `./schemas.js`_:

```js

import * as v from "valibot";

export const AString = v.string();

const AnObject = v.object({ aString: AString });

export default AnObject;

```

_Output conversion_:

```json

{

    "$schema": "http://json-schema.org/draft-07/schema#",

    "$defs": {

        "AString": {

            "type": "string"

        }

    },

    "properties": {

        "aString": {

            "$ref": "#/$defs/AString"

        }

    },

    "required": ["aString"],

    "type": "object"

}

```

`AnObject` is the default export in the source module, so it is converted as the root definition. `AString` is exported

separately, so it is exported to the `definitions` section.

[See @valibot/to-json-schema README](https://github.com/fabian-hiller/valibot/blob/main/packages/to-json-schema/README.md) 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:

```shell

# Convert from TS/ESM module using bunx

bunx @gcornut/cli-valibot-to-json-schema ./schemas.ts

# Convert from TS/ESM module with esbuild-runner preinstalled

npm install esbuild esbuild-runner

npx @gcornut/cli-valibot-to-json-schema ./schemas.ts

# Convert from TS/ESM module using `yarn dlx` multi-package feature

yarn dlx -p esbuild -p esbuild-runner -p @gcornut/cli-valibot-to-json-schema valibot-json-schema ./schemas.ts

```

## Parameters

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

Use `-t ` 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 ` 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.