Skip to content

Commit 35463c1

Browse files
achingbrainachingbrain
committed
chore: update project config
1 parent c2ea85d commit 35463c1

File tree

10 files changed

+291
-357
lines changed

10 files changed

+291
-357
lines changed

‎README.md‎

Lines changed: 110 additions & 71 deletions
Large diffs are not rendered by default.

‎packages/libp2p/README.md‎

Lines changed: 96 additions & 77 deletions
Large diffs are not rendered by default.

‎packages/libp2p/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@
166166
"@libp2p/bootstrap": "^8.0.0",
167167
"@libp2p/daemon-client": "^6.0.2",
168168
"@libp2p/daemon-server": "^5.0.2",
169-
"@libp2p/floodsub": "^7.0.1",
169+
"@libp2p/floodsub": "^7.0.0",
170170
"@libp2p/interface-compliance-tests": "^3.0.0",
171171
"@libp2p/interop": "^8.0.0",
172172
"@libp2p/kad-dht": "^9.0.0",

‎packages/libp2p/tsconfig.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@
5353
{
5454
"path": "../peer-store"
5555
},
56+
{
57+
"path": "../pubsub-floodsub"
58+
},
5659
{
5760
"path": "../stream-multiplexer-mplex"
5861
},

‎packages/pubsub-floodsub/README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
5-
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-floodsub.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-floodsub)
6-
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-floodsub/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-floodsub/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
5+
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
77

