https://github.com/simenandre/protoc-gen-runtypes

Generate Runtypes from Protobuf files
https://github.com/simenandre/protoc-gen-runtypes

generate-runtypes protobuf runtype runtypes typescript

Last synced: about 1 month ago
JSON representation

Generate Runtypes from Protobuf files

• Host: GitHub
• URL: https://github.com/simenandre/protoc-gen-runtypes
• Owner: simenandre
• License: apache-2.0
• Created: 2021-05-07T22:57:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-28T17:51:05.000Z (about 1 month ago)
• Last Synced: 2024-11-28T18:36:10.985Z (about 1 month ago)
• Topics: generate-runtypes, protobuf, runtype, runtypes, typescript
• Language: TypeScript
• Homepage:
• Size: 292 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Protoc Generate Runtypes

> Protoc Plugin for generating Runtypes

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![NPM version](https://img.shields.io/npm/v/protoc-gen-runtypes.svg)](https://www.npmjs.com/package/protoc-gen-runtypes)

[![codecov](https://codecov.io/gh/cobraz/protoc-gen-runtypes/branch/main/graph/badge.svg)](https://codecov.io/gh/cobraz/protoc-gen-runtypes)

`protoc-gen-runtypes` is a [protoc](https://github.com/google/protobuf) plugin

that generates Runtypes types from Protobuf files.

We are thankful for all help with adding new functionality, fixing issues, or

improve the package. Feel free to open issues and pull requests ❤️

**Note**: This plugin is not released yet, see

[#15](https://github.com/cobraz/protoc-gen-runtypes/issues/15) for more! If you

are looking to convert some Protobuf files right away, I have another that does

just that (without using `protoc`):

[protobuf-to-runtypes](https://github.com/cobraz/protobuf-to-runtypes)

## Quickstart

```shell

▶ yarn add protoc-gen-runtypes

```

If you use [buf](https://buf.build/), you can find an example

[here](./buf.gen.yaml).

## Documentation

Apart from this README, you can find details and examples of using the SDK in

the following places:

- [API Documentation][docs]

[runtypes]: https://github.com/pelotom/runtypes

[docs]: ./docs