core(console): factor Console class to use validTruffleConsoleCommands

- simplifies the console class.
- changes error output in console/repl

Author: cds-amal

packages/core/lib/commands/develop/run.js

@@ -6,14 +6,11 @@ const {
 } = require("../../configAdapter");
 
 const runConsole = async (config, ganacheOptions) => {
-  const { Console, validTruffleConsoleCommands } = require("../../console");
+  const { Console } = require("../../console");
   const { Environment } = require("@truffle/environment");
 
   await Environment.develop(config, ganacheOptions);
-  const c = new Console(
-    validTruffleConsoleCommands,
-    config.with({ noAliases: true })
-  );
+  const c = new Console(config.with({ noAliases: true }));
   c.on("exit", () => process.exit());
   return await c.start();
 };

packages/core/lib/console-child.js

@@ -8,7 +8,7 @@ const {
   displayGeneralHelp
 } = require("./command-utils");
 const { handleHelpInput } = require("./cliHelp");
-const { validTruffleConsoleCommands } = require("./console");
+const { validTruffleConsoleCommands } = require("./commands/commands");
 
 // we split off the part Truffle cares about and need to convert to an array
 const input = process.argv[2].split(" -- ");

packages/core/lib/console.js

@@ -16,16 +16,13 @@ const { spawn } = require("child_process");
 const Require = require("@truffle/require");
 const debug = require("debug")("console");
 const { getCommand, parseQuotesAndEscapes } = require("./command-utils");
-const {
-  validTruffleCommands,
-  validTruffleConsoleCommands
-} = require("./commands/commands");
+const { validTruffleConsoleCommands } = require("./commands/commands");
 
 // Create an expression that returns a string when evaluated
 // by the REPL
 const makeIIFE = str => `(() => "${str}")()`;
 
-const processInput = (input, allowedCommands) => {
+const processInput = input => {
   const words = input.trim().split(/\s+/);
 
   // empty input
@@ -42,20 +39,19 @@ const processInput = (input, allowedCommands) => {
     }
 
     const normalizedCommand = cmd.toLowerCase();
-    if (validTruffleCommands.includes(normalizedCommand)) {
-      return allowedCommands.includes(normalizedCommand)
-        ? words.slice(1).join(" ")
-        : makeIIFE(`ℹ️ : '${cmd}' is not allowed within Truffle REPL`);
-    }
-    return makeIIFE(`ℹ️ : '${cmd}' is not a valid Truffle command`);
+    return validTruffleConsoleCommands.includes(normalizedCommand)
+      ? words.slice(1).join(" ")
+      : makeIIFE(
+          `ℹ️ : '${words[0]} ${cmd}' is not valid in Console environment.`
+        );
   }
 
   // an expression
   return input.trim();
 };
 
 class Console extends EventEmitter {
-  constructor(allowedCommands, options) {
+  constructor(options) {
     super();
     EventEmitter.call(this);
 
@@ -72,7 +68,6 @@ class Console extends EventEmitter {
       "build_directory"
     ]);
 
-    this.allowedCommands = allowedCommands;
     this.options = options;
 
     this.repl = null;
@@ -401,9 +396,9 @@ class Console extends EventEmitter {
   }
 
   async interpret(input, context, filename, callback) {
-    const processedInput = processInput(input, this.allowedCommands);
+    const processedInput = processInput(input);
     if (
-      this.allowedCommands.includes(processedInput.split(/\s+/)[0]) &&
+      validTruffleConsoleCommands.includes(processedInput.split(/\s+/)[0]) &&
       getCommand({
         inputStrings: processedInput.split(/\s+/),
         options: {},
@@ -530,6 +525,5 @@ class Console extends EventEmitter {
 }
 
 module.exports = {
-  validTruffleConsoleCommands,
   Console
 };

packages/core/test/lib/console.js

@@ -1,7 +1,6 @@
 const assert = require("chai").assert;
 const path = require("path");
 const { Console } = require("../../lib/console");
-const { validTruffleConsoleCommands } = require("../../lib/commands/commands");
 const sinon = require("sinon");
 const Config = require("@truffle/config");
 const Web3 = require("web3");
@@ -37,7 +36,7 @@ describe("Console", function () {
         { path: pathToMoreUserJs },
         { path: pathToUserJs, as: "namespace" }
       ];
-      truffleConsole = new Console(validTruffleConsoleCommands, consoleOptions);
+      truffleConsole = new Console(consoleOptions);
       sinon
         .stub(truffleConsole.interfaceAdapter, "getAccounts")
         .returns(["0x0"]);
@@ -83,10 +82,7 @@ describe("Console", function () {
           "test/sources/moreUserVariables.js"
         );
         otherConsoleOptions["require-none"] = true;
-        otherTruffleConsole = new Console(
-          validTruffleConsoleCommands,
-          otherConsoleOptions
-        );
+        otherTruffleConsole = new Console(otherConsoleOptions);
       });
 
       it("won't load any user-defined JS", async function () {
@@ -115,10 +111,7 @@ describe("Console", function () {
           config.working_directory,
           "test/sources/nameConflicts.js"
         );
-        otherTruffleConsole = new Console(
-          validTruffleConsoleCommands,
-          otherConsoleOptions
-        );
+        otherTruffleConsole = new Console(otherConsoleOptions);
       });
 
       it("won't let users clobber Truffle variables", async function () {
@@ -144,10 +137,7 @@ describe("Console", function () {
           provider: new Web3.providers.WebsocketProvider("ws://localhost:666"),
           resolver: new Resolver(config)
         });
-        otherTruffleConsole = new Console(
-          validTruffleConsoleCommands,
-          otherConsoleOptions
-        );
+        otherTruffleConsole = new Console(otherConsoleOptions);
       });
 
       it("accepts options.r", async function () {

packages/truffle/test/scenarios/commands/develop.js

@@ -78,19 +78,19 @@ describe("truffle develop", function () {
     [
       {
         cmd: "console",
-        expectedError: `ℹ️ : 'console' is not allowed within Truffle REPL`
+        expectedError: `ℹ️ : 'truffle console' is not valid in Console environment.`
       },
       {
         cmd: "CONSOLE",
-        expectedError: `ℹ️ : 'CONSOLE' is not allowed within Truffle REPL`
+        expectedError: `ℹ️ : 'truffle CONSOLE' is not valid in Console environment.`
       },
       {
         cmd: "develop",
-        expectedError: `ℹ️ : 'develop' is not allowed within Truffle REPL`
+        expectedError: `ℹ️ : 'truffle develop' is not valid in Console environment.`
       },
       {
         cmd: "alakazam",
-        expectedError: `ℹ️ : 'alakazam' is not a valid Truffle command`
+        expectedError: `ℹ️ : 'truffle alakazam' is not valid in Console environment`
       },
       {
         cmd: "",