fix: update project config (libp2p#65)

Updates project config using the `aegir check-project` command. * Updates CI files ahead of turning on unified CI * Resets project version to 0 (otherwise first version published will be 2.0.0) * Renames project to publish under @libp2p namespace * Standardises readme * Remove unused dependencies * Use chai from aegir * Fix formatting in example
maschad · Dec 13, 2022 · 09c33cc · 09c33cc
1 parent 43c70bc
commit 09c33cc
Show file tree

Hide file tree

Showing 24 changed files with 295 additions and 173 deletions.
diff --git a/.aegir.js b/.aegir.js
@@ -3,6 +3,6 @@ export default {
     config: {
       platform: 'node'
     },
-    bundlesizeMax: '31KB'
+    bundlesizeMax: '117KB'
   }
 }
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,3 +6,6 @@ updates:
     interval: daily
     time: "10:00"
   open-pull-requests-limit: 10
+  commit-message:
+    prefix: "deps"
+    prefix-development: "deps(dev)"
diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml
@@ -1,6 +1,3 @@
-# File managed by web3-bot. DO NOT EDIT.
-# See https://github.com/protocol/.github/ for details.
-
 name: Automerge
 on: [ pull_request ]
 

diff --git a/.github/workflows/js-test-and-release.yml b/.github/workflows/js-test-and-release.yml
@@ -4,29 +4,45 @@ on:
     branches:
       - main # with #262 - ${{{ github.default_branch }}}
   pull_request:
-    branches:
-      - main # with #262 - ${{{ github.default_branch }}}
-      - develop
 
 jobs:
 
   check:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-node@v2
