Skip to content

BrainMaestro/eslint-plugin-optimize-regex

Folders and files

NameName
Last commit message
Last commit date
Jul 26, 2021
Apr 14, 2017
Apr 23, 2020
Apr 20, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 14, 2017
Apr 19, 2020
Sep 15, 2018
Apr 14, 2017
Sep 15, 2018
Apr 19, 2020
Jul 18, 2023
Dec 30, 2022

Repository files navigation

eslint-plugin-optimize-regex

npm npm

Optimize regex literals

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-optimize-regex:

npm install eslint-plugin-optimize-regex --save-dev

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

Usage

Add optimize-regex to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "optimize-regex"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "optimize-regex/optimize-regex": "warn"
    }
}

If you wish to add a whitelist or blacklist array against regexp-tree's transforms, you can add them on an objects object:

{
    "rules": {
        "optimize-regex/optimize-regex": ["warn", {
            "blacklist": ["charClassClassrangesMerge"]
        }]
    }
}

If you want the latter particular settings, you can avoid setting plugins and rules and just use:

{
  "extends": ["optimize-regex/recommended"]
}

Or without the blacklist:

{
  "extends": ["optimize-regex/all"]
}

Rules

Inspiration

License

MIT © Ezinwa Okpoechi