Merge pull request #228 from pinkiebell/bounty

Feature: run solium cli without config files

Author: Raghav Dua

docs/user-guide.rst

@@ -73,8 +73,16 @@ Use ``solium --help`` for more information on usage.
 	``-d`` can be used in place of ``--dir`` and ``-f`` in place of ``--file``.
 
 
-After linting over your code, Solium produces either warnings, errors or both. The app exits with a non-zero code ONLY if 1 or more errors were found.
-So if all you got was warnings, solium exits with code ``0``.
+You can specify rules or plugins to apply as commandline options. If you specify one, it overrides its corresponding configuration in the soliumrc file.
+
+``solium --plugin zeppelin --rule 'indentation: ["error", 4]' -d contracts/``
+
+Use ``--no-soliumrc`` and ``--no-soliumignore`` if you want to run solium in any arbitrary folder without looking for the config files.
+
+``solium --no-soliumrc --no-soliumignore --plugin zeppelin --rule 'indentation: ["error", 4]' -f contract.sol``
+
+After linting over your code, Solium produces either warnings, errors or both. The tool exits with a non-zero code only if 1 or more errors were found.
+So if all you got was warnings, solium exits with ``0``.
 
 Whether an issue should be flagged as an error or warning by its rule is configurable through ``.soliumrc.json``.
 

lib/cli.js

@@ -203,6 +203,11 @@ function lint(userConfig, input, ignore, errorReporter) {
  * @param {Object} cliObject Commander Object handling the cli
  */
 function createCliOptions(cliObject) {
+    function collect(val, memo) {
+        memo.push(val);
+        return memo;
+    }
+
     cliObject
         .version(`Solium version ${version}`)
         .description("Linter to find & fix style and security issues in Solidity smart contracts.")
@@ -217,7 +222,21 @@ function createCliOptions(cliObject) {
         .option("--fix", "Fix Lint issues where possible")
         .option("--debug", "Display debug information")
         .option("--watch", "Watch for file changes")
-        .option("--hot", "(Deprecated) Same as --watch");
+        .option("--hot", "(Deprecated) Same as --watch")
+        .option("--no-soliumignore", "Do not look for .soliumignore file")
+        .option("--no-soliumrc", "Do not look for soliumrc configuration file")
+        .option(
+            "--rule [rule]",
+            "Rule to execute. This overrides the specified rule's configuration in soliumrc if present",
+            collect,
+            []
+        )
+        .option(
+            "--plugin [plugin]",
+            "Plugin to execute. This overrides the specified plugin's configuration in soliumrc if present",
+            collect,
+            []
+        );
 }
 
 /**
@@ -243,7 +262,7 @@ function getErrorReporter(name) {
  */
 function execute(programArgs) {
 
-    let userConfig, ignore, errorReporter;
+    let userConfig = {}, ignore, errorReporter;
 
     createCliOptions(cli);
     programArgs.length === 2 ? cli.help() : cli.parse(programArgs);
@@ -259,31 +278,33 @@ function execute(programArgs) {
         process.exit(errorCodes.INVALID_PARAMS);
     }
 
-    /**
-     * If cli.config option is NOT specified, then resort to .soliumrc in current dir.
-     * Else,
-     *   If path is absolute, assign as-it-is.
-     *   Else (relative pathing) join path with current dir.
-     */
-    const soliumrcAbsPath = cli.config ?
-        (path.isAbsolute(cli.config) ? cli.config : path.join(CWD, cli.config)) :
-        SOLIUMRC_FILENAME_ABSOLUTE;
-
-    try {
-        userConfig = require(soliumrcAbsPath);
-    } catch (e) {
-        // Check if soliumrc file exists. If yes, then the file is in an invalid format.
-        if (fs.existsSync(soliumrcAbsPath)) {
-            errorReporter.reportFatal(`An invalid ${SOLIUMRC_FILENAME} was provided. ${e.message}`);
-        } else {
-            if (cli.config) {
-                errorReporter.reportFatal(`${soliumrcAbsPath} does not exist.`);
+    if (cli.soliumrc) {
+        /**
+         * If cli.config option is NOT specified, then resort to .soliumrc in current dir.
+         * Else,
+         *   If path is absolute, assign as-it-is.
+         *   Else (relative pathing) join path with current dir.
+         */
+        const soliumrcAbsPath = cli.config ?
+            (path.isAbsolute(cli.config) ? cli.config : path.join(CWD, cli.config)) :
+            SOLIUMRC_FILENAME_ABSOLUTE;
+
+        try {
+            userConfig = require(soliumrcAbsPath);
+        } catch (e) {
+            // Check if soliumrc file exists. If yes, then the file is in an invalid format.
+            if (fs.existsSync(soliumrcAbsPath)) {
+                errorReporter.reportFatal(`An invalid ${SOLIUMRC_FILENAME} was provided. ${e.message}`);
             } else {
-                errorReporter.reportFatal(`Couldn't find ${SOLIUMRC_FILENAME} in the current directory.`);
+                if (cli.config) {
+                    errorReporter.reportFatal(`${soliumrcAbsPath} does not exist.`);
+                } else {
+                    errorReporter.reportFatal(`Couldn't find ${SOLIUMRC_FILENAME} in the current directory.`);
+                }
             }
-        }
 
-        process.exit(errorCodes.NO_SOLIUMRC);
+            process.exit(errorCodes.NO_SOLIUMRC);
+        }
     }
 
     //if custom rules' file is set, make sure we have its absolute path
@@ -302,13 +323,39 @@ function execute(programArgs) {
         debug: Boolean(cli.debug)
     };
 
+    userConfig.plugins = userConfig.plugins || [];
+    userConfig.rules = userConfig.rules || {};
+
+    for (const plugin of cli.plugin) {
+        userConfig.plugins.push(plugin);
+    }
+
+    for (const rule of cli.rule) {
+        // If no ":" was found, it means only the rule's name was specified.
+        // Treat it as an error and adopt its default configuration options.
+        if (!rule.includes(":")) {
+            userConfig.rules[rule] = "error";
+            continue;
+        }
+
+        let [key, value] = rule.split(":").map(i => i.trim());
+        try {
+            value = JSON.parse(value);
+        } catch (e) {
+            errorReporter.reportFatal(`There was an error trying to parse '${rule}': ${e.message}`);
+            process.exit(errorCodes.INVALID_PARAMS);
+        }
+        userConfig.rules[key] = value;
+    }
+
     //get all files & folders to ignore from .soliumignore
-    try {
-        ignore = fs.readFileSync(SOLIUMIGNORE_FILENAME_ABSOLUTE, "utf8").split("\n");
-    } catch (e) {
-        errorReporter.reportInternal(
-            `There was an error trying to read '${SOLIUMIGNORE_FILENAME_ABSOLUTE}': ${e.message}`
-        );
+    if (cli.soliumignore) {
+        try {
+            ignore = fs.readFileSync(SOLIUMIGNORE_FILENAME_ABSOLUTE, "utf8").split("\n");
+        } catch (e) {
+            errorReporter.reportInternal(
+                `There was an error trying to read '${SOLIUMIGNORE_FILENAME_ABSOLUTE}': ${e.message}`);
+        }
     }
 
     if (cli.hot) {