tjenkinson / eslint-plugin-redos-detector

An ESLint plugin that detects vulnerable regex using "https://github.com/tjenkinson/redos-detector".

eslint-plugin-redos-detector

An ESLint plugin that detects vulnerable regex using "RedosDetector". It processes all RegExp literals. I.e. /ab+c/ but not new RegExp('ab+c').

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-redos-detector:

npm i --save-dev eslint-plugin-redos-detector

Usage

Add redos-detector to the plugins section of your .eslintrc configuration file.

{
  "plugins": ["redos-detector"]
}

Then configure the rule under the rules section.

{
  "rules": {
    "redos-detector/no-unsafe-regex": "error"
  }
}

Or do the following to provide options.

{
  "rules": {
    "redos-detector/no-unsafe-regex": [
      "error",
      {
        "ignoreError": true
      }
    ]
  }
}

Options

• ignoreError: If true any error getting results be ignored. It's possible for the detection to fail with some patterns, or if the patten is malformed or uses unsupported features. See this doc for the type of errors. (Default: false)
• maxSteps: See the option in this doc with the same name. (Default: See linked doc)
• maxBacktracks: See the option in this doc with the same name. (Default: See linked doc)
• timeout: See the option in this doc with the same name. (Default: See linked doc)

eslint-plugin-redos-detector's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency node to v18.20.2
• Update dependency eslint to v9
• Update dependency husky to v9
• Update dependency node to v20 (node, @types/node)
• Update github/codeql-action action to v3
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/automerge.yml

• tjenkinson/gh-action-auto-merge-dependency-updates v1

.github/workflows/build.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/codeql-analysis.yml

• actions/checkout v4
• github/codeql-action v2
• github/codeql-action v2

.github/workflows/publish.yml

• actions/checkout v4
• actions/setup-node v4

nodenv

.node-version

• node 18

npm

package.json

• @rollup/plugin-node-resolve 15.2.3
• @rollup/plugin-typescript 11.1.6
• @types/eslint 8.56.10
• @types/jest 29.5.12
• @types/node 20.8.10
• eslint 8.57.0
• husky 8.0.3
• jest 29.7.0
• lint-staged 15.2.2
• micromatch 4.0.5
• prettier 3.2.5
• redos-detector 5.1.0
• rollup 4.17.2
• ts-jest 29.1.2
• tslib 2.6.2
• typescript 5.4.5
• eslint >=6

---

• Check this box to trigger a request for Renovate to run again on this repository