88
> libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).
99
@@ -13,6 +13,7 @@
1313
- [Browser `<script>` tag](#browser-script-tag)
1414
- [Don't use this module](#dont-use-this-module)
1515
- [Usage](#usage)
16+
- [API Docs](#api-docs)
1617
- [License](#license)
1718
- [Contribution](#contribution)
1819

@@ -58,6 +59,10 @@ node.pubsub.addEventListener('message', (evt) => {
5859
node.pubsub.publish('fruit', new TextEncoder().encode('banana'))
5960
```
6061

62+
## API Docs
63+
64+
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_floodsub.html>
65+
6166
## License
6267

6368
Licensed under either of

‎packages/pubsub-floodsub/package.json‎

Lines changed: 12 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
"version": "7.0.2",
44
"description": "libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).",
55
"license": "Apache-2.0 OR MIT",
6-
"homepage": "https://github.com/libp2p/js-libp2p-floodsub#readme",
6+
"homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/pubsub-floodsub#readme",
77
"repository": {
88
"type": "git",
9-
"url": "git+https://github.com/libp2p/js-libp2p-floodsub.git"
9+
"url": "git+https://github.com/libp2p/js-libp2p.git"
1010
},
1111
"bugs": {
12-
"url": "https://github.com/libp2p/js-libp2p-floodsub/issues"
12+
"url": "https://github.com/libp2p/js-libp2p/issues"
1313
},
1414
"keywords": [
1515
"IPFS",
@@ -19,10 +19,6 @@
1919
"libp2p",
2020
"pubsub"
2121
],
22-
"engines": {
23-
"node": ">=16.0.0",
24-
"npm": ">=7.0.0"
25-
},
2622
"type": "module",
2723
"types": "./dist/src/index.d.ts",
2824
"files": [
@@ -46,91 +42,6 @@
4642
"*.d.ts"
4743
]
4844
},
49-
"release": {
50-
"branches": [
51-
"master"
52-
],
53-
"plugins": [
54-
[
55-
"@semantic-release/commit-analyzer",
56-
{
57-
"preset": "conventionalcommits",
58-
"releaseRules": [
59-
{
60-
"breaking": true,
61-
"release": "major"
62-
},
63-
{
64-
"revert": true,
65-
"release": "patch"
66-
},
67-
{
68-
"type": "feat",
69-
"release": "minor"
70-
},
71-
{
72-
"type": "fix",
73-
"release": "patch"
74-
},
75-
{
76-
"type": "docs",
77-
"release": "patch"
78-
},
79-
{
80-
"type": "test",
81-
"release": "patch"
82-
},
83-
{
84-
"type": "deps",
85-
"release": "patch"
86-
},
87-
{
88-
"scope": "no-release",
89-
"release": false
90-
}
91-
]
92-
}
93-
],
94-
[
95-
"@semantic-release/release-notes-generator",
96-
{
97-
"preset": "conventionalcommits",
98-
"presetConfig": {
99-
"types": [
100-
{
101-
"type": "feat",
102-
"section": "Features"
103-
},
104-
{
105-
"type": "fix",
106-
"section": "Bug Fixes"
107-
},
108-
{
109-
"type": "chore",
110-
"section": "Trivial Changes"
111-
},
112-
{
113-
"type": "docs",
114-
"section": "Documentation"
115-
},
116-
{
117-
"type": "deps",
118-
"section": "Dependencies"
119-
},
120-
{
121-
"type": "test",
122-
"section": "Tests"
123-
}
124-
]
125-
}
126-
}
127-
],
128-
"@semantic-release/changelog",
129-
"@semantic-release/npm",
130-
"@semantic-release/github",
131-
"@semantic-release/git"
132-
]
133-
},
13445
"scripts": {
13546
"clean": "aegir clean",
13647
"lint": "aegir lint",
@@ -143,27 +54,29 @@
14354
"test:firefox": "aegir test -t browser -- --browser firefox",
14455
"test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
14556
"test:node": "aegir test -t node --cov",
146-
"test:electron-main": "aegir test -t electron-main",
147-
"release": "aegir release"
57+
"test:electron-main": "aegir test -t electron-main"
14858
},
14959
"dependencies": {
15060
"@libp2p/interface": "~0.0.1",
15161
"@libp2p/logger": "^2.0.0",
15262
"@libp2p/pubsub": "^7.0.0",
15363
"protons-runtime": "^5.0.0",
154-
"uint8arraylist": "^2.1.1",
155-
"uint8arrays": "^4.0.3"
64+
"uint8arraylist": "^2.4.3",
65+
"uint8arrays": "^4.0.4"
15666
},
15767
"devDependencies": {
15868
"@libp2p/interface-compliance-tests": "^3.0.0",
15969
"@libp2p/peer-collections": "^3.0.0",
16070
"@libp2p/peer-id-factory": "^2.0.0",
161-
"@multiformats/multiaddr": "^12.0.0",
71+
"@multiformats/multiaddr": "^12.1.3",
16272
"@types/sinon": "^10.0.15",
16373
"aegir": "^39.0.10",
164-
"multiformats": "^11.0.0",
74+
"multiformats": "^12.0.1",
16575
"p-wait-for": "^5.0.0",
16676
"protons": "^7.0.2",
167-
"sinon": "^15.0.1"
77+
"sinon": "^15.1.2"
78+
},
79+
"typedoc": {
80+
"entryPoint": "./src/index.ts"
16881
}
16982
}

‎packages/pubsub-floodsub/tsconfig.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,25 @@
66
"include": [
77
"src",
88
"test"
9+
],
10+
"references": [
11+
{
12+
"path": "../interface"
13+
},
14+
{
15+
"path": "../interface-compliance-tests"
16+
},
17+
{
18+
"path": "../logger"
19+
},
20+
{
21+
"path": "../peer-collections"
22+
},
23+
{
24+
"path": "../peer-id-factory"
25+
},
26+
{
27+
"path": "../pubsub"
28+
}
929
]
1030
}

‎packages/pubsub/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
5-
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-pubsub.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-pubsub)
6-
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-pubsub/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-pubsub/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
5+
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
77

88
> libp2p pubsub base class
99
@@ -46,7 +46,7 @@ class MyPubsubImplementation extends PubSubBaseProtocol {
4646

4747
## API Docs
4848

49-
- <https://libp2p.github.io/js-libp2p-pubsub>
49+
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_pubsub.html>
5050

5151
## License
5252

0 commit comments

Comments
 (0)