Add cli option: --max-warnings (#255)

lib/cli.js

@@ -24,7 +24,14 @@ let CWD = process.cwd(),
     DEFAULT_SOLIUMIGNORE_PATH = `${__dirname}/cli-utils/.default-solium-ignore`,
     DEFAULT_SOLIUMRC_PATH = `${__dirname}/cli-utils/.default-soliumrc.json`;
 
-let errorCodes = { ERRORS_FOUND: 1, NO_SOLIUMRC: 3, WRITE_FAILED: 4, INVALID_PARAMS: 5, FILE_NOT_FOUND: 6 };
+let errorCodes = {
+    ERRORS_FOUND: 1,
+    NO_SOLIUMRC: 3,
+    WRITE_FAILED: 4,
+    INVALID_PARAMS: 5,
+    FILE_NOT_FOUND: 6,
+    WARNING_THRESHOLD_EXCEEDED: 7
+};
 
 /**
  * Create default configuration files in the user's directory
@@ -78,16 +85,35 @@ function createDefaultConfigJSON() {
     writeConfigFile(require(DEFAULT_SOLIUMRC_PATH));
 }
 
+/**
+ * Count the number of errors and warnings
+ * @param {Array} issues Array of ethlint issue objects
+ * @returns {Integer, Integer} Total number of errors and warnings present in issues
+ */
+function countErrWarn(issues) {
+    let e = 0, w = 0;
+
+    issues.forEach(i => {
+        if (i.type === "error") {
+            e++;
+        } else if (i.type === "warning") {
+            w++;
+        }
+    });
+
+    return { w, e };
+}
+
 /**
  * Lint a source code string based on user settings. If autofix is enabled, write the fixed code back to file.
  * @param {String} sourceCode The source code to be linted
  * @param {Object} userConfig User configuration
  * @param {Object} errorReporter The error reporter to use
  * @param {String} fileName (optional) File name to use when reporting errors
- * @returns {Integer} numOfErrors Number of Lint ERRORS that occured.
+ * @returns {Integer, Integer} Total number of errors and warnings found
  */
 function lintString(sourceCode, userConfig, errorReporter, fileName) {
-    let lintErrors, fixesApplied;
+    let lintErrors, fixesApplied, additionalErrors = [];
 
     try {
         if (userConfig.options.autofix || userConfig.options.autofixDryrun) {
@@ -98,6 +124,10 @@ function lintString(sourceCode, userConfig, errorReporter, fileName) {
                 applyFixes(fileName, result);
                 fixesApplied = result.fixesApplied;
             } else {
+                // When using only fix dry run, the warnings that were fixed
+                // must also be counted in totalWarnings. See issue #255.
+                additionalErrors = result.fixesApplied;
+
                 errorReporter.reportDiff(fileName,
                     sourceCode, result.fixedSourceCode, result.fixesApplied.length);
             }
@@ -125,9 +155,11 @@ function lintString(sourceCode, userConfig, errorReporter, fileName) {
     lintErrors.length &&
         errorReporter.report(fileName, sourceCode, lintErrors, fixesApplied);
 
-    return lintErrors.reduce(function(numOfErrors, err) {
-        return err.type === "error" ? numOfErrors+1 : numOfErrors;
-    }, 0);
+    const { e, w } = countErrWarn(lintErrors),
+        { w: aw } = countErrWarn(additionalErrors);
+
+    // TODO: fix issue #258
+    return { errorCount: e, warningCount: w+aw };
 }
 
 function applyFixes(fileName, lintResult) {
@@ -139,7 +171,7 @@ function applyFixes(fileName, lintResult) {
  * @param {String} fileName The path to the file to be linted
  * @param {Object} userConfig User configuration
  * @param {Object} errorReporter The error reporter to use
- * @returns {Integer} numOfErrors Number of Lint ERRORS that occured (the result returned by lintString())
+ * @returns {Integer, Integer} Total number of errors and warnings found
  */
 function lintFile(fileName, userConfig, errorReporter) {
     let sourceCode;
@@ -155,14 +187,14 @@ function lintFile(fileName, userConfig, errorReporter) {
 }
 
 /**
- * Function that calls Solium object's linter based on user settings.
- * If not given, we lint the entire directory's (and sub-directories') solidity files.
+ * Function that calls Solium object's linter based on user settings
+ * If not given, we lint the entire directory's (and sub-directories') solidity files
  * @param {Object} userConfig User's configurations that contain information about which linting rules to apply
- * @param {String} filename (optional) The single file to be linted.
- * @returns {Integer} totalNumOfErrors Total no. of errors found throughout the codebase (directory) linted.
+ * @param {String} filename (optional) The single file to be linted
+ * @returns {Integer, Integer} Total number of errors and warnings found
  */
 function lint(userConfig, input, ignore, errorReporter) {
-    let filesToLint, errorCount;
+    let filesToLint, errorCount = 0, warningCount = 0;
 
     //If filename is provided, lint it. Otherwise, lint over current directory & sub-directories
     if (input.file) {
@@ -185,23 +217,32 @@ function lint(userConfig, input, ignore, errorReporter) {
     }
 
     if (filesToLint) {
-        errorCount = sum(filesToLint.map(function(file, index) {
-            userConfig.options.returnInternalIssues = (index === 0);
-            return lintFile(file, userConfig, errorReporter);
-        }));
+        filesToLint.forEach((file, i) => {
+            // Avoid repeatedly reporting internal issues.
+            // Only report them once, during linting of the first file.
+            userConfig.options.returnInternalIssues = (i === 0);
+            const { errorCount: e, warningCount: w } = lintFile(file, userConfig, errorReporter);
+
+            errorCount += e;
+            warningCount += w;
+        });
     } else if (input.stdin) {
-        // This only works on *nix. Need to fix to enable stdin input in windows.
+        // This only works on unix.
+        // TODO: Need to fix this to enable stdin input in windows.
         let sourceCode = fs.readFileSync("/dev/stdin", "utf-8");
 
         userConfig.options.returnInternalIssues = true;
-        errorCount = lintString(sourceCode, userConfig, errorReporter, "[stdin]");
+        const { errorCount: e, warningCount: w } = lintString(sourceCode, userConfig, errorReporter, "[stdin]");
+
+        errorCount = e;
+        warningCount = w;
     } else {
-        errorReporter.reportFatal("Must specify input for linter using --file, --dir or --stdin");
+        errorReporter.reportFatal("Must specify input for linter (either file, directory or stdin)");
         process.exit(errorCodes.INVALID_PARAMS);
     }
 
     errorReporter.finalize && errorReporter.finalize();
-    return errorCount;
+    return { errorCount, warningCount };
 }
 
 /**
@@ -224,6 +265,7 @@ function createCliOptions(cliObject) {
         .option("-d, --dir [dirpath::String]", "Directory containing Solidity files to lint")
         .option("-R, --reporter [name::String]", "Format to report lint issues in (pretty | gcc)", "pretty")
         .option("-c, --config [filepath::String]", "Path to the .soliumrc configuration file")
+        .option("-w, --max-warnings [count::Integer]", "Maximum number of warnings tolerable", -1)
         .option("-, --stdin", "Read input file from stdin")
         .option("--fix", "Fix Lint issues where possible")
         .option("--fix-dry-run", "Output fix diff without applying it")
@@ -392,7 +434,16 @@ function execute(programArgs) {
         }
     }
 
-    let errorCount = lint(userConfig, { file: cli.file, dir: cli.dir, stdin: cli.stdin }, ignore, errorReporter);
+    let { errorCount, warningCount } = lint(
+        userConfig,
+        {
+            file: cli.file,
+            dir: cli.dir,
+            stdin: cli.stdin
+        },
+        ignore,
+        errorReporter
+    );
 
     if (cli.watch) {
 
@@ -407,6 +458,8 @@ function execute(programArgs) {
 
     } else if (errorCount > 0) {
         process.exit(errorCodes.ERRORS_FOUND);
+    } else if (cli.maxWarnings > -1 && warningCount > cli.maxWarnings) {
+        process.exit(errorCodes.WARNING_THRESHOLD_EXCEEDED);
     }
 }