Add URL to rule documentation to the metadata

ESLint v4.15.0 added an official location for rules to store a URL to
their documentation in the rule metadata in eslint/eslint#9788. This
adds the URL to all the existing rules so anything consuming them can
know where their documentation is without having to resort to external
packages to guess.

src/rules/callback-binding.js

@@ -11,6 +11,12 @@
 // ------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/callback-binding.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodVisitors} = require('../util/lodashUtil')
         const {getFunctionMaxArity} = require('../util/methodDataUtil')

src/rules/chain-style.js

@@ -11,6 +11,9 @@
 //------------------------------------------------------------------------------
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/chain-style.md'
+        },
         schema: [{
             enum: ['as-needed', 'implicit', 'explicit']
         }]
@@ -53,4 +56,4 @@ module.exports = {
         visitors.CallExpression = callExpressionVisitors[context.options[0] || 'as-needed']
         return visitors
     }
-}
+}

src/rules/chaining.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/chaining.md'
+        },
         schema: [{
             enum: ['always', 'never']
         }, {

src/rules/collection-method-value.js

@@ -10,6 +10,12 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/collection-method-value.md'
+        }
+    },
+
     create(context) {
         const {isChainBreaker, getLodashMethodVisitors, isCallToMethod} = require('../util/lodashUtil')
         const {getMethodName} = require('../util/astUtil')

src/rules/collection-return.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/collection-return.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodCallExpVisitor, getLodashContext} = require('../util/lodashUtil')
         const {isCollectionMethod} = require('../util/methodDataUtil')

src/rules/consistent-compose.js

@@ -10,6 +10,9 @@ const possibleDirections = ['pipe', 'compose', 'flow', 'flowRight']
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/consistent-compose.md'
+        },
         schema: [{
             enum: possibleDirections
         }]
@@ -37,4 +40,4 @@ module.exports = {
             }
         })
     }
-}
+}

src/rules/identity-shorthand.js

@@ -13,6 +13,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/identity-shorthand.md'
+        },
         schema: [{
             enum: ['always', 'never']
         }]

src/rules/import-scope.js

@@ -34,10 +34,14 @@ const allImportsAreOfType = (node, types) => every(node.specifiers, specifier =>
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/import-scope.md'
+        },
         schema: [{
             enum: ['method', 'member', 'full', 'method-package']
         }]
     },
+
     create(context) {
         const importType = context.options[0] || 'method'
 

src/rules/matches-prop-shorthand.js

@@ -11,6 +11,9 @@
 // ------------------------------------------------------------------------------
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/matches-prop-shorthand.md'
+        },
         schema: [{
             enum: ['always', 'never']
         }, {

src/rules/matches-shorthand.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/matches-shorthand.md'
+        },
         schema: [{
             enum: ['always', 'never']
         }, {

src/rules/no-commit.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/no-commit.md'
+        }
+    },
+
     create(context) {
         const {getLodashContext, isCallToMethod} = require('../util/lodashUtil')
         const {isMethodCall} = require('../util/astUtil')

src/rules/no-double-unwrap.js

@@ -12,8 +12,12 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/no-double-unwrap.md'
+        },
         fixable: "code"
     },
+
     create(context) {
         const {getLodashContext, isChainBreaker, isChainable} = require('../util/lodashUtil')
         const {isMethodCall, getCaller, getMethodName} = require('../util/astUtil')

src/rules/no-extra-args.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/no-extra-args.md'
+        }
+    },
+
     create(context) {
         const {version} = require('../util/settingsUtil').getSettings(context)
         const {getLodashMethodVisitors} = require('../util/lodashUtil')

src/rules/no-unbound-this.js

@@ -7,6 +7,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/no-unbound-this.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodCallExpVisitor, getLodashContext} = require('../util/lodashUtil')
         const {isCollectionMethod} = require('../util/methodDataUtil')

src/rules/path-style.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/path-style.md'
+        },
         schema: [{
             enum: ['as-needed', 'array', 'string']
         }]
@@ -110,4 +113,4 @@ module.exports = {
             }
         })
     }
-}
+}

src/rules/prefer-compact.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-compact.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodVisitors} = require('../util/lodashUtil')
         const {isNegationExpression, isIdentifierWithName, getValueReturnedInFirstStatement, getFirstParamName} = require('../util/astUtil')

src/rules/prefer-constant.js

@@ -12,6 +12,10 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-constant.md'
+        },
+
         schema: [{
             type: 'boolean'
         }, {

src/rules/prefer-filter.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-filter.md'
+        },
         schema: [{
             type: 'integer'
         }]
@@ -54,4 +57,4 @@ module.exports = {
             }
         })
     }
-}
+}

src/rules/prefer-flat-map.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-flat-map.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodVisitors, isCallToMethod, isCallToLodashMethod} = require('../util/lodashUtil')
         const {getCaller} = require('../util/astUtil')
@@ -28,4 +34,4 @@ module.exports = {
             }
         })
     }
-}
+}

src/rules/prefer-get.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-get.md'
+        },
         schema: [{
             type: 'integer',
             minimum: 2
@@ -52,4 +55,4 @@ module.exports = {
             }
         }
     }
-}
+}

src/rules/prefer-includes.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-includes.md'
+        },
         schema: [{
             type: 'object',
             properties: {
@@ -42,4 +45,4 @@ module.exports = {
         }
         return visitors
     }
-}
+}

src/rules/prefer-invoke-map.js

@@ -9,7 +9,9 @@
 
 module.exports = {
     meta: {
-        docs: {}
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-invoke-map.md'
+        }
     },
 
     create(context) {
@@ -33,4 +35,4 @@ module.exports = {
             }
         })
     }
-}
+}

src/rules/prefer-is-nil.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-is-nil.md'
+        }
+    },
+
     create(context) {
         const {isNegationExpression, isEquivalentMemberExp} = require('../util/astUtil')
         const {isCallToLodashMethod, getLodashContext} = require('../util/lodashUtil')

src/rules/prefer-lodash-chain.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-lodash-chain.md'
+        }
+    },
+
     create(context) {
         const {getLodashContext, isChainBreaker, isNativeCollectionMethodCall, isLodashWrapperMethod} = require('../util/lodashUtil')
         const {isMethodCall, isObjectOfMethodCall, getMethodName} = require('../util/astUtil')

src/rules/prefer-lodash-method.js

@@ -9,6 +9,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-lodash-method.md'
+        },
         schema: [{
             type: 'object',
             properties: {

src/rules/prefer-lodash-typecheck.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-lodash-typecheck.md'
+        }
+    },
+
     create(context) {
         const some = require('lodash/some')
         const {getIsTypeMethod} = require('../util/lodashUtil')

src/rules/prefer-map.js

@@ -11,6 +11,12 @@
 //------------------------------------------------------------------------------
 
 module.exports = {
+    meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-map.md'
+        }
+    },
+
     create(context) {
         const {getLodashMethodVisitors} = require('../util/lodashUtil')
         const {getFirstFunctionLine, hasOnlyOneStatement, getMethodName, isFunctionDefinitionWithBlock, collectParameterValues} = require('../util/astUtil')

src/rules/prefer-matches.js

@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/wix/eslint-plugin-lodash/tree/master/docs/rules/prefer-matches.md'
+        },
         schema: [{
             type: 'integer',
             minimum: 2
@@ -56,4 +59,4 @@ module.exports = {
             }
         }
     }
-}
+}