.config/coc/extensions/node_modules/coc-prettier/node_modules/to-regex/README.md

   1 # to-regex [![NPM version](https://img.shields.io/npm/v/to-regex.svg?style=flat)](https://www.npmjs.com/package/to-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/to-regex.svg?style=flat)](https://npmjs.org/package/to-regex) [![NPM total downloads](https://img.shields.io/npm/dt/to-regex.svg?style=flat)](https://npmjs.org/package/to-regex) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/to-regex.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/to-regex)
   2
   3 > Generate a regex from a string or array of strings.
   4
   5 Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
   6
   7 - [Install](#install)
   8 - [Usage](#usage)
   9 - [Options](#options)
  10   * [options.contains](#optionscontains)
  11   * [options.negate](#optionsnegate)
  12   * [options.nocase](#optionsnocase)
  13   * [options.flags](#optionsflags)
  14   * [options.cache](#optionscache)
  15   * [options.safe](#optionssafe)
  16 - [About](#about)
  17   * [Related projects](#related-projects)
  18   * [Author](#author)
  19   * [License](#license)
  20
  21 _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
  22
  23 ## Install
  24
  25 Install with [npm](https://www.npmjs.com/):
  26
  27 ```sh
  28 $ npm install --save to-regex
  29 ```
  30
  31 ## Usage
  32
  33 ```js
  34 var toRegex = require('to-regex');
  35
  36 console.log(toRegex('foo'));
  37 //=> /^(?:foo)$/
  38
  39 console.log(toRegex('foo', {negate: true}));
  40 //=> /^(?:(?:(?!^(?:foo)$).)*)$/
  41
  42 console.log(toRegex('foo', {contains: true}));
  43 //=> /(?:foo)/
  44
  45 console.log(toRegex(['foo', 'bar'], {negate: true}));
  46 //=> /^(?:(?:(?!^(?:(?:foo)|(?:bar))$).)*)$/
  47
  48 console.log(toRegex(['foo', 'bar'], {negate: true, contains: true}));
  49 //=> /^(?:(?:(?!(?:(?:foo)|(?:bar))).)*)$/
  50 ```
  51
  52 ## Options
  53
  54 ### options.contains
  55
  56 **Type**: `Boolean`
  57
  58 **Default**: `undefined`
  59
  60 Generate a regex that will match any string that _contains_ the given pattern. By default, regex is strict will only return true for exact matches.
  61
  62 ```js
  63 var toRegex = require('to-regex');
  64 console.log(toRegex('foo', {contains: true}));
  65 //=> /(?:foo)/
  66 ```
  67
  68 ### options.negate
  69
  70 **Type**: `Boolean`
  71
  72 **Default**: `undefined`
  73
  74 Create a regex that will match everything except the given pattern.
  75
  76 ```js
  77 var toRegex = require('to-regex');
  78 console.log(toRegex('foo', {negate: true}));
  79 //=> /^(?:(?:(?!^(?:foo)$).)*)$/
  80 ```
  81
  82 ### options.nocase
  83
  84 **Type**: `Boolean`
  85
  86 **Default**: `undefined`
  87
  88 Adds the `i` flag, to enable case-insensitive matching.
  89
  90 ```js
  91 var toRegex = require('to-regex');
  92 console.log(toRegex('foo', {nocase: true}));
  93 //=> /^(?:foo)$/i
  94 ```
  95
  96 Alternatively you can pass the flags you want directly on [options.flags](#options.flags).
  97
  98 ### options.flags
  99
 100 **Type**: `String`
 101
 102 **Default**: `undefined`
 103
 104 Define the flags you want to use on the generated regex.
 105
 106 ```js
 107 var toRegex = require('to-regex');
 108 console.log(toRegex('foo', {flags: 'gm'}));
 109 //=> /^(?:foo)$/gm
 110 console.log(toRegex('foo', {flags: 'gmi', nocase: true})); //<= handles redundancy
 111 //=> /^(?:foo)$/gmi
 112 ```
 113
 114 ### options.cache
 115
 116 **Type**: `Boolean`
 117
 118 **Default**: `true`
 119
 120 Generated regex is cached based on the provided string and options. As a result, runtime compilation only happens once per pattern (as long as options are also the same), which can result in dramatic speed improvements.
 121
 122 This also helps with debugging, since adding options and pattern are added to the generated regex.
 123
 124 **Disable caching**
 125
 126 ```js
 127 toRegex('foo', {cache: false});
 128 ```
 129
 130 ### options.safe
 131
 132 **Type**: `Boolean`
 133
 134 **Default**: `undefined`
 135
 136 Check the generated regular expression with [safe-regex](https://github.com/substack/safe-regex) and throw an error if the regex is potentially unsafe.
 137
 138 **Examples**
 139
 140 ```js
 141 console.log(toRegex('(x+x+)+y'));
 142 //=> /^(?:(x+x+)+y)$/
 143
 144 // The following would throw an error
 145 toRegex('(x+x+)+y', {safe: true});
 146 ```
 147
 148 ## About
 149
 150 <details>
 151 <summary><strong>Contributing</strong></summary>
 152
 153 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
 154
 155 </details>
 156
 157 <details>
 158 <summary><strong>Running Tests</strong></summary>
 159
 160 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:
 161
 162 ```sh
 163 $ npm install && npm test
 164 ```
 165
 166 </details>
 167
 168 <details>
 169 <summary><strong>Building docs</strong></summary>
 170
 171 _(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.)_
 172
 173 To generate the readme, run the following command:
 174
 175 ```sh
 176 $ npm install -g verbose/verb#dev verb-generate-readme && verb
 177 ```
 178
 179 </details>
 180
 181 ### Related projects
 182
 183 You might also be interested in these projects:
 184
 185 * [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob "Returns `true` if an array has a glob pattern.")
 186 * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
 187 * [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex "Regular expression for matching the parts of a file path.")
 188 * [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/micromatch/to-regex-range) | [homepage](https://github.com/micromatch/to-regex-range "Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.78 million test assertions.")
 189
 190 ### Author
 191
 192 **Jon Schlinkert**
 193
 194 * [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
 195 * [github/jonschlinkert](https://github.com/jonschlinkert)
 196 * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 197
 198 ### License
 199
 200 Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
 201 Released under the [MIT License](LICENSE).
 202
 203 ***
 204
 205 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 24, 2018._