Add a --warnings-as-errors flag to json-refs resolve

Author: whitlockjc

bin/json-refs

@@ -97,6 +97,7 @@ program
   .option('-f, --force', 'Do not fail when the document has invalid JSON References')
   .option('-H, --header <header>', 'The header to use when retrieving a remote document', optionArrayAppender(), [])
   .option('-I, --filter <type>', 'The type of JSON References to resolved', optionArrayAppender(), [])
+  .option('-w, --warnings-as-errors', 'Treat warnings as errors')
   .option('-y, --yaml', 'Output as YAML')
   .action(function (location) {
     var options = {
@@ -136,8 +137,8 @@ program
           Object.keys(results.refs).forEach(function (refPtr) {
             var refDetails = results.refs[refPtr];
 
-            if (refDetails.type === 'invalid' || refDetails.error) {
-              errors.push('  ' + refPtr + ': ' + refDetails.error);
+            if (refDetails.type === 'invalid' || refDetails.error || (that.warningsAsErrors && refDetails.warning)) {
+              errors.push('  ' + refPtr + ': ' + (refDetails.warning ? refDetails.warning : refDetails.error));
             }
           });
         }

test/test-cli.js

@@ -82,11 +82,12 @@ var resolveHelp = [
   '',
   '  Options:',
   '',
-  '    -h, --help             output usage information',
-  '    -f, --force            Do not fail when the document has invalid JSON References',
-  '    -H, --header <header>  The header to use when retrieving a remote document',
-  '    -I, --filter <type>    The type of JSON References to resolved',
-  '    -y, --yaml             Output as YAML',
+  '    -h, --help                output usage information',
+  '    -f, --force               Do not fail when the document has invalid JSON References',
+  '    -H, --header <header>     The header to use when retrieving a remote document',
+  '    -I, --filter <type>       The type of JSON References to resolved',
+  '    -w, --warnings-as-errors  Treat warnings as errors',
+  '    -y, --yaml                Output as YAML',
   '',
   ''
 ].join('\n');
@@ -355,6 +356,30 @@ describe('json-refs CLI', function () {
         });
       });
 
+      it('--warnings-as-errors option', function (done) {
+        this.timeout(10000);
+
+        executeJsonRefs(['resolve', testDocumentLocation, '--warnings-as-errors'], function (stderr, stdout) {
+          assert.equal(stdout, '');
+
+          assert.equal(stderr, [
+            '',
+            '  error: Document has invalid references:',
+            '',
+            '  #/missing: JSON Pointer points to missing location: #/some/missing/path',
+            '  #/warning: Extra JSON Reference properties will be ignored: ignored',
+            '  #/invalid: HTTP URIs must have a host.',
+            '  #/remote/relative/missing: JSON Pointer points to missing location: #/some/missing/path',
+            '  #/remote/relative/child/missing: JSON Pointer points to missing location: #/some/missing/path',
+            '  #/remote/relative/child/ancestor/missing: JSON Pointer points to missing location: #/some/missing/path',
+            '',
+            ''
+          ].join('\n'));
+
+          done();
+        });
+      });
+
       it('--yaml option', function (done) {
         this.timeout(10000);