Feature: Add --quiet option to suppress warnings (#157)

Author: ShukantPal

.idea/codestream.xml

@@ -18,8 +18,8 @@ require("./shims");// Node v10 support
 
 declare var global: Object;
 
-export function initLogger(verbose: boolean = false) {
-  const defaultLevel = verbose ? "INFO" : "WARN";
+export function initLogger(verbose: boolean = false, quiet: boolean = false) {
+  const defaultLevel = verbose ? "INFO" : quiet ? "ERROR" : "WARN";
 
   log.init(
     {
@@ -44,15 +44,13 @@ export function initLogger(verbose: boolean = false) {
         break;
       }
     });
+
+  initParserLogger(defaultLevel);
 }
 
 // main() is the default command.
 async function main(argv: yargs.Argv) {
-  initLogger(!!argv.verbose);
-
-  if (argv.verbose) {
-    initParserLogger("INFO");
-  }
+  initLogger(!!argv.verbose, !!argv.quiet);
 
   const start = performance.now();
 
@@ -184,6 +182,7 @@ const argv = yargs.scriptName("@webdoc/cli")
   .alias("c", "config")
   .alias("u", "tutorials")
   .alias("v", "verbose")
+  .alias("q", "quiet")
   .command("$0", "Run webdoc", () => {})
   .argv;
 

packages/webdoc-cli/src/index.js

@@ -36,6 +36,7 @@ export function initLogger(defaultLevel: string = "INFO") {
       DocParser: defaultLevel,
       DocumentTreeModifier: defaultLevel,
       Indexer: defaultLevel,
+      Validator: defaultLevel,
     },
     (level, tag, msg, params) => {
       let tagPrefix = `[${tag}]:`;

packages/webdoc-parser/src/Logger.js

@@ -1,6 +1,7 @@
 // @flow
 
 import type {DocShape, Param} from "@webdoc/types";
+import {parserLogger, tag} from "../Logger";
 import type {SymbolSignature} from "../types/Symbol";
 
 // Validate the parameters are structurally (not nominally) correct
@@ -20,7 +21,7 @@ function validateParameters(doc: DocShape, meta: SymbolSignature): void {
     const name = param.identifier;
 
     if (!name) {
-      console.warn("Anonymous documented parameters are not supported");
+      parserLogger.error(tag.Validator, "Anonymous documented parameters are not supported");
     }
 
     const dotIndex = name.indexOf(".");
@@ -33,14 +34,14 @@ function validateParameters(doc: DocShape, meta: SymbolSignature): void {
       // @param {string} string
       // @param {string} options.title
       if (firstId !== lastParam) {
-        console.warn(`Object property ${name} parameter must be placed` +
+        parserLogger.warn(tag.Validator, `Object property ${name} parameter must be placed` +
               `directly after object parameter ${firstId}`);
       }
 
       continue;
     }
     if (j >= metaParams.length) {
-      console.warn(`"${name}" is not a parameter & cannot` +
+      parserLogger.warn(tag.Validator, `"${name}" is not a parameter & cannot` +
             ` come after the last parameter "${lastParam || ""}"`);
     }