lib/loader.js

@@ -6,6 +6,7 @@ const path = require('path');
 const rules = require('./rules.js');
 const resolver = require('oas-resolver');
 const yaml = require('js-yaml');
+const readline = require('readline');
 
 class ExtendableError extends Error {
     constructor(message) {
@@ -27,6 +28,21 @@ function readFileAsync(filename, encoding) {
     });
 }
 
+function readFileStdinAsync() {
+    return new Promise((resolve, reject) => {
+        const rl = readline.createInterface({
+            input: process.stdin
+        });
+        let lines = [];
+        rl.on('line', (line) => {
+            lines.push(line);
+        });
+        rl.on('close', () => {
+            resolve(lines.join('\n'));
+        });
+    });
+}
+
 const fetchUrl = async (url) => {
     let response;
     try {
@@ -45,18 +61,24 @@ const fetchUrl = async (url) => {
 };
 
 
+// file can be null, meaning stdin
 function readSpecFile(file, options) {
     if (options.verbose > 1) {
-        console.log('GET ' + file);
+        file ? console.error('GET ' + file) : console.error('GET <stdin>');
     }
-    if (file && file.startsWith('http')) {
+    if (!file) {
+        // standard input
+        return readFileStdinAsync();
+    } else if (file && file.startsWith('http')) {
+        // remote file
         return fetch(file).then(res => {
             if (res.status !== 200) {
                 throw new Error(`Received status code ${res.status}`);
             }
             return res.text();
         })
     } else {
+        // local file
         // TODO error handlers?
         return readFileAsync(file, 'utf8');
     }
@@ -83,16 +105,16 @@ const recursivelyLoadRulesets = async (ruleset, loadedRulesets, options) => {
     let text;
     // If the ruleset looks like a HTTP URL
     if (ruleset && ruleset.startsWith('http')) {
-        if (verbose > 1) console.log('GET ' + ruleset);
+        if (verbose > 1) console.error('GET ' + ruleset);
         text = await fetchUrl(ruleset);
     }
     else if (fs.existsSync(ruleset)) {
-        if (verbose > 1) console.log('READ ' + ruleset);
+        if (verbose > 1) console.error('READ ' + ruleset);
         text = fs.readFileSync(ruleset, 'utf8');
     }
     else {
         const rulesetFile = path.join(__dirname, '../rules/' + ruleset + '.yaml');
-        if (verbose > 1) console.log('READ ' + rulesetFile);
+        if (verbose > 1) console.error('READ ' + rulesetFile);
         text = fs.readFileSync(rulesetFile, 'utf8');
     }
 
@@ -111,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}
 `;
     });