diff --git a/README.md b/README.md new file mode 100644 index 0000000..640cb77 --- /dev/null +++ b/README.md @@ -0,0 +1,186 @@ +# execa-pro [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url] + +> Thin layer on top of [execa][] that allows executing multiple commands in series + +
+ +_You might also be interested in [execa][highlighted-link] or in the other [related projects](#related-projects)._ + +## Quality Assurance :100: + +[![bitHound Code][bithound-code-img]][bithound-code-url] +[![Code Style Standard][standard-img]][standard-url] +[![Linux Build][circleci-img]][circleci-url] +[![Code Coverage][codecov-img]][codecov-url] +[![bitHound Score][bithound-score-img]][bithound-score-url] +[![bitHound Deps][bithound-deps-img]][bithound-deps-url] +[![Dependencies Status][dependencies-img]][dependencies-url] + +If you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **join the chat** rooms or [open an issue][open-issue-url]. +You may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _"How to contribute?"_, we describe everything **_stated_** by the badges. + +[![tunnckoCore support][chat-img]][chat-url] +[![Code Format Prettier][prettier-img]][prettier-url] +[![Node Security Status][nodesecurity-img]][nodesecurity-url] +[![Conventional Commits][ccommits-img]][ccommits-url] +[![Make A Pull Request][prs-welcome-img]][prs-welcome-url] +[![Node Version Required][nodeversion-img]][nodeversion-url] +[![Renovate App Status][renovate-img]][renovate-url] + + + Sponsor + +

+ +[![All Contributors Spec][all-contributors-img]](#contributors) +[![Make A Pull Request][prs-welcome-img]][prs-welcome-url] +[![Newsletter Subscribe][tinyletter-img]][tinyletter-url] +[![PayPal Author Support][paypal-donate-img]][paypal-donate-url] +[![Share Love Tweet][share-love-img]][share-love-url] +[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url] +[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url] +[![NPM Downloads Total][downloads-total-img]][npmv-url] + +## Table of Contents +- [Install](#install) +- [API](#api) +- [Related Projects](#related-projects) +- [Contributing](#contributing) +- [Contributors](#contributors) +- [Users](#users) +- [License](#license) + +_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ + +## Install + +This project requires [**Node.js**][nodeversion-url] **v8** or above. Install it using [**yarn**](https://yarnpkg.com) **v1** or above / [**npm**](https://www.npmjs.com) **v5** or above. + +``` +$ yarn add execa-pro +``` + + +## API +Review carefully the provided examples and the working [tests](./test). + +**[back to top](#thetop)** + +## Related Projects +Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance! +- [dush](https://www.npmjs.com/package/dush): Microscopic & functional event emitter in ~350 bytes, extensible through plugins | [homepage](https://github.com/tunnckocore/dush#readme "Microscopic & functional event emitter in ~350 bytes, extensible through plugins") +- [execa](https://www.npmjs.com/package/execa): A better `child_process` | [homepage](https://github.com/sindresorhus/execa#readme "A better `child_process`") +- [hela](https://www.npmjs.com/package/hela): Powerful & flexible task runner framework in 80 lines, based on execa… [more](https://github.com/tunnckoCore/hela#readme) | [homepage](https://github.com/tunnckoCore/hela#readme "Powerful & flexible task runner framework in 80 lines, based on execa. Supports presets, a la ESLint but for tasks & npm scripts") +- [mri](https://www.npmjs.com/package/mri): Quickly scan for CLI flags and arguments | [homepage](https://github.com/lukeed/mri#readme "Quickly scan for CLI flags and arguments") +- [p-map-series](https://www.npmjs.com/package/p-map-series): Map over promises serially | [homepage](https://github.com/sindresorhus/p-map-series#readme "Map over promises serially") + +**[back to top](#thetop)** + +## Contributing +Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices. +For bugs reports and feature requests, [please create an issue][open-issue-url] or join us at our [Flock chat][chat-url] rooms. + +## Contributors +Thanks to the hard work of [these wonderful people](./CONTRIBUTORS.md) this project is alive and it also follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. +[Pull requests](./CONTRIBUTING.md#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always welcome. + +## Users +You can see who uses `execa-pro` in the [USERS.md](./USERS.md) file. Please feel free adding this file if it not exists. +If you or your organization are using this project, consider adding yourself to the list of users. **Thank You!** + +## License +Copyright (c) 2017-present, [Charlike Mike Reagent][author-link] ``. +Released under the [Apache-2.0 License][license-url]. + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 14, 2017._ +_Project scaffolded and managed with [hela][]._ + +[execa]: https://github.com/sindresorhus/execa +[hela]: https://github.com/tunnckoCore/hela + + +[npmv-url]: https://www.npmjs.com/package/execa-pro +[npmv-img]: https://img.shields.io/npm/v/execa-pro.svg?label=npm%20version + +[github-release-url]: https://github.com/tunnckoCore/execa-pro/releases/latest +[github-release-img]: https://img.shields.io/github/release/tunnckoCore/execa-pro.svg?label=github%20release + +[license-url]: https://github.com/tunnckoCore/execa-pro/blob/master/LICENSE +[license-img]: https://img.shields.io/npm/l/execa-pro.svg + + +[downloads-monthly-img]: https://img.shields.io/npm/dm/execa-pro.svg + + +[bithound-score-url]: https://www.bithound.io/github/tunnckoCore/execa-pro +[bithound-score-img]: https://www.bithound.io/github/tunnckoCore/execa-pro/badges/score.svg + +[bithound-code-url]: https://www.bithound.io/github/tunnckoCore/execa-pro +[bithound-code-img]: https://www.bithound.io/github/tunnckoCore/execa-pro/badges/code.svg + +[standard-url]: https://github.com/airbnb/javascript +[standard-img]: https://img.shields.io/badge/code_style-airbnb-brightgreen.svg + +[circleci-url]: https://circleci.com/gh/tunnckoCore/execa-pro/tree/master +[circleci-img]: https://img.shields.io/circleci/project/github/tunnckoCore/execa-pro/master.svg + +[codecov-url]: https://codecov.io/gh/tunnckoCore/execa-pro +[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/execa-pro/master.svg + +[bithound-deps-url]: https://www.bithound.io/github/tunnckoCore/execa-pro/dependencies/npm +[bithound-deps-img]: https://www.bithound.io/github/tunnckoCore/execa-pro/badges/dependencies.svg + +[dependencies-url]: https://david-dm.org/tunnckoCore/execa-pro +[dependencies-img]: https://img.shields.io/david/tunnckoCore/execa-pro.svg + + +[chat-url]: https://tunnckocore.flock.com/?i=cx2xoeofjtj6eo6c +[chat-img]: https://img.shields.io/badge/chat-on_flock-brightgreen.svg + +[prettier-url]: https://github.com/prettier/prettier +[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg + +[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/777a99d4-955c-441e-9f5d-8d7352f93d71/master +[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/777a99d4-955c-441e-9f5d-8d7352f93d71/badge + + +[ccommits-url]: https://conventionalcommits.org/ +[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg + +[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg +[prs-welcome-url]: http://makeapullrequest.com + +[nodeversion-url]: https://nodejs.org/en/download +[nodeversion-img]: https://img.shields.io/node/v/execa-pro.svg + +[renovate-url]: https://renovateapp.com +[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg + + +[all-contributors-img]: https://img.shields.io/github/contributors/tunnckoCore/execa-pro.svg?label=all%20contributors&colorB=ffa500 + +[tinyletter-url]: https://tinyletter.com/tunnckoCore +[tinyletter-img]: https://img.shields.io/badge/join-newsletter-9caaf8.svg + +[paypal-donate-url]: https://paypal.me/tunnckoCore/10 +[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg + +[downloads-weekly-img]: https://img.shields.io/npm/dw/execa-pro.svg +[downloads-total-img]: https://img.shields.io/npm/dt/execa-pro.svg + + +[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCore/execa-pro&via=tunnckoCore +[share-love-img]: https://img.shields.io/badge/share-love-1da1f2.svg +[open-issue-url]: https://github.com/tunnckoCore/execa-pro/issues/new + +[highlighted-link]: https://ghub.now.sh/execa +[author-link]: https://i.am.charlike.online + diff --git a/package.json b/package.json index 1bcbc36..8cbd740 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Thin layer on top of [execa][] that allows executing multiple commands in series", "repository": "tunnckoCore/execa-pro", "author": "Charlike Mike Reagent (https://i.am.charlike.online)", - "nspId": "todo", + "nspId": "777a99d4-955c-441e-9f5d-8d7352f93d71", "main": "./src/index.js", "scripts": { "test": "NODE_ENV=test yarn hela test", @@ -60,6 +60,9 @@ "lint": { "reflinks": true }, - "reflinks": [] + "reflinks": [ + "execa", + "hela" + ] } -} +} \ No newline at end of file