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

type-schema-compiler

v0.0.3

Published

An intuitive type schema specification language

Downloads

28

Readme

Type schema compiler

A compiler for an intuitive Javascript type schema definition language. Allows to build type checking schemas easily. For know, only compiles to AJV schemas.

(This software has been written using Haskell)

Usage

Run:

npx type-schema-compiler [files]

It will produce one js file per schema file that exports AJV schemas ready to compile.

Example

schema status
number
---
schema productStore
{
  products: [{
    name: string,
    stars: number,
    price: number
  }],
  store: string
}
---
schema user
[{
  id: number,
  name: string,
  age: number,
  worth: number,
  friends: [{
    id: number
  }]
}]

It will compile into a file of this shape

// schemaList.js
export const status = { type: "number" };
export const productStore = {type: ...};
export const user = {type: ...};

You can import them within a parent file and insert them in AJV compiler and move from there

import { status, productStore, user } from "./schemaList";
import Ajv from "ajv";

const ajv = new Ajv();

const statusValidator = ajv.compile(status);
const productValidator = ajv.compile(productStore);
const userValidator = ajv.compile(user);

const data = // .... the data to validate

const valid = productValidator.validate(data);

if (valid) {
  // ...
}

TODO

  • [ ] Improve error messaging
  • [ ] Improve export system
    • [ ] Add the possibility to have API routes as schema names
    • [ ] Make the compilation process within the export
  • [ ] Control output folder
  • [ ] Add more library choice
  • [ ] Add watch mode
  • [ ] Improve the complexity of the parsing algorithm
  • [ ] Improve error catching
    • [ ] Reserved keyword
    • [ ] Distinct schema names
  • [ ] Improve generality
    • [ ] More general object fields
    • [ ] Add tuples
    • [ ] Add checks

Feel free to contribute and suggest more features.