Skip to content

Commit 698c8d8

Browse files
tunnckoCoretunnckoCore
committed
fix: update readmes, build koa-better-body
Signed-off-by: Charlike Mike Reagent <opensource@tunnckocore.com>
1 parent 2658a80 commit 698c8d8

File tree

22 files changed

+179
-159
lines changed

22 files changed

+179
-159
lines changed

‎@tunnckocore/babel-preset/.verb.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<!-- docks-start -->
2-
32
## API
43

5-
_Generated using [jest-runner-docs](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
4+
_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
65

76
<!-- docks-end -->

‎@tunnckocore/babel-preset/README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ Project is [semantically](https://semver.org) versioned & automatically released
4141
| For any critical problems and security reports | ![tunnckocore_security][tunnckocore_security] |
4242
| Consulting, professional support, personal or team training | ![tunnckocore_consulting][tunnckocore_consulting] |
4343
| For any questions about Open Source, partnerships and sponsoring | ![tunnckocore_opensource][tunnckocore_opensource] |
44-
| Curited interesting news, announcements, articles, and thoughts | ![tunnckocore_newsletter][tunnckocore_newsletter] |
4544

4645
<!-- Logo when needed:
4746
@@ -58,10 +57,10 @@ Project is [semantically](https://semver.org) versioned & automatically released
5857
- [Install](#install)
5958
- [API](#api)
6059
- [Contributing](#contributing)
61-
- [Guides and Community](#guides-and-community)
62-
- [Support the project](#support-the-project)
63-
- [OPEN Open Source](#open-open-source)
64-
- [Wonderful Contributors](#wonderful-contributors)
60+
* [Guides and Community](#guides-and-community)
61+
* [Support the project](#support-the-project)
62+
* [OPEN Open Source](#open-open-source)
63+
* [Wonderful Contributors](#wonderful-contributors)
6564
- [License](#license)
6665

6766
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
@@ -77,10 +76,9 @@ $ yarn add @tunnckocore/babel-preset
7776
```
7877

7978
<!-- docks-start -->
80-
8179
## API
8280

83-
_Generated using [jest-runner-docs](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
81+
_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
8482

8583
<!-- docks-end -->
8684

@@ -145,6 +143,7 @@ Released under the [MPL-2.0 License][license-url].
145143

146144
[npmv-url]: https://www.npmjs.com/package/@tunnckocore/babel-preset
147145
[npmv-img]: https://badgen.net/npm/v/@tunnckocore/babel-preset?icon=npm
146+
148147
[nodejs-img]: https://badgen.net/npm/node/@tunnckocore/babel-preset
149148

150149
<!--
@@ -173,9 +172,11 @@ Released under the [MPL-2.0 License][license-url].
173172
[community-url]: https://github.com/tunnckocorehq/community
174173
[last-commit-img]: https://badgen.net/github/last-commit/tunnckoCore/opensource/master
175174
[last-commit-url]: https://github.com/tunnckoCore/opensource/commits/master
175+
176176
[downloads-weekly-img]: https://badgen.net/npm/dw/@tunnckocore/babel-preset?icon=npm
177177
[downloads-monthly-img]: https://badgen.net/npm/dm/@tunnckocore/babel-preset?icon=npm
178178
[downloads-total-img]: https://badgen.net/npm/dt/@tunnckocore/babel-preset?icon=npm
179+
179180
[renovateapp-url]: https://renovatebot.com
180181
[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
181182
[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green
@@ -213,3 +214,4 @@ Released under the [MPL-2.0 License][license-url].
213214
[tunnckocore_security]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/security/tunnckocore?label&color=ed1848&icon=https://svgshare.com/i/Dt6.svg
214215
[tunnckocore_opensource]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/opensource/tunnckocore?label&color=ff7a2f&icon=https://svgshare.com/i/Dt6.svg
215216
[tunnckocore_newsletter]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg
217+

‎@tunnckocore/create-jest-runner/.verb.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<!-- docks-start -->
2-
32
## API
43

5-
_Generated using [jest-runner-docs](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
4+
_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
65

76
<!-- docks-end -->

‎@tunnckocore/create-jest-runner/README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ Project is [semantically](https://semver.org) versioned & automatically released
4141
| For any critical problems and security reports | ![tunnckocore_security][tunnckocore_security] |
4242
| Consulting, professional support, personal or team training | ![tunnckocore_consulting][tunnckocore_consulting] |
4343
| For any questions about Open Source, partnerships and sponsoring | ![tunnckocore_opensource][tunnckocore_opensource] |
44-
| Curited interesting news, announcements, articles, and thoughts | ![tunnckocore_newsletter][tunnckocore_newsletter] |
4544

4645
<!-- Logo when needed:
4746
@@ -58,10 +57,10 @@ Project is [semantically](https://semver.org) versioned & automatically released
5857
- [Install](#install)
5958
- [API](#api)
6059
- [Contributing](#contributing)
61-
- [Guides and Community](#guides-and-community)
62-
- [Support the project](#support-the-project)
63-
- [OPEN Open Source](#open-open-source)
64-
- [Wonderful Contributors](#wonderful-contributors)
60+
* [Guides and Community](#guides-and-community)
61+
* [Support the project](#support-the-project)
62+
* [OPEN Open Source](#open-open-source)
63+
* [Wonderful Contributors](#wonderful-contributors)
6564
- [License](#license)
6665

6766
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
@@ -77,10 +76,9 @@ $ yarn add @tunnckocore/create-jest-runner
7776
```
7877

7978
<!-- docks-start -->
80-
8179
## API
8280

83-
_Generated using [jest-runner-docs](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
81+
_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
8482

8583
<!-- docks-end -->
8684

@@ -145,6 +143,7 @@ Released under the [MPL-2.0 License][license-url].
145143

146144
[npmv-url]: https://www.npmjs.com/package/@tunnckocore/create-jest-runner
147145
[npmv-img]: https://badgen.net/npm/v/@tunnckocore/create-jest-runner?icon=npm
146+
148147
[nodejs-img]: https://badgen.net/npm/node/@tunnckocore/create-jest-runner
149148

150149
<!--
@@ -173,9 +172,11 @@ Released under the [MPL-2.0 License][license-url].
173172
[community-url]: https://github.com/tunnckocorehq/community
174173
[last-commit-img]: https://badgen.net/github/last-commit/tunnckoCore/opensource/master
175174
[last-commit-url]: https://github.com/tunnckoCore/opensource/commits/master
175+
176176
[downloads-weekly-img]: https://badgen.net/npm/dw/@tunnckocore/create-jest-runner?icon=npm
177177
[downloads-monthly-img]: https://badgen.net/npm/dm/@tunnckocore/create-jest-runner?icon=npm
178178
[downloads-total-img]: https://badgen.net/npm/dt/@tunnckocore/create-jest-runner?icon=npm
179+
179180
[renovateapp-url]: https://renovatebot.com
180181
[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
181182
[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green
@@ -213,3 +214,4 @@ Released under the [MPL-2.0 License][license-url].
213214
[tunnckocore_security]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/security/tunnckocore?label&color=ed1848&icon=https://svgshare.com/i/Dt6.svg
214215
[tunnckocore_opensource]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/opensource/tunnckocore?label&color=ff7a2f&icon=https://svgshare.com/i/Dt6.svg
215216
[tunnckocore_newsletter]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg
217+

‎@tunnckocore/execa/.verb.md‎

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<!-- docks-start -->
2-
32
## API
43

5-
_Generated using [jest-runner-docs](https://github.com/tunnckoCore/opensource/tree/master/packages/jest-runner-docs)._
4+
_Generated using [jest-runner-docs](https://npmjs.com/package/jest-runner-docs)._
65

76
### [.exec](./src/index.js#L39)
87

@@ -17,7 +16,7 @@ instead of in parallel which is the default behavior.
1716
**Signature**
1817

1918
```ts
20-
function(cmds, options)
19+
function(cmds, options)
2120
```
2221

2322
**Params**
@@ -27,7 +26,7 @@ function(cmds, options)
2726
- `returns` - resolved or rejected promises
2827

2928
> It also can accept array of multiple strings of commands that will be
30-
> executed in series or in parallel (default).
29+
executed in series or in parallel (default).
3130

3231
**Example**
3332

@@ -40,13 +39,10 @@ async function main() {
4039
await exec('echo "hello world"', { stdio: 'inherit' });
4140
4241
// executes in series (because `concurrency` option is set to `1`)
43-
await exec(
44-
[
45-
'prettier-eslint --write foobar.js',
46-
'eslint --format codeframe foobar.js --fix',
47-
],
48-
{ stdio: 'inherit', preferLocal: true, concurrency: 1 },
49-
);
42+
await exec([
43+
'prettier-eslint --write foobar.js',
44+
'eslint --format codeframe foobar.js --fix'
45+
], { stdio: 'inherit', preferLocal: true, concurrency: 1 });
5046
}
5147
5248
main();
@@ -59,7 +55,7 @@ Similar to `exec`, but also **can** access the system's environment variables fr
5955
**Signature**
6056

6157
```ts
62-
function(cmds, options)
58+
function(cmds, options)
6359
```
6460

6561
**Params**
@@ -68,6 +64,8 @@ function(cmds, options)
6864
- `options` - directly passed to `execa`
6965
- `returns` - resolved or rejected promises
7066

67+
68+
7169
**Example**
7270

7371
```js
@@ -77,13 +75,18 @@ import { shell } from '@tunnckocore/execa';
7775
7876
async function main() {
7977
// executes in series
80-
await shell(['echo unicorns', 'echo "foo-$HOME-bar"', 'echo dragons'], {
81-
stdio: 'inherit',
82-
});
78+
await shell([
79+
'echo unicorns',
80+
'echo "foo-$HOME-bar"',
81+
'echo dragons'
82+
], { stdio: 'inherit' });
8383
8484
// exits with code 3
8585
try {
86-
await shell(['exit 3', 'echo nah']);
86+
await shell([
87+
'exit 3',
88+
'echo nah'
89+
]);
8790
} catch (er) {
8891
console.error(er);
8992
// => {
@@ -110,7 +113,7 @@ Think of this as a mix of `child_process.execFile()` and `child_process.spawn()`
110113
**Signature**
111114

112115
```ts
113-
function(file, args, options)
116+
function(file, args, options)
114117
```
115118

116119
**Params**
@@ -119,10 +122,12 @@ function(file, args, options)
119122
- `args` - arguments / flags to be passed to `file`
120123
- `options` - optional options, passed to `child_process`'s methods
121124

125+
126+
122127
**Example**
123128

124129
```js
125-
import execa from '@tunnckocore/execa';
130+
import execa from '@tunnckocore/execa'
126131
// or
127132
// const execa = require('@tunnckocore/execa');
128133

0 commit comments

Comments
 (0)