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

@verdant-robotics/cbuf

v2.0.0

Published

A parser and serializer/deserializer for the cbuf Interface Definition Language (IDL)

Downloads

21

Readme

cbuf.js

A TypeScript parser and serializer/deserializer for the Verdant Robotics cbuf Interface Definition Language (IDL)

What is this?

Verdant Robotics robots use an Interface Definition Language and message serialization format called "cbuf". This is similar to other IDLs such as Google Protobufs, FlatBuffers, Cap'n'Proto, DDS IDL+CDR, ROS message definitions, etc. It optimizes for matching on-wire and in-memory representations where possible, and the definition language is oriented toward C++ code generation, although dynamic parsing and non-C++ languages are also supported.

This library provides a TypeScript/JavaScript API for parsing .cbuf message definitions, and serializing and deserializing binary cbuf payloads.

Usage

Here's a simple example of parsing a single schema definition with no #import statements:

import { preprocessSchema, parseSchema } from "@verdant-robotics/cbuf"

// `preprocessSchema()` is used here to strip comments
const stripped = preprocessSchema(`struct vec2 { float x; float y; } // test`)
const result = parseSchema(stripped)
console.dir(result, { depth: null })
/**
  [
    {
      name: 'vec2',
      namespaces: [],
      definitions: [ { name: 'x', type: 'float32' }, { name: 'y', type: 'float32' } ],
      hashValue: 6141859528966909963n,
      isEnum: false,
    }
  ]
*/

Here's a more complete parsing example that handles multiple schema definitions and #import statements:

import { preprocessSchema, parseSchema } from "@verdant-robotics/cbuf"
import { readFileSync, readdirSync } from "fs"

// Load `schemas/*.cbuf` file contents into a Map<string, string> where the
// key is the filename and the value is the file contents
const schemas = new Map<string, string>()
for (const filename of readdirSync("schemas")) {
  schemas.set(filename, readFileSync(`schemas/${filename}`, "utf-8"))
}

const schemaToParse = schemas.get("example.cbuf")!
const preprocessed = preprocessSchema(schemaToParse)
const result = parseSchema(preprocessed, schemas)
console.dir(result, { depth: null })
// ...

Refer to the tests for more examples of how to use the library, including serialization and deserialization.

Development

You will need node.js >= 18.x and the yarn package manager installed.

  1. yarn install
  2. yarn build
  3. yarn test

License

cbuf.js is licensed under the MIT.

Releasing

  1. Run yarn version --[major|minor|patch] to bump version
  2. Run git push && git push --tags to push new tag
  3. GitHub Actions will take care of the rest