https://github.com/iambpn/proto_to_ts_schema

proto to ts schema compiler/transpiler.
https://github.com/iambpn/proto_to_ts_schema

proto protobuf transpiler ts typescript

Last synced: 2 months ago
JSON representation

proto to ts schema compiler/transpiler.

• Host: GitHub
• URL: https://github.com/iambpn/proto_to_ts_schema
• Owner: iambpn
• License: gpl-3.0
• Created: 2023-01-06T10:02:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-02T11:59:26.000Z (over 2 years ago)
• Last Synced: 2025-04-11T22:17:42.610Z (6 months ago)
• Topics: proto, protobuf, transpiler, ts, typescript
• Language: TypeScript
• Homepage:
• Size: 112 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# proto_to_ts_schema

proto to ts schema compiler/transpiler.

## Usage

Proto to TS Schema

`config`: Path to the config file which must be in js/ts format. (default: CWD/p2t.js) usage: --config [-c]

`help`: To show help docs. usage: --help [-h]

`out`: Path to output folder. (default: CWD) usage: --out  [-o ]

`proto_files`: List of proto files to compile to TS. (default: All proto files inside of 'proto_path' or CWD) usage: --proto_files   [-f ]

`proto_path`: Path to Proto folder, (default: CWD) usage: --proto_path  [-p ]

## CLI Usage with `p2ti`

install package globally: `npm i -g proto_ts_schema`.

- To show help docs: `p2ti -h`

## Config Example

```js

module.exports = {

  rpcFuncReturn: undefined, // Function (type:string) =>string

  imports: [], // Additional imports to include in TS file. Options: Array | undefined

};

```

## Known Caveats

(There are many caveats in this compiler still to be found but here are some known caveats)

- Ordering of the `message` in proto matters. You need to declare proto message first then only you can use it else it will result in error.

## Features

- Support for Relative Imports

- Support for config file

- Built in CLI