mathiasbynens / babel-plugin-transform-modern-regexp

Babel plugin for modern RegExp features in JavaScript

babel-plugin-transform-modern-regexp

Enables modern RegExp features in JavaScript.

Table of Contents

• Features
  • dotAll s-flag
  • Named capturing groups
  • Extended x-flag
• Usage
  • Via .babelrc
  • Via CLI
  • Via Node.js API

Features

The plugin enables the following features for JS regular expressions:

• "dotAll" s-flag (stage 3 proposal)
• Named capturing groups (stage 3 proposal)
• Extended x-flag (non-standard)

See also examples in compat-transpile, and regexp extensions secions of regexp-tree.

dotAll s-flag

By default the . symbol matchs all symbols but new lines. The "dotAll" s flag enables matching \n with the . symbol:

// Simple.
/./s;

// With unicode `u` flag.
/./su;

It is translated into:

// Simple.
/[\0-\uFFFF]/;

// With unicode `u` flag.
/[\0-\u{10FFFF}]/u;

Named capturing groups

See details in the proposal.

Capturing groups in JS regexes until recent supported only numbered-matching.

For example, given /(\d{4})-(\d{2})-(\d{2})/ that matches a date, one cannot be sure which group corresponds to the month and which one is the day without examining the surrounding code. Also, if one wants to swap the order of the month and the day, the group references should also be updated.

Named capture groups provide a nice solution for these issues.

/(?<year>\d{4})-(?<month>\d{2})-(?<day>\d{2})/

To backreference a named group, we can use \k<name> notation:

/(?<value>a)\k<value>\1/

The above regexp is transalted into:

/(a)\1\1/

Extended x-flag

Note: x-flag is not yet standardized by ES spec. It's a standard flag in PCRE, Python, and other regexes.

Some features, like x-flag currently can only be used via new RegExp(...) pattern, since are not suppored yet by JavaScript parsers for regexp literals:

new RegExp(`

  # A regular expression for date.

  (?<year>\d{4})-    # year part of a date
  (?<month>\d{2})-   # month part of a date
  (?<day>\d{2})      # day part of a date

`, 'x');

Translated into:

new RegExp('(\\d{4})-(\\d{2})-(\\d{2})', '');

Usage

Via .babelrc

.babelrc

{
  "plugins": ["transform-modern-regexp"]
}

Via CLI

$ babel --plugins transform-modern-regexp script.js

Via Node.js API

require('babel-core').transform(code, {
  'plugins': ['transform-modern-regexp']
});