match-requires

Match require statements in a string. Returns an array of matching require statements. Each match is an object with line number, variable name, and module name. Statements in code comments are ignored.

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

Install

Install with npm:

1$ npm install --save match-requires

Usage

1const matches = require('match-requires');
2console.log(matches('require(\'a-b-c\');\nvar fooBar = require(\'foo-bar\');'));

Returns:

1[ { string: 'require(\'a-b-c\');', 
2    variable: '', 
3    name: 'a-b-c' },
4  { string: 'var fooBar = require(\'foo-bar\');',
5    variable: 'fooBar',
6    name: 'foo-bar' } ]

Ignore requires in code comments

To ignore require() statements found inside code comments, pass true as the second argument to strip comments before matching. Alternatively, you may pass a function as the second argument to use your own approach to stripping comments.

Without comments stripped

1console.log(matches('/* require(\'a-b-c\');*/\nvar fooBar = require(\'foo-bar\');')); 
2// [ { string: 'require(\'a-b-c\');', variable: '', name: 'a-b-c' },
3//   { string: 'var fooBar = require(\'foo-bar\');',
4//     variable: 'fooBar',
5//     name: 'foo-bar' } ]

With comments stripped

1console.log(matches('/* require(\'a-b-c\');*/\nvar fooBar = require(\'foo-bar\');', true));
2// [ { string: 'var fooBar = require(\'foo-bar\');',
3//     variable: 'fooBar',
4//     name: 'foo-bar' } ]

With custom function

1const str = '/* require(\'a-b-c\');*/\nvar fooBar = require(\'foo-bar\');';
2const fn = require('some-comment-stripping-library');
3console.log(matches(str, fn));
4// [ { string: 'var fooBar = require(\'foo-bar\');',
5//     variable: 'fooBar',
6//     name: 'foo-bar' } ]

About

1$ npm install && npm test

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

Related projects

You might also be interested in these projects:

• requires-regex: Regular expression for matching javascript require statements. | homepage
• to-regex-range: Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… more | homepage
• year-range-regex: Generates a regular expression for validating a range of years. | homepage

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

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.