+    - uses: actions/setup-node@v3
       with:
         node-version: lts/*
     - uses: ipfs/aegir/actions/cache-node-modules@master
     - run: npm run --if-present lint
     - run: npm run --if-present dep-check
 
+  test-node:
+    needs: check
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        node: [lts/*]
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - run: npm run --if-present test:node
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        with:
+          flags: node
+
   test-chrome:
     needs: check
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
@@ -35,12 +51,26 @@ jobs:
         with:
           flags: chrome
 
+  test-chrome-webworker:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - run: npm run --if-present test:chrome-webworker
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        with:
+          flags: chrome-webworker
+
   test-firefox:
     needs: check
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
@@ -49,15 +79,57 @@ jobs:
         with:
           flags: firefox
 
+  test-firefox-webworker:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - run: npm run --if-present test:firefox-webworker
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        with:
+          flags: firefox-webworker
+
+  test-electron-main:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - run: npx xvfb-maybe npm run --if-present test:electron-main
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        with:
+          flags: electron-main
+
+  test-electron-renderer:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - run: npx xvfb-maybe npm run --if-present test:electron-renderer
+      - uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        with:
+          flags: electron-renderer
+
   release:
-    needs: [test-chrome, test-firefox]
+    needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-electron-main, test-electron-renderer]
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master' # with #262 - 'refs/heads/${{{ github.default_branch }}}'
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main' # with #262 - 'refs/heads/${{{ github.default_branch }}}'
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master

diff --git a/.nvmrc b/.nvmrc
diff --git a/.prettierrc b/.prettierrc
diff --git a/README.md b/README.md
@@ -1,36 +1,43 @@
 # @libp2p/webrtc <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
-[![codecov](https://img.shields.io/codecov/c/github/little-bear-labs/js-libp2p-webrtc.svg?style=flat-square)](https://codecov.io/gh/little-bear-labs/js-libp2p-webrtc)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/little-bear-labs/js-libp2p-webrtc/actions/workflows/js-test-and-release.yml)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-webrtc.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-webrtc/test%20&%20maybe%20release/main?style=flat-square)](https://github.com/libp2p/js-libp2p-webrtc/actions/workflows/js-test-and-release.yml)
 
-> The browser implementation of the WebRTC module for libp2p.
+> A libp2p transport using WebRTC connections
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [Examples](#examples)
 - [Interfaces](#interfaces)
   - [Transport](#transport)
   - [Connection](#connection)
-- [Contribute](#contribute)
+- [Development](#development)
   - [Build](#build)
   - [Protocol Buffers](#protocol-buffers)
   - [Test](#test)
   - [Lint](#lint)
   - [Clean](#clean)
   - [Check Dependencies](#check-dependencies)
-  - [Build a Release](#build-a-release)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute)
 
 ## Install
 
-```shell
-npm i @libp2p/webrtc
+```console
+$ npm i @libp2p/webrtc
+```
+
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pWebrtc` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/webrtc/dist/index.min.js"></script>
 ```
 
 ## Usage
@@ -52,13 +59,14 @@ const node = await createLibp2p({
 await node.start()
 
 const ma =  multiaddr('/ip4/0.0.0.0/udp/56093/webrtc/certhash/uEiByaEfNSLBexWBNFZy_QB1vAKEj7JAXDizRs4_SnTflsQ')
-const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0']) 
+const stream = await node.dialProtocol(ma, ['/my-protocol/1.0.0'])
 const message = `Hello js-libp2p-webrtc\n`
 const response = await pipe([fromString(message)], stream, async (source) => await first(source))
 const responseDecoded = toString(response.slice(0, response.length))
 ```
 
 ## Examples
+
 Examples can be found in the [examples folder](examples/README.md).
 
 ## Interfaces
@@ -106,7 +114,7 @@ interface MultiaddrConnection extends Duplex<Uint8Array> {
 class WebRTCMultiaddrConnection implements MultiaddrConnection { }
 ```
 
-## Contribute
+## Development
 
 Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
 
@@ -119,9 +127,10 @@ Please be aware that all interactions related to libp2p are subject to the IPFS
 
 Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
 
-This module leans heavily on (Aegir)[https://github.com/ipfs/aegir] for most of the `package.json` scripts.
+This module leans heavily on (Aegir)\[<https://github.com/ipfs/aegir>] for most of the `package.json` scripts.
 
 ### Build
+
 The build script is a wrapper to `aegir build`.  To build this package:
 
 ```shell
@@ -142,7 +151,7 @@ To run all tests:
 npm test
 ```
 
-To run tests for Chome only:
+To run tests for Chrome only:
 
 ```shell
 npm run test:chrome
@@ -155,8 +164,9 @@ npm run test:firefox
 ```
 
 ### Lint
+
 Aegir is also used to lint the code, which follows the [Standard](https://github.com/standard/standard) JS linter.
-The VS Code plugin for this standard is located at https://marketplace.visualstudio.com/items?itemName=standard.vscode-standard.
+The VS Code plugin for this standard is located at <https://marketplace.visualstudio.com/items?itemName=standard.vscode-standard>.
 To lint this repo:
 
 ```shell
@@ -181,18 +191,13 @@ npm run clean
 npm run deps-check
 ```
 
-### Build a Release
-
-```shell
-npm run release
-```
 ## License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+## Contribute
 
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
diff --git a/examples/browser-to-server/index.js b/examples/browser-to-server/index.js
@@ -6,34 +6,34 @@ import { pipe } from "it-pipe";
 import { fromString, toString } from "uint8arrays";
 import { webRTC } from 'js-libp2p-webrtc'
 
-  let stream;
-  const output = document.getElementById('output')
-  const sendSection = document.getElementById('send-section')
-  const appendOutput = (line) => output.innerText += `${line}\n`
-  const clean = (line) => line.replaceAll('\n', '')
+let stream;
+const output = document.getElementById('output')
+const sendSection = document.getElementById('send-section')
+const appendOutput = (line) => output.innerText += `${line}\n`
+const clean = (line) => line.replaceAll('\n', '')
 
-  const node = await createLibp2p({
-    transports: [webRTC()],
-    connectionEncryption: [() => new Noise()],
-  });
-
-  await node.start()
+const node = await createLibp2p({
+  transports: [webRTC()],
+  connectionEncryption: [() => new Noise()],
+});
 
-  node.connectionManager.addEventListener('peer:connect', (connection) => {
-    appendOutput(`Peer connected '${node.getConnections().map(c => c.remoteAddr.toString())}'`)
-    sendSection.style.display = 'block'
-  })
-
-  window.connect.onclick = async () => {
-    const ma = multiaddr(window.peer.value)
-    appendOutput(`Dialing ${ma}`)
-    stream = await node.dialProtocol(ma, ['/echo/1.0.0']) 
-  }
-
-  window.send.onclick = async () => {
-    const message = `${window.message.value}\n`
-    appendOutput(`Sending message '${clean(message)}'`)
-    const response = await pipe([fromString(message)], stream, async (source) => await first(source))
-    const responseDecoded = toString(response.slice(0, response.length));
-    appendOutput(`Received message '${clean(responseDecoded)}'`)
-  }
+await node.start()
+
+node.connectionManager.addEventListener('peer:connect', (connection) => {
+  appendOutput(`Peer connected '${node.getConnections().map(c => c.remoteAddr.toString())}'`)
+  sendSection.style.display = 'block'
+})
+
+window.connect.onclick = async () => {
+  const ma = multiaddr(window.peer.value)
+  appendOutput(`Dialing ${ma}`)
+  stream = await node.dialProtocol(ma, ['/echo/1.0.0'])
+}
+
+window.send.onclick = async () => {
+  const message = `${window.message.value}\n`
+  appendOutput(`Sending message '${clean(message)}'`)
+  const response = await pipe([fromString(message)], stream, async (source) => await first(source))
+  const responseDecoded = toString(response.slice(0, response.length));
+  appendOutput(`Received message '${clean(responseDecoded)}'`)
+}