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

joi-schema-to-file

v0.0.8

Published

Take any JavaScript object and output a `joi` schema to an importable module.

Downloads

10

Readme

joi-schema-to-file

Take any JavaScript object and output a joi schema to an importable module.

Thanks to Alan Shaw for the underlying work on joi-machine, which this module wraps.

Install

npm i joi-schema-to-file

Usage

import { generateSchema } from 'joi-schema-to-file'

// My JavaScript object
const myObj = {
  stringKey: 'string',
  numberKey: 1,
  objectKey: {
    str: 'str'
  },
  arrayKey:[
    'string1',
    'string2'
  ]
}

// NOTE: Cannot currently be run concurrently

// Specify the full path to the file you want to create (e.g.)
const fileNameAndPath = `${__dirname}/import-export-output.js`
generateSchema(myObj, {
  stdOut: false,
  fileNameAndPath,
  jsModuleOptions: {
    importType: 'import',
    joiOrHapiJoi: 'joi',
    exportType: 'export',
    schemaName: 'myObjSchema'
  }
});

const fileNameAndPath = `${__dirname}/require-module-output.js`
generateSchema(myObj, {
  stdOut: false,
  fileNameAndPath,
  jsModuleOptions: {
    importType: 'require',
    joiOrHapiJoi: '@hapi/joi',
    exportType: 'module',
    schemaName: 'myObjSchema'
  }
});

const fileNameAndPath = `${__dirname}/schema-only-output.js`
generateSchema(myObj, {
  stdOut: false,
  fileNameAndPath,
});

Generates the following three files in the specified directory with the following:

import Joi from 'joi'

export const myObjSchema = Joi.object().keys({
    stringKey: Joi.string(),
    numberKey: Joi.number().integer(),
    objectKey: Joi.object().keys({
        str: Joi.string()
    }),
    arrayKey: Joi.array().items(Joi.string(), Joi.string())
})
const Joi = require('@hapi/joi')

exports.myObjSchema = Joi.object().keys({
    stringKey: Joi.string(),
    numberKey: Joi.number().integer(),
    objectKey: Joi.object().keys({
        str: Joi.string()
    }),
    arrayKey: Joi.array().items(Joi.string(), Joi.string())
})
Joi.object().keys({
    stringKey: Joi.string(),
    numberKey: Joi.number().integer(),
    objectKey: Joi.object().keys({
        str: Joi.string()
    }),
    arrayKey: Joi.array().items(Joi.string(), Joi.string())
})

One test included in the github repo that generates the above.