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

@shinymayhem/json-schema-generator

v1.0.3

Published

Generate/compile .yaml files (not .yml at the moment) into a single JSON schema file. Resolves references to other schema docuements in the same directory

Downloads

12

Readme

#JSON Schema Generator

Generate/compile .yaml files (not .yml at the moment) into a single JSON schema file. Resolves references to other schema docuements in the same directory

Requires Node >= 5.0

Usage

cli

npm install -g @shinymayhem/json-schema-generator

schemagen ./schemas/car.yaml

module

var generator = require("@shinymayhem/json-schema-generator");

generator.generate('test/data/car.yaml', function onGenerated(err, schema) {
  if (err) {
    throw err;
  }
  console.log(schema);
});

Examples

Input

window.yaml

---
$schema: http://json-schema.org/draft-04/hyper-schema
id: window
title: Window
strictProperties: true
additionalProperties: false
definitions:
  style:
    type:
      - string
    enum:
      - georgian
      - center bar
type:
  - object
required:
  - size
  - style
properties:
  style:
    $ref: window#/definitions/style
  size:
    $ref: size

size.yaml

---
$schema: http://json-schema.org/draft-04/hyper-schema
id: size
title: Size
description: Length and width
strictProperties: true
additionalProperties: false
definitions:
  width:
    type: integer
    minimum: 1
    maximum: 100
  height:
    type: integer
    minimum: 1
    maximum: 100
  units:
    type: string
    enum:
      - inches
      - centimeters
type:
  - object
required:
  - width
  - height
  - units
properties:
  height:
    $ref: size#/definitions/height
  width:
    $ref: size#/definitions/width
  units:
    $ref: size#/definitions/units

Run it

schemagen ./window.yaml

Output

{  
   "$schema":"http://json-schema.org/draft-04/hyper-schema",
   "id":"window",
   "title":"Window",
   "strictProperties":true,
   "additionalProperties":false,
   "definitions":{  
      "style":{  
         "type":[  
            "string"
         ],
         "enum":[  
            "georgian",
            "center bar"
         ]
      },
      "size":{  
         "$schema":"http://json-schema.org/draft-04/hyper-schema",
         "id":"size",
         "title":"Size",
         "description":"Length and width",
         "strictProperties":true,
         "additionalProperties":false,
         "definitions":{  
            "width":{  
               "type":"integer",
               "minimum":1,
               "maximum":100
            },
            "height":{  
               "type":"integer",
               "minimum":1,
               "maximum":100
            },
            "units":{  
               "type":"string",
               "enum":[  
                  "inches",
                  "centimeters"
               ]
            }
         },
         "type":[  
            "object"
         ],
         "required":[  
            "width",
            "height",
            "units"
         ],
         "properties":{  
            "height":{  
               "$ref":"#/definitions/size/definitions/height"
            },
            "width":{  
               "$ref":"#/definitions/size/definitions/width"
            },
            "units":{  
               "$ref":"#/definitions/size/definitions/units"
            }
         }
      }
   },
   "type":[  
      "object"
   ],
   "required":[  
      "size",
      "style"
   ],
   "properties":{  
      "style":{  
         "$ref":"#/definitions/style"
      },
      "size":{  
         "$ref":"#/definitions/size"
      }
   }
}

Valid data

{
  "style": "georgian",
  "size": {
    "width": 32,
    "height": 32,
    "units": "inches"
  }
}

Alternatively, see 'test/data' dir for example schema files