Make the default output framing behaviour configurable #90

extraterm/src/Config.ts

@@ -29,6 +29,8 @@ export interface GeneralConfig {
   showTitleBar?: boolean;
 
   windowConfiguration?: WindowConfiguration;
+
+  frameByDefault?: boolean;
 }
 
 // This is the format of the user config JSON file as stored on the filesystem.

extraterm/src/main_process/Main.ts

@@ -446,6 +446,10 @@ function setupConfig(): void {
     userStoredConfig.showTitleBar = false;
   }
 
+  if (userStoredConfig.frameByDefault !== true && userStoredConfig.frameByDefault !== false) {
+    userStoredConfig.frameByDefault = true;
+  }
+
   const keyBindingsDir = path.join(__dirname, KEYBINDINGS_DIRECTORY);
   const keyBindingsFiles = scanKeyBindingFiles(keyBindingsDir);
 
@@ -549,6 +553,7 @@ function setConfigDefaults(config: UserStoredConfig): void {
   config.themeSyntax = defaultValue(config.themeSyntax, "default");
   config.themeGUI = defaultValue(config.themeGUI, "atomic-dark-ui");
   config.showTitleBar = defaultValue(config.showTitleBar, false);
+  config.frameByDefault = defaultValue(config.frameByDefault, true);
 
   if (config.commandLineActions === undefined) {
     const defaultCLA: CommandLineAction[] = [

extraterm/src/render_process/Terminal.ts

@@ -55,6 +55,7 @@ import { ConfigDatabase, CommandLineAction, injectConfigDatabase, AcceptsConfigD
 import * as SupportsClipboardPaste from "./SupportsClipboardPaste";
 import * as SupportsDialogStack from "./SupportsDialogStack";
 import { ExtensionManager } from './extension/InternalTypes';
+import { DeepReadonlyObject, DeepReadonly } from 'extraterm-readonly-toolbox';
 
 type VirtualScrollable = VirtualScrollArea.VirtualScrollable;
 type VirtualScrollArea = VirtualScrollArea.VirtualScrollArea;
@@ -410,7 +411,6 @@ export class EtTerminal extends ThemeableElementBase implements Commandable, Acc
 
     pty.onData((text: string): void => {
       this._emulator.write(text);
-      // FIXME flow control.
     });
 
     doLater(() => {
@@ -438,40 +438,51 @@ export class EtTerminal extends ThemeableElementBase implements Commandable, Acc
     this._extensionManager = extensionManager;
   }
 
-  private _isNoFrameCommand(commandLine: string): boolean {
+  private _commandNeedsFrame(commandLine: string): boolean {
     const cleanCommandLine = commandLine.trim();
     if (cleanCommandLine === "") {
-      return true;
+      return false;
     }
 
     const commandParts = cleanCommandLine.split(/\s+/);
     if (this._configManager === null) {
       return false;
     } else {
 
-      const commandLineActions = this._configManager.getConfig(COMMAND_LINE_ACTIONS_CONFIG) || [];
-      return commandLineActions
-        .filter( cla => ! cla.frame)
-        .some( cla => {
-          if (cla.matchType === 'name') {
-            const matcherParts = cla.match.split(/\s+/);
-            for (let i=0; i < matcherParts.length; i++) {
-              if (i >= commandParts.length) {
-                return false;
-              }
-              if (matcherParts[i] !== commandParts[i]) {
-                return false;
-              }
-            }
-            return true;        
-          } else {
-            // regexp
-            return (new RegExp(cla.match)).test(cleanCommandLine);
-          }
-        } );
+      const commandLineActions: DeepReadonly<CommandLineAction[]> = 
+        this._configManager.getConfig(COMMAND_LINE_ACTIONS_CONFIG) || [];
+      const frameByDefault = this._configManager.getConfig(GENERAL_CONFIG).frameByDefault;
+
+      for (const cla of commandLineActions) {
+        if (this._commandLineActionMatches(commandLine, cla)) {
+          return cla.frame;
+        }
+      }
+      return frameByDefault;
     }
   }
 
+  private _commandLineActionMatches(command: string, cla: DeepReadonly<CommandLineAction>): boolean {
+    const cleanCommandLine = command.trim();
+    const commandParts = command.trim().split(/\s+/);
+
+    if (cla.matchType === 'name') {
+      const matcherParts = cla.match.split(/\s+/);
+      for (let i=0; i < matcherParts.length; i++) {
+        if (i >= commandParts.length) {
+          return false;
+        }
+        if (matcherParts[i] !== commandParts[i]) {
+          return false;
+        }
+      }
+      return true;        
+    } else {
+      // regexp
+      return (new RegExp(cla.match)).test(cleanCommandLine);
+    }   
+  }
+
   /**
    * Get this terminal's title.
    *
@@ -1738,7 +1749,7 @@ export class EtTerminal extends ThemeableElementBase implements Commandable, Acc
       cleancommand = trimmed.slice(trimmed.indexOf(" ")).trim();
     }
 
-    if ( ! this._isNoFrameCommand(cleancommand)) {
+    if (this._commandNeedsFrame(cleancommand)) {
       // Create and set up a new command-frame.
       const el = this._createEmbeddedViewerElement();
 

extraterm/src/render_process/settings/FrameSettings.ts

@@ -7,7 +7,7 @@ import * as _ from 'lodash';
 import Vue from 'vue';
 
 import { FrameSettingsUi, nextId, Identifiable, IdentifiableCommandLineAction} from './FrameSettingsUi';
-import { COMMAND_LINE_ACTIONS_CONFIG, ConfigKey, CommandLineAction } from '../../Config';
+import { COMMAND_LINE_ACTIONS_CONFIG, ConfigKey, CommandLineAction, GENERAL_CONFIG, GeneralConfig } from '../../Config';
 import { Logger, getLogger } from '../../logging/Logger';
 import log from '../../logging/LogDecorator';
 import { SettingsBase } from './SettingsBase';
@@ -19,13 +19,13 @@ export class FrameSettings extends SettingsBase<FrameSettingsUi> {
   private _log: Logger = null;
 
   constructor() {
-    super(FrameSettingsUi, [COMMAND_LINE_ACTIONS_CONFIG]);
+    super(FrameSettingsUi, [GENERAL_CONFIG, COMMAND_LINE_ACTIONS_CONFIG]);
     this._log = getLogger(FRAME_SETTINGS_TAG, this);
   }
 
   protected _setConfig(key: ConfigKey, config: any): void {
+    const ui = this._getUi();
     if (key === COMMAND_LINE_ACTIONS_CONFIG) {
-      const ui = this._getUi();
       const commandLineActions = <CommandLineAction[]> config;
 
       const cleanCommandLineAction = _.cloneDeep(ui.commandLineActions);
@@ -37,13 +37,22 @@ export class FrameSettings extends SettingsBase<FrameSettingsUi> {
         ui.commandLineActions = updateCLA;
       }
     }
+
+    if (key === GENERAL_CONFIG) {
+      const generalConfig = <GeneralConfig> config;
+      ui.frameByDefault = config.frameByDefault ? "true" : "false";
+    }
   }
 
   protected _dataChanged(): void {
     const ui = this._getUi();
     const commandLineActions = _.cloneDeep(ui.commandLineActions);
     stripIds(commandLineActions);
     this._updateConfig(COMMAND_LINE_ACTIONS_CONFIG, commandLineActions);
+
+    const generalConfig = <GeneralConfig> this._getConfigCopy(GENERAL_CONFIG);
+    generalConfig.frameByDefault = ui.frameByDefault === "true" ? true : false;
+    this._updateConfig(GENERAL_CONFIG, generalConfig);
   }
 }
 

extraterm/src/render_process/settings/FrameSettingsUi.ts

@@ -34,6 +34,19 @@ export function nextId(): string {
     template: `
 <div class="settings-page">
   <h2><i class="far fa-window-maximize"></i>&nbsp;&nbsp;Frame Handling Rules</h2>
+
+  <div class="form-horizontal">
+    <div class="form-group">
+      <label for="tips" class="col-sm-4 control-label">Default action:</label>
+      <div class="input-group col-sm-4">
+        <select v-model="frameByDefault" class="form-control">
+          <option value="true">Frame command output</option>
+          <option value="false">Do not frame command output</option>
+        </select>
+      </div>
+    </div>
+  </div>
+
   <table class="table">
     <thead v-if="commandLineActions.length !== 0">
       <tr><th>Match</th><th>Command</th><th>Frame</th><th></th></tr>
@@ -68,7 +81,8 @@ export function nextId(): string {
 })
 export class FrameSettingsUi extends Vue {
 
-  commandLineActions: IdentifiableCommandLineAction[];
+  frameByDefault: "true" | "false" = "true";
+  commandLineActions: IdentifiableCommandLineAction[] = [];
 
   constructor() {
     super();