feat: clear log on execution start (#1168)

Author: scnwwu

client/src/commands/run.ts

@@ -12,10 +12,13 @@ import {
 } from "vscode";
 import type { BaseLanguageClient } from "vscode-languageclient";
 
+import { basename, extname } from "path";
+
 import { showResult } from "../components/ResultPanel";
 import {
   appendExecutionLogFn,
   appendSessionLogFn,
+  setFileName,
 } from "../components/logViewer";
 import { sasDiagnostic } from "../components/logViewer/sasDiagnostics";
 import { SASCodeDocument } from "../components/utils/SASCodeDocument";
@@ -112,6 +115,9 @@ async function runCode(selected?: boolean, uri?: Uri) {
   session.onExecutionLogFn = onExecutionLogFn;
   session.onSessionLogFn = appendSessionLogFn;
 
+  const fileName = basename(codeDoc.getUri(), extname(codeDoc.getUri()));
+  setFileName(fileName);
+
   await session.setup();
 
   await window.withProgress(
@@ -222,6 +228,9 @@ async function _runTask(
   );
   session.onSessionLogFn = appendSessionLogFn;
 
+  const fileName = basename(codeDoc.getUri(), extname(codeDoc.getUri()));
+  setFileName(fileName);
+
   messageEmitter.fire(`${l10n.t("Connecting to SAS session...")}\r\n`);
   !cancelled && (await session.setup(true));
 

client/src/components/logViewer/index.ts

@@ -12,6 +12,7 @@ import type { OnLogFn } from "../../connection";
 import { useLogStore, useRunStore } from "../../store";
 import { logSelectors, runSelectors } from "../../store/selectors";
 import {
+  clearLogOnExecutionStart,
   showLogOnExecutionFinish,
   showLogOnExecutionStart,
 } from "../utils/settings";
@@ -20,6 +21,7 @@ const { setProducedExecutionLogOutput } = useLogStore.getState();
 
 let outputChannel: OutputChannel;
 let data: string[] = [];
+let fileName = "";
 
 export const legend = {
   tokenTypes: ["error", "warning", "note"],
@@ -66,9 +68,16 @@ export const appendLogToken = (type: string): void => {
   data.push(type);
 };
 
+export const setFileName = (name: string) => {
+  fileName = name;
+};
+
 const appendLogLines: OnLogFn = (logs) => {
   if (!outputChannel) {
-    outputChannel = window.createOutputChannel(l10n.t("SAS Log"), "sas-log");
+    const name = clearLogOnExecutionStart()
+      ? l10n.t("SAS Log: {name}", { name: fileName })
+      : l10n.t("SAS Log");
+    outputChannel = window.createOutputChannel(name, "sas-log");
   }
   for (const line of logs) {
     appendLogToken(line.type);
@@ -100,6 +109,12 @@ useRunStore.subscribe(
       }
     } else if (isExecuting && !prevIsExecuting) {
       setProducedExecutionLogOutput(false);
+
+      if (clearLogOnExecutionStart() && outputChannel) {
+        outputChannel.dispose();
+        outputChannel = undefined;
+        data = [];
+      }
     }
   },
 );

client/src/components/utils/settings.ts

@@ -26,6 +26,10 @@ export function showLogOnExecutionFinish(): boolean {
   return workspace.getConfiguration("SAS").get("log.showOnExecutionFinish");
 }
 
+export function clearLogOnExecutionStart(): boolean {
+  return workspace.getConfiguration("SAS").get("log.clearOnExecutionStart");
+}
+
 export function isShowProblemsFromSASLogEnabled(): boolean {
   return workspace.getConfiguration("SAS").get("problems.log.enabled");
 }

package.json

@@ -474,6 +474,12 @@
             "type": "boolean",
             "default": true,
             "description": "%configuration.SAS.log.showOnExecutionFinish%"
+          },
+          "SAS.log.clearOnExecutionStart": {
+            "order": 9,
+            "type": "boolean",
+            "default": true,
+            "description": "%configuration.SAS.log.clearOnExecutionStart%"
           }
         }
       }

package.nls.json

@@ -54,6 +54,7 @@
   "configuration.SAS.flowConversionMode": "Choose the conversion mode for notebooks",
   "configuration.SAS.flowConversionModeNode": "Convert each notebook cell to a node",
   "configuration.SAS.flowConversionModeSwimlane": "Convert each notebook cell to a swimlane",
+  "configuration.SAS.log.clearOnExecutionStart": "Clear SAS Log when code execution starts",
   "configuration.SAS.log.showOnExecutionFinish": "Show SAS Log when code execution is finished",
   "configuration.SAS.log.showOnExecutionStart": "Show SAS Log when code execution starts",
   "configuration.SAS.problems.log.enabled": "Show problems from SAS log",

package.nls.zh-cn.json

@@ -54,6 +54,7 @@
   "configuration.SAS.flowConversionMode": "选择笔记本的转换模式",
   "configuration.SAS.flowConversionModeNode": "将每个笔记本单元转换为一个节点",
   "configuration.SAS.flowConversionModeSwimlane": "将每个笔记本单元转换为泳道",
+  "configuration.SAS.log.clearOnExecutionStart": "代码执行开始时清空 SAS 日志",
   "configuration.SAS.log.showOnExecutionFinish": "代码执行完成时显示 SAS 日志",
   "configuration.SAS.log.showOnExecutionStart": "代码执行开始时显示 SAS 日志",
   "configuration.SAS.problems.log.enabled": "显示SAS日志中报告的问题",

website/docs/Configurations/sasLog.md

@@ -37,3 +37,9 @@ Example
   }
 }
 ```
+
+:::tip
+
+To view the SAS log as a text file, click the `...` icon on the top right of the OUTPUT panel, and select `Open Output in Editor`.
+
+:::