Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commenthol/named-regexp-groups
Regular expressions with named capture groups and named back-references
https://github.com/commenthol/named-regexp-groups
Last synced: about 1 month ago
JSON representation
Regular expressions with named capture groups and named back-references
- Host: GitHub
- URL: https://github.com/commenthol/named-regexp-groups
- Owner: commenthol
- License: mit
- Created: 2017-01-08T21:07:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T20:38:04.000Z (over 2 years ago)
- Last Synced: 2024-05-12T17:47:01.368Z (about 2 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-ponyfills - named-regexp-groups - [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) (Uncategorised)
README
# named-regexp-groups
> Regular expressions with named capture groups and named back-references
[](https://www.npmjs.com/package/named-regexp-groups)
[](https://github.com/commenthol/named-regexp-groups/actions/workflows/ci.yml?query=branch%3Amaster)
Create a named capture group with `(?.*)` or `(:.*)` when using
a RegExp. The methods of RegExp are supported excluding compile and toString.
Use named back-references using `(?&name)` to include already defined named pattern.
* [Installation](#installation)
* [Usage](#usage)
* [exec](#exec)
* [test](#test)
* [String.replace](#stringreplace)
* [String.match](#stringmatch)
* [String.split](#stringsplit)
* [ES7](#es7)
* [License](#license)
## Installation
npm install --save named-regexp-groups
## Usage
```js
import NamedRegExp from 'named-regexp-groups'
//or
const NamedRegExp = require('named-regexp-groups')
// as string
var r = new NamedRegExp('(?foo)(?)(-)(?:wat)(?(?:na)+)(?&na)')
// or as regex
var r = new NamedRegExp(/(:foo)(:)(-)(?:wat)(:(?:na)+)(:&na)/)
r.source
// => r.source === '(foo)([^]+)(-)(?:wat)((?:na)+)((?:na)+)'
```
For nodejs < v5.0 `core-js` polyfills are required.
Use `npm i -S core-js` in your project and add:
```js
// for node < v0.11
require('core-js/es6/object')
// for node < v5.0
require('core-js/es6/string')
require('core-js/es6/symbol')
```
### exec
```js
var r = new NamedRegExp('(?foo)(?bar)(-)(?:wat)(?(?:na)+)(?&na)')
r.exec('nanafoobar-watnana')
// => [ 'foobar-watnana', 'foo', 'bar', '-', 'na', 'na',
// index: 4,
// input: 'nanafoobar-watnana',
// groups: { foo: 'foo', bar: 'bar', '0': '-', na: 'na', '1': 'na' } ]
```
### test
```js
r = new NamedRegExp('(?foo)(bar)(?:waah)')
r.source
// => '(foo)(bar)(?:waah)'
r.test('nanafoobarwaah')
// => true
```
### String.replace
If using a string as replacement use `$+{name}` to define the placeholder for the capture group.
This follows the Syntax of [PCRE Named backreferences][].
```js
var r = new NamedRegExp(/(:\d+)-(:\d+)-(:\d+)/)
// ---- using strings
'2017-01-02'.replace(r, 'day: $+{day}, month: $+{month}, year: $+{year}')
// => 'day: 02, month: 01, year: 2017')
// ---- using function
'2016-11-22'.replace(r, function () { // take care of NOT using an arrow function here!
var args = [].slice.call(arguments)
var g = this.groups
return `day: ${args[g.day]}, month: ${args[g.month]}, year: ${args[g.year]}`
})
// => 'day: 22, month: 11, year: 2017')
```
### String.match
```js
r = new NamedRegExp('(?foo)(bar)(?:waah)')
'nanafoobarwaah'.match(r)
// => [ 'foobarwaah', 'foo', 'bar',
// index: 4, input: 'nanafoobarwaah',
// groups: { '0': 'bar', foo: 'foo' } ]
```
### String.split
```js
r = new NamedRegExp('(?foo)')
'nanafoobarwaah'.split(r)
// => [ 'nana', 'foo', 'barwaah' ]
```
## ES7
The proposed [TC39 proposal-regexp-named-groups](https://github.com/tc39/proposal-regexp-named-groups) is finding it's way into the standard.
Chrome>=64 already supports named groups. Maybe node>=10 soon as well...
Paste this into Chrome>=64
```js
r = new RegExp(/(?foo)(?bar)(-)(?:wat)(?(?:na)+)/);
o = r.exec('nanafoobar-watnana')
//> (5) ["foobar-watnana", "foo", "bar", "-", "na",
//> index: 4, input: "nanafoobar-watnana",
//> groups: {foo: "foo", bar: "bar", na: "nana"}]
```
## License
Software is released under [MIT][license].
[license]: ./LICENSE
[PCRE Named backreferences]: http://perldoc.perl.org/perlretut.html#Named-backreferences