npmpackage.info

Gathering detailed insights and metrics for eslint-plugin-clean-regex

eslint-plugin-clean-regex - 0.5.2 | npmpackage.info

eslint-plugin-clean-regex

An ESLint plugin for writing better regular expressions.

0.5.2

270

MIT

TypeScript

2.7

Installations

npm install eslint-plugin-clean-regex

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=12.0.0

Node Version

14.15.4

NPM Version

6.14.10 Pull Requests

Open

0

Total

8

Closed

3

Merged

5

Issues

Open

0

Total

24

Closed

24

Releases

Deprecation

v0.5.2

Updated on Oct 11, 2021

0.5.1

v0.5.1

Updated on Mar 25, 2021

0.5.0

v0.5.0

Updated on Oct 26, 2020

0.4.0

v0.4.0

Updated on May 04, 2020

View All 4 releases

Languages

TypeScript

JavaScript

TypeScript (97.74%)

JavaScript (2.26%)

Developer

RunDevelopment

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

270 Stars

247 Commits

2 Forks

6 Watchers

2 Branches

2 Contributors

Updated on Jun 12, 2025

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

0.5.2

Package Id

eslint-plugin-clean-regex@0.5.2

Size

36.09 kB

NPM Version

6.14.10

Node Version

14.15.4

Published on

Oct 11, 2021

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

eslint-plugin-clean-regex

An ESLint plugin for writing better regular expressions.

⚠️ Deprecated ⚠️

This project is deprecated.

Please use eslint-plugin-regexp instead.

What happened?

eslint-plugin-clean-regex and eslint-plugin-regexp have joined forces. We decided to work together on one ESLint plugin for JavaScript regexes. Since maintaining two plugins with similar rules takes too much work, I decided to stop working on eslint-plugin-clean-regex.

As of right now, eslint-plugin-regexp supports all rules of eslint-plugin-clean-regex along improvements to those rules and with many more useful rules.

Migration

See the migration guide.

About

This is an ESLint plugin to lint JavaScript regular expressions. Its goal is to help both beginners and experts to write better regular expressions by pointing out errors and suggesting improvements.

The plugin offers rules for possible errors, best practices, and coding style in regular expressions.

Right now, this project is still young (and many rules are opinionated). Feel free to open an issue if you think rules are too strict/lax/inflexible. Suggestions and feature requests are welcome as well!

Getting started

You'll need to install ESLint and eslint-plugin-clean-regex:

$ npm i eslint eslint-plugin-clean-regex --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-clean-regex globally.

Add clean-regex to the plugins section of your .eslintrc configuration file (you can omit the eslint-plugin- prefix) and configure the rules you want:

1{
2    "plugins": [
3        "clean-regex"
4    ],
5    "rules": {
6        "clean-regex/rule-name": 2
7    }
8}

You can also use the recommended config:

1{
2    "plugins": [
3        "clean-regex"
4    ],
5    "extends": [
6        "plugin:clean-regex/recommended"
7    ]
8}

The setting of every rule in the recommended config can be found in the table below.

Highlights

Some highlights of the working and working-together of rules in the recommended config.

Optimize character classes

Before:

1- /[0-9]/i
2- /[^\s]/
3- /[a-fA-F0-9]/i
4- /[a-zA-Z0-9_-]/
5- /[a-z\d\w]/
6- /[\S\d]/
7- /[\w\p{ASCII}]/u

After:

1- /\d/
2- /\S/
3- /[a-f0-9]/i
4- /[\w-]/
5- /\w/
6- /\S/
7- /\p{ASCII}/u

Simplify patterns

Before:

1- /(?:\w|\d)+/
2- /(?:a|(b)|c|(?:d)|(?:ee)){0,}/
3- /(?<!\w)a+(?=$)/mi
4- /[\s\S]#[\0-\uFFFF]/ysi
5- /\d*\w(?:[a-z_]|\d+)*/im

After:

