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

verbose-regexp

v3.0.0

Published

Verbose Regular Expressions

Downloads

397

Readme

verbose-regexp

This module provides a way to use verbose regular expressions in JavaScript and TypeScript, similar to re.VERBOSE in Python. It provides that white-space at the start and end of lines are ignored, as are newlines, and anything following // to the end of the line.

It allows you to easily write multi-line regular expressions, and to make your regular expressions more self-documenting using formatting and comments.

Example:

    import { rx } from 'verbose-regexp'
    // or: const { rx } = require('verbose-regexp')

    const dateTime = rx`
      (\d{4}-\d{2}-\d{2}) // date
      T                   // time separator
      (\d{2}:\d{2}:\d{2}) // time
    `
    console.log(dateTime.exec(new Date().toISOString()))

You can also embed regular expressions within each other, to allow a complicated regular expression to be built up in steps from simpler parts, e.g.:

    const date = rx`\d{4}-\d{2}-\d{2}`
    const time = rx`\d{2}:\d{2}:\d{2}`
    const dateTime = rx`
      (${date})           // date
      T                   // time separator
      (${time})           // time
    `
    console.log(dateTime.exec(new Date().toISOString()))

Note that embedded sub-expressions are automatically surrounded with (?: and ), so that they are always treated as a self-contained unit. Also note that embedded sub-expressions will be run using the flags of the parent expression, regardless of what flags were on the sub-expression - so, for example, if the sub-expression had the 'case insensitive' flag set but the parent expression didn't, then the sub-expression will be executed in a case sensitive manner.

You can use regular expression flags by accessing them as a property of rx, e.g.:

    const alpha = rx.i`[a-z]+`
    const allAlpha = rx.gi`[a-z]+`

If you want to use a string that would otherwise be ignored (i.e. whitespace or //), you can simply escape it with backslashes or a character class:

    const url = rx.i`
      [ ]*([a-z]+):\/\/  // scheme
      ([^/]+)           // location
      (?:/(.*))         // path
    `

History

3.0.0 (2023-06-04)

  • Allow embedding of other RegExp objects.

2.0.0 (2022-05-03)

  • Use 'Proxy' objects to avoid having to create static properties for every permutation of the possible flags.

1.0.0 (2021-05-24)

  • Initial release.