use custom documentation rules

Author: pderaaij

lib/loader.js

@@ -133,7 +133,7 @@ const recursivelyLoadRulesets = async (ruleset, loadedRulesets, options) => {
                 console.log(`Found ${data.rules.length} rules in ${ruleset}: ${data.rules.map(x => x.name)}`);
             }
             // Create and hold the rules
-            rules.createNewRules(data.rules);
+            rules.createNewRules(data.rules, data.url);
         }
 
         return loadedRulesets;

lib/rules.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const documentationUrl = 'https://speccy.io/rules/1-rulesets';
 let activeRules = {};
 let skipRules = [];
 
@@ -8,14 +9,17 @@ const init = (params = {}) => {
     skipRules = params.skip || [];
 };
 
-const createNewRules = rules => {
-    rules.forEach(rule => createNewRule(rule));
+const createNewRules = (rules, rulesetDocumentationUrl) => {
+    rules.forEach(rule => createNewRule(rule, rulesetDocumentationUrl));
 };
 
-const createNewRule = rule => {
+const createNewRule = (rule, rulesetDocumentationUrl) => {
     if (rule.disabled === true) return;
     // @DEPRECATED in v0.9.0, use `disabled: true`
     if (rule.enabled === false) return;
+
+    if (!rule.url) rule.url = (rulesetDocumentationUrl) ? rulesetDocumentationUrl : documentationUrl;
+
     activeRules[rule.name] = rule;
 }
 

lint.js

@@ -58,7 +58,7 @@ const formatLintResults = lintResults => {
 ${colors.yellow + pointer} ${colors.cyan} R: ${rule.name} ${colors.white} D: ${rule.description}
 ${colors.reset + truncateLongMessages(error.message)}
 
-More information: https://speccy.io/rules/1-rulesets#${rule.name}
+More information: ${rule.url}#${rule.name}
 `;
     });
 

test/lib/rules.test.js

@@ -2,17 +2,22 @@
 
 const rules = require('../../lib/rules.js');
 
+let activeRule, disabledRule, negativelyEnabledRule;
+
+beforeEach(() => {
+    activeRule = { name: "active-rule", disabled: false };
+    disabledRule = { name: "disabled-rule", disabled: true };
+    negativelyEnabledRule = { name: "negatively-enabled-rule", enabled: false };
+});
+
 describe('Rules', () => {
     describe('createNewRule()', () => {
-        const activeRule = { name: "active-rule", disabled: false };
-        const disabledRule = { name: "disabled-rule", disabled: true };
-        const negativelyEnabledRule = { name: "negatively-enabled-rule", enabled: false };
-
         describe('when creating a new rule', () => {
             test('accepts an active rule', () => {
                 rules.init();
                 rules.createNewRule(activeRule);
                 expect(rules.getRules().rules).toHaveLength(1);
+                expect(rules.getRules().rules[0].url).toBe('https://speccy.io/rules/1-rulesets');
             });
 
             test('skips a disabled rule', () => {
@@ -27,6 +32,13 @@ describe('Rules', () => {
                 expect(rules.getRules().rules).toHaveLength(0);
             });
 
+            test('accepts an rule can override url', () => {
+                rules.init();
+                rules.createNewRule(activeRule, 'http://test');
+                expect(rules.getRules().rules).toHaveLength(1);
+                expect(rules.getRules().rules[0].url).toBe('http://test');
+            });
+
         });
 
         describe('when skipping rules', () => {