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

requires-regex

v1.0.4

Published

Regular expression for matching javascript require statements.

Downloads

112,476

Readme

requires-regex NPM version NPM monthly downloads NPM total downloads Linux Build Status

Regular expression for matching javascript require statements.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save requires-regex

Usage

THe main export is a function that must be called. This ensures that a new regex is returned each time the function is called.

const regex = require('requires-regex')();
const match = regex.exec('const foo = require(\'@bar/baz\');');

console.log(match);
// [ 'const foo = require(\'@bar/baz\');',
//   undefined,
//   'foo',
//   '\'',
//   '@bar/baz',
//   'bar',
//   'baz',
//   index: 0,
//   input: 'const foo = require(\'@bar/baz\');' ]

Match results

  • 0 - the full match
  • 1 - require statements inside quoted strings, otherwise undefined.
  • 2 - variable name before require(), if defined, otherwise undefined
  • 3 - leading quote inside require(), this is used as a reference to match ends on a trailing quote of the same type
  • 4 - the full name inside the require() statement. For example, in require("@foo/bar"), the full name is @foo/bar.
  • 5 - the first segment of a scoped name. For example, foo in @foo/bar. Otherwise undefined.
  • 6 - the second segment of a scoped name. For example, bar in @foo/bar. Otherwise undefined.

About

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

  • lint-deps: CLI tool that tells you when dependencies are missing from package.json and offers you a… more | homepage
  • match-requires: Match require statements in a string. Returns an array of matching require statements. Each match… more | homepage
  • regex-cache: Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of… more | homepage

Contributors

| Commits | Contributor | | --- | --- | | 22 | jonschlinkert | | 1 | alvinsight |

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on April 15, 2018.