Adding support for loading custom rulesets off the filesystem. (#196)

Author: erunion

docs/rules/2-custom-rulesets.md

@@ -64,7 +64,7 @@ There is a reserved `require` property (type `string`) at the top level, which c
 
 ### Using Custom Rulesets
 
-The `speccy lint` command supports `--rules`, and currently the value needs to be a URL to your custom ruleset file. Local file paths will not work. Pull requests welcome!
+The `speccy lint` command supports `--rules`, and the value can either be a URL to your custom ruleset file, or a path to a ruleset on your filesystem.
 
 <hr>
 

lib/loader.js

@@ -93,9 +93,13 @@ const recursivelyLoadRuleFiles = async (file, loadedFiles, options) => {
         if (verbose > 1) console.log('GET ' + file);
         data = await fetchUrl(file);
     }
+    else if (fs.existsSync(file)) {
+        if (verbose > 1) console.log('READ ' + file);
+        data = yaml.safeLoad(fs.readFileSync(file, 'utf8'));
+    }
     else {
         const ruleFile = path.join(__dirname, '../rules/' + file + '.json');
-        if (verbose > 1) console.log('GET ' + ruleFile);
+        if (verbose > 1) console.log('READ ' + ruleFile);
         data = yaml.safeLoad(fs.readFileSync(ruleFile, 'utf8'));
     }
 

test/loader.test.js

@@ -17,11 +17,17 @@ describe('Loader', () => {
             loader.loadRuleFiles(['strict']).should.be.fulfilledWith(['strict', 'default']);
         });
 
-
         it('load default & strict rules', () => {
             loader.loadRuleFiles(['strict', 'default']).should.be.fulfilledWith(['strict', 'default']);
         });
 
+        context('when loading from a local file', () => {
+            it('retrieves rules from the file', () => {
+                const file = __dirname + '/../rules/strict.json'
+                loader.loadRuleFiles([file]).should.be.fulfilledWith([file, 'default']);
+            })
+        })
+
         context('when loading from url', () => {
             const host = 'http://example.org';
             const url = host + '/';