Merge pull request #472 from nellh/json-output

Add --json flag to produce machine readable output.

Author: chrisgorgo

bin/bids-validator

@@ -15,6 +15,8 @@ var argv = require('yargs')
     .describe('ignoreNiftiHeaders', 'disregard NIfTI header content during validation')
     .boolean('verbose')
     .describe('verbose', 'Log more extensive information about issues.')
+    .boolean('json')
+    .describe('json', 'Output results as JSON.')
     .option('config', {
         alias: 'c',
         describe: 'Optional configuration file. See https://github.com/INCF/bids-validator for more info.'

circle.yml

@@ -16,6 +16,9 @@ test:
     - npm run lint
     # Run unit tests
     - npm run test
+    # Smoke tests
+    - bin/bids-validator tests/data/valid_headers/ --ignoreNiftiHeaders
+    - bin/bids-validator tests/data/valid_headers/ --ignoreNiftiHeaders --json
     # Test gh-pages build
     - rm -rf node_modules/
     - git checkout gh-pages

cli.js

@@ -7,31 +7,50 @@ var pluralize = require('pluralize');
 var bytes     = require('bytes');
 var fs        = require('fs');
 
-module.exports = function (dir, options) {
+module.exports = function(dir, options) {
     if (fs.existsSync(dir)) {
-        validate.BIDS(dir, options, function (issues, summary) {
-            var errors = issues.errors;
-            var warnings = issues.warnings;
-            if (issues.errors.length === 1 && issues.errors[0].code === '61') {
-                console.log(colors.red("The directory " + dir + " failed an initial Quick Test. This means the basic names and structure of the files and directories do not comply with BIDS specification. For more info go to http://bids.neuroimaging.io/"));
-            } else if (issues.config && issues.config.length >= 1) {
-                console.log(colors.red('Invalid Config File'));
-                for (var i = 0; i < issues.config.length; i++) {
-                    var issue = issues.config[i];
-                    issue.file.file = {relativePath: issue.file.path};
-                    issue.files = [issue.file];
+        if (options.json) {
+            validate.BIDS(dir, options, function (issues, summary) {
+                console.log(JSON.stringify({ issues, summary }));
+            });
+        } else {
+            validate.BIDS(dir, options, function (issues, summary) {
+                var errors = issues.errors;
+                var warnings = issues.warnings;
+                if (issues.errors.length === 1 && issues.errors[0].code === "61") {
+                    console.log(
+                        colors.red(
+                            "The directory " +
+                            dir +
+                            " failed an initial Quick Test. This means the basic names and structure of the files and directories do not comply with BIDS specification. For more info go to http://bids.neuroimaging.io/"
+                        )
+                    );
+                } else if (issues.config && issues.config.length >= 1) {
+                    console.log(colors.red("Invalid Config File"));
+                    for (var i = 0; i < issues.config.length; i++) {
+                        var issue = issues.config[i];
+                        issue.file.file = { relativePath: issue.file.path };
+                        issue.files = [issue.file];
+                    }
+                    logIssues(issues.config, "red", options);
+                } else if (errors.length >= 1 || warnings.length >= 1) {
+                    logIssues(errors, "red", options);
+                    logIssues(warnings, "yellow", options);
+                } else {
+                    console.log(
+                        colors.green("This dataset appears to be BIDS compatible.")
+                    );
                 }
-                logIssues(issues.config, 'red', options);
-            } else if (errors.length >= 1 || warnings.length >= 1) {
-                logIssues(errors, 'red', options);
-                logIssues(warnings, 'yellow', options);
-            }
-            else {
-                console.log(colors.green("This dataset appears to be BIDS compatible."));
-            }
-            logSummary(summary);
-            if (issues === 'Invalid' || errors && errors.length >= 1 || issues.config && issues.config.length >= 1) {process.exit(1);}
-        });
+                logSummary(summary);
+                if (
+                    issues === "Invalid" ||
+                    (errors && errors.length >= 1) ||
+                    (issues.config && issues.config.length >= 1)
+                ) {
+                    process.exit(1);
+                }
+            });
+        }
     } else {
         console.log(colors.red(dir + " does not exist"));
         process.exit(2);