Skip to content

Commit e56c6ae

Browse files
authored
chore: update project config, fix broken badges (#53)
1 parent f1bfa06 commit e56c6ae

File tree

59 files changed

+366
-134
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+366
-134
lines changed

.github/workflows/js-test-and-release.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: test & maybe release
22
on:
33
push:
44
branches:
5-
- master # with #262 - ${{{ github.default_branch }}}
5+
- master
66
pull_request:
77

88
jobs:
@@ -33,7 +33,7 @@ jobs:
3333
node-version: ${{ matrix.node }}
3434
- uses: ipfs/aegir/actions/cache-node-modules@master
3535
- run: npm run --if-present test:node
36-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
36+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
3737
with:
3838
flags: node
3939

@@ -47,7 +47,7 @@ jobs:
4747
node-version: lts/*
4848
- uses: ipfs/aegir/actions/cache-node-modules@master
4949
- run: npm run --if-present test:chrome
50-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
50+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
5151
with:
5252
flags: chrome
5353

@@ -61,7 +61,7 @@ jobs:
6161
node-version: lts/*
6262
- uses: ipfs/aegir/actions/cache-node-modules@master
6363
- run: npm run --if-present test:chrome-webworker
64-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
64+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
6565
with:
6666
flags: chrome-webworker
6767

@@ -75,7 +75,7 @@ jobs:
7575
node-version: lts/*
7676
- uses: ipfs/aegir/actions/cache-node-modules@master
7777
- run: npm run --if-present test:firefox
78-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
78+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
7979
with:
8080
flags: firefox
8181

@@ -89,7 +89,7 @@ jobs:
8989
node-version: lts/*
9090
- uses: ipfs/aegir/actions/cache-node-modules@master
9191
- run: npm run --if-present test:firefox-webworker
92-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
92+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
9393
with:
9494
flags: firefox-webworker
9595

@@ -103,7 +103,7 @@ jobs:
103103
node-version: lts/*
104104
- uses: ipfs/aegir/actions/cache-node-modules@master
105105
- run: npx xvfb-maybe npm run --if-present test:electron-main
106-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
106+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
107107
with:
108108
flags: electron-main
109109

@@ -117,14 +117,14 @@ jobs:
117117
node-version: lts/*
118118
- uses: ipfs/aegir/actions/cache-node-modules@master
119119
- run: npx xvfb-maybe npm run --if-present test:electron-renderer
120-
- uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
120+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
121121
with:
122122
flags: electron-renderer
123123

124124
release:
125125
needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-electron-main, test-electron-renderer]
126126
runs-on: ubuntu-latest
127-
if: github.event_name == 'push' && github.ref == 'refs/heads/master' # with #262 - 'refs/heads/${{{ github.default_branch }}}'
127+
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
128128
steps:
129129
- uses: actions/checkout@v3
130130
with:
@@ -139,5 +139,5 @@ jobs:
139139
docker-username: ${{ secrets.DOCKER_USERNAME }}
140140
- run: npm run --if-present release
141141
env:
142-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
142+
GITHUB_TOKEN: ${{ secrets.UCI_GITHUB_TOKEN || github.token }}
143143
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
node_modules
2-
*.log
3-
.DS_Store
4-
Thumbs.db
5-
.vscode
6-
.nyc_output
7-
coverage
8-
bin
9-
packages/*/dist
2+
build
3+
dist
4+
.docs
5+
.coverage
6+
node_modules
107
package-lock.json
11-
8+
yarn.lock
9+
.vscode

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# it <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> A collection of utilities for making working with iterables more bearable
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Structure](#structure)
1111
- [License](#license)
12-
- [Contribute](#contribute)
12+
- [Contribution](#contribution)
1313

1414
## Structure
1515

@@ -49,6 +49,6 @@ Licensed under either of
4949
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
5050
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
5151

52-
## Contribute
52+
## Contribution
5353

5454
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.

packages/blob-to-it/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
# blob-to-it <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> Turns a blob into an async iterator
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Install](#install)
11+
- [Browser `<script>` tag](#browser-script-tag)
1112
- [Usage](#usage)
1213
- [License](#license)
13-
- [Contribute](#contribute)
14+
- [Contribution](#contribution)
1415

1516
## Install
1617

1718
```console
1819
$ npm i blob-to-it
1920
```
2021

22+
### Browser `<script>` tag
23+
24+
Loading this module through a script tag will make it's exports available as `BlobToIt` in the global namespace.
25+
26+
```html
27+
<script src="https://unpkg.com/blob-to-it/dist/index.min.js"></script>
28+
```
29+
2130
## Usage
2231

2332
```javascript
@@ -38,6 +47,6 @@ Licensed under either of
3847
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
3948
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
4049

41-
## Contribute
50+
## Contribution
4251

4352
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.

packages/blob-to-it/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"types": "./dist/src/index.d.ts",
2121
"files": [
2222
"src",
23-
"dist/src",
23+
"dist",
2424
"!dist/test",
2525
"!**/*.tsbuildinfo"
2626
],

packages/browser-readablestream-to-it/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
11
# browser-readablestream-to-it <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> Turns a browser readble stream into an async iterator
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Install](#install)
11+
- [Browser `<script>` tag](#browser-script-tag)
1112
- [Usage](#usage)
1213
- [preventCancel](#preventcancel)
1314
- [License](#license)
14-
- [Contribute](#contribute)
15+
- [Contribution](#contribution)
1516

1617
## Install
1718

1819
```console
1920
$ npm i browser-readablestream-to-it
2021
```
2122

23+
### Browser `<script>` tag
24+
25+
Loading this module through a script tag will make it's exports available as `BrowserReadablestreamToIt` in the global namespace.
26+
27+
```html
28+
<script src="https://unpkg.com/browser-readablestream-to-it/dist/index.min.js"></script>
29+
```
30+
2231
## Usage
2332

2433
```javascript
@@ -62,6 +71,6 @@ Licensed under either of
6271
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
6372
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
6473

65-
## Contribute
74+
## Contribution
6675

6776
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.

packages/browser-readablestream-to-it/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"types": "./dist/src/index.d.ts",
2121
"files": [
2222
"src",
23-
"dist/src",
23+
"dist",
2424
"!dist/test",
2525
"!**/*.tsbuildinfo"
2626
],

packages/it-all/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
# it-all <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> Collects all values from an (async) iterable and returns them as an array
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Install](#install)
11+
- [Browser `<script>` tag](#browser-script-tag)
1112
- [Usage](#usage)
1213
- [License](#license)
13-
- [Contribute](#contribute)
14+
- [Contribution](#contribution)
1415

1516
## Install
1617

1718
```console
1819
$ npm i it-all
1920
```
2021

22+
### Browser `<script>` tag
23+
24+
Loading this module through a script tag will make it's exports available as `ItAll` in the global namespace.
25+
26+
```html
27+
<script src="https://unpkg.com/it-all/dist/index.min.js"></script>
28+
```
29+
2130
For when you need a one-liner to collect iterable values.
2231

2332
## Usage
@@ -40,6 +49,6 @@ Licensed under either of
4049
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
4150
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
4251

43-
## Contribute
52+
## Contribution
4453

4554
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.

packages/it-all/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"types": "./dist/src/index.d.ts",
2121
"files": [
2222
"src",
23-
"dist/src",
23+
"dist",
2424
"!dist/test",
2525
"!**/*.tsbuildinfo"
2626
],

packages/it-batch/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
# it-batch <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> Takes an async iterator that emits things and emits them as fixed size batches
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Install](#install)
11+
- [Browser `<script>` tag](#browser-script-tag)
1112
- [Usage](#usage)
1213
- [License](#license)
13-
- [Contribute](#contribute)
14+
- [Contribution](#contribution)
1415

1516
## Install
1617

1718
```console
1819
$ npm i it-batch
1920
```
2021

22+
### Browser `<script>` tag
23+
24+
Loading this module through a script tag will make it's exports available as `ItBatch` in the global namespace.
25+
26+
```html
27+
<script src="https://unpkg.com/it-batch/dist/index.min.js"></script>
28+
```
29+
2130
The final batch may be smaller than the max.
2231

2332
## Usage
@@ -42,6 +51,6 @@ Licensed under either of
4251
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
4352
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
4453

45-
## Contribute
54+
## Contribution
4655

4756
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.

packages/it-batch/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"types": "./dist/src/index.d.ts",
2121
"files": [
2222
"src",
23-
"dist/src",
23+
"dist",
2424
"!dist/test",
2525
"!**/*.tsbuildinfo"
2626
],

packages/it-batched-bytes/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
# it-batched-bytes <!-- omit in toc -->
22

33
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
4-
[![CI](https://img.shields.io/github/workflow/status/achingbrain/it/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml)
4+
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/it/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
55

66
> Takes an async iterator that emits byte arrays and emits them as fixed size batches
77
88
## Table of contents <!-- omit in toc -->
99

1010
- [Install](#install)
11+
- [Browser `<script>` tag](#browser-script-tag)
1112
- [Usage](#usage)
1213
- [License](#license)
13-
- [Contribute](#contribute)
14+
- [Contribution](#contribution)
1415

1516
## Install
1617

1718
```console
1819
$ npm i it-batched-bytes
1920
```
2021

22+
### Browser `<script>` tag
23+
24+
Loading this module through a script tag will make it's exports available as `ItBatchedBytes` in the global namespace.
25+
26+
```html
27+
<script src="https://unpkg.com/it-batched-bytes/dist/index.min.js"></script>
28+
```
29+
2130
The final batch may be smaller than the max.
2231

2332
## Usage
@@ -48,6 +57,6 @@ Licensed under either of
4857
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
4958
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
5059

51-
## Contribute
60+
## Contribution
5261

5362
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.

packages/it-batched-bytes/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"types": "./dist/src/index.d.ts",
2121
"files": [
2222
"src",
23-
"dist/src",
23+
"dist",
2424
"!dist/test",
2525
"!**/*.tsbuildinfo"
2626
],

0 commit comments

Comments
 (0)