@@ -56,14 +56,14 @@ Project is [semantically](https://semver.org) versioned & automatically released
5656
5757- [ Install] ( #install )
5858- [ API] ( #api )
59- * [ .exec] ( #exec )
60- * [ .shell] ( #shell )
61- * [ execa] ( #execa )
59+ - [ .exec] ( #exec )
60+ - [ .shell] ( #shell )
61+ - [ execa] ( #execa )
6262- [ Contributing] ( #contributing )
63- * [ Guides and Community] ( #guides-and-community )
64- * [ Support the project] ( #support-the-project )
65- * [ OPEN Open Source] ( #open-open-source )
66- * [ Wonderful Contributors] ( #wonderful-contributors )
63+ - [ Guides and Community] ( #guides-and-community )
64+ - [ Support the project] ( #support-the-project )
65+ - [ OPEN Open Source] ( #open-open-source )
66+ - [ Wonderful Contributors] ( #wonderful-contributors )
6767- [ License] ( #license )
6868
6969_ (TOC generated by [ verb] ( https://github.com/verbose/verb ) using [ markdown-toc] ( https://github.com/jonschlinkert/markdown-toc ) )_
@@ -79,6 +79,7 @@ $ yarn add @tunnckocore/execa
7979```
8080
8181<!-- docks-start -->
82+
8283## API
8384
8485_ Generated using [ jest-runner-docs] ( https://npmjs.com/package/jest-runner-docs ) ._
@@ -96,7 +97,7 @@ instead of in parallel which is the default behavior.
9697** Signature**
9798
9899``` ts
99- function (cmds , options )
100+ function (cmds , options )
100101```
101102
102103** Params **
@@ -106,7 +107,7 @@ function(cmds, options)
106107- ` returns ` - resolved or rejected promises
107108
108109> It also can accept array of multiple strings of commands that will be
109- executed in series or in parallel (default ).
110+ > executed in series or in parallel (default ).
110111
111112** Example **
112113
@@ -119,10 +120,13 @@ async function main() {
119120 await exec('echo "hello world"', { stdio: 'inherit' });
120121
121122 // executes in series (because ` concurrency ` option is set to ` 1 ` )
122- await exec([
123- 'prettier-eslint --write foobar.js',
124- 'eslint --format codeframe foobar.js --fix'
125- ], { stdio: 'inherit', preferLocal: true, concurrency: 1 });
123+ await exec(
124+ [
125+ 'prettier-eslint --write foobar.js',
126+ 'eslint --format codeframe foobar.js --fix',
127+ ],
128+ { stdio: 'inherit', preferLocal: true, concurrency: 1 },
129+ );
126130}
127131
128132main();
@@ -135,7 +139,7 @@ Similar to `exec`, but also **can** access the system's environment variables fr
135139** Signature **
136140
137141` ` ` ts
138- function(cmds, options)
142+ function(cmds, options)
139143` ` `
140144
141145** Params **
@@ -153,18 +157,13 @@ import { shell } from '@tunnckocore/execa';
153157
154158async function main() {
155159 // executes in series
156- await shell([
157- 'echo unicorns',
158- 'echo "foo-$HOME-bar"',
159- 'echo dragons'
160- ], { stdio: 'inherit' });
160+ await shell(['echo unicorns', 'echo "foo-$HOME-bar"', 'echo dragons'], {
161+ stdio: 'inherit',
162+ });
161163
162164 // exits with code 3
163165 try {
164- await shell([
165- 'exit 3',
166- 'echo nah'
167- ]);
166+ await shell(['exit 3', 'echo nah']);
168167 } catch (er) {
169168 console.error(er);
170169 // => {
@@ -191,7 +190,7 @@ Think of this as a mix of `child_process.execFile()` and `child_process.spawn()`
191190** Signature **
192191
193192` ` ` ts
194- function(file, args, options)
193+ function(file, args, options)
195194` ` `
196195
197196** Params **
@@ -203,7 +202,7 @@ function(file, args, options)
203202** Example **
204203
205204` ` ` js
206- import execa from '@tunnckocore/execa'
205+ import execa from '@tunnckocore/execa';
207206// or
208207// const execa = require('@tunnckocore/execa');
209208
@@ -277,7 +276,6 @@ Released under the [MPL-2.0 License][license-url].
277276
278277[npmv - url ]: https :// www.npmjs.com/package/@tunnckocore/execa
279278[npmv - img ]: https :// badgen.net/npm/v/@tunnckocore/execa?icon=npm
280-
281279[nodejs - img ]: https :// badgen.net/npm/node/@tunnckocore/execa
282280
283281< ! --
@@ -306,11 +304,9 @@ Released under the [MPL-2.0 License][license-url].
306304[community - url ]: https :// github.com/tunnckocorehq/community
307305[last - commit - img ]: https :// badgen.net/github/last-commit/tunnckoCore/opensource/master
308306[last - commit - url ]: https :// github.com/tunnckoCore/opensource/commits/master
309-
310307[downloads - weekly - img ]: https :// badgen.net/npm/dw/@tunnckocore/execa?icon=npm
311308[downloads - monthly - img ]: https :// badgen.net/npm/dm/@tunnckocore/execa?icon=npm
312309[downloads - total - img ]: https :// badgen.net/npm/dt/@tunnckocore/execa?icon=npm
313-
314310[renovateapp - url ]: https :// renovatebot.com
315311[renovateapp - img ]: https :// badgen.net/badge/renovate/enabled/green
316312[prs - welcome - img ]: https :// badgen.net/badge/PRs/welcome/green
@@ -348,5 +344,4 @@ Released under the [MPL-2.0 License][license-url].
348344[tunnckocore_security ]: https :// badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/security/tunnckocore?label&color=ed1848&icon=https://svgshare.com/i/Dt6.svg
349345[tunnckocore_opensource ]: https :// badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/opensource/tunnckocore?label&color=ff7a2f&icon=https://svgshare.com/i/Dt6.svg
350346[tunnckocore_newsletter ]: https :// badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg
351-
352- [execa ]: https :// github.com/sindresorhus/execa
347+ [execa ]: https :// github.com/sindresorhus/execa
0 commit comments