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

vite-plugin-json-schema-generator

v1.0.0

Published

Vite plugin to generate a JSON schema from a TypeScript type definition

Downloads

6

Readme

vite-plugin-json-schema-generator

Vite plugin to generate a JSON schema from a TypeScript type definition

Installation

npm i -D vite-plugin-json-schema-generator

Usage

// Your vite.config.ts file
import jsonSchemaGenerator from 'vite-plugin-json-schema-generator';

export default defineConfig({
  plugins: [
    jsonSchemaGenerator({
      sourceTypesPath: resolve(__dirname, 'src/types.ts'),
      targetSchemaPath: resolve(__dirname, 'schema.json'),
      schemaOverrides: {
        '$ref': '#/definitions/RootType'
      },
    }),
  ],
});

Thanks to

This is a tiny wrapper around (ts-json-schema-generator)[https://www.npmjs.com/package/ts-json-schema-generator] which does all the heavy lifting.

Caveats

There is one significant caveat that I haven't bothered to resolve since this works fine for me. If there is interest, then I'll look to address it.

Due to downstream caching this Vite plugin makes a copy of the source file in a temp folder and runs the JSON schema generator against this copy. The end result is that the type definition must be a single standalone file. It cannot reference any other files.