cadl/packages/protobuf
Timothee Guerin 1cf4374f95
Fix: Versioning and protobuf package should have peerDependency on compiler (#1917)
2023-05-09 15:16:32 +00:00
..
lib [playground] Add/enable protobuf kiosk sample in the playground (#1863) 2023-04-27 09:51:32 -04:00
src [playground] Add/enable protobuf kiosk sample in the playground (#1863) 2023-04-27 09:51:32 -04:00
test Enforce fixes for missing docs (#1860) 2023-04-28 09:32:54 -07:00
.c8rc.json [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
.eslintrc.cjs [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
.gitignore [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
.mocharc.yaml [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
CHANGELOG.json [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
LICENSE [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
README.md [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00
package.json Fix: Versioning and protobuf package should have peerDependency on compiler (#1917) 2023-05-09 15:16:32 +00:00
tsconfig.json [gRPC] @typespec/protobuf (#636) 2023-04-25 16:23:51 +00:00

README.md

TypeSpec Protobuf library and emitter

Warning ⚠️: This pre-release emitter is in active development and may change. Your feedback is highly appreciated.

This package provides support for defining and emitting Protobuf specifications in TypeSpec and an emitter that generates Protobuf output files from TypeSpec sources.

Install

In your project root:

npm install @typespec/protobuf

Using the Protobuf emitter

  1. Using the TypeSpec CLI (tsp):
tsp compile . --emit @typespec/protobuf
  1. Using the TypeSpec project configuration file:

Add the following to your tspproject.yaml file.

emit:
  - "@typespec/protobuf"