https://github.com/JonasBa/eslint-plugin-no-lookahead-lookbehind-regexp

Lint the use of lookahead and lookbehind regex expressions.
https://github.com/JonasBa/eslint-plugin-no-lookahead-lookbehind-regexp

eslint lookahead lookbehind regex-pattern

Last synced: 3 months ago
JSON representation

Lint the use of lookahead and lookbehind regex expressions.

• Host: GitHub
• URL: https://github.com/JonasBa/eslint-plugin-no-lookahead-lookbehind-regexp
• Owner: JonasBa
• License: mit
• Created: 2021-11-25T09:40:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-25T13:19:21.000Z (over 1 year ago)
• Last Synced: 2024-08-19T08:10:55.852Z (4 months ago)
• Topics: eslint, lookahead, lookbehind, regex-pattern
• Language: TypeScript
• Homepage:
• Size: 8.48 MB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# eslint-plugin-no-lookahead-lookbehind-regexp



Lint the use of lookahead and lookbehind regexp expression. The expression is problematic, as compiling it in an unsupported browser will throw an error and possibly crash your browser. The plugin handles both Regexp [literal and constructor notations](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#literal_notation_and_constructor).

## 1. Install

```bash

npm install --save-dev eslint-plugin-no-lookahead-lookbehind-regexp

```

## 2. Add plugin to your ESlint configuration

#### `.eslintrc.json`

```diff

   {

+    "extends": ["plugin:no-lookahead-lookbehind-regexp/recommended"],

+    "env": {

+      "browser": true

+    },

   }

```

## 3. Configure Browser Targets

We use [browserslist](https://github.com/browserslist/browserslist) to resolve browser support - **if no browserslist config** is found, then the use of lookahead and lookbehind regexp group will always throw an error!

### `package.json`

```diff

   {

+    "browserslist": [

+      "defaults"

+    ]

  }

```

## 4. Customizing rules

By default, the plugin will report on all lookahead and lookbehind regexp as well as their negative counterparts(if they are not supported with above browserslist target settings). To enable only individual rules like erroring only on lookbehind expressions, you can pass a list of rules that you wish to enable as options in your eslint. **Note that once a single rule is passed as a configuration option, all of the other rules are disabled by default and you are in full control.**

```js

rules: {

   'no-lookahead-lookbehind-regexp/no-lookahead-lookbehind-regexp': [

      'error',

      'no-lookahead',

      'no-lookbehind',

      'no-negative-lookahead',

      'no-negative-lookbehind',

   ],

}

```

## 5. Disable Browserslist Support

By default, the plugin will use yours project's browserslist settings to find availability of lookahead/lookbehind and their negative counterparts. However, if you want to disable this feature to report all usages(still controlled by above rules settings) as errors, you can pass an additional object options.

```js

rules: {

   'no-lookahead-lookbehind-regexp/no-lookahead-lookbehind-regexp': [

      'error',

      'no-lookahead',

      { browserslist: false },

   ],

}

```

## Contributing

Be respectful, contributions of all sorts are well appreciated. If you have an issue with the package, file a descriptive issue with a reproducible case (if possible ofc). In case you want to improve the package or have ideas, file an issue before submitting a PR to avoid frustration in case we do not want to adopt the changes. Keep it positive ✌️