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

ipld-schema

v3.0.3

Published

IPLD Schema parser and CLI utilities for JavaScript

Downloads

393

Readme

ipld-schema

IPLD Schema DSL Parser and CLI utilities

Read more about IPLD Schemas at https://github.com/ipld/specs/tree/master/schemas

For validation of JavaScript object forms against an IPLD schema, see ipld-schema-validator.

Usage

import { parse } from 'ipld-schema'

let schema = parse(`
  type SimpleStruct struct {
    foo Int
    bar Bool
    baz String
  }
  type MyMap { String: SimpleStruct }
`)

console.dir(schema, { depth: Infinity })

// →
// {
//   SimpleStruct: {
//     struct: {
//       fields: {
//         foo: { type: 'Int' },
//         bar: { type: 'Bool' },
//         baz: { type: 'String' }
//       },
//       representation: { map: {} }
//     }
//   },
//   MyMap: { map: { keyType: 'String', valueType: 'SimpleStruct' } }
// }

You can also convert the parsed form back to DSL form with the print function:

import { print } from 'ipld-schema/print.js'

console.log(print(schema))

Command line

ipld-schema also exports an executable: if installed with -g you will get an ipld-schema command in your PATH.

This executable has two commands that operate on files or stdin.

  • ipld-schema validate [files...]
  • ipld-schema to-json [-t] [files...]

Both commands take either .ipldsch or .md files. When using .md files, ipld-schema will extract any ``` code blocks using the ipldsch or sh language codes.

Validation

The validate command will take an .ipldsch or .md file and validate its schema contents.

$ ipld-schema validate simple-struct.ipldsch
Validated simple-struct.ipldsch ...

or

$ ipld-schema validate README.md
Validated README.md ...

Alternatively, you can provide IPLD schema data via stdin:

$ cat simple-struct.ipldsch | ipld-schema validate
Validated <stdin> ...

JSONification

The to-json command will take one or more .ipldsch or .md files and print a JSON form of the schemas found within.

$ ipld-schema to-json simple-struct.ipldsch
{
  "schema": {
    "SimpleStruct": {
      "struct": {
        "fields": {
          "foo": {
            "type": "Int"
          },
          "bar": {
            "type": "Bool"
          },
          "baz": {
            "type": "String"
          }
        },
        "representation": {
          "map": {}
        }
      }
    },
    "MyMap": {
      "map": {
        "keyType": "String",
        "valueType": "SimpleStruct"
      }
    }
  }
}

Provide a -t to print with tabs instead of two-spaces.

ipld-schema to-json also accepts input via stdin:

$ cat simple-struct.ipldsch | ipld-schema to-json
...

License and Copyright

Copyright 2019 Rod Vagg

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.