Skip to content

Commit 3199131

Browse files
achingbrainachingbrain
committed
fix: update project config
1 parent c9291e0 commit 3199131

File tree

9 files changed

+148
-41
lines changed

9 files changed

+148
-41
lines changed

‎.github/dependabot.yml

+3
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ updates:
66
interval: daily
77
time: "10:00"
88
open-pull-requests-limit: 10
9+
commit-message:
10+
prefix: "deps"
11+
prefix-development: "deps(dev)"

‎README.md

+36-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1-
# protons
1+
# protons <!-- omit in toc -->
22

3-
[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/protons.svg?style=flat-square)](https://codecov.io/gh/ipfs/protons)
7+
[![CI](https://img.shields.io/github/workflow/status/ipfs/protons/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
48

5-
> `.proto` to `.ts` transpiler
9+
> Protobuf to ts transpiler
10+
11+
## Table of contents <!-- omit in toc -->
12+
13+
- [Structure](#structure)
14+
- [Packages](#packages)
15+
- [Contribute](#contribute)
16+
- [License](#license)
17+
- [Contribute](#contribute-1)
18+
19+
## Structure
20+
21+
- [`/packages/protons`](./packages/protons) Protobuf to ts transpiler
22+
- [`/packages/protons-benchmark`](./packages/protons-benchmark) Protobuf to ts transpiler
23+
- [`/packages/protons-runtime`](./packages/protons-runtime) Shared code to make your bundle smaller when running protons in your app
624

725
Transpiles `.proto` files to `.ts` - uses `Uint8Array` for `byte` fields and `BigInt` for `int64`/`uint64` and `sint64`.
826

927
## Packages
1028

11-
* [`/packages/protons`](./packages/protons) The transpiler
12-
* [`/packages/protons-benchmark`](./packages/protons-benchmark) A benchmark suite
13-
* [`/packages/protons-runtime`](./packages/protons-runtime) Shared components that turn values to bytes and back again
29+
- [`/packages/protons`](./packages/protons) The transpiler
30+
- [`/packages/protons-benchmark`](./packages/protons-benchmark) A benchmark suite
31+
- [`/packages/protons-runtime`](./packages/protons-runtime) Shared components that turn values to bytes and back again
1432

1533
## Contribute
1634

@@ -22,4 +40,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
2240

2341
## License
2442

25-
[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs
43+
Licensed under either of
44+
45+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
46+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
47+
48+
## Contribute
49+
50+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
51+
52+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
53+
54+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/protons-benchmark/README.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
# protons-benchmark <!-- omit in toc -->
22

3-
> Benchmark protons against other protobuf modules
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/protons.svg?style=flat-square)](https://codecov.io/gh/ipfs/protons)
7+
[![CI](https://img.shields.io/github/workflow/status/ipfs/protons/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
8+
9+
> Protobuf to ts transpiler
410
511
## Table of contents <!-- omit in toc -->
612

713
- [Install](#install)
814
- [Usage](#usage)
15+
- [License](#license)
16+
- [Contribute](#contribute)
917

1018
## Install
1119

12-
- Clone the parent repo
13-
- Install the deps
14-
- Switch to the benchmark directory
20+
```console
21+
$ npm i protons-benchmark
22+
```
1523

1624
```console
1725
$ git clone git@github.com:ipfs/protons.git
@@ -43,3 +51,18 @@ Finished 3 cases!
4351
Fastest: protobufjs
4452
Slowest: protons
4553
```
54+
55+
## License
56+
57+
Licensed under either of
58+
59+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
60+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
61+
62+
## Contribute
63+
64+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
65+
66+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
67+
68+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/protons-benchmark/package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@
4141
],
4242
"exports": {
4343
".": {
44-
"import": "./dist/src/index.js",
45-
"types": "./dist/src/index.d.ts"
44+
"types": "./dist/src/index.d.ts",
45+
"import": "./dist/src/index.js"
4646
},
4747
"./status": {
48-
"import": "./dist/src/status.js",
49-
"types": "./dist/src/status.d.ts"
48+
"types": "./dist/src/status.d.ts",
49+
"import": "./dist/src/status.js"
5050
}
5151
},
5252
"eslintConfig": {

‎packages/protons-benchmark/tsconfig.json

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
"references": [
1515
{
1616
"path": "../protons"
17+
},
18+
{
19+
"path": "../protons-runtime"
1720
}
1821
]
1922
}

‎packages/protons-runtime/README.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
# protons-runtime <!-- omit in toc -->
22

3-
[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/protons.svg?style=flat-square)](https://codecov.io/gh/ipfs/protons)
7+
[![CI](https://img.shields.io/github/workflow/status/ipfs/protons/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
48

5-
> Shared components that turn values to bytes and back again
9+
> Shared code to make your bundle smaller when running protons in your app
610
7-
Contains shared code to reduce code duplication between modules transpiled by protons.
8-
9-
## Table of contents <!-- omit in toc -->
11+
## Table of contents <!-- omit in toc -->
1012

13+
- [Install](#install)
1114
- [Contribute](#contribute)
1215
- [License](#license)
16+
- [Contribute](#contribute-1)
17+
18+
## Install
19+
20+
```console
21+
$ npm i protons-runtime
22+
```
23+
24+
Contains shared code to reduce code duplication between modules transpiled by protons.
1325

1426
## Contribute
1527

@@ -21,4 +33,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
2133

2234
## License
2335

24-
[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs
36+
Licensed under either of
37+
38+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
39+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
40+
41+
## Contribute
42+
43+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
44+
45+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
46+
47+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/protons-runtime/package.json

+12-8
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@
4141
],
4242
"exports": {
4343
".": {
44-
"import": "./dist/src/index.js",
45-
"types": "./dist/src/index.d.ts"
44+
"types": "./dist/src/index.d.ts",
45+
"import": "./dist/src/index.js"
4646
},
4747
"./status": {
48-
"import": "./dist/src/status.js",
49-
"types": "./dist/src/status.d.ts"
48+
"types": "./dist/src/status.d.ts",
49+
"import": "./dist/src/status.js"
5050
}
5151
},
5252
"eslintConfig": {
@@ -82,15 +82,15 @@
8282
"release": "patch"
8383
},
8484
{
85-
"type": "chore",
85+
"type": "docs",
8686
"release": "patch"
8787
},
8888
{
89-
"type": "docs",
89+
"type": "test",
9090
"release": "patch"
9191
},
9292
{
93-
"type": "test",
93+
"type": "deps",
9494
"release": "patch"
9595
},
9696
{
@@ -120,7 +120,11 @@
120120
},
121121
{
122122
"type": "docs",
123-
"section": "Trivial Changes"
123+
"section": "Documentation"
124+
},
125+
{
126+
"type": "deps",
127+
"section": "Dependencies"
124128
},
125129
{
126130
"type": "test",

‎packages/protons/README.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
# protons <!-- omit in toc -->
22

3-
[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/protons.svg?style=flat-square)](https://codecov.io/gh/ipfs/protons)
7+
[![CI](https://img.shields.io/github/workflow/status/ipfs/protons/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)
48

5-
> Generate typescript from .proto files
9+
> Protobuf to ts transpiler
610
711
## Table of contents <!-- omit in toc -->
812

913
- [Install](#install)
1014
- [Usage](#usage)
1115
- [Contribute](#contribute)
1216
- [License](#license)
17+
- [Contribute](#contribute-1)
1318

1419
## Install
1520

16-
To use this project, add `protons` as a development dependency and `protons-runtime` as a runtime dependency.
21+
```console
22+
$ npm i protons
23+
```
1724

1825
`protons` contains the code to compile `.proto` files to `.ts` files and `protons-runtime` contains the code to do serialization/deserialization to `Uint8Array`s during application execution.
1926

@@ -62,4 +69,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
6269

6370
## License
6471

65-
[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs
72+
Licensed under either of
73+
74+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
75+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
76+
77+
## Contribute
78+
79+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
80+
81+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
82+
83+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/protons/package.json

+12-8
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@
4444
],
4545
"exports": {
4646
".": {
47-
"import": "./dist/src/index.js",
48-
"types": "./dist/src/index.d.ts"
47+
"types": "./dist/src/index.d.ts",
48+
"import": "./dist/src/index.js"
4949
},
5050
"./status": {
51-
"import": "./dist/src/status.js",
52-
"types": "./dist/src/status.d.ts"
51+
"types": "./dist/src/status.d.ts",
52+
"import": "./dist/src/status.js"
5353
}
5454
},
5555
"eslintConfig": {
@@ -85,15 +85,15 @@
8585
"release": "patch"
8686
},
8787
{
88-
"type": "chore",
88+
"type": "docs",
8989
"release": "patch"
9090
},
9191
{
92-
"type": "docs",
92+
"type": "test",
9393
"release": "patch"
9494
},
9595
{
96-
"type": "test",
96+
"type": "deps",
9797
"release": "patch"
9898
},
9999
{
@@ -123,7 +123,11 @@
123123
},
124124
{
125125
"type": "docs",
126-
"section": "Trivial Changes"
126+
"section": "Documentation"
127+
},
128+
{
129+
"type": "deps",
130+
"section": "Dependencies"
127131
},
128132
{
129133
"type": "test",

0 commit comments

Comments
 (0)