https://github.com/thesayyn/protoc-gen-ts

Compile protocol buffer messages to TypeScript.
https://github.com/thesayyn/protoc-gen-ts

enums grpc grpc-client grpc-node grpc-typescript grpc-web proto-files protoc-gen protoc-plugin protocol-buffers typescript

Last synced: about 9 hours ago
JSON representation

Compile protocol buffer messages to TypeScript.

• Host: GitHub
• URL: https://github.com/thesayyn/protoc-gen-ts
• Owner: thesayyn
• Created: 2019-11-24T17:50:33.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-13T23:11:58.000Z (8 months ago)
• Last Synced: 2024-04-14T02:19:59.215Z (7 months ago)
• Topics: enums, grpc, grpc-client, grpc-node, grpc-typescript, grpc-web, proto-files, protoc-gen, protoc-plugin, protocol-buffers, typescript
• Language: TypeScript
• Homepage:
• Size: 62.2 MB
• Stars: 336
• Watchers: 5
• Forks: 70
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Protoc Gen Typescript 

![conformance](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fthesayyn%2Fprotoc-gen-ts%2Frust-rewrite%2Finfra%2Fstats.json&query=percentile&suffix=%25&label=conformance)

[![test](https://github.com/thesayyn/protoc-gen-ts/actions/workflows/test.yaml/badge.svg)](https://github.com/thesayyn/protoc-gen-ts/actions/workflows/test.yaml)

[![npm](https://img.shields.io/npm/v/protoc-gen-ts)](https://www.npmjs.com/package/protoc-gen-ts?activeTab=versions)

[![npm](https://img.shields.io/npm/dm/protoc-gen-ts)](https://www.npmjs.com/package/protoc-gen-ts?activeTab=versions)

[![npm](https://opencollective.com/protoc-gen-ts/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/protoc-gen-ts)

Compile `.proto` files to plain TypeScript. Supports gRPC Node and gRPC Web.

> [!NOTE] 

> As of 2024, this project has adopted Rust as its primary programming language, replacing JavaScript.

> See [the issue](https://github.com/thesayyn/protoc-gen-ts/issues/255) for the details.

## Contributing

I have limited availability to consistently maintain this project, as my time is primarily allocated to cutting new releases and implementing fixes on an ad hoc basis.

[See issues that needs help](https://github.com/thesayyn/protoc-gen-ts/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)

[See issues for newcomers](https://github.com/thesayyn/protoc-gen-ts/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)

 

Become a maintainer? Send an [email](mailto:[email protected]?subject=Become%20a%20maintainer)

## Features

- Passes all required conformance tests

- Supports well-known types

- Supports [gRPC](docs/rpc.md) (`@grpc/grpc-js`)

- Supports [gRPC Web](docs/rpc.md) (`grpc-web`)

- Supports json encoding (`toJson`, `fromJson`)

- Supports binary encoding (`toBinary`, `fromBinary`)

- Optimized for [de]serialization speed.

## Usage

```sh

npm install -g protoc-gen-ts

```

### Protoc

```properties

protoc -I=sourcedir --ts_out=dist myproto.proto

```

### Buf

```yaml

version: v1

plugins:

  - name: ts

    path: ./node_modules/.bin/protoc-gen-ts

    out: ./dist

```

### Example

```proto

syntax = "proto3";

enum Role {

    ADMIN = 0;

    MOD = 1;

}

message Author {

    Role role = 2;

    oneof id_or_name {

        string id = 4;

        string name = 5;

    }

}

```

```typescript

const author = Author.fromJson({

    role: Kind.ADMIN,

    name: "mary poppins",

});

// Serialize to binary

const bytes: Uint8Array = author.toBinary();

// Deserialize from binary

const received: Change = Change.fromBinary(bytes);

console.log(received.toJson())

```

## Development

```sh

./infra/test.sh

```

## Contributors

![GitHub Contributors Image](https://contrib.rocks/image?repo=thesayyn/protoc-gen-ts)

## Support

We need your constant support to keep protoc-gen-ts well maintained and add new features.

If your corporate has a OSS funding scheme, please consider supporting us monthly through open collective.