Enhancement: Allow use of optimize options and add recommended config (#60)

* - Breaking change: To support nyc testing on Travis, dropping looking at Node 6
- Enhancement: Allow use of `optimize` options
- Enhancement: Add `recommended` and `all` configs which avoid need for `plugins` and `rules` together
- Linting: Apply eslint:recommended, with a few additional rules and an ignore file
- Travis: Update from 7 to check 8, 10, 12
- npm: Add recommended fields (bugs, homepage, contributors); use https URL for
    auto-opening within IDEs and linting against package.json validator
- npm: Add `eslint` script
- npm: Update devDeps
- Maintenance: `.editorconfig` to enforce spacing on Markdown
- Testing: Add nyc coverage

Author: brettz9

Diff for: .editorconfig

@@ -11,3 +11,7 @@ indent_size = 2
 [Makefile]
 indent_style = tab
 indent_size = 4
+
+[*.md]
+indent_style = space
+indent_size = 4

Diff for: .eslintignore

@@ -0,0 +1,2 @@
+node_modules
+!.eslintrc.js

Diff for: .eslintrc.js

@@ -0,0 +1,20 @@
+'use strict'
+module.exports = {
+  env: {
+    node: true,
+    es6: true
+  },
+  extends: [
+    'eslint:recommended'
+  ],
+  rules: {
+    semi: [2, 'never'],
+    quotes: [2, 'single', {
+      avoidEscape: true
+    }],
+    'prefer-const': [2],
+    'no-var': [2],
+    'prefer-destructuring': [2],
+    'object-shorthand': [2]
+  }
+}

Diff for: .travis.yml

@@ -1,9 +1,10 @@
 language: node_js
 
 node_js:
-  - "7"
-  
+  - 8
+  - 10
+  - 12
+
 cache:
   directories:
     - "node_modules"
-    

Diff for: README.md

@@ -43,6 +43,36 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
+If you wish to add a `whitelist` or `blacklist` array against `regexp-tree`'s
+[transforms](https://github.com/DmitrySoshnikov/regexp-tree/blob/master/src/optimizer/README.md#transforms), you can add them on an objects object:
+
+```json
+{
+    "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:
+
+```json
+{
+  "extends": ["optimize-regex/recommended"]
+}
+```
+
+Or without the blacklist:
+
+```json
+{
+  "extends": ["optimize-regex/all"]
+}
+```
+
 ## Rules
 
 * [optimize-regex](./docs/rules/optimize-regex.md)

Diff for: lib/index.js

@@ -5,6 +5,25 @@
 
 'use strict'
 
-module.exports.rules = {
-  'optimize-regex': require('./rules/optimize-regex'),
+module.exports = {
+  rules: {
+    'optimize-regex': require('./rules/optimize-regex'),
+  },
+
+  configs: {
+    recommended: {
+      plugins: ['optimize-regex'],
+      rules: {
+        'optimize-regex/optimize-regex': ['warn', {
+          'blacklist': ['charClassClassrangesMerge']
+        }]
+      }
+    },
+    all: {
+      plugins: ['optimize-regex'],
+      rules: {
+        'optimize-regex/optimize-regex': ['warn']
+      }
+    }
+  }
 }

Diff for: lib/rules/optimize-regex.js

@@ -7,6 +7,10 @@
 
 const { parse, generate, optimize } = require('regexp-tree')
 
+const optimizerTransforms = require('regexp-tree/dist/optimizer/transforms/index.js')
+
+const transforms = [...optimizerTransforms.keys()]
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -19,11 +23,32 @@ module.exports = {
       recommended: true,
     },
     fixable: 'code',
-    schema: [],
+    schema: [
+      {
+        additionalProperties: false,
+        type: 'object',
+        properties: {
+          whitelist: {
+            type: 'array',
+            items: {
+              type: 'string',
+              enum: transforms
+            }
+          },
+          blacklist: {
+            type: 'array',
+            items: {
+              type: 'string',
+              enum: transforms
+            }
+          }
+        }
+      }
+    ],
   },
 
-  create: function(context) {
-    const sourceCode = context.getSourceCode()
+  create (context) {
+    const options = context.options[0] || {}
 
     /**
      * Optimize regular expression literals
@@ -34,30 +59,34 @@ module.exports = {
      */
 
     function optimizeRegexLiteral(node) {
-      const { type, value, start } = sourceCode.getFirstToken(node)
-
-      if (type !== 'RegularExpression') {
-        return
-      }
+      const { raw /* , start */ } = node
 
       let parsedSource
       try {
-        parsedSource = parse(value)
+        parsedSource = parse(raw)
       } catch (e) {
+        // istanbul ignore next
         context.report({
           node,
           message: "{{original}} can't be parsed: {{message}}",
           data: {
-            original: value,
+            original: raw,
             message: e.message,
           },
         })
 
+        // istanbul ignore next
         return
       }
 
       const originalRegex = generate(parsedSource).toString()
-      const optimizedRegex = optimize(value).toString()
+      const optimizedRegex = optimize(
+        raw,
+        options.whitelist,
+        {
+          blacklist: options.blacklist
+        }
+      ).toString()
 
       if (originalRegex === optimizedRegex) {
         return
@@ -67,7 +96,7 @@ module.exports = {
         node,
         message: '{{original}} can be optimized to {{optimized}}',
         data: {
-          original: value,
+          original: raw,
           optimized: optimizedRegex,
         },
         fix(fixer) {
@@ -77,7 +106,7 @@ module.exports = {
     }
 
     return {
-      Literal: optimizeRegexLiteral,
+      'Literal[regex]': optimizeRegexLiteral,
     }
   },
 }