tunnckoCore · tunnckoCore · Mar 16, 2020 · Mar 16, 2020
diff --git a/@packages/ip-filter/.verb.md b/@packages/ip-filter/.verb.md
@@ -0,0 +1,7 @@
+## API
+
+<!-- docks-start -->
+
+{%= include(process.cwd() + "/docs/src/index.md") %}
+
+<!-- docks-end -->
diff --git a/@packages/ip-filter/CHANGELOG.md b/@packages/ip-filter/CHANGELOG.md
@@ -0,0 +1,38 @@
+
+
+## 2.0.0 - 2016-10-06
+
+- update repo style and dotfiles
+- use standard-version
+- follow semver and standards
+- use npm scripts
+
+**BREAKING CHANGES**
+
+- make 3rd argument to be `options` object instead of boolean
+- fixes #3 and add more tests
+
+## 1.0.2 - 2015-03-26
+- Release v1.0.2 / npm@v1.0.2
+- use verb to generate docs
+- update boilerplate and license year
+- use pre-commit to guarantee workflow
+
+## 1.0.1 - 2015-03-26
+- Release v1.0.1 / npm@v1.0.1
+- add more tests
+- little refactor to use `to-file-path` in strict mode
+  + forced to be done, because of `micromatch@2.2` that works only for filepaths
+- update deps
+
+## 1.0.0 - 2015-05-24
+- Release v1.0.0 / npm@v1.0.0
+- add support for no strict mode
+- run npm-related(1)
+- run keywords(1)
+- Commits on May 23, 2015
+- add test for when invalid ip
+- implement
+
+## 0.0.0 - 2015-05-23
+- first commits
diff --git a/@packages/ip-filter/LICENSE.md b/@packages/ip-filter/LICENSE.md
diff --git a/@packages/ip-filter/README.md b/@packages/ip-filter/README.md
@@ -0,0 +1,324 @@
+
+
+# ip-filter [![npm version][npmv-img]][npmv-url] [![License][license-img]][license-url] [![Libera Manifesto][libera-manifesto-img]][libera-manifesto-url]
+
+> Validates valid IPs (IPv4 and IPv6) using [micromatch][] - glob patterns, RegExp, string or array of globs. If match returns the IP, otherwise null.
+
+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="readme"></div>
+
+[![Code style][codestyle-img]][codestyle-url]
+[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]
+[![CodeCov coverage status][codecoverage-img]][codecoverage-url]
+[![Renovate App Status][renovateapp-img]][renovateapp-url]
+[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
+[![Time Since Last Commit][last-commit-img]][last-commit-url]
+
+<!-- [![Semantically Released][standard-release-img]][standard-release-url] -->
+
+If you have any _how-to_ kind of questions, please read the [Contributing
+Guide][contributing-url] and [Code of Conduct][code_of_conduct-url] documents.
+For bugs reports and feature requests, [please create an issue][open-issue-url]
+or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.
+
+[![Conventional Commits][ccommits-img]][ccommits-url]
+[![Minimum Required Nodejs][nodejs-img]][npmv-url]
+[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]
+[![NPM Downloads Total][downloads-total-img]][npmv-url]
+[![Share Love Tweet][twitter-share-img]][twitter-share-url]
+[![Twitter][twitter-img]][twitter-url]
+
+Project is [semantically](https://semver.org) versioned & automatically released
+from [GitHub Actions](https://github.com/features/actions) with
+[Lerna](https://github.com/lerna/lerna).
+
+[![Become a Patron][patreon-img]][patreon-url]
+[![Buy me a Kofi][kofi-img]][kofi-url]
+[![PayPal Donation][paypal-img]][paypal-url]
+[![Bitcoin Coinbase][bitcoin-img]][bitcoin-url]
+[![Keybase PGP][keybase-img]][keybase-url]
+
+| Topic                                                            |                                           Contact |
+| :--------------------------------------------------------------- | ------------------------------------------------: |
+| Any legal or licensing questions, like private or commerical use |           ![tunnckocore_legal][tunnckocore_legal] |
+| For any critical problems and security reports                   |     ![tunnckocore_security][tunnckocore_security] |
+| Consulting, professional support, personal or team training      | ![tunnckocore_consulting][tunnckocore_consulting] |
+| For any questions about Open Source, partnerships and sponsoring | ![tunnckocore_opensource][tunnckocore_opensource] |
+
+<!-- Logo when needed:
+
+<p align="center">
+  <a href="https://github.com/tunnckoCore/opensource">
+    <img src="./media/logo.png" width="85%">
+  </a>
+</p>
+
+-->
+
+## Table of Contents
+
+- [Install](#install)
+- [API](#api)
+  * [ipFilter](#ipfilter)
+- [See Also](#see-also)
+- [Contributing](#contributing)
+  * [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))_
+
+## Install
+
+This project requires [**Node.js**](https://nodejs.org) **>=10.13**
+_(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
+think to contribute to this project._
+
+```bash
+$ yarn add ip-filter
+```
+
+## API
+
+<!-- docks-start -->
+
+_Generated using [jest-runner-docs](https://ghub.now.sh/jest-runner-docs)._
+
+### [ipFilter](./src/index.js#L44)
+
+Filter `ip` against glob `patterns`, using [micromatch][] under the hood,
+so `options` are passed to it.
+
+<span id="ipfilter-signature"></span>
+
+#### Signature
+
+```ts
+function(ip, patterns, options)
+```
+
+<span id="ipfilter-params"></span>
+
+#### Params
+
+- `ip` **{string}** - Accepts only valid IPs by default
+- `patterns` **{string|array}** - Basically everything that [micromatch][]'s second argument can accept.
+- `options` **{object}** - Pass `strict: false` if want to validate non-ip values,
+                       options are also passed to [micromatch][].
+- `returns` **{string}** - a `string` or `null` If not match returns `null`, otherwise the passed `ip` as string.
+
+<span id="ipfilter-examples"></span>
+
+#### Examples
+
+```js
+const ipFilter = require('ip-filter');
+
+console.log(ipFilter('123.77.34.89', '123.??.34.8*')); // => '123.77.34.89'
+console.log(ipFilter('123.222.34.88', '123.??.34.8*')); // => null
+console.log(ipFilter('123.222.33.1', ['123.*.34.*', '*.222.33.*'])); // => '123.222.33.1'
+
+// should notice the difference
+console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.**']));
+// => null
+console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.*']));
+// => '123.222.34.88'
+```
+
+<span id="ipfilter-examples"></span>
+
+#### Examples
+
+```js
+const ipFilter = require('ip-filter');
+//
+// NON-STRICT mode
+//
+
+const res = ipFilter('x-koaip', ['*-koaip', '!foo-koa*'], { strict: false });
+console.log(res); // => 'x-koaip'
+
+const res = ipFilter('x-koa.foo', ['*-koa.*', '!foo-koa.*'], { strict: false });
+console.log(res); // => 'x-koa.foo'
+```
+
+<!-- docks-end -->
+
+**[back to top](#readme)**
+
+## See Also
+
+Some of these projects are used here or were inspiration for this one, others
+are just related. So, thanks for your existance!
+
+- [ip-regex](https://www.npmjs.com/package/ip-regex): Regular expression for matching IP addresses (IPv4 & IPv6) | [homepage](https://github.com/sindresorhus/ip-regex#readme "Regular expression for matching IP addresses (IPv4 & IPv6)")
+- [is-match-ip](https://www.npmjs.com/package/is-match-ip): Matching IPs using [micromatch][] and [ip-filter][] - glob patterns, RegExp… [more](https://github.com/tunnckocore/is-match-ip#readme) | [homepage](https://github.com/tunnckocore/is-match-ip#readme "Matching IPs using [micromatch][] and [ip-filter][] - glob patterns, RegExp, string or array of globs. Returns matcher function.")
+- [is-match](https://www.npmjs.com/package/is-match): Create a matching function from a glob pattern, regex, string… [more](https://github.com/jonschlinkert/is-match) | [homepage](https://github.com/jonschlinkert/is-match "Create a matching function from a glob pattern, regex, string, array, object or function.")
+- [koa-ip-filter](https://www.npmjs.com/package/koa-ip-filter): Middleware for [koa][] that filters IPs against glob patterns, RegExp… [more](https://github.com/tunnckocore/koa-ip-filter#readme) | [homepage](https://github.com/tunnckocore/koa-ip-filter#readme "Middleware for [koa][] that filters IPs against glob patterns, RegExp, string or array of globs. Support custom `403 Forbidden` message and custom ID.")
+- [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A replacement and faster alternative to… [more](https://github.com/micromatch/micromatch) | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.")
+- [to-file-path](https://www.npmjs.com/package/to-file-path): Create a filepath from an object path (dot notation), list… [more](https://github.com/tunnckocore/to-file-path#readme) | [homepage](https://github.com/tunnckocore/to-file-path#readme "Create a filepath from an object path (dot notation), list of arguments, array, number or Arguments object.")
+
+**[back to top](#readme)** 
+
+## Contributing
+
+### Guides and Community
+
+Please read the [Contributing Guide][contributing-url] and [Code of
+Conduct][code_of_conduct-url] documents for advices.
+
+For bug reports and feature requests, please join our [community][community-url]
+forum and open a thread there with prefixing the title of the thread with the
+name of the project if there's no separate channel for it.
+
+Consider reading the
+[Support and Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy)
+guide if you are interested in what are the supported Node.js versions and how
+we proceed. In short, we support latest two even-numbered Node.js release lines.
+
+### Support the project
+
+[Become a Partner or Sponsor?][kofi-url] :dollar: Check the **OpenSource**
+Commision (tier). :tada: You can get your company logo, link & name on this
+file. It's also rendered on package's page in [npmjs.com][npmv-url] and
+[yarnpkg.com](https://yarnpkg.com/en/package/ip-filter) 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:
+
+## Contributors
+
+This project follows the
+[all-contributors](https://github.com/all-contributors/all-contributors)
+specification. Contributions of any kind are welcome!
+
+Thanks goes to these wonderful people
+([emoji key](https://allcontributors.org/docs/en/emoji-key)), consider showing
+your [support](#support-the-project) to them:
+
+<!-- ALL-CONTRIBUTORS-LIST:START -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://tunnckoCore.com"><img src="https://avatars3.githubusercontent.com/u/5038030?v=4" width="100px;" alt=""/><br /><sub><b>Charlike Mike Reagent</b></sub></a><br /><a href="#infra-tunnckoCore" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Code">💻</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Documentation">📖</a> <a href="#ideas-tunnckoCore" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-tunnckoCore" title="Maintenance">🚧</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Tests">⚠️</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+**[back to top](#readme)**
+
+## License
+
+Copyright (c) 2015-present,
+[Charlike Mike Reagent](https://tunnckocore.com) `<opensource@tunnckocore.com>`
+& [contributors](#wonderful-contributors).<br> Released under the
+[MPL-2.0 License][license-url].
+
+<!-- badges -->
+
+<!-- prettier-ignore-start -->
+
+[contributing-url]: https://github.com/tunnckoCore/opensource/blob/master/CONTRIBUTING.md
+[code_of_conduct-url]: https://github.com/tunnckoCore/opensource/blob/master/CODE_OF_CONDUCT.md
+
+<!-- Heading badges -->
+
+[npmv-url]: https://www.npmjs.com/package/ip-filter
+[npmv-img]: https://badgen.net/npm/v/ip-filter?icon=npm&cache=300
+
+[license-url]: https://github.com/tunnckoCore/opensource/blob/master/packages/ip-filter/LICENSE
+[license-img]: https://badgen.net/npm/license/ip-filter?cache=300
+
+[libera-manifesto-url]: https://liberamanifesto.com
+[libera-manifesto-img]: https://badgen.net/badge/libera/manifesto/grey
+
+<!-- Front line badges -->
+
+[codecoverage-img]: https://badgen.net/badge/coverage/unknown/grey?icon=codecov&cache=300
+
+[codecoverage-url]: https://codecov.io/gh/tunnckoCore/opensource
+
+[codestyle-url]: https://github.com/airbnb/javascript
+[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
+
+[ccommits-url]: https://conventionalcommits.org/
+[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/green?cache=300
+
+[standard-release-url]: https://github.com/standard-release/standard-release
+[standard-release-img]: https://badgen.net/badge/semantically/released/05c5ff?cache=300
+
+[community-img]: https://badgen.net/badge/join/community/7b16ff?cache=300
+[community-url]: https://github.com/tunnckocorehq/community
+
+[last-commit-img]: https://badgen.net/github/last-commit/tunnckoCore/opensource/master?cache=300
+[last-commit-url]: https://github.com/tunnckoCore/opensource/commits/master
+
+[nodejs-img]: https://badgen.net/badge/node/>=10.13/green?cache=300
+
+[downloads-weekly-img]: https://badgen.net/npm/dw/ip-filter?icon=npm&cache=300
+[downloads-monthly-img]: https://badgen.net/npm/dm/ip-filter?icon=npm&cache=300
+[downloads-total-img]: https://badgen.net/npm/dt/ip-filter?icon=npm&cache=300
+
+[renovateapp-url]: https://renovatebot.com
+[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green?cache=300
+
+[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green?cache=300
+[prs-welcome-url]: http://makeapullrequest.com
+
+<!-- TODO: update icon -->
+
+[paypal-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=HYJJEZNSGAPGC&source=url
+[paypal-img]: https://badgen.net/badge/PayPal/donate/003087?cache=300&icon=https://simpleicons.now.sh/paypal/fff
+
+<!-- TODO: update icon -->
+
+[kofi-url]: https://ko-fi.com/tunnckoCore
+[kofi-img]: https://badgen.net/badge/Buy%20me/a%20coffee/29abe0c2?cache=300&icon=https://rawcdn.githack.com/tunnckoCore/badgen-icons/f8264c6414e0bec449dd86f2241d50a9b89a1203/icons/kofi.svg
+
+<!-- TODO: update icon -->
+
+[bitcoin-url]: https://www.blockchain.com/btc/payment_request?address=3QNHKun1K1SUui1b4Z3KEGPPsWC1TgtnqA&message=Open+Source+Software&amount_local=10&currency=USD
+[bitcoin-img]: https://badgen.net/badge/Bitcoin%20tip/3QNHKun...b4Z3KEGPPsWC1TgtnqA/yellow?cache=300&icon=https://simpleicons.now.sh/bitcoin/fff
+[keybase-url]: https://keybase.io/tunnckoCore
+[keybase-img]: https://badgen.net/keybase/pgp/tunnckoCore?cache=300
+[twitter-url]: https://twitter.com/tunnckoCore
+[twitter-img]: https://badgen.net/twitter/follow/tunnckoCore?icon=twitter&color=1da1f2&cache=300
+[patreon-url]: https://www.patreon.com/bePatron?u=5579781
+[patreon-img]: https://badgen.net/badge/Become/a%20patron/F96854?icon=patreon
+
+<!-- [patreon-img]: https://badgen.net/badge/Patreon/tunnckoCore/F96854?icon=patreon -->
+
+[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon
+[twitter-share-url]: https://twitter.com/intent/tweet?text=https://ghub.now.sh/ip-filter&via=tunnckoCore
+[twitter-share-img]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
+[open-issue-url]: https://github.com/tunnckoCore/opensource/issues/new
+[tunnckocore_legal]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/legal/tunnckocore?label&color=A56016&icon=https://svgshare.com/i/Dt6.svg
+[tunnckocore_consulting]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/consulting/tunnckocore?label&color=07ba96&icon=https://svgshare.com/i/Dt6.svg
+[tunnckocore_security]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/security/tunnckocore?label&color=ed1848&icon=https://svgshare.com/i/Dt6.svg
+[tunnckocore_opensource]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/opensource/tunnckocore?label&color=ff7a2f&icon=https://svgshare.com/i/Dt6.svg
+[tunnckocore_newsletter]: https://badgen.net/https/liam-badge-daknys6gadky.runkit.sh/com/newsletter/tunnckocore?label&color=5199FF&icon=https://svgshare.com/i/Dt6.svg
+
+<!-- prettier-ignore-end -->
+
+[ip-filter]: https://github.com/tunnckocore/ip-filter
+[is-match]: https://github.com/jonschlinkert/is-match
+[koa]: https://github.com/koajs/koa
+[micromatch]: https://github.com/micromatch/micromatch