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

@naturalcycles/json-schema-lib

v1.11.1

Published

JSON schema to/from TypeScript parser/generator

Downloads

14

Readme

@naturalcycles/json-schema-lib

JSON schema to/from TypeScript parser/generator

npm code style: prettier

Allows to generate JSON Schema from a set of Typescript files with Interfaces (also Types and Enums).

Also, to generate Typescript files from JSON schemas (reverse).

Status: experimental! Everything is subject to change!

Example

Install json-schema-lib as your devDependency:

yarn add -D @naturacycles/json-schema-lib

Define a jsonSchemaGenerator.cfg.js in the root of you project:

module.exports = {
  paths: ['src/types/*.ts'],
  outputDir: 'resources/schemas',
}

Config says to scan all *.ts files in src/types, parse them, generate JSON schemas, write them into resources/schemas folder.

Similar projects

  • https://github.com/YousefED/typescript-json-schema
  • https://github.com/vega/ts-json-schema-generator

Develop

Typescript AST debugging: https://ts-ast-viewer.com/

Supported

  • Schemas from:
    • Interfaces
    • Types
    • Enums
    • Classes
  • string, number, boolean
  • Literal types, e.g someString, 15, true
  • null type
  • object, array
  • tuple
  • enum (string and number values)
  • optional/required properties
  • Union types (|), Intersections (&), extends
  • jsdoc @validationType (e.g. integer)
  • Type references, e.g. p: Person (where Person is defined elsewhere, can be in another file)
  • Parsing a list of files (not necessary for all types to be in 1 file)
  • Partial, Required
  • Record<A, B>
  • Indexed properties ({ [name: string]: string })
  • StringMap (aka Dictionary)
  • jsdoc tags:
    • validationType to override type, e.g. @validationType integer
    • General: deprecated, readOnly, writeOnly, default
    • String: pattern, format, minLength, maxLength
    • Number: multipleOf, minimum, exclusiveMinimum, maximum, exclusiveMaximum
    • Object: additionalProperties, minProperties, maxProperties
    • Array: minItems, maxItems, uniqueItems
    • Schema composition: if, then, else, dependencies, dependentRequired, dependentSchemas

Currently NOT supported

  • Omit, Pick
  • Generic interfaces, e.g. interface MyType<T> { current: T, future: T }
  • typeof
  • keyof
  • Conditional types