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

eslint-plugin-no-unsafe-regex

v1.0.0

Published

ESLint rules to disallow unsafe regular expressions.

Downloads

11,590

Readme

Rules: No Unsafe Regex

NPM version Build Status Coverage Status Dependencies

ESLint rules to disallow unsafe regular expressions.

Installation

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

Usage

Plugin

To use the plugin in an .eslintrc file,

{
	'plugins': [
		'no-unsafe-regex'
	]
}

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

{
	'plugins': [
		'no-unsafe-regex'
	],
	'rules': {
		'no-unsafe-regex/no-unsafe-regex': 2
	}
}

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

Module

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

plugin

ESLint rules to disallow unsafe regular expressions.

console.dir( plugin );
/*
	{
		'rules': {
			'no-unsafe-regex': <rule>
		},
		'rulesConfig': {
			'no-unsafe-regex': 2
		}
	}
*/

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.

    var re;
    
    // Validated:
    re = /beep/;
    
    // Validated:
    re = new RegExp( 'beep', 'i' );
    
    // Not validated:
    str = 'beep';
    re = new RegExp( str, 'i' );
    
    // Not validated:
    re = 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

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

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

Examples

module.exports = {
	'env': {
		'node': true
	},
	'plugins': [
		// Declare the plugin:
		'no-unsafe-regex'
	],
	'rules': {
		'no-path-concat': 2,
		'no-process-exit': 0,
		'no-sync': 1,
		'no-mixed-requires': [ 2, false ],

		// Prefix a plugin rule with `{{plugin_name}}/`:
		'no-unsafe-regex/no-unsafe-regex': 2
	}
};

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

$ 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:

$ 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:

$ make test-cov

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

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.