sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
50 lines
907 B
Markdown
50 lines
907 B
Markdown
# resolve-protobuf-schema
|
|
|
|
Read a protobuf schema from the disk, parse it and resolve all imports
|
|
|
|
```
|
|
npm install resolve-protobuf-schema
|
|
```
|
|
|
|
[](http://travis-ci.org/mafintosh/resolve-protobuf-schema)
|
|
|
|
## Usage
|
|
|
|
Store the following example protobuf schema in `test.proto`
|
|
|
|
```
|
|
message Test {
|
|
optional string test = 1;
|
|
}
|
|
```
|
|
|
|
Then run
|
|
|
|
``` js
|
|
var resolve = require('resolve-protobuf-schema')
|
|
console.log(resolve.sync('test.proto')) // prints the parsed schema
|
|
```
|
|
|
|
Schema imports will resolved as well
|
|
|
|
```
|
|
import "./test.proto"
|
|
|
|
message AnotherTest {
|
|
optional string test = 1;
|
|
}
|
|
```
|
|
|
|
``` js
|
|
console.log(resolve.sync('./another-test.proto')) // will print a combined parsed schema
|
|
```
|
|
|
|
## API
|
|
|
|
* `resolve(path, cb)` read and resolve a schema
|
|
* `resolve.sync(path)` sync version of `resolve`
|
|
|
|
## License
|
|
|
|
MIT
|