fix: run docs

Signed-off-by: Charlike Mike Reagent <[email protected]>
tunnckoCoreLabs · Nov 6, 2018 · f1d6ac0 · f1d6ac0
1 parent 7c760f5
commit f1d6ac0
Show file tree

Hide file tree

Showing 4 changed files with 302 additions and 2 deletions.
diff --git a/.verb.md b/.verb.md
@@ -54,6 +54,45 @@ $ yarn add {%= name %}
 ## API
 
 <!-- docks-start -->
+_Generated using [docks](http://npm.im/docks)._
+
+### [src/index.js](/src/index.js)
+
+#### [circleci](/src/index.js#L41)
+Currently only supports `POST` request to the API, so endpoints
+such as `/follow` and `/build` are working, but not `/me` because
+it needs a `GET` request. Basically what this module is doing
+by default is that you pass a `options.repository` and `options.token`,
+and it "follows" (e.g. enables) a CircleCI service on that repository.
+The token also can be passed as `options.circleci_token` or as
+an environment variable `process.env.CIRCLE_CI`.
+
+If you want to trigger a build, instead of enabling a project,
+then pass second parameter `'build'`.
+
+**Params**
+- `[options]` **{object}** optional, pass `options.repository` and `options.token`
+- `[type]` **{string}** type of action, by default `'follow'`
+
+**Returns**
+- `Promise<object>` response from the api, requested with [axios][]
+
+**Examples**
+```javascript
+import circleci from '@tunnckocore/circleci';
+
+async function main() {
+  const options = { repository: 'tunnckoCoreLabs/foobar', token: 'XXX' };
+  const resultOfFollow = await circleci(options);
+  console.log(resultOfFollow);
+
+  const triggeredBuild = await circleci(options, 'build');
+  console.log(triggeredBuild)
+}
+
+main().catch(console.error);
+```
+
 <!-- docks-end -->
 
 **[back to top](#thetop)**

diff --git a/README.md b/README.md
@@ -0,0 +1,227 @@
+# @tunnckocore/circleci [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]
+
+> Small and simple CircleCI client library to requesting the API and authorization via token
+
+Please consider following this project's author, [Charlike Mike Reagent](https://github.com/tunnckoCore), and :star: the project to show your :heart: and support.
+
+<div id="thetop"></div>
+
+[![Code style][codestyle-img]][codestyle-url]
+[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]
+[![CodeCov coverage status][codecoverage-img]][codecoverage-url]
+[![DavidDM dependency status][dependencies-img]][dependencies-url]
+[![Renovate App Status][renovateapp-img]][renovateapp-url]
+[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
+[![Semantically Released][new-release-img]][new-release-url]
+
+If you have any _how-to_ kind of questions, please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents.  
+For bugs reports and feature requests, [please create an issue][open-issue-url] or ping
+[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.
+
+[![Become a Patron][patreon-img]][patreon-url]
+[![Conventional Commits][ccommits-img]][ccommits-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]
+[![Share Love Tweet][shareb]][shareu]
+
+Project is [semantically](https://semver.org) & automatically released on [CircleCI](https://circleci.com) with [new-release][] and its [New Release](https://github.com/apps/new-release) GitHub App.
+
+<!-- Logo when needed:
+
+<p align="center">
+  <a href="https://github.com/tunnckoCoreLabs/circleci">
+    <img src="./media/logo.png" width="85%">
+  </a>
+</p>
+
+-->
+
+## Table of Contents
+
+- [Install](#install)
+- [API](#api)
+  * [src/index.js](#srcindexjs)
+    + [circleci](#circleci)
+- [See Also](#see-also)
+- [Contributing](#contributing)
+  * [Follow the Guidelines](#follow-the-guidelines)
+  * [Support the project](#support-the-project)
+  * [OPEN Open Source](#open-open-source)
+  * [Wonderful Contributors](#wonderful-contributors)
+- [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**](https://nodejs.org) **^8.11.0 || >=10.13.0**. Install it using
+[**yarn**](https://yarnpkg.com) or [**npm**](https://npmjs.com).  
+_We highly recommend to use Yarn when you think to contribute to this project._
+
+```bash
+$ yarn add @tunnckocore/circleci
+```
+
+## API
+
+<!-- docks-start -->
+_Generated using [docks](http://npm.im/docks)._
+
+### [src/index.js](/src/index.js)
+
+#### [circleci](/src/index.js#L41)
+Currently only supports `POST` request to the API, so endpoints
+such as `/follow` and `/build` are working, but not `/me` because
+it needs a `GET` request. Basically what this module is doing
+by default is that you pass a `options.repository` and `options.token`,
+and it "follows" (e.g. enables) a CircleCI service on that repository.
+The token also can be passed as `options.circleci_token` or as
+an environment variable `process.env.CIRCLE_CI`.
+
+If you want to trigger a build, instead of enabling a project,
+then pass second parameter `'build'`.
+
+**Params**
+- `[options]` **{object}** optional, pass `options.repository` and `options.token`
+- `[type]` **{string}** type of action, by default `'follow'`
+
+**Returns**
+- `Promise<object>` response from the api, requested with [axios][]
+
+**Examples**
+```javascript
+import circleci from '@tunnckocore/circleci';
+
+async function main() {
+  const options = { repository: 'tunnckoCoreLabs/foobar', token: 'XXX' };
+  const resultOfFollow = await circleci(options);
+  console.log(resultOfFollow);
+
+  const triggeredBuild = await circleci(options, 'build');
+  console.log(triggeredBuild)
+}
+
+main().catch(console.error);
+```
+
+<!-- docks-end -->
+
+**[back to top](#thetop)**
+
+## See Also
+
+Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your
+existance!
+- [@tunnckocore/config](https://www.npmjs.com/package/@tunnckocore/config): All the configs for all the tools, in one place | [homepage](https://github.com/tunnckoCoreLabs/config "All the configs for all the tools, in one place")
+- [@tunnckocore/create-project](https://www.npmjs.com/package/@tunnckocore/create-project): Create and scaffold a new project, its GitHub repository and… [more](https://github.com/tunnckoCoreLabs/create-project) | [homepage](https://github.com/tunnckoCoreLabs/create-project "Create and scaffold a new project, its GitHub repository and contents")
+- [@tunnckocore/execa](https://www.npmjs.com/package/@tunnckocore/execa): Thin layer on top of [execa][] that allows executing multiple… [more](https://github.com/tunnckoCoreLabs/execa) | [homepage](https://github.com/tunnckoCoreLabs/execa "Thin layer on top of [execa][] that allows executing multiple commands in parallel or in sequence")
+- [@tunnckocore/scripts](https://www.npmjs.com/package/@tunnckocore/scripts): Universal and minimalist scripts & tasks runner. | [homepage](https://github.com/tunnckoCoreLabs/scripts "Universal and minimalist scripts & tasks runner.")
+- [@tunnckocore/update](https://www.npmjs.com/package/@tunnckocore/update): Update a repository with latest templates from `charlike`. | [homepage](https://github.com/tunnckoCoreLabs/update "Update a repository with latest templates from `charlike`.")
+- [asia](https://www.npmjs.com/package/asia): Blazingly fast, magical and minimalist testing framework, for Today and… [more](https://github.com/olstenlarck/asia#readme) | [homepage](https://github.com/olstenlarck/asia#readme "Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow")
+- [charlike](https://www.npmjs.com/package/charlike): Small & fast project scaffolder with sane defaults. Supports hundreds… [more](https://github.com/tunnckoCoreLabs/charlike) | [homepage](https://github.com/tunnckoCoreLabs/charlike "Small & fast project scaffolder with sane defaults. Supports hundreds of template engines through the @JSTransformers API or if you want custom `render` function passed through options")
+- [docks](https://www.npmjs.com/package/docks): Extensible system for parsing and generating documentation. It just freaking… [more](https://github.com/tunnckoCore/docks) | [homepage](https://github.com/tunnckoCore/docks "Extensible system for parsing and generating documentation. It just freaking works!")
+- [gitcommit](https://www.npmjs.com/package/gitcommit): Lightweight and joyful `git commit` replacement. Conventional Commits compliant. | [homepage](https://github.com/tunnckoCore/gitcommit "Lightweight and joyful `git commit` replacement. Conventional Commits compliant.")
+
+**[back to top](#thetop)**
+
+## Contributing
+
+### Follow the Guidelines
+
+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 ping
+[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.
+
+### Support the project
+
+[Become a Partner or Sponsor?][patreon-url] :dollar: Check the **Partner**, **Sponsor** or **Omega-level** tiers! :tada: You can get your company logo, link & name on this file. It's also rendered on package page in [npmjs.com][npmv-url] and [yarnpkg.com](https://yarnpkg.com/en/package/@tunnckocore/circleci) sites too! :rocket:
+
+Not financial support? Okey! [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always
+welcome. :sparkles:
+
+### OPEN Open Source
+
+This project is following [OPEN Open Source](http://openopensource.org) model
+
+> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.
+
+There are a few basic ground-rules for its contributors
+
+1. Any **significant modifications** must be subject to a pull request to get feedback from other contributors.
+2. [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request) to get feedback are _encouraged_ for any other trivial contributions, but are not required.
+3. Contributors should attempt to adhere to the prevailing code-style and development workflow.
+
+### Wonderful Contributors
+
+Thanks to the hard work of these wonderful people this project is alive! It follows the
+[all-contributors](https://github.com/kentcdodds/all-contributors) specification.  
+Don't hesitate to add yourself to that list if you have made any contribution! ;) [See how,
+here](https://github.com/jfmengels/all-contributors-cli#usage).
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+| [<img src="https://avatars3.githubusercontent.com/u/5038030?v=4" width="120px;"/><br /><sub><b>Charlike Mike Reagent</b></sub>](https://tunnckocore.com)<br />[💻](https://github.com/tunnckoCoreLabs/circleci/commits?author=tunnckoCore "Code") [📖](https://github.com/tunnckoCoreLabs/circleci/commits?author=tunnckoCore "Documentation") [💬](#question-tunnckoCore "Answering Questions") [👀](#review-tunnckoCore "Reviewed Pull Requests") [🔍](#fundingFinding-tunnckoCore "Funding Finding") |
+| :---: |
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+Consider showing your [support](#support-the-project) to them. :sparkling_heart:
+
+## License
+
+Copyright (c) 2018-present, [Charlike Mike Reagent](https://tunnckocore.com) `<[email protected]>` & [contributors](#wonderful-contributors).  
+Released under the [Apache-2.0 License][license-url].
+
+<!-- Heading badges -->
+
+[npmv-url]: https://www.npmjs.com/package/@tunnckocore/circleci
+[npmv-img]: https://badgen.net/npm/v/@tunnckocore/circleci?icon=npm
+
+[ghrelease-url]: https://github.com/tunnckoCoreLabs/circleci/releases/latest
+[ghrelease-img]: https://badgen.net/github/release/tunnckoCoreLabs/circleci?icon=github
+
+[license-url]: https://github.com/tunnckoCoreLabs/circleci/blob/master/LICENSE
+[license-img]: https://badgen.net/npm/license/@tunnckocore/circleci
+
+<!-- Front line badges -->
+
+[codestyle-url]: https://github.com/airbnb/javascript
+[codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb
+
+[linuxbuild-url]: https://circleci.com/gh/tunnckoCoreLabs/circleci/tree/master
+[linuxbuild-img]: https://badgen.net/circleci/github/tunnckoCoreLabs/circleci/master?label=build&icon=circleci
+
+[codecoverage-url]: https://codecov.io/gh/tunnckoCoreLabs/circleci
+[codecoverage-img]: https://badgen.net/codecov/c/github/tunnckoCoreLabs/circleci?icon=codecov
+
+[dependencies-url]: https://david-dm.org/tunnckoCoreLabs/circleci
+[dependencies-img]: https://badgen.net/david/dep/tunnckoCoreLabs/circleci?label=deps
+
+[ccommits-url]: https://conventionalcommits.org/
+[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/dfb317
+[new-release-url]: https://ghub.io/new-release
+[new-release-img]: https://badgen.net/badge/semantically/released/05c5ff
+
+[downloads-weekly-img]: https://badgen.net/npm/dw/@tunnckocore/circleci
+[downloads-monthly-img]: https://badgen.net/npm/dm/@tunnckocore/circleci
+[downloads-total-img]: https://badgen.net/npm/dt/@tunnckocore/circleci
+
+[renovateapp-url]: https://renovatebot.com
+[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
+[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green
+[prs-welcome-url]: http://makeapullrequest.com
+[paypal-donate-url]: https://paypal.me/tunnckoCore/10
+[paypal-donate-img]: https://badgen.net/badge/$/support/purple
+[patreon-url]: https://www.patreon.com/bePatron?u=5579781
+[patreon-img]: https://badgen.net/badge/patreon/tunnckoCore/F96854?icon=patreon
+[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon
+
+[shareu]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCoreLabs/circleci&via=tunnckoCore
+[shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
+[open-issue-url]: https://github.com/tunnckoCoreLabs/circleci/issues/new
+
+[axios]: https://github.com/axios/axios
+[execa]: https://github.com/sindresorhus/execa
+[new-release]: https://github.com/tunnckoCore/new-release
+[semantic-release]: https://github.com/semantic-release/semantic-release
diff --git a/package.json b/package.json
@@ -71,7 +71,9 @@
     },
     "reflinks": [
       "new-release",
-      "semantic-release"
+      "semantic-release",
+      "axios",
+      "execa"
     ]
   }
-}
+}
diff --git a/src/index.js b/src/index.js
@@ -6,6 +6,38 @@
 import proc from 'process';
 import axios from 'axios';
 
+/**
+ * Currently only supports `POST` request to the API, so endpoints
+ * such as `/follow` and `/build` are working, but not `/me` because
+ * it needs a `GET` request. Basically what this module is doing
+ * by default is that you pass a `options.repository` and `options.token`,
+ * and it "follows" (e.g. enables) a CircleCI service on that repository.
+ * The token also can be passed as `options.circleci_token` or as
+ * an environment variable `process.env.CIRCLE_CI`.
+ *
+ * If you want to trigger a build, instead of enabling a project,
+ * then pass second parameter `'build'`.
+ *
+ * @example
+ * import circleci from '@tunnckocore/circleci';
+ *
+ * async function main() {
+ *   const options = { repository: 'tunnckoCoreLabs/foobar', token: 'XXX' };
+ *   const resultOfFollow = await circleci(options);
+ *   console.log(resultOfFollow);
+ *
+ *   const triggeredBuild = await circleci(options, 'build');
+ *   console.log(triggeredBuild)
+ * }
+ *
+ * main().catch(console.error);
+ *
+ * @name  circleci
+ * @param {object} [options={}] optional, pass `options.repository` and `options.token`
+ * @param {string} [type='follow'] type of action, by default `'follow'`
+ * @returns {Promise<object>} response from the api, requested with [axios][]
+ * @public
+ */
 export default async function enableCircleCI(answers = {}, type = 'follow') {
   const api = 'https://circleci.com/api/v1.1/';
   const token =