## 1.3.0 - January 2021

* Adds replacements for invalid patterns.
* Improves code coverage.
* Improves documentation.
* Improves project configuration.

Author: gmullerb

CHANGELOG.md

@@ -1,5 +1,12 @@
 # ESLint Plugin Regex Change Log
 
+## 1.3.0 - January 2021
+
+* Adds replacements for invalid patterns.
+* Improves code coverage.
+* Improves documentation.
+* Improves project configuration.
+
 ## 1.2.1 - August 2020
 
 * Fixes #4 peerDependencies.

README.md

@@ -70,6 +70,7 @@ Detailed configuration:
       "error", [{
           "regex": "invalidRegex1",
           "message": "errorMessage1",
+          "replacement": "newValue"
         }, {
           "id": "regexIdN",
           "regex": "invalidRegexN",
@@ -108,10 +109,10 @@ The idea is to allow to create different eslint rules based on Regular Expressio
 
 ## Rules
 
-Two rules are defined:
-
-* [`regex/invalid`](docs/rules/invalid-regex-rule.md).
-* [`regex/required`](docs/rules/required-regex-rule.md).
+Name                                                  | Fixable | Description
+----------------------------------------------------- | ------- | -----------
+[`regex/invalid`](docs/rules/invalid-regex-rule.md)   | Yes     | checks that specified patterns are not found
+[`regex/required`](docs/rules/required-regex-rule.md) | No      | checks that specified patterns are found
 
 ### `regex/invalid`
 
@@ -209,10 +210,11 @@ It is specified by just a regular expression `string`, i.e. `"regex"`
 
 It is specified by an `object`, with the following fields:
 
-* `id`: A `string` representing the **Pattern Id**.
-* `regex`: A `string` representing the **Regular expression to look for**.
-* `message`: A `string` specifying the **Message to be shown when an error happens** (invalid `regex` is found or required `regex` is not found).
-* `files`: An `object` specifying which files to analyze:
+* `regex`: A **required** `string` representing the **Regular expression to look for**.
+* `replacement`: If present this `string` will use to replace **invalid** found pattern.
+* `id`: An optional `string` representing the **Pattern Id**.
+* `message`: An optional `string` specifying the **Message to be shown when an error happens** (invalid `regex` is found or required `regex` is not found).
+* `files`: An optional `object` specifying which files to analyze:
   * `ignore`: A `string` representing **Regular expression of the files to be ignored** when validating this specific pattern.
   * `inspect`:  A `string` representing **Regular expression of the files to be inspected** when validating this specific pattern.
 
@@ -228,8 +230,10 @@ It is specified by an `object`, with the following fields:
 }
 ```
 
-> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/` define the following string `"\bhttp:"` when using `.eslintrc.js` or `"\\bhttp:"` when using `.eslintrc.json` (backslash needs to de double in a json file).  
-> * When `ignore` and `inspect` are present, `ignore` takes precedence.  
+> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/`:
+>   * when using `.eslintrc.js`, define the following string `"\bhttp:"`, or
+>   * when using `.eslintrc.json`, define `"\\bhttp:"` (backslash needs to de double in a json file).
+> * When `ignore` and `inspect` are present, `ignore` takes precedence.
 > * Global ignore file pattern, takes precedence over `files` patterns.
 
 #### Mixing definitions
@@ -329,6 +333,16 @@ Array of patterns represent different logical operation for each rule:
 * `regex/invalid`: **OR** => the presence in a file of *any* of the patterns defined in the *array* is invalid.
 * `regex/required`: **AND** => the presence in file of *all* of the patterns defined in the *array* is required.
 
+### Examples
+
+[For a set of Regex Rules examples check `eslint-plugin-base-style-config`](https://github.com/gmullerb/base-style-config/tree/master/js#regex-rules)
+
+__________________
+
+## Prerequisites
+
+* [`"eslint": ">=4.0.0"`](https://www.npmjs.com/package/eslint).
+
 __________________
 
 ## Extending/Developing

docs/rules/invalid-regex-rule.md

@@ -56,15 +56,18 @@ It is specified by just a regular expression `string`, i.e. `"regex"`
 
 It is specified by an `object`, with the following fields:
 
-* `id`: A `string` representing the **Pattern Id**.
-* `regex`: A `string` representing the **Regular expression to look for**.
-* `message`: A `string` specifying the **Message to be shown when an error happens** (invalid `regex` is found or required `regex` is not found).
-* `files`: An `object` specifying which files to analyze:
+* `regex`: A **required** `string` representing the **Regular expression to look for**.
+* `replacement`: An optional `string` used to replace invalid found pattern.
+* `id`: An optional `string` representing the **Pattern Id**.
+* `message`: An optional `string` specifying the **Message to be shown when an invalid `regex` is found**.
+* `files`: An optional `object` specifying which files to analyze:
   * `ignore`: A `string` representing **Regular expression of the files to be ignored** when validating this specific pattern.
   * `inspect`:  A `string` representing **Regular expression of the files to be inspected** when validating this specific pattern.
 
-> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/` define the following string `"\bhttp:"` when using `.eslintrc.js` or `"\\bhttp:"` when using `.eslintrc.json` (backslash needs to de double in a json file).  
-> * When `ignore` and `inspect` are present, `ignore` takes precedence.  
+> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/`:
+>   * when using `.eslintrc.js`, define the following string `"\bhttp:"`, or
+>   * when using `.eslintrc.json`, define `"\\bhttp:"` (backslash needs to de double in a json file).
+> * When `ignore` and `inspect` are present, `ignore` takes precedence.
 > * Global ignore file pattern, takes precedence over `files` patterns.
 
 `.eslintrc.json`:
@@ -79,6 +82,7 @@ It is specified by an `object`, with the following fields:
       "error", [{
           "regex": "invalidRegex1",
           "message": "errorMessage1",
+          "replacement": "newValue"
         }, {
           "id": "regexIdN",
           "regex": "invalidRegexN",
@@ -98,13 +102,7 @@ Internally, each string from the array will be converted into a Regular Expressi
 
 `"invalidRegex1"` will be transformed into `/invalidRegex1/gm`
 
-When the pattern is found splitting in more the one line the error message will not reflect the location (i.e. `1:1` will be shown), e.g.:
-
-```bash
- 1:1  error  Invalid regular expression /invalidRegex1/gm found in file  regex/invalid
-```
-
-When the pattern is found inside an specific line the error message will reflect the exact location, e.g.:
+When the pattern is found, the error message will reflect the exact location, e.g.:
 
 ```bash
  34:25  error  Invalid regular expression /invalidRegex1/gm found  regex/invalid
@@ -116,4 +114,5 @@ When the pattern is found inside an specific line the error message will reflect
 
 ## More information
 
-[Back](../README.md)
+* [`eslint-plugin-regex`](../README.md)
+* [For a set of Regex Rules examples check `eslint-plugin-base-style-config`](https://github.com/gmullerb/base-style-config/tree/master/js#regex-rules)

docs/rules/required-regex-rule.md

@@ -57,15 +57,17 @@ It is specified by just a regular expression `string`, i.e. `"regex"`
 
 It is specified by an `object`, with the following fields:
 
-* `id`: A `string` representing the **Pattern Id**.
-* `regex`: A `string` representing the **Regular expression to look for**.
-* `message`: A `string` specifying the **Message to be shown when an error happens** (invalid `regex` is found or required `regex` is not found).
-* `files`: An `object` specifying which files to analyze:
+* `regex`: A **required** `string` representing the **Regular expression to look for**.
+* `id`: An optional `string` representing the **Pattern Id**.
+* `message`: An optional `string` specifying the **Message to be shown when a required `regex` is not found**.
+* `files`: An optional `object` specifying which files to analyze:
   * `ignore`: A `string` representing **Regular expression of the files to be ignored** when validating this specific pattern.
   * `inspect`:  A `string` representing **Regular expression of the files to be inspected** when validating this specific pattern.
 
-> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/` define the following string `"\bhttp:"` when using `.eslintrc.js` or `"\\bhttp:"` when using `.eslintrc.json` (backslash needs to de double in a json file).  
-> * When `ignore` and `inspect` are present, `ignore` takes precedence.  
+> * `regex` is the only Required field. Slashes (`/`) are not required in the string, e.g. To get the following regex `/\bhttp:/`:
+>   * when using `.eslintrc.js`, define the following string `"\bhttp:"`, or
+>   * when using `.eslintrc.json`, define `"\\bhttp:"` (backslash needs to de double in a json file).
+> * When `ignore` and `inspect` are present, `ignore` takes precedence.
 > * Global ignore file pattern, takes precedence over `files` patterns.
 
 `.eslintrc.json`:
@@ -109,4 +111,5 @@ Internally, each string from the array will be converted into a Regular Expressi
 
 ## More information
 
-[Back](../README.md)
+* [`eslint-plugin-regex`](../README.md)
+* [For a set of Regex Rules examples check `eslint-plugin-base-style-config`](https://github.com/gmullerb/base-style-config/tree/master/js#regex-rules)

lib/index.js

@@ -4,7 +4,7 @@
 
 module.exports = {
   rules: {
-    invalid: require('../lib/rules/invalid-regex-rule.js'),
-    required: require('../lib/rules/required-regex-rule.js')
+    invalid: require('./rules/invalid-regex-rule.js'),
+    required: require('./rules/required-regex-rule.js')
   }
 }

lib/rules/invalid-regex-rule.js

@@ -31,6 +31,20 @@ function checkRegexInLines(sourceLines, nextLine, nextChar, regex) {
   }
 }
 
+function checkRegexInSource(source, regex) {
+  regex.test('')
+  const foundDetail = regex.exec(source)
+  return !!foundDetail
+    ? {
+      patternIndex: foundDetail.index,
+      nextChar: regex.lastIndex
+    }
+    : {
+      patternIndex: -1,
+      nextChar: -1
+    }
+}
+
 function foundStart(source, nextLine, foundAt) {
   return Array.from(source.substring(0, foundAt))
     .reduce((result, char) => char === '\n'
@@ -39,11 +53,12 @@ function foundStart(source, nextLine, foundAt) {
     { line: nextLine, column: 0 })
 }
 
-function checkRegex(source, sourceLines, nextLine, nextChar, pattern, report, node) {
+function checkRegex(source, sourceLines, nextLine, nextChar, rootChar, pattern, replace, report) {
   if (source.length !== 0) {
-    const patternIndex = source.search(pattern.regex)
-    if (patternIndex !== -1) {
-      const remainingSource = source.slice(patternIndex + 1)
+    const sourceDetail = checkRegexInSource(source, pattern.regex)
+    if (sourceDetail.patternIndex !== -1) {
+      const remainingSourceStart = sourceDetail.patternIndex + 1
+      const remainingSource = source.slice(remainingSourceStart)
       let foundDetail = checkRegexInLines(sourceLines, nextLine, nextChar, pattern.regex)
       if (foundDetail.nextLine !== -1) {
         report({
@@ -56,43 +71,51 @@ function checkRegex(source, sourceLines, nextLine, nextChar, pattern, report, no
           message: formatReportMessage(
             pattern,
             from => `Invalid regular expression ${from} found`
-          )
+          ),
+          fix: replace(rootChar, sourceDetail.patternIndex, sourceDetail.nextChar)
         })
-        checkRegex(remainingSource, sourceLines, foundDetail.nextLine, foundDetail.nextChar, pattern, report, node)
+        checkRegex(remainingSource, sourceLines, foundDetail.nextLine, foundDetail.nextChar, rootChar + remainingSourceStart,
+          pattern, replace, report)
       }
       else {
         report({
-          loc: { start: foundStart(source, nextLine + 1, patternIndex) },
+          loc: { start: foundStart(source, nextLine + 1, sourceDetail.patternIndex) },
           message: formatReportMessage(
             pattern,
             from => `Invalid regular expression ${from} found`
-          )
+          ),
+          fix: replace(rootChar, sourceDetail.patternIndex, sourceDetail.nextChar)
         })
-        checkRegex(remainingSource, sourceLines, nextLine + 1, nextChar, pattern, report, node)
+        checkRegex(remainingSource, sourceLines, nextLine + 1, nextChar, rootChar + remainingSourceStart, pattern, replace, report)
       }
     }
   }
 }
 
-function checkPatterns(fileName, source, patterns, report, node) {
+function checkPatterns(fileName, source, patterns, report) {
   const sourceLines = source.split('\n')
   patterns.forEach(pattern => shouldCheck(pattern.details, fileName) && checkRegex(
     source,
     sourceLines,
     0,
     0,
+    0,
     pattern,
-    report,
-    node
+    typeof pattern.details.replacement === 'string'
+      ? (from, deltaStart, deltaEnd) => fixer => fixer.replaceTextRange([from + deltaStart, from + deltaEnd], pattern.details.replacement)
+      : () => undefined,
+    report
   ))
 }
 
 module.exports = {
   meta: {
     type: 'suggestion',
+    fixable: 'code',
     docs: {
       description: 'Invalid regular expressions to be reported',
       category: 'Stylistic Issues',
+      url: 'https://github.com/gmullerb/eslint-plugin-regex/blob/master/docs/rules/invalid-regex-rule.md'
     },
     schema: [{
       title: 'Invalid regular expressions',
@@ -121,6 +144,11 @@ module.exports = {
               type: 'string',
               minLength: 1
             },
+            replacement:  {
+              title: 'Replacement',
+              description: 'Replacement for invalid pattern',
+              type: 'string'
+            },
             message: {
               title: 'Invalid message',
               description: 'Message to be shown when Invalid pattern is found',

lib/rules/required-regex-rule.js

@@ -24,6 +24,7 @@ module.exports = {
     docs: {
       description: 'Required regular expressions to be looked',
       category: 'Stylistic Issues',
+      url: 'https://github.com/gmullerb/eslint-plugin-regex/blob/master/docs/rules/required-regex-rule.md'
     },
     schema: [{
       title: 'Required regular expressions',

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-regex",
   "description": "ESLint rules using Regular Expression",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "license": "MIT",
   "author": "Gonzalo Müller Bravo",
   "main": "lib/index.js",
@@ -73,7 +73,8 @@
     "test": "echo ==== Test With Coverage ==== && mkdir -p build && nyc npm run test.only",
     "prepack": "echo ==== Build Package ====",
     "check": "npm install && npm run lint && npm test && mkdir -p build && cd build && npm pack ../",
-    "check.all": "npm run check && npm audit"
+    "check.all": "npm run check && npm audit",
+    "prepublishOnly": "npm run check"
   },
   "peerDependencies": {
     "eslint": ">=4.0.0"

package.json

@@ -1,3 +1,5 @@
+//  Copyright (c) 2020 Gonzalo Müller Bravo.
+//  Licensed under the MIT License (MIT), see LICENSE.txt
 require('./invalid-regex-rule.e2e-test')
 require('./required-regex-rule.e2e-test')
 require('./invalid-regex-detailed-rule.e2e-test')