aboutsummaryrefslogtreecommitdiff
path: root/node_modules/regex-cache
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/regex-cache
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/regex-cache')
-rw-r--r--node_modules/regex-cache/LICENSE21
-rw-r--r--node_modules/regex-cache/README.md166
-rw-r--r--node_modules/regex-cache/index.js68
-rw-r--r--node_modules/regex-cache/package.json64
4 files changed, 319 insertions, 0 deletions
diff --git a/node_modules/regex-cache/LICENSE b/node_modules/regex-cache/LICENSE
new file mode 100644
index 00000000..c0d7f136
--- /dev/null
+++ b/node_modules/regex-cache/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2017, Jon Schlinkert.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE. \ No newline at end of file
diff --git a/node_modules/regex-cache/README.md b/node_modules/regex-cache/README.md
new file mode 100644
index 00000000..8c660147
--- /dev/null
+++ b/node_modules/regex-cache/README.md
@@ -0,0 +1,166 @@
+# regex-cache [![NPM version](https://img.shields.io/npm/v/regex-cache.svg?style=flat)](https://www.npmjs.com/package/regex-cache) [![NPM monthly downloads](https://img.shields.io/npm/dm/regex-cache.svg?style=flat)](https://npmjs.org/package/regex-cache) [![NPM total downloads](https://img.shields.io/npm/dt/regex-cache.svg?style=flat)](https://npmjs.org/package/regex-cache) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/regex-cache.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/regex-cache) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/regex-cache.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/jonschlinkert/regex-cache)
+
+> Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in surprising performance improvements.
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install --save regex-cache
+```
+
+* Read [what this does](#what-this-does).
+* See [the benchmarks](#benchmarks)
+
+## Usage
+
+Wrap a function like this:
+
+```js
+var cache = require('regex-cache');
+var someRegex = cache(require('some-regex-lib'));
+```
+
+**Caching a regex**
+
+If you want to cache a regex after calling `new RegExp()`, or you're requiring a module that returns a regex, wrap it with a function first:
+
+```js
+var cache = require('regex-cache');
+
+function yourRegex(str, opts) {
+ // do stuff to str and opts
+ return new RegExp(str, opts.flags);
+}
+
+var regex = cache(yourRegex);
+```
+
+## Recommendations
+
+### Use this when...
+
+* **No options are passed** to the function that creates the regex. Regardless of how big or small the regex is, when zero options are passed, caching will be faster than not.
+* **A few options are passed**, and the values are primitives. The limited benchmarks I did show that caching is beneficial when up to 8 or 9 options are passed.
+
+### Do not use this when...
+
+* **The values of options are not primitives**. When non-primitives must be compared for equality, the time to compare the options is most likely as long or longer than the time to just create a new regex.
+
+### Example benchmarks
+
+Performance results, with and without regex-cache:
+
+```bash
+# no args passed (defaults)
+ with-cache x 8,699,231 ops/sec ±0.86% (93 runs sampled)
+ without-cache x 2,777,551 ops/sec ±0.63% (95 runs sampled)
+
+# string and six options passed
+ with-cache x 1,885,934 ops/sec ±0.80% (93 runs sampled)
+ without-cache x 1,256,893 ops/sec ±0.65% (97 runs sampled)
+
+# string only
+ with-cache x 7,723,256 ops/sec ±0.87% (92 runs sampled)
+ without-cache x 2,303,060 ops/sec ±0.47% (99 runs sampled)
+
+# one option passed
+ with-cache x 4,179,877 ops/sec ±0.53% (100 runs sampled)
+ without-cache x 2,198,422 ops/sec ±0.47% (95 runs sampled)
+
+# two options passed
+ with-cache x 3,256,222 ops/sec ±0.51% (99 runs sampled)
+ without-cache x 2,121,401 ops/sec ±0.79% (97 runs sampled)
+
+# six options passed
+ with-cache x 1,816,018 ops/sec ±1.08% (96 runs sampled)
+ without-cache x 1,157,176 ops/sec ±0.53% (100 runs sampled)
+
+#
+# diminishing returns happen about here
+#
+
+# ten options passed
+ with-cache x 1,210,598 ops/sec ±0.56% (92 runs sampled)
+ without-cache x 1,665,588 ops/sec ±1.07% (100 runs sampled)
+
+# twelve options passed
+ with-cache x 1,042,096 ops/sec ±0.68% (92 runs sampled)
+ without-cache x 1,389,414 ops/sec ±0.68% (97 runs sampled)
+
+# twenty options passed
+ with-cache x 661,125 ops/sec ±0.80% (93 runs sampled)
+ without-cache x 1,208,757 ops/sec ±0.65% (97 runs sampled)
+
+#
+# when non-primitive values are compared
+#
+
+# single value on the options is an object
+ with-cache x 1,398,313 ops/sec ±1.05% (95 runs sampled)
+ without-cache x 2,228,281 ops/sec ±0.56% (99 runs sampled)
+```
+
+## Run benchmarks
+
+Install dev dependencies:
+
+```bash
+npm i -d && npm run benchmarks
+```
+
+## What this does
+
+If you're using `new RegExp('foo')` instead of a regex literal, it's probably because you need to dyamically generate a regex based on user options or some other potentially changing factors.
+
+When your function creates a string based on user inputs and passes it to the `RegExp` constructor, regex-cache caches the results. The next time the function is called if the key of a cached regex matches the user input (or no input was given), the cached regex is returned, avoiding unnecessary runtime compilation.
+
+Using the RegExp constructor offers a lot of flexibility, but the runtime compilation comes at a price - it's slow. Not specifically because of the call to the RegExp constructor, but **because you have to build up the string before `new RegExp()` is even called**.
+
+## About
+
+### Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Contributors
+
+| **Commits** | **Contributor** |
+| --- | --- |
+| 31 | [jonschlinkert](https://github.com/jonschlinkert) |
+| 1 | [MartinKolarik](https://github.com/MartinKolarik) |
+
+### Building docs
+
+_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
+
+To generate the readme, run the following command:
+
+```sh
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
+```
+
+### Running tests
+
+Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
+
+```sh
+$ npm install && npm test
+```
+
+### Author
+
+**Jon Schlinkert**
+
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
+
+### License
+
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
+
+***
+
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 01, 2017._ \ No newline at end of file
diff --git a/node_modules/regex-cache/index.js b/node_modules/regex-cache/index.js
new file mode 100644
index 00000000..df8c4231
--- /dev/null
+++ b/node_modules/regex-cache/index.js
@@ -0,0 +1,68 @@
+/*!
+ * regex-cache <https://github.com/jonschlinkert/regex-cache>
+ *
+ * Copyright (c) 2015-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ */
+
+'use strict';
+
+var equal = require('is-equal-shallow');
+var basic = {};
+var cache = {};
+
+/**
+ * Expose `regexCache`
+ */
+
+module.exports = regexCache;
+
+/**
+ * Memoize the results of a call to the new RegExp constructor.
+ *
+ * @param {Function} fn [description]
+ * @param {String} str [description]
+ * @param {Options} options [description]
+ * @param {Boolean} nocompare [description]
+ * @return {RegExp}
+ */
+
+function regexCache(fn, str, opts) {
+ var key = '_default_', regex, cached;
+
+ if (!str && !opts) {
+ if (typeof fn !== 'function') {
+ return fn;
+ }
+ return basic[key] || (basic[key] = fn(str));
+ }
+
+ var isString = typeof str === 'string';
+ if (isString) {
+ if (!opts) {
+ return basic[str] || (basic[str] = fn(str));
+ }
+ key = str;
+ } else {
+ opts = str;
+ }
+
+ cached = cache[key];
+ if (cached && equal(cached.opts, opts)) {
+ return cached.regex;
+ }
+
+ memo(key, opts, (regex = fn(str, opts)));
+ return regex;
+}
+
+function memo(key, opts, regex) {
+ cache[key] = {regex: regex, opts: opts};
+}
+
+/**
+ * Expose `cache`
+ */
+
+module.exports.cache = cache;
+module.exports.basic = basic;
diff --git a/node_modules/regex-cache/package.json b/node_modules/regex-cache/package.json
new file mode 100644
index 00000000..a9072f67
--- /dev/null
+++ b/node_modules/regex-cache/package.json
@@ -0,0 +1,64 @@
+{
+ "name": "regex-cache",
+ "description": "Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in surprising performance improvements.",
+ "version": "0.4.4",
+ "homepage": "https://github.com/jonschlinkert/regex-cache",
+ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
+ "contributors": [
+ "Jon Schlinkert (http://twitter.com/jonschlinkert)",
+ "Martin Kolárik (https://kolarik.sk)"
+ ],
+ "repository": "jonschlinkert/regex-cache",
+ "bugs": {
+ "url": "https://github.com/jonschlinkert/regex-cache/issues"
+ },
+ "license": "MIT",
+ "files": [
+ "index.js"
+ ],
+ "main": "index.js",
+ "engines": {
+ "node": ">=0.10.0"
+ },
+ "scripts": {
+ "test": "mocha",
+ "benchmarks": "node benchmark"
+ },
+ "dependencies": {
+ "is-equal-shallow": "^0.1.3"
+ },
+ "devDependencies": {
+ "ansi-bold": "^0.1.1",
+ "benchmarked": "^0.1.5",
+ "gulp-format-md": "^0.1.7",
+ "micromatch": "^2.3.7",
+ "should": "^8.3.0"
+ },
+ "keywords": [
+ "cache",
+ "expression",
+ "regex",
+ "regexp",
+ "regular",
+ "regular expression",
+ "store",
+ "to-regex"
+ ],
+ "verb": {
+ "run": true,
+ "toc": false,
+ "layout": "default",
+ "tasks": [
+ "readme"
+ ],
+ "plugins": [
+ "gulp-format-md"
+ ],
+ "reflinks": [
+ "verb"
+ ],
+ "lint": {
+ "reflinks": true
+ }
+ }
+}