Add URL to rule documentation to the metadata

src/docsUrl.js

@@ -0,0 +1,10 @@
+const repoUrl = 'https://github.com/benmosher/eslint-plugin-import'
+
+export default function docsUrl(ruleName, commitHash) {
+  let baseUrl = `${repoUrl}/tree/master/docs/rules`
+  if (commitHash) {
+    baseUrl = `${repoUrl}/blob/${commitHash}/docs/rules`
+  }
+
+  return `${baseUrl}/${ruleName}.md`
+}

src/rules/default.js

@@ -1,8 +1,11 @@
 import Exports from '../ExportMap'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('default'),
+    },
   },
 
   create: function (context) {

src/rules/export.js

@@ -1,8 +1,11 @@
 import ExportMap, { recursivePatternCapture } from '../ExportMap'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('export'),
+    },
   },
 
   create: function (context) {

src/rules/exports-last.js

@@ -1,10 +1,18 @@
+import docsUrl from '../docsUrl'
+
 function isNonExportStatement({ type }) {
   return type !== 'ExportDefaultDeclaration' &&
     type !== 'ExportNamedDeclaration' &&
     type !== 'ExportAllDeclaration'
 }
 
 module.exports = {
+  meta: {
+    docs: {
+      url: docsUrl('exports-last'),
+    },
+  },
+
   create: function (context) {
     return {
       Program: function ({ body }) {

src/rules/extensions.js

@@ -2,6 +2,7 @@ import path from 'path'
 
 import resolve from 'eslint-module-utils/resolve'
 import { isBuiltIn, isExternalModuleMain, isScopedMain } from '../core/importType'
+import docsUrl from '../docsUrl'
 
 const enumValues = { enum: [ 'always', 'ignorePackages', 'never' ] }
 const patternProperties = {
@@ -10,7 +11,7 @@ const patternProperties = {
 }
 const properties = {
   type: 'object',
-  properties: { 
+  properties: {
     'pattern': patternProperties,
     'ignorePackages': { type: 'boolean' },
   },
@@ -46,15 +47,17 @@ function buildProperties(context) {
       // If ignorePackages is provided, transfer it to result
       if (obj.ignorePackages !== undefined) {
         result.ignorePackages = obj.ignorePackages
-      }      
+      }
     })
 
     return result
 }
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('extensions'),
+    },
 
     schema: {
       anyOf: [
@@ -66,7 +69,7 @@ module.exports = {
         {
           type: 'array',
           items: [
-            enumValues, 
+            enumValues,
             properties,
           ],
           additionalItems: false,
@@ -75,7 +78,7 @@ module.exports = {
           type: 'array',
           items: [properties],
           additionalItems: false,
-        },                
+        },
         {
           type: 'array',
           items: [patternProperties],

src/rules/first.js

@@ -1,6 +1,10 @@
+import docsUrl from '../docsUrl'
+
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('first'),
+    },
   },
 
   create: function (context) {

src/rules/group-exports.js

@@ -1,4 +1,10 @@
-const meta = {}
+import docsUrl from '../docsUrl'
+
+const meta = {
+  docs: {
+    url: docsUrl('group-exports'),
+  },
+}
 /* eslint-disable max-len */
 const errors = {
   ExportNamedDeclaration: 'Multiple named export declarations; consolidate all named exports into a single export declaration',

src/rules/imports-first.js

@@ -1,5 +1,12 @@
-import first from './first'
+import docsUrl from '../docsUrl'
 
-const newMeta = Object.assign({}, first.meta, { deprecated: true })
+const first = require('./first')
+
+const newMeta = Object.assign({}, first.meta, {
+  deprecated: true,
+  docs: {
+    url: docsUrl('imports-first', '7b25c1cb95ee18acc1531002fd343e1e6031f9ed'),
+  },
+})
 
 module.exports = Object.assign({}, first, { meta: newMeta })

src/rules/max-dependencies.js

@@ -1,4 +1,5 @@
 import isStaticRequire from '../core/staticRequire'
+import docsUrl from '../docsUrl'
 
 const DEFAULT_MAX = 10
 
@@ -15,7 +16,9 @@ const countDependencies = (dependencies, lastNode, context) => {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('max-dependencies'),
+    },
 
     schema: [
       {

src/rules/named.js

@@ -1,9 +1,12 @@
 import * as path from 'path'
 import Exports from '../ExportMap'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('named'),
+    },
   },
 
   create: function (context) {

src/rules/namespace.js

@@ -1,9 +1,14 @@
+import declaredScope from 'eslint-module-utils/declaredScope'
 import Exports from '../ExportMap'
 import importDeclaration from '../importDeclaration'
-import declaredScope from 'eslint-module-utils/declaredScope'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
+    docs: {
+      url: docsUrl('namespace'),
+    },
+
     schema: [
       {
         'type': 'object',

src/rules/newline-after-import.js

@@ -4,6 +4,7 @@
  */
 
 import isStaticRequire from '../core/staticRequire'
+import docsUrl from '../docsUrl'
 
 import debug from 'debug'
 const log = debug('eslint-plugin-import:rules:newline-after-import')
@@ -44,7 +45,9 @@ function isClassWithDecorator(node) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('newline-after-import'),
+    },
     schema: [
       {
         'type': 'object',

src/rules/no-absolute-path.js

@@ -1,9 +1,12 @@
-import { isAbsolute } from '../core/importType'
 import moduleVisitor, { makeOptionsSchema } from 'eslint-module-utils/moduleVisitor'
+import { isAbsolute } from '../core/importType'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-absolute-path'),
+    },
     schema: [ makeOptionsSchema() ],
   },
 

src/rules/no-amd.js

@@ -3,13 +3,17 @@
  * @author Jamund Ferguson
  */
 
+import docsUrl from '../docsUrl'
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
 module.exports = {
     meta: {
-        docs: {},
+        docs: {
+            url: docsUrl('no-amd'),
+        },
     },
 
     create: function (context) {

src/rules/no-anonymous-default-export.js

@@ -3,6 +3,8 @@
  * @author Duncan Beevers
  */
 
+import docsUrl from '../docsUrl'
+
 const defs = {
   ArrayExpression: {
     option: 'allowArray',
@@ -69,6 +71,10 @@ const defaults = Object.keys(defs)
 
 module.exports = {
   meta: {
+    docs: {
+      url: docsUrl('no-anonymous-default-export'),
+    },
+
     schema: [
       {
         type: 'object',

src/rules/no-commonjs.js

@@ -3,6 +3,8 @@
  * @author Jamund Ferguson
  */
 
+import docsUrl from '../docsUrl'
+
 const EXPORT_MESSAGE = 'Expected "export" or "export default"'
     , IMPORT_MESSAGE = 'Expected "import" instead of "require()"'
 
@@ -19,7 +21,9 @@ function allowPrimitive(node, context) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-commonjs'),
+    },
   },
 
   create: function (context) {

src/rules/no-deprecated.js

@@ -1,5 +1,6 @@
-import Exports from '../ExportMap'
 import declaredScope from 'eslint-module-utils/declaredScope'
+import Exports from '../ExportMap'
+import docsUrl from '../docsUrl'
 
 function message(deprecation) {
   return 'Deprecated' + (deprecation.description ? ': ' + deprecation.description : '.')
@@ -16,7 +17,9 @@ function getDeprecation(metadata) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-deprecated'),
+    },
   },
 
   create: function (context) {

src/rules/no-duplicates.js

@@ -1,4 +1,5 @@
 import resolve from 'eslint-module-utils/resolve'
+import docsUrl from '../docsUrl'
 
 function checkImports(imported, context) {
   for (let [module, nodes] of imported.entries()) {
@@ -12,7 +13,9 @@ function checkImports(imported, context) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-duplicates'),
+    },
   },
 
   create: function (context) {

src/rules/no-dynamic-require.js

@@ -1,3 +1,5 @@
+import docsUrl from '../docsUrl'
+
 function isRequire(node) {
   return node &&
     node.callee &&
@@ -13,7 +15,9 @@ function isStaticValue(arg) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-dynamic-require'),
+    },
   },
 
   create: function (context) {

src/rules/no-extraneous-dependencies.js

@@ -5,6 +5,7 @@ import minimatch from 'minimatch'
 import resolve from 'eslint-module-utils/resolve'
 import importType from '../core/importType'
 import isStaticRequire from '../core/staticRequire'
+import docsUrl from '../docsUrl'
 
 function getDependencies(context, packageDir) {
   try {
@@ -112,7 +113,9 @@ function testConfig(config, filename) {
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-extraneous-dependencies'),
+    },
 
     schema: [
       {

src/rules/no-internal-modules.js

@@ -3,10 +3,13 @@ import minimatch from 'minimatch'
 import resolve from 'eslint-module-utils/resolve'
 import importType from '../core/importType'
 import isStaticRequire from '../core/staticRequire'
+import docsUrl from '../docsUrl'
 
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-internal-modules'),
+    },
 
     schema: [
       {

src/rules/no-mutable-exports.js

@@ -1,6 +1,10 @@
+import docsUrl from '../docsUrl'
+
 module.exports = {
   meta: {
-    docs: {},
+    docs: {
+      url: docsUrl('no-mutable-exports'),
+    },
   },
 
   create: function (context) {