Merge pull request #3354 from trufflesuite/sections

Enhancement: Group variables by section in debugger

packages/core/lib/debug/printer.js

@@ -480,33 +480,36 @@ class DebugPrinter {
   }
 
   async printVariables() {
-    let variables = await this.session.variables();
-
-    debug("variables %o", variables);
+    const values = await this.session.variables();
+    const sections = this.session.view(data.current.identifiers.sections);
 
-    const variableKeys = Object.keys(variables);
-
-    // Get the length of the longest name.
-    const longestNameLength = variableKeys.reduce((longest, name) => {
-      return name.length > longest ? name.length : longest;
-    }, -Infinity);
+    const sectionNames = {
+      builtin: "Solidity built-ins",
+      contract: "Contract variables",
+      local: "Local variables"
+    };
 
     this.config.logger.log();
 
-    variableKeys.forEach(name => {
-      let paddedName = name + ":";
-
-      while (paddedName.length <= longestNameLength) {
-        paddedName = " " + paddedName;
+    for (const [section, variables] of Object.entries(sections)) {
+      if (variables.length > 0) {
+        this.config.logger.log(sectionNames[section] + ":");
+        // Get the length of the longest name.
+        const longestNameLength = variables.reduce((longest, name) => {
+          return name.length > longest ? name.length : longest;
+        }, -Infinity);
+        for (const variable of variables) {
+          const paddedName = variable.padStart(longestNameLength) + ":";
+          const value = values[variable];
+          const formatted = DebugUtils.formatValue(
+            value,
+            longestNameLength + 5
+          );
+          this.config.logger.log("  " + paddedName, formatted);
+        }
+        this.config.logger.log();
       }
-
-      const value = variables[name];
-      const formatted = DebugUtils.formatValue(value, longestNameLength + 5);
-
-      this.config.logger.log("  " + paddedName, formatted);
-    });
-
-    this.config.logger.log();
+    }
   }
 
   /**

packages/debugger/lib/data/selectors/index.js

@@ -1200,6 +1200,37 @@ const data = createSelectorTree({
         )
       },
 
+      /**
+       * data.current.identifiers.sections
+       * intended for use by Teams Debugger
+       */
+      sections: createLeaf(["./refs"], refs => {
+        let sections = {
+          builtin: [],
+          contract: [],
+          local: []
+        };
+        for (const [identifier, ref] of Object.entries(refs)) {
+          switch (ref.location) {
+            case "special":
+              sections.builtin.push(identifier);
+              break;
+            case "stack":
+              sections.local.push(identifier);
+              break;
+            case "storage":
+            case "code":
+            case "nowhere":
+            case "memory":
+            case "definition":
+              sections.contract.push(identifier);
+              break;
+            //other cases shouldn't happen
+          }
+        }
+        return sections;
+      }),
+
       /**
        * data.current.identifiers.refs
        *