Rules: No Unsafe Regex

ESLint rules to disallow unsafe regular expressions.

Installation

1$ npm install eslint-plugin-no-unsafe-regex

Usage

Plugin

To use the plugin in an .eslintrc file,

1{
2	'plugins': [
3		'no-unsafe-regex'
4	]
5}

where no-unsafe-regex is shorthand for eslint-plugin-no-unsafe-regex. To configure plugin rules,

1{
2	'plugins': [
3		'no-unsafe-regex'
4	],
5	'rules': {
6		'no-unsafe-regex/no-unsafe-regex': 2
7	}
8}

where a plugin rule must be prefixed with the plugin name and a /; e.g., no-unsafe-regex/<rule>.

Module

1var plugin = require( 'eslint-plugin-no-unsafe-regex' );

plugin

ESLint rules to disallow unsafe regular expressions.

1console.dir( plugin );
2/*
3	{
4		'rules': {
5			'no-unsafe-regex': <rule>
6		},
7		'rulesConfig': {
8			'no-unsafe-regex': 2
9		}
10	}
11*/

Notes

• In order to use the plugin, the plugin must first be installed as a node_modules dependency.

• The plugin only validates regular expression literals and regular expressions created using the RegExp constructor and literal arguments.

  1var re;
  2
  3// Validated:
  4re = /beep/;
  5
  6// Validated:
  7re = new RegExp( 'beep', 'i' );
  8
  9// Not validated:
  10str = 'beep';
  11re = new RegExp( str, 'i' );
  12
  13// Not validated:
  14re = new RegExp( new Array( 5 ).join( 'ab' ) );

  Validating regular expressions created using non-literal arguments would require reconstructing an execution context, which is beyond the scope of this module. For example, consider

  1var getStr = require( './path/to/my/string' ),
  2	str = getStr();
  3
  4var re = new RegExp( str );

  If the return value of getStr is dynamic, validation is impossible.

Examples

1module.exports = {
2	'env': {
3		'node': true
4	},
5	'plugins': [
6		// Declare the plugin:
7		'no-unsafe-regex'
8	],
9	'rules': {
10		'no-path-concat': 2,
11		'no-process-exit': 0,
12		'no-sync': 1,
13		'no-mixed-requires': [ 2, false ],
14
15		// Prefix a plugin rule with `{{plugin_name}}/`:
16		'no-unsafe-regex/no-unsafe-regex': 2
17	}
18};

To run the example code from the top-level application directory,

1$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

1$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

1$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

1$ make view-cov

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.