CLI Builder

[waynevanson]

Hey Everyone!

I want to share an idea I'm working on.

https://github.com/waynevanson/valibot-cli

Basically, build a CLI using the schema of your app, with a few non-intrusive calls to CLI methods.

You can then parse your schema.

import * as v from "valibot"
import * as c from "@waynevanson/valibot-cli"
import * as fs from 'node:fs'

// describe using valibot where possible,
// extend cli specific options using metadata
const schema = v.strictObject({
    config: c.flag(v.optional(v.string(), "./config.json"), {
        name: "config",
        longs: ["config"],
        shorts: ["c"]
    }),
    operation: v.subcommand(
        v.variant('type', {
            read: v.object({
                type: v.literal('read')
                filepath: c.value(v.string(), { name: "file" })
            }),
            write: v.object({
                type: v.literal('write')
                filepath: c.value(v.string(), { name: "file" })
                contents: c.value(v.string())
            })
        }),
        {
            name: "operation"
        }
    )
})

function main(){
    // Creates a valid input (not the output type) to the schema.
    const input = c.parse(schema, process.argv.slice(2))

    // Whatever you like, probably applying the schema validation
    const args = v.parse(schema, input)

    // Application logic here

    const config = JSON.parse(fs.readFileSync(args.config))

    switch (args.operation.type) {
        case 'read':
            fs.readFileSync(args.filepath)
            break
        case "write":
            fs.writeFileSync(args.filepath)
            break
    }
}

// example
// <bin> -c configuration.json write '{ "name": "jay son" }' output.json
// <bin> -c configuration.json read input.json
main()

[fabian-hiller]

That's really cool! We should add it to our ecosystem page! Is your library public?

[waynevanson]

I would love to add it to the ecosystem page but it's still in it's infancy.
It will be public soon!

[fabian-hiller]

Feel free to reach out here or also on Discord if you have questions about Valibot

[waynevanson]

@fabian-hiller
https://github.com/waynevanson/valibot-cli

I'll create a PR when it supports more data types, currently supports strict_tuple, string and boolean for now.