chore(glob-cache): format

tunnckoCore · tunnckoCore · commit 4c82136c21d0 · 2020-03-05T04:23:09.000+02:00
Signed-off-by: Charlike Mike Reagent &lt;opensource@tunnckocore.com&gt;
diff --git a/@packages/glob-cache/README.md b/@packages/glob-cache/README.md
@@ -7,7 +7,9 @@
 
 # glob-cache [![npm version][npmv-img]][npmv-url] [![License][license-img]][license-url] [![Libera Manifesto][libera-manifesto-img]][libera-manifesto-url]
 
-> Best and fastest file globbing solution for Node.js - can use **any** glob library like `glob`, `globby` or `fast-glob`! Streaming, Promise and Hook APIs, with built in caching layer using `cacache`. Makes you Instant Fast™.
+> Best and fastest file globbing solution for Node.js - can use **any** glob
+> library like `glob`, `globby` or `fast-glob`! Streaming, Promise and Hook
+> APIs, with built in caching layer using `cacache`. Makes you Instant Fast™.
 
 Please consider following this project's author,
 [Charlike Mike Reagent](https://github.com/tunnckoCore), and :star: the project
@@ -67,31 +69,31 @@ from [GitHub Actions](https://github.com/features/actions) with
 
 - [Install](#install)
 - [API](#api)
-  * [globCache](#globcache)
-    + [Signature](#signature)
-    + [Params](#params)
-    + [Examples](#examples)
-  * [globCache.stream](#globcachestream)
-    + [Signature](#signature-1)
-    + [Params](#params-1)
-    + [Examples](#examples-1)
-  * [globCache.promise](#globcachepromise)
-    + [Signature](#signature-2)
-    + [Params](#params-2)
-    + [Examples](#examples-2)
+  - [globCache](#globcache)
+    - [Signature](#signature)
+    - [Params](#params)
+    - [Examples](#examples)
+  - [globCache.stream](#globcachestream)
+    - [Signature](#signature-1)
+    - [Params](#params-1)
+    - [Examples](#examples-1)
+  - [globCache.promise](#globcachepromise)
+    - [Signature](#signature-2)
+    - [Params](#params-2)
+    - [Examples](#examples-2)
 - [Context and how it works](#context-and-how-it-works)
 - [Contributing](#contributing)
-  * [Guides and Community](#guides-and-community)
-  * [Support the project](#support-the-project)
+  - [Guides and Community](#guides-and-community)
+  - [Support the project](#support-the-project)
 - [Contributors](#contributors)
 - [License](#license)
 
-_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
+_(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) **>=10.18**
-_(see
+This project requires [**Node.js**](https://nodejs.org) **>=10.18** _(see
 [Support & Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy))_.
 Install it using [**yarn**](https://yarnpkg.com) or
 [**npm**](https://npmjs.com).<br> _We highly recommend to use Yarn when you
@@ -109,9 +111,9 @@ _Generated using [jest-runner-docs](https://ghub.now.sh/jest-runner-docs)._
 
 ### [globCache](./src/index.js#L40)
 
-A mirror of `globCache.stream` and so an "async generator" function,
-returning an AsyncIterable. This mirror exists because it's
-a common practice to have a `(globPatterns, options)` signature.
+A mirror of `globCache.stream` and so an "async generator" function, returning
+an AsyncIterable. This mirror exists because it's a common practice to have a
+`(globPatterns, options)` signature.
 
 <span id="globcache-signature"></span>
 
@@ -136,24 +138,25 @@ function(patterns, options)
 const globCache = require('glob-cache');
 
 const iterable = globCache(['src/*.js', 'test/*.{js,ts}'], {
-  cwd: './foo/bar'
+  cwd: './foo/bar',
 });
 
 // equivalent to
 
 const iter = globCache.stream({
   include: ['src/*.js', 'test/*.{js,ts}'],
-  cwd: './foo/bar'
+  cwd: './foo/bar',
 });
 ```
 
 ### [globCache.stream](./src/index.js#L84)
 
-Match files and folders with glob patterns, by default using [fast-glob's `.stream()`](https://ghub.now.sh/fast-glob).
-This function is [async generator](https://javascript.info/async-iterators-generators)
-and returns "async iterable", so you can use the `for await ... of` loop. Note that this loop
-should be used inside an `async function`.
-Each item is a [Context](#context-and-how-it-works) object, which is also passed to each hook.
+Match files and folders with glob patterns, by default using
+[fast-glob's `.stream()`](https://ghub.now.sh/fast-glob). This function is
+[async generator](https://javascript.info/async-iterators-generators) and
+returns "async iterable", so you can use the `for await ... of` loop. Note that
+this loop should be used inside an `async function`. Each item is a
+[Context](#context-and-how-it-works) object, which is also passed to each hook.
 
 <span id="globcache.stream-signature"></span>
 
@@ -170,17 +173,25 @@ function(options)
 - `options.cwd` **{string}** - working directory, defaults to `process.cwd()`
 - `options.include` **{string|Array}** - string or array of string glob patterns
 - `options.patterns` **{string|Array}** - alias of `options.include`
-- `options.exclude` **{string|Array}** - ignore glob patterns, passed to `options.globOptions.ignore`
+- `options.exclude` **{string|Array}** - ignore glob patterns, passed to
+  `options.globOptions.ignore`
 - `options.ignore` **{string|Array}** - alias of `options.exclude`
-- `options.hooks` **{object}** - an object with hooks functions, each hook passed with [Context](#context-and-how-it-works)
+- `options.hooks` **{object}** - an object with hooks functions, each hook
+  passed with [Context](#context-and-how-it-works)
 - `options.hooks.found` **{Function}** - called when a cache for a file is found
-- `options.hooks.notFound` **{Function}** - called when file is not found in cache (usually the first hit)
-- `options.hooks.changed` **{Function}** - called always when source file differs the cache file
-- `options.hooks.notChanged` **{Function}** - called when both source file and cache file are "the same"
+- `options.hooks.notFound` **{Function}** - called when file is not found in
+  cache (usually the first hit)
+- `options.hooks.changed` **{Function}** - called always when source file
+  differs the cache file
+- `options.hooks.notChanged` **{Function}** - called when both source file and
+  cache file are "the same"
 - `options.hooks.always` **{Function}** - called always, no matter of the state
-- `options.glob` **{Function}** - a function `(patterns, options) => {}` or globbing library like [glob][], [globby][], [fast-glob][]
-- `options.globOptions` **{object}** - options passed to the `options.glob` library
-- `options.cacheLocation` **{string}** - a filepath location of the cache, defaults to `.cache/glob-cache` in `options.cwd`
+- `options.glob` **{Function}** - a function `(patterns, options) => {}` or
+  globbing library like [glob][], [globby][], [fast-glob][]
+- `options.globOptions` **{object}** - options passed to the `options.glob`
+  library
+- `options.cacheLocation` **{string}** - a filepath location of the cache,
+  defaults to `.cache/glob-cache` in `options.cwd`
 - `returns` **{AsyncIterable}**
 
 <span id="globcache.stream-examples"></span>
@@ -194,7 +205,7 @@ const globCache = require('glob-cache');
   // Using the Stream API
   const iterable = globCache.stream({
     include: 'src/*.js',
-    cacheLocation: './foo-cache'
+    cacheLocation: './foo-cache',
   });
 
   for await (const ctx of iterable) {
@@ -205,8 +216,8 @@ const globCache = require('glob-cache');
 
 ### [globCache.promise](./src/index.js#L243)
 
-Using the Promise API allows you to use the Hooks API, and it's actually
-the recommended way of using the hooks api. By default, if the returned promise
+Using the Promise API allows you to use the Hooks API, and it's actually the
+recommended way of using the hooks api. By default, if the returned promise
 resolves, it will be an empty array. That's intentional, because if you are
 using the hooks api it's unnecessary to pollute the memory putting huge objects
 to a "result array". So if you want results array to contain the Context objects
@@ -224,9 +235,12 @@ function(options)
 
 #### Params
 
-- `options` **{object}** - see `globCache.stream` options, in addition here we have `options.buffered` too
-- `options.buffered` **{boolean}** - if `true` returned array will contain [Context]((#context-and-how-it-works)) objects, default `false`
-- `returns` **{Promise}** - if `options.buffered: true` resolves to `Array<Context>`, otherwise empty array
+- `options` **{object}** - see `globCache.stream` options, in addition here we
+  have `options.buffered` too
+- `options.buffered` **{boolean}** - if `true` returned array will contain
+  [Context](<(#context-and-how-it-works)>) objects, default `false`
+- `returns` **{Promise}** - if `options.buffered: true` resolves to
+  `Array<Context>`, otherwise empty array
 
 <span id="globcache.promise-examples"></span>
 
@@ -245,7 +259,7 @@ const globby = require('globby');
     hooks: {
       changed(ctx) {},
       always(ctx) {},
-    }
+    },
   });
   console.log(res); // => []
 
@@ -465,10 +479,9 @@ your [support](#support-the-project) to them:
 
 ## License
 
-Copyright (c) 2020-present,
-[Charlike Mike Reagent](https://tunnckocore.com) `<opensource@tunnckocore.com>`
-& [contributors](#wonderful-contributors).<br> Released under the
-[MPL-2.0 License][license-url].
+Copyright (c) 2020-present, [Charlike Mike Reagent](https://tunnckocore.com)
+`<opensource@tunnckocore.com>` & [contributors](#wonderful-contributors).<br>
+Released under the [MPL-2.0 License][license-url].
 
 <!-- badges -->
 
@@ -498,7 +511,7 @@ Copyright (c) 2020-present,
 [codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb&cache=300
 
 [linuxbuild-url]: https://github.com/tunnckocore/opensource/actions
-[linuxbuild-img]: https://badgen.net/github/checks/tunnckoCore/opensource/master?cache=300&label=build&icon=github
+[linuxbuild-img]: https://badgen-net.charlike.now.sh/github/checks/tunnckoCore/opensource/master/test?cache=300&label=build&icon=github
 
 [ccommits-url]: https://conventionalcommits.org/
 [ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/green?cache=300
@@ -563,4 +576,4 @@ Copyright (c) 2020-present,
 [fast-glob]: https://github.com/mrmlnc/fast-glob
 [glob]: https://github.com/isaacs/node-glob
 [globby]: https://github.com/sindresorhus/globby
-[tiny-glob]: https://github.com/terkelg/tiny-glob
+[tiny-glob]: https://github.com/terkelg/tiny-glob
diff --git a/@packages/glob-cache/docs/src/index.md b/@packages/glob-cache/docs/src/index.md
@@ -1,12 +1,10 @@
-
-
 _Generated using [jest-runner-docs](https://ghub.now.sh/jest-runner-docs)._
 
 ### [globCache](./src/index.js#L40)
 
-A mirror of `globCache.stream` and so an "async generator" function,
-returning an AsyncIterable. This mirror exists because it's
-a common practice to have a `(globPatterns, options)` signature.
+A mirror of `globCache.stream` and so an "async generator" function, returning
+an AsyncIterable. This mirror exists because it's a common practice to have a
+`(globPatterns, options)` signature.
 
 <span id="globcache-signature"></span>
 
@@ -23,8 +21,6 @@ function(patterns, options)
 - `patterns` **{string|Array}** - string or array of glob patterns
 - `options` **{object}** - see `globCache.stream` options
 
-
-
 <span id="globcache-examples"></span>
 
 #### Examples
@@ -33,24 +29,25 @@ function(patterns, options)
 const globCache = require('glob-cache');
 
 const iterable = globCache(['src/*.js', 'test/*.{js,ts}'], {
-  cwd: './foo/bar'
+  cwd: './foo/bar',
 });
 
 // equivalent to
 
 const iter = globCache.stream({
   include: ['src/*.js', 'test/*.{js,ts}'],
-  cwd: './foo/bar'
+  cwd: './foo/bar',
 });
 ```
 
 ### [globCache.stream](./src/index.js#L84)
 
-Match files and folders with glob patterns, by default using [fast-glob's `.stream()`](https://ghub.now.sh/fast-glob).
-This function is [async generator](https://javascript.info/async-iterators-generators)
-and returns "async iterable", so you can use the `for await ... of` loop. Note that this loop
-should be used inside an `async function`.
-Each item is a [Context](#context-and-how-it-works) object, which is also passed to each hook.
+Match files and folders with glob patterns, by default using
+[fast-glob's `.stream()`](https://ghub.now.sh/fast-glob). This function is
+[async generator](https://javascript.info/async-iterators-generators) and
+returns "async iterable", so you can use the `for await ... of` loop. Note that
+this loop should be used inside an `async function`. Each item is a
+[Context](#context-and-how-it-works) object, which is also passed to each hook.
 
 <span id="globcache.stream-signature"></span>
 
@@ -67,21 +64,27 @@ function(options)
 - `options.cwd` **{string}** - working directory, defaults to `process.cwd()`
 - `options.include` **{string|Array}** - string or array of string glob patterns
 - `options.patterns` **{string|Array}** - alias of `options.include`
-- `options.exclude` **{string|Array}** - ignore glob patterns, passed to `options.globOptions.ignore`
+- `options.exclude` **{string|Array}** - ignore glob patterns, passed to
+  `options.globOptions.ignore`
 - `options.ignore` **{string|Array}** - alias of `options.exclude`
-- `options.hooks` **{object}** - an object with hooks functions, each hook passed with [Context](#context-and-how-it-works)
+- `options.hooks` **{object}** - an object with hooks functions, each hook
+  passed with [Context](#context-and-how-it-works)
 - `options.hooks.found` **{Function}** - called when a cache for a file is found
-- `options.hooks.notFound` **{Function}** - called when file is not found in cache (usually the first hit)
-- `options.hooks.changed` **{Function}** - called always when source file differs the cache file
-- `options.hooks.notChanged` **{Function}** - called when both source file and cache file are "the same"
+- `options.hooks.notFound` **{Function}** - called when file is not found in
+  cache (usually the first hit)
+- `options.hooks.changed` **{Function}** - called always when source file
+  differs the cache file
+- `options.hooks.notChanged` **{Function}** - called when both source file and
+  cache file are "the same"
 - `options.hooks.always` **{Function}** - called always, no matter of the state
-- `options.glob` **{Function}** - a function `(patterns, options) => {}` or globbing library like [glob][], [globby][], [fast-glob][]
-- `options.globOptions` **{object}** - options passed to the `options.glob` library
-- `options.cacheLocation` **{string}** - a filepath location of the cache, defaults to `.cache/glob-cache` in `options.cwd`
+- `options.glob` **{Function}** - a function `(patterns, options) => {}` or
+  globbing library like [glob][], [globby][], [fast-glob][]
+- `options.globOptions` **{object}** - options passed to the `options.glob`
+  library
+- `options.cacheLocation` **{string}** - a filepath location of the cache,
+  defaults to `.cache/glob-cache` in `options.cwd`
 - `returns` **{AsyncIterable}**
 
-
-
 <span id="globcache.stream-examples"></span>
 
 #### Examples
@@ -93,7 +96,7 @@ const globCache = require('glob-cache');
   // Using the Stream API
   const iterable = globCache.stream({
     include: 'src/*.js',
-    cacheLocation: './foo-cache'
+    cacheLocation: './foo-cache',
   });
 
   for await (const ctx of iterable) {
@@ -104,8 +107,8 @@ const globCache = require('glob-cache');
 
 ### [globCache.promise](./src/index.js#L243)
 
-Using the Promise API allows you to use the Hooks API, and it's actually
-the recommended way of using the hooks api. By default, if the returned promise
+Using the Promise API allows you to use the Hooks API, and it's actually the
+recommended way of using the hooks api. By default, if the returned promise
 resolves, it will be an empty array. That's intentional, because if you are
 using the hooks api it's unnecessary to pollute the memory putting huge objects
 to a "result array". So if you want results array to contain the Context objects
@@ -123,11 +126,12 @@ function(options)
 
 #### Params
 
-- `options` **{object}** - see `globCache.stream` options, in addition here we have `options.buffered` too
-- `options.buffered` **{boolean}** - if `true` returned array will contain [Context]((#context-and-how-it-works)) objects, default `false`
-- `returns` **{Promise}** - if `options.buffered: true` resolves to `Array<Context>`, otherwise empty array
-
-
+- `options` **{object}** - see `globCache.stream` options, in addition here we
+  have `options.buffered` too
+- `options.buffered` **{boolean}** - if `true` returned array will contain
+  [Context](<(#context-and-how-it-works)>) objects, default `false`
+- `returns` **{Promise}** - if `options.buffered: true` resolves to
+  `Array<Context>`, otherwise empty array
 
 <span id="globcache.promise-examples"></span>
 
@@ -146,7 +150,7 @@ const globby = require('globby');
     hooks: {
       changed(ctx) {},
       always(ctx) {},
-    }
+    },
   });
   console.log(res); // => []
 
@@ -160,4 +164,3 @@ const globby = require('globby');
   console.log(results); // => [Context, Context, ...]
 })();
 ```
-
