npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wbydo/zodidien

v1.0.2

Published

Generates zod schema from JSON string on standard inputs.

Downloads

25

Readme

zodidien

Unit Testing LICENSE Created by wbydo npm

Generates zod schema from JSON string on standard inputs.

Installation

npm install --save-dev @wbydo/zodidien

Usage

Generating a schema

When you type this command...

echo '{"foo": 1234, "bar": "asdf"}' | npx zodidien foobar

This string will be output

const foobarSchema = z.object({
  foo: z.number(),
  bar: z.string(),
});

It reads from standard input and outputs to standard output, so it can be used like this.

pbpaste | npx zodidien foobar

# output
#
# const foobarSchema = z.object({
#    foo: z.number(),
#    bar: z.string()
#});

Generating a schema in code

TODO...

Convert Types

Here is what the types on JSON are converted to.†1

| JSON | TypeScript | | ------- | --------------- | | number | z.number() | | string | z.string() | | boolean | z.boolean() | | array | z.array() †2 | | object | z.object() †3 |

  • †1: If anything other than the types in the table is entered, an error will occur.
  • †2: Ignored except for first elements.
  • †3: Non-string type keys are not supported.

Dependencies

This package has the following dependencies:

zod - A TypeScript-first schema validation library.

Similar Library

rsinohara/json-to-zod - Converts JSON objects or file to simple Zod schemas

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

To check the operation in the local development environment, execute the following command

git clone https://github.com/wbydo/zodidien.git

cd zodidien

npm ci

npm test

echo '{"foo": 1234, "bar": "asdf"}' | npm start prefix

License

This library is licensed under the MIT license.