Make the lint output less verbose by adding ora (#2528)

* lint: make output less verbose

* Uses ora to display a spinner with succeed/fail feedback.
* Removes `console.log` calls for succeeding checks.

* lint: make ora use stdout + stderr

* lint: use console.warn for error summary

package.json

@@ -27,7 +27,8 @@
   "homepage": "https://github.com/mdn/browser-compat-data#readme",
   "devDependencies": {
     "ajv": "^5.0.1",
-    "mdn-confluence": "0.0.7"
+    "mdn-confluence": "0.0.7",
+    "ora": "^3.0.0"
   },
   "scripts": {
     "confluence": "node ./node_modules/mdn-confluence/main/generate.es6.js --output-dir=. --bcd-module=./index.js",

test/lint.js

@@ -1,6 +1,7 @@
 'use strict';
 const fs = require('fs');
 const path = require('path');
+const ora = require('ora');
 const {testStyle} = require('./test-style');
 const {testSchema} = require('./test-schema');
 const {testVersions} = require('./test-versions');
@@ -26,7 +27,20 @@ function load(...files) {
       if (path.extname(file) === '.json') {
         let hasStyleErrors, hasSchemaErrors, hasVersionErrors = false;
         const relativeFilePath = path.relative(process.cwd(), file);
-        console.log(relativeFilePath);
+
+        const spinner = ora({
+          stream: process.stdout,
+          text: relativeFilePath
+        });
+
+        const console_error = console.error;
+        console.error = (...args) => {
+          spinner.stream = process.stderr;
+          spinner.fail(relativeFilePath);
+          console.error = console_error;
+          console.error(...args);
+        }
+
         if (file.indexOf('browsers' + path.sep) !== -1) {
           hasSchemaErrors = testSchema(file, './../schemas/browsers.schema.json');
         } else {
@@ -37,7 +51,11 @@ function load(...files) {
         if (hasStyleErrors || hasSchemaErrors || hasVersionErrors) {
           hasErrors = true;
           filesWithErrors.set(relativeFilePath, file);
+        } else {
+          console.error = console_error;
+          spinner.succeed();
         }
+
       }
 
       continue;
@@ -72,10 +90,10 @@ if (process.argv[2]) {
 }
 
 if (hasErrors) {
-  console.log("");
+  console.warn("");
   console.warn(`Problems in ${filesWithErrors.size} file${filesWithErrors.size > 1 ? 's' : ''}:`);
   for (const [fileName, file] of filesWithErrors) {
-    console.log(fileName);
+    console.warn(fileName);
     testSchema(file);
     testStyle(file);
     testVersions(file);

test/test-schema.js

@@ -10,7 +10,6 @@ function testSchema(dataFilename, schemaFilename = './../schemas/compat-data.sch
   );
 
   if (valid) {
-    console.log('\x1b[32m  JSON schema – OK \x1b[0m');
     return false;
   } else {
     console.error('\x1b[31m  File : ' + path.relative(process.cwd(), dataFilename));

test/test-style.js

@@ -28,9 +28,7 @@ function testStyle(filename) {
     expected = expected.replace(/\r/g, "");
   }
 
-  if (actual === expected) {
-    console.log('\x1b[32m  Style – OK \x1b[0m');
-  } else {
+  if (actual !== expected) {
     hasErrors = true;
     console.error('\x1b[31m  File : ' + path.relative(process.cwd(), filename));
     console.error('\x1b[31m  Style – Error on line ' + jsonDiff(actual, expected));

test/test-versions.js

@@ -72,7 +72,6 @@ function testVersions(dataFilename) {
     console.error('\x1b[31m  Browser version error(s)\x1b[0m');
     return true;
   } else {
-    console.log('\x1b[32m  Browser versions – OK \x1b[0m');
     return false;
   }
 }