feat: terminal.close and terminal improvements

Author: pd93

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+- Added `terminal.per` setting to allow a new terminal per task (#125, #126 by
+  @yoiang).
+- Added `terminal.close` setting to control if the existing terminal should
+  close before running another task (by @pd93).
+- General improvements to how terminals are handled (by @pd93).
+
 ## v0.3.2 - 2023-11-20
 
 - Fixed another small bug with the new argument passing (#94 by @MaxCheetham).

package.json

@@ -326,6 +326,15 @@
                   ],
                   "default": "window",
                   "description": "When to spawn a new Terminal instance."
+                },
+                "close": {
+                  "type": "string",
+                  "enum": [
+                    "never",
+                    "onNextTask"
+                  ],
+                  "default": "never",
+                  "description": "When to close the Terminal instance."
                 }
               }
             }

src/services/taskfile.ts

@@ -6,7 +6,7 @@ import * as path from 'path';
 import * as semver from 'semver';
 import * as vscode from 'vscode';
 import * as models from '../models';
-import { OutputTo, TerminalPer, TreeSort, log, settings } from '../utils';
+import { OutputTo, TerminalClose, TerminalPer, TreeSort, log, settings } from '../utils';
 import stripAnsi = require('strip-ansi');
 
 const octokit = new Octokit();
@@ -34,6 +34,7 @@ const errCodeTaskCalledTooManyTimes = 204;
 class TaskfileService {
     private static _instance: TaskfileService;
     private static outputChannel: vscode.OutputChannel;
+    private static terminal: vscode.Terminal;
     private lastTaskName: string | undefined;
     private lastTaskDir: string | undefined;
     private version: semver.SemVer | undefined;
@@ -224,16 +225,18 @@ class TaskfileService {
     public async runTask(taskName: string, dir?: string, cliArgs?: string): Promise<void> {
         if (settings.outputTo === OutputTo.terminal) {
             log.info(`Running task: "${taskName} ${cliArgs}" in: "${dir}"`);
-            var terminal: vscode.Terminal;
-            if (vscode.window.activeTerminal !== undefined && settings.terminal.per === TerminalPer.window) {
-                log.info("Using existing terminal");
-                terminal = vscode.window.activeTerminal;
-            } else {
+            if (TaskfileService.terminal !== undefined && settings.terminal.close === TerminalClose.onNextTask) {
+                log.info("Closing old terminal");
+                TaskfileService.terminal.dispose();
+            }
+            if (TaskfileService.terminal === undefined || TaskfileService.terminal.exitStatus !== undefined || settings.terminal.per === TerminalPer.task) {
                 log.info("Using new terminal");
-                terminal = vscode.window.createTerminal("Task");
+                TaskfileService.terminal = vscode.window.createTerminal("Task");
+            } else {
+                log.info("Using existing terminal");
             }
-            terminal.show();
-            terminal.sendText(this.command(taskName, cliArgs));
+            TaskfileService.terminal.show();
+            TaskfileService.terminal.sendText(this.command(taskName, cliArgs));
         } else {
             return await new Promise((resolve) => {
                 log.info(`Running task: "${taskName}" in: "${dir}"`);

src/utils/settings.ts

@@ -80,6 +80,7 @@ export enum TreeSort {
 class TerminalSettings {
     private static _instance: TerminalSettings;
     public per!: TerminalPer;
+    public close!: TerminalClose;
 
     constructor() {
         this.update();
@@ -98,6 +99,7 @@ class TerminalSettings {
 
         // Set the properties
         this.per = config.get("terminal.per") ?? TerminalPer.window;
+        this.close = config.get("terminal.close") ?? TerminalClose.never;
     }
 }
 
@@ -106,4 +108,10 @@ export enum TerminalPer {
     task = "task"
 }
 
+export enum TerminalClose {
+    never = "never",
+    taskComplete = "taskComplete",
+    onNextTask = "onNextTask"
+}
+
 export const settings = Settings.instance;