npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

perf-regexes

v1.0.1

Published

Optimized and powerful regexes for JavaScript

Downloads

157,746

Readme

perf-regexes

Optimized and powerful regexes for JavaScript

npm Version License Build Status Bundle Size

Breaking Changes

In ES5, matching literal regexes with other regex in medium complexity code is highly risky.In ES6 it is practically impossible.

For this reason, as of v1.0 JS_REGEX_P is deprecated and will be removed in the next minor version.

JS_REGEX will be maintained, but its use should be limited to complement other utilities, such as skip-regex, which uses a customized version of JS_REGEX to identify regular expresions reliably.

The minimum supported version of NodeJS now is 6.14 (oldest maintained LTS version w/fixes).

Install

npm install perf-regexes --save
# or
yarn add perf-regexes

In the browser, this loads perf-regexes in the global R object:

<script src="https://unpkg.com/perf-regexes/index.min.js"></script>

Included Regexes

All of these regexes recognize Win/Mac/Unix line-endings and are ready to be used, but you can customize them using the RegExp constructor and the source property of the desired regex.

HTML:

Name | Flags | Matches ---------- | :---: | ------- HTML_CMNT | g | Valid HTML comments, according to the SGML standard.

JavaScript:

Name | Flags | Matches ---------- | :---: | ------- JS_MLCMNT | g | Multiline JS comment, with support for embedded '/*' sequences. JS_SLCMNT | g | Single-line JS comments, not including its line-ending. JS_DQSTR | g | Double quoted JS string, with support for escaped quotes and line-endings. JS_SQSTR | g | Single quoted JS string, with support for escaped quotes and line-endings. JS_STRING | g | Combines JS_SQSTR and JS_DQSTR to match single or double quoted strings. JS_REGEX | g | Regex. Note: The result must be validated. JS_REGEX_P | g | Deprecated, do not use it.

Selection of lines:

Name | Flags | Matches --------------- | :---: | ------- EMPTY_LINES | gm | Empty line or line with only whitespace within, including its line-ending, if it has one. NON_EMPTY_LINES | gm | Line with at least one non-whitespace character, including its line-ending, if it has one. TRAILING_WS | gm | The trailing whitespace of a line, without including its line-ending. OPT_WS_EOL | g | Zero or more blank characters followed by a line-ending, or the final blanks, if the (last) line has no line-ending. EOL | g | Line-ending of any type

NOTE

Because the 'g' flag, always set lastIndex or clone the regex before using it with the exec method.

Example

Using only one regex, this simple example will...

  • Remove trailing whitespace of each line.
  • Remove the empty lines.
  • Normalize the line-endings to unix style.
const R = require('perf-regexes')

const cleaner = (text) => text.split(R.OPT_WS_EOL).filter(Boolean).join('\n')

console.dir(cleaner(' \r\r\n\nAA\t\t\t\r\n\rBB\nCC  \rDD  '))
// ⇒ 'AA\nBB\nCC\nDD'

Use the previous function to cleanup HTML text:

const htmlCleaner = (html) => cleaner(html.replace(R.HTML_CMNT, ''))

console.dir(htmlCleaner(
  '\r<!--header--><h1>A</h1>\r<div>B<br>\r\nC</div> <!--end-->\n'))
// ⇒ '<h1>A</h1>\n<div>B<br>\nC</div>'

Line-endings Normalization

const R = require('perf-regexes')

const normalize = (text) => text.split(R.EOL).join('\n')

console.dir(normalize('\rAA\r\r\nBB\r\nCC \nDD\r'))
// ⇒ '\nAA\n\nBB\nCC \nDD\n'

Double-quoted to single-quoted strings

const toSingleQuotes = (text) => text.replace(R.JS_STRING, (str) => {
  return str[0] === '"'
    ? `'${str.slice(1, -1).replace(/'/g, "\\'")}'`
    : str
})

console.log(toSingleQuotes(`"A's" 'B' "C"`))
// ⇒ 'A\'s' 'B' 'C'

Matching Regexes

With the arrival of ES6TL and new keywords, finding literal regexes with another regex is not viable, you need a JS parser such as acorn or a specialized one such as skip-regex to do it correctly.

This is a very basic example that uses skip-regex:

import R from 'perf-regexes'
import skipRegex from 'skip-regex'

/**
 * Source to match quoted string, comments, and slashes.
 * Captures en $1 the slash
 */
const reStr = `${R.JS_STRING.source}|${R.JS_MLCMNT.source}|${R.JS_SLCMNT.source}|(/)`

/**
 * Search regexes in `code` and display the result to the console.
 */
const searchRegexes = (code) => {

  // Creating `re` here keeps its lastIndex private
  const re = RegExp(reStr, 'g')
  let match = re.exec(code)

  while (match) {
    if (match[1]) {
      const start = match.index
      const end = skipRegex(code, start)

      // skipRegex returns start+1 if this is not a regex
      if (end > start + 1) {
        console.log(`Found "${code.slice(start, end)}" at ${start}`)
      }
      re.lastIndex = end
    }
    match = re.exec(code)
  }
}

const code = `
const A = 2
const s = '/A/'            // must not find /A/

const re1 = /A/g           // regex
re1.lastIndex = 2 /A/ 1    // must not find /A/

/* /B/                     // must not find /B/
*/
const re2 = /B/g           // regex
re1.exec(s || "/B/")       // must not find /B/
`

searchRegexes(code)
// output:
// Found "/A/g" at 74
// Found "/B/b" at 210

The previous code does not support ES6TL, but it works quite well on ES5 files and is very fast.

For a more complete example of using perf-regexes, see js-cleanup, an advanced utility with support for ES6 that trims trailing spaces, compacts empty lines, normalizes line-endings, and removes comments conditionally.

ES6 Template Literals

ES6TLs are too complex to be identified by one single regex, do not even try.

Support my Work

I'm a full-stack developer with more than 20 year of experience and I try to share most of my work for free and help others, but this takes a significant amount of time and effort so, if you like my work, please consider...

Of course, feedback, PRs, and stars are also welcome 🙃

Thanks for your support!

License

The MIT License (MIT)