Mathias Bynens 96c0415c86
Remove outdated sentence from README (#7311)
Unicode property escapes are now part of ECMAScript proper.

[skip ci]
2018-02-01 14:27:13 -08:00

61 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# @babel/plugin-proposal-unicode-property-regex
Compile [Unicode property escapes](https://github.com/mathiasbynens/regexpu-core/blob/master/property-escapes.md) (`\p{…}` and `\P{…}`) in Unicode regular expressions to ES5 or ES6 that works in todays environments.
[Heres an online demo.](https://mothereff.in/regexpu#input=var+regex+%3D+/%5Cp%7BScript_Extensions%3DGreek%7D/u%3B&unicodePropertyEscape=1)
## Installation
```sh
npm install --save-dev @babel/plugin-proposal-unicode-property-regex
```
## Usage
### Via `.babelrc` (recommended)
`.babelrc`
```json
{
"plugins": ["@babel/plugin-proposal-unicode-property-regex"]
}
```
### Via CLI
```sh
babel --plugins @babel/@babel/plugin-proposal-unicode-property-regex script.js
```
### Via Node.js API
```js
require("@babel/core").transform(code, {
"plugins": ["@babel/plugin-proposal-unicode-property-regex"]
});
```
To transpile to ES6/ES2015:
```js
require("@babel/core").transform(code, {
"plugins": [
["@babel/plugin-proposal-unicode-property-regex", { "useUnicodeFlag": false }]
]
});
```
## Options
* `useUnicodeFlag` (defaults to `true`)
When disabled with `false`, the transform converts Unicode regexes to
non-Unicode regexes for wider support, removing the `u` flag. See https://github.com/mathiasbynens/regexpu-core#useunicodeflag-default-false for more information.
## Author
| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
|---|
| [Mathias Bynens](https://mathiasbynens.be/) |