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

protobuffctl

v1.0.10

Published

js api for automating protobuff workflow

Downloads

22

Readme

protobuffctl npm version

npm version npm version NPM Downloads

  • protobuffctl offers an API that enables you to automate all protobuf functions.
  • It stores all Components in the Componentregistry.
  • Quickly create new message types, fields, services, methods and enums using the API and cli commands.
  • Automatically generates the corresponding protobuf files when making changes to the protofiles.
  • Roll back to old protofile, or to an registry state using historical .config file just like with version control.
  • Preview the Protofile-Code before actually building it.
  • Create your own User Interface and manage Protocollbuffers using the API and input events.

Getting Started

Docs: API

Install:

npm i protobuffctl

How to

Protobuffctl has a command-line interface (CLI) tool designed to manage components and watchers for a project, possibly related to Protocol Buffers (protobuf). This documentation provides an overview of the available commands and their usage. The the export module functions do exactly the same


Flowchart

graph TD;
    CLI["💻 Command Line Interface"]-->Api;
CLI["💻 Command Line Interface"]-->Daemon;
    Api-->WatcherManager;
    Api-->ComponentRegistry;
    WatcherManager-->FileWatcher;
    FileWatcher-->Api;
    Api-->ProtobuffFile;
    Api-->ProtoUser;
    Api-->ProtoFile;
    ProtoFile-->ProtobuffFile;
    ProtoFile-->ComponentRegistry;
    ProtobuffFile-->ProtoUser;
    ProtobuffFile-->ComponentRegistry;
    ProtoUser-->ComponentRegistry;
  Daemon-->Api;
    subgraph protobuffctl [🏢 protobuffctl]
        Api;
        WatcherManager;
        FileWatcher;
        ComponentRegistry;
    end
    subgraph components [🔧 Components]
        ProtoFile;
        ProtobuffFile;
        ProtoUser;
    end
    style components fill:#f9d71c,stroke:#333,stroke-width:2px
    style ComponentRegistry fill:#f9d71c,stroke:#333,stroke-width:2px
    style components fill:#f9d71c,stroke:#333,stroke-width:2px
    style ComponentRegistry fill:#f9d71c,stroke:#333,stroke-width:2px
    style Daemon fill:#f9d71c,stroke:#333,stroke-width:2px

Comming up

  • 🚧 Set up File Watcher to monitor your proto files for any changes. => Rescan and update the Componentregistry.
  • 🚧 Get complete visual feedback for all related methods, components, and files directly with our VC CODE EXTENSION.

Update

  • Fast Saving and Loading: Added a daemon to keep the main object alive, including the registry.
  • Protobuff Registry: Protobuff registry and creation are working fine.
  • Export to JSON: All components are stored and can be reproduced. See example JSON.
  • New Services, Types, Enums: Create new services, types, enums via CLI command by copying from the registry or via command.
  • automated Proto-gen: Related protobuf files will automatically get compiled to their target folders using the protoc-helper repo.
  • this thing works, which is nice. complete api to edit your protobuff projects and files. you can set every important value via cli know and ill add support to get all protofiles from certain folders.
  • you can apply changes via api know -> registry is getting updated -> protofiles are getting updates -> protobuff-files are getting upddated <- i actually need to implement that :) but my db was created as a wrapper for protobuffjs, so i just need a bridge/method

TODO

files and object cant be redundant, however if failures arise due to the user, or missing drives, the config/save-file can get damaged which can lead to weird behaviour when automated processes are using the faulty objects, so i decided to add a health-state field for each object. unhealthy files will be ignored and not further be processed, but also the main statehandler wont delete that file, if it may become usuable again later.

  • Health State Field: Add a health-state field for each object to handle failures and misconfigurations.
  • Health Check: Add a health check to ensure the integrity of the objects.
  • ~~Merge Function: Add a merge function for the user to copy fields back over to a healthy file if there were misconfigurations.~~