Set URLs to documentation for each rule (#34)

Close #32 

Now each rule is linked to documentation page, so users can get necessary information from convenient place.

lib/rules/no-broken-template.js

@@ -5,7 +5,7 @@
 
 const lexer = require('pug-lexer')
 
-const { isReactPugReference, buildLocation } = require('../util/eslint')
+const { isReactPugReference, buildLocation, docsUrl } = require('../util/eslint')
 const getTemplate = require('../util/getTemplate')
 
 //------------------------------------------------------------------------------
@@ -18,6 +18,7 @@ module.exports = {
       description: 'Disallow broken template',
       category: 'Possible Errors',
       recommended: true,
+      url: docsUrl('no-broken-template'),
     },
     schema: [],
   },

lib/rules/no-interpolation.js

@@ -3,7 +3,7 @@
  * @author Eugene Zhlobo
  */
 
-const { isReactPugReference, buildLocation } = require('../util/eslint')
+const { isReactPugReference, buildLocation, docsUrl } = require('../util/eslint')
 
 //------------------------------------------------------------------------------
 // Rule Definition
@@ -15,6 +15,7 @@ module.exports = {
       description: 'Disallow JavaScript interpolation',
       category: 'Best Practices',
       recommended: true,
+      url: docsUrl('no-interpolation'),
     },
     schema: [],
   },

lib/rules/no-undef.js

@@ -3,7 +3,7 @@
  * @author Eugene Zhlobo
  */
 
-const { isReactPugReference, buildLocation } = require('../util/eslint')
+const { isReactPugReference, buildLocation, docsUrl } = require('../util/eslint')
 const getTemplate = require('../util/getTemplate')
 const getVariables = require('../util/getVariables')
 
@@ -17,6 +17,7 @@ module.exports = {
       description: 'Disallow undeclared variables in Pug',
       category: 'Possible Errors',
       recommended: true,
+      url: docsUrl('no-undef'),
     },
     schema: [],
   },

lib/rules/quotes.js

@@ -6,7 +6,7 @@
 const { parse } = require('@babel/parser')
 const codeWalk = require('@babel/traverse').default
 
-const { isReactPugReference, buildLocation } = require('../util/eslint')
+const { isReactPugReference, buildLocation, docsUrl } = require('../util/eslint')
 const getTemplate = require('../util/getTemplate')
 const getTokens = require('../util/getTokens')
 
@@ -33,6 +33,7 @@ module.exports = {
       description: 'Manage quotes in Pug',
       category: 'Best Practices',
       recommended: true,
+      url: docsUrl('quotes'),
     },
     schema: [],
   },

lib/rules/uses-react.js

@@ -3,7 +3,7 @@
  * @author Eugene Zhlobo
  */
 
-const { isReactPugReference } = require('../util/eslint')
+const { isReactPugReference, docsUrl } = require('../util/eslint')
 
 //------------------------------------------------------------------------------
 // Rule Definition
@@ -15,6 +15,7 @@ module.exports = {
       description: 'Prevent React to be marked as unused',
       category: 'Best Practices',
       recommended: true,
+      url: docsUrl('uses-react'),
     },
     schema: [],
   },

lib/rules/uses-vars.js

@@ -3,7 +3,7 @@
  * @author Eugene Zhlobo
  */
 
-const { isReactPugReference } = require('../util/eslint')
+const { isReactPugReference, docsUrl } = require('../util/eslint')
 const getTemplate = require('../util/getTemplate')
 const getVariables = require('../util/getVariables')
 
@@ -17,6 +17,7 @@ module.exports = {
       description: 'Prevent variables used in Pug to be marked as unused',
       category: 'Best Practices',
       recommended: true,
+      url: docsUrl('uses-vars'),
     },
     schema: [],
   },

lib/util/eslint.js

@@ -1,3 +1,7 @@
+function docsUrl(ruleName) {
+  return `https://github.com/ezhlobo/eslint-plugin-react-pug/blob/master/docs/rules/${ruleName}.md`
+}
+
 function buildLocation(startCoord, endCoord) {
   return {
     start: {
@@ -16,6 +20,7 @@ function isReactPugReference({ tag }) {
 }
 
 module.exports = {
+  docsUrl,
   buildLocation,
 
   isReactPugReference,

tests/each-rule.js

@@ -0,0 +1,21 @@
+const assert = require('assert')
+const fs = require('fs')
+const path = require('path')
+
+const { docsUrl } = require('../lib/util/eslint')
+
+const ruleFiles = fs.readdirSync(path.resolve(__dirname, '..', 'lib', 'rules'))
+  .map(file => path.basename(file, '.js'))
+
+describe('URLs to documentation', () => {
+  ruleFiles.forEach((ruleName) => {
+    it(ruleName, () => {
+      const filepath = path.resolve(__dirname, '..', 'lib', 'rules', `${ruleName}.js`)
+
+      // eslint-disable-next-line global-require, import/no-dynamic-require
+      const file = require(filepath)
+
+      assert.equal(file.meta.docs.url, docsUrl(ruleName))
+    })
+  })
+})

tests/lib/rules/no-undef.js

@@ -17,9 +17,6 @@ const rule = require('../../../lib/rules/no-undef')
 const parserOptions = {
   ecmaVersion: 8,
   sourceType: 'module',
-  ecmaFeatures: {
-    experimentalObjectRestSpread: true,
-  },
 }
 
 //------------------------------------------------------------------------------

tests/lib/rules/quotes.js

@@ -16,9 +16,6 @@ const rule = require('../../../lib/rules/quotes')
 const parserOptions = {
   ecmaVersion: 8,
   sourceType: 'module',
-  ecmaFeatures: {
-    experimentalObjectRestSpread: true,
-  },
 }
 
 //------------------------------------------------------------------------------

tests/lib/rules/uses-react.js

@@ -17,9 +17,6 @@ const rule = require('../../../lib/rules/uses-react')
 const parserOptions = {
   ecmaVersion: 8,
   sourceType: 'module',
-  ecmaFeatures: {
-    experimentalObjectRestSpread: true,
-  },
 }
 
 //------------------------------------------------------------------------------

tests/lib/rules/uses-vars.js

@@ -18,9 +18,6 @@ const rule = require('../../../lib/rules/uses-vars')
 const parserOptions = {
   ecmaVersion: 8,
   sourceType: 'module',
-  ecmaFeatures: {
-    experimentalObjectRestSpread: true,
-  },
 }
 
 //------------------------------------------------------------------------------