regex-not

What is regex-not?

The regex-not npm package is designed to create regular expressions for matching everything except a specified pattern. This can be particularly useful when you need to exclude certain patterns from your matches.

What are regex-not's main functionalities?

Basic Negation

This feature allows you to create a regular expression that matches any string except the specified pattern. In this example, the pattern 'foo' is excluded from the matches.

const not = require('regex-not');
const re = not('foo');
console.log(re); // => /^(?:(?!^(?:foo)$).)+$/

Negation with Flags

This feature allows you to add flags to the negated regular expression. In this example, the global flag 'g' is added to the pattern that excludes 'foo'.

const not = require('regex-not');
const re = not('foo', { flags: 'g' });
console.log(re); // => /^(?:(?!^(?:foo)$).)+$/g

Negation with Custom Delimiters

This feature allows you to specify custom delimiters for the negated pattern. In this example, the delimiters '<' and '>' are used around the pattern 'foo'.

const not = require('regex-not');
const re = not('foo', { delimiters: ['<', '>'] });
console.log(re); // => /^(?:(?!<foo>).)+$/

Other packages similar to regex-not

negate

The 'negate' package provides similar functionality by allowing you to create a negated version of a given regular expression. It is simpler and more focused on negation without additional customization options like flags or delimiters.

README

regex-not

Create a javascript regular expression for matching everything except for the given string.

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 regex-not

Usage

var not = require('regex-not');

The main export is a function that takes a string an options object.

not(string[, options]);

Example

var not = require('regex-not');
console.log(not('foo'));
//=> /^(?:(?!^(?:foo)$).)+$/

Strict matching

By default, the returned regex is for strictly (not) matching the exact given pattern (in other words, "match this string if it does NOT exactly equal foo"):

var re = not('foo');
console.log(re.test('foo'));     //=> false
console.log(re.test('bar'));     //=> true
console.log(re.test('foobar'));  //=> true
console.log(re.test('barfoo'));  //=> true

.create

Returns a string to allow you to create your own regex:

console.log(not.create('foo'));
//=> '(?:(?!^(?:foo)$).)+'

Options

options.contains

You can relax strict matching by setting options.contains to true (in other words, "match this string if it does NOT contain foo"):

var re = not('foo');
console.log(re.test('foo', {contains: true}));     //=> false
console.log(re.test('bar', {contains: true}));     //=> true
console.log(re.test('foobar', {contains: true}));  //=> false
console.log(re.test('barfoo', {contains: true}));  //=> false

About

Contributing

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

Running Tests

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

Building docs

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

• regex-cache: Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of… more | homepage
• to-regex: Generate a regex from a string or array of strings. | homepage

Contributors

Commits	Contributor
9	jonschlinkert
1	doowb
1	EdwardBetts

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

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

This file was generated by verb-generate-readme, v0.6.0, on February 19, 2018.