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

@pqstudio/protobuf_ts_framework

v2.0.4

Published

framework to create protoc plugins

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

pqstudiopqstudio

Keywords

Protocol BuffersprotobufTypeScriptprotoc

Readme

@protobuf-ts/plugin-framework

A framework to create protoc plugins in typescript.

The google protocol buffer compiler (protoc) has a plugin system. With a protoc plugin, it is possible to generate code for .proto files in any language, not just the ones supported directly by protoc.

A protoc plugin receives a CodeGeneratorRequest (a protobuf message) via stdin and returns a CodeGeneratorResponse via stdout.

This framework aims to make it as easy as possible to write a protoc plugin in typescript. It has special support for generating typescript code, but can be used to generate code in other languages.

Features

  • provides a symbol table that can be used to track generated types in any language

  • has special support for generating typescript code using the typescript compiler API. For example, it has a simple API to import objects from a package, or from the symbol table.

  • provides a base class for plugins that supports parameters, error handling, supported features and easy setup.

  • builds a tree of descriptors so that it is trivial to lookup the parent of a nested message, for example.

  • builds a lookup object to find the descriptor for a given type name

  • provides a string format object that can print a message field like it was typed by the user.

  • provides a source code comment lookup that can be used to easily find comments for a given element in a .proto

  • provides convenience methods to check if a field was declared optional or as a oneof member

Getting started

  • Check the types and comments of descriptor.proto and plugin.proto to get familiar with the plugin system of protoc.
  • Take a look at descriptor-registry.ts to see the if it can help you work with the descriptor protos that the compiler sends you.
  • Take a look at plugin-base.ts for a base class that can help with some plumbing.
  • Take a look at the source code of protobuf-ts, which uses this framework.

Copyright

  • The files plugin.ts and descriptor.ts are Copyright 2008 Google Inc., licensed under BSD-3-Clause
  • All other files are licensed under Apache-2.0, see LICENSE.