1- /\w+/
2- /(?:[acd]|(b)|ee)*/
3- /\ba+$/im
4- /.#./sy
5- /\w+/

Detect non-functional code and potential errors

1- /\1(a)/        // `\1` won't work
2- /a+b*?/        // `b*?` can be removed
3- /(?:\b)?a/     // `(?:\b)?` can be removed
4- /[a-z]+|Foo/i  // `Foo` can be removed
5- /(?=a?)\w\Ba/  // `(?=a?)` and `\B` always accept and can be removed
6- /[*/+-^&|]/    // `+-^` will match everything from \x2B to \x5E including all character A to Z

Supported Rules

Fixable rules are denoted with a :wrench:.

Problems

	Rule	Description
	confusing-quantifier	Warn about confusing quantifiers.
	disjoint-alternatives	Disallow different alternatives that can match the same words.
	no-empty-alternative	Disallow alternatives without elements.
	no-empty-backreference	Disallow backreferences that will always be replaced with the empty string.
	no-empty-lookaround	Disallow lookarounds that can match the empty string.
	no-lazy-ends	Disallow lazy quantifiers at the end of an expression.
	no-obscure-range	Disallow obscure ranges in character classes.
	no-octal-escape	Disallow octal escapes outside of character classes.
	no-optional-assertion	Disallow optional assertions.
	no-potentially-empty-backreference	Disallow backreferences that reference a group that might not be matched.
	no-unnecessary-assertions	Disallow assertions that are known to always accept (or reject).
:wrench:	no-zero-quantifier	Disallow quantifiers with a maximum of 0.
	optimal-lookaround-quantifier	Disallows the alternatives of lookarounds that end with a non-constant quantifier.

Suggestions

	Rule	Description
:wrench:	consistent-match-all-characters	Use one character class consistently whenever all characters have to be matched.
:wrench:	identity-escape	How to handle identity escapes.
	no-constant-capturing-group	Disallow capturing groups that can match only one word.
:wrench:	no-trivially-nested-lookaround	Disallow lookarounds that only contain another assertion.
:wrench:	no-trivially-nested-quantifier	Disallow nested quantifiers that can be rewritten as one quantifier.
:wrench:	no-unnecessary-character-class	Disallow unnecessary character classes.
:wrench:	no-unnecessary-flag	Disallow unnecessary regex flags.
:wrench:	no-unnecessary-group	Disallow unnecessary non-capturing groups.
:wrench:	no-unnecessary-lazy	Disallow unnecessarily lazy quantifiers.
:wrench:	no-unnecessary-quantifier	Disallow unnecessary quantifiers.
:wrench:	optimal-concatenation-quantifier	Use optimal quantifiers for concatenated quantified characters.
:wrench:	optimized-character-class	Disallows unnecessary elements in character classes.
:wrench:	prefer-character-class	Prefer character classes wherever possible instead of alternations.
:wrench:	prefer-predefined-assertion	Prefer predefined assertions over equivalent lookarounds.
:wrench:	prefer-predefined-character-set	Prefer predefined character sets instead of their more verbose form.
:wrench:	prefer-predefined-quantifiers	Prefer predefined quantifiers (+*?) instead of their more verbose form.
:wrench:	simple-constant-quantifier	Prefer simple constant quantifiers over the range form.
:wrench:	sort-flags	Requires the regex flags to be sorted.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

eslint-plugin-clean-regex

Installations

Developer Guide

No

CommonJS

>=12.0.0

14.15.4

6.14.10

Pull Requests

0

8

3

5

Issues

0

24

24

Releases

Languages

Developer

RunDevelopment

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

eslint-plugin-clean-regex

⚠️ Deprecated ⚠️

What happened?

Migration

About

Getting started

Highlights

Optimize character classes

Simplify patterns

Detect non-functional code and potential errors

Supported Rules

Problems

Suggestions

10

10

10

3

0

0

0

0

0

0

0

0

0

2.7

/10