Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shannonmoeller/regx
Tagged-template-string regular-expression compiler.
https://github.com/shannonmoeller/regx
Last synced: 12 days ago
JSON representation
Tagged-template-string regular-expression compiler.
- Host: GitHub
- URL: https://github.com/shannonmoeller/regx
- Owner: shannonmoeller
- License: mit
- Created: 2016-02-03T15:08:29.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-20T23:07:27.000Z (almost 7 years ago)
- Last Synced: 2024-10-03T12:39:27.144Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://npm.im/regx
- Size: 9.77 KB
- Stars: 33
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# regx
[![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url] [![Tip][amazon-img]][amazon-url]
Tagged template string [regular expression][guide] compiler. Supports multiline expressions, partials, and embedded comments.
## Install
$ npm install --save regx
## Example
```js
import regx from 'regx';
// RegExp partial to match opening block comment (flags ignored)
const openPartial = /\/\*\*/i;
// String partial to match closing block comment (extra escaping required)
const closePartial = '\\*\\/';
// Time to write a human-readable expression
const expression = regx('gm')`
// Match a non-recursive block comment
(
// Must be first thing on a line
^[\t ]*
${openPartial} // Block opener
// Capture content independently
(
// Match any character including newlines (non-greedy)
[\s\S]*?
)
${closePartial} // Block closer
)
// Grab trailing newlines and discard them
[\r\n]*
`;
// The result is the same as if you had written the following
const expression = /(^[\t ]*\/\*\*([\s\S]*?)\*\/)[\r\n]*/gm;
```
## API
### `regx([flags]) : regxTagFunction`
Creates a template-string tag function. Optionally accepts RegExp [flags][flags].
```js
const a = regx('gm')`
^ // start of line
a+ // one or more 'a' characters
$ // end of line
`; // result: /^a+$/gm
```
### `regxTagFunction(strings, ...values) : RegExp`
The functions returned by `regx()` may be cached and reused.
```js
const rx = regx('gm');
const a = rx`
^ // start of line
a+ // one or more 'a' characters
$ // end of line
`; // result: /^a+$/gm
const b = rx`
^ // start of line
b+ // one or more 'b' characters
$ // end of line
`; // result: /^b+$/gm
```
All whitespace at the beginning and end of each line is ignored. To match literal whitespace at the beginning or end of a line you must use a character set.
```js
const rx = regx('i');
const spaceBefore = rx`
[ ]foo bar
`; // result: /[ ]foo bar/i
const spaceAfter = rx`
foo bar[ ]
`; // result: /foo bar[ ]/i
```
----
MIT © [Shannon Moeller](http://shannonmoeller.com)
[guide]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[flags]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Advanced_searching_with_flags
[amazon-img]: https://img.shields.io/badge/amazon-tip_jar-yellow.svg?style=flat-square
[amazon-url]: https://www.amazon.com/gp/registry/wishlist/1VQM9ID04YPC5?sort=universal-price
[downloads-img]: http://img.shields.io/npm/dm/regx.svg?style=flat-square
[npm-img]: http://img.shields.io/npm/v/regx.svg?style=flat-square
[npm-url]: https://npmjs.org/package/regx