Add insertLineSpeed configuration and implement line-by-line insertion in DemoRunner

Author: estruyf

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [0.0.29] - 2025-10-29
+
+- Implement a line-by-line insert/replace action
+- Configure the line-by-line insert/replace speed with the `demoTime.insertLineSpeed` setting
+
 ## [0.0.28] - 2025-10-21
 
 - Changed completed action icon color

README.md

@@ -356,6 +356,7 @@ To use the extension, you need to create a `.demo` folder in your workspace. Onc
 | `demoTime.highlightZoomEnabled` | Enable zooming when highlighting code | `false` |
 | `demoTime.showClock` | Show a clock in the status bar | `true` |
 | `demoTime.timer` | Count down timer for how long the session should last. If not set, it will not count down. The value is the number of minutes. | `null` |
+| `demoTime.insertLineSpeed` | The speed in milliseconds for inserting lines. If you set it to `0`, it will insert its content immediately. | `25` |
 
 ### Tips
 

package.json

@@ -85,6 +85,11 @@
           "type": "boolean",
           "default": true,
           "description": "Show a clock in the status bar"
+        },
+        "demoTime.insertLineSpeed": {
+          "type": "number",
+          "default": 25,
+          "description": "The time out between inserting lines of code (in milliseconds)"
         }
       }
     },

src/constants/Config.ts

@@ -8,4 +8,7 @@ export const Config = {
     show: "showClock",
     timer: "timer",
   },
+  insert: {
+    speed: "insertLineSpeed",
+  },
 };

src/services/DemoRunner.ts

@@ -1,4 +1,4 @@
-import { COMMAND, StateKeys } from "../constants";
+import { COMMAND, Config, StateKeys } from "../constants";
 import { Demo, DemoFileCache, Demos, Step, Subscription } from "../models";
 import { Extension } from "./Extension";
 import {
@@ -17,7 +17,7 @@ import {
 } from "vscode";
 import { FileProvider } from "./FileProvider";
 import { DemoPanel } from "../panels/DemoPanel";
-import { getFileContents, sleep } from "../utils";
+import { getFileContents, insertContent, insertLineByLine, replaceContent, sleep } from "../utils";
 import { ActionTreeItem } from "../providers/ActionTreeviewProvider";
 import { DecoratorService } from "./DecoratorService";
 import { Notifications } from "./Notifications";
@@ -400,19 +400,29 @@ export class DemoRunner {
       // do nothing
     }
 
-    const edit = new WorkspaceEdit();
+    const lineSpeed = Extension.getInstance().getSetting<number>(Config.insert.speed) || 0;
 
     let range = new Range(position, position);
     if (!lineContent) {
-      edit.insert(fileUri, position, content);
+      // Insert the content at the specified position
+      if (!lineSpeed) {
+        await insertContent(fileUri, position, content);
+      } else {
+        await insertLineByLine(fileUri, editor.lineAt(position), content, lineSpeed);
+      }
     } else {
-      const line = editor.lineAt(position);
-      range = line.range;
-      edit.replace(fileUri, line.range, content);
+      if (!lineSpeed) {
+        const line = editor.lineAt(position);
+        range = line.range;
+        await replaceContent(fileUri, line.range, content);
+      } else {
+        const line = editor.lineAt(position);
+        range = line.range;
+        await replaceContent(fileUri, line.range, "");
+        await insertLineByLine(fileUri, line, content, lineSpeed);
+      }
     }
 
-    await workspace.applyEdit(edit);
-
     if (textEditor) {
       textEditor.revealRange(range, TextEditorRevealType.InCenter);
       textEditor.selection = new Selection(range.start, range.start);
@@ -444,17 +454,35 @@ export class DemoRunner {
       return;
     }
 
-    const edit = new WorkspaceEdit();
+    const lineSpeed = Extension.getInstance().getSetting<number>(Config.insert.speed) || 0;
 
     if (range) {
-      edit.replace(fileUri, range, content);
+      if (!lineSpeed) {
+        await replaceContent(fileUri, range, content);
+      } else {
+        const startLine = editor.lineAt(range.start);
+        const endLine = editor.lineAt(range.end);
+        const start = new Position(startLine.lineNumber, 0);
+        const end = new Position(endLine.lineNumber, endLine.text.length);
+
+        await replaceContent(fileUri, new Range(start, end), "");
+        await insertLineByLine(fileUri, startLine, content, lineSpeed);
+      }
     } else if (position) {
-      const line = editor.lineAt(position);
-      range = line.range;
-      edit.replace(fileUri, line.range, content);
-    }
+      if (!lineSpeed) {
+        const line = editor.lineAt(position);
+        range = line.range;
 
-    await workspace.applyEdit(edit);
+        await replaceContent(fileUri, line.range, content);
+      } else {
+        const line = editor.lineAt(position);
+        range = line.range;
+
+        await replaceContent(fileUri, line.range, "");
+
+        await insertLineByLine(fileUri, line, content, lineSpeed);
+      }
+    }
 
     if (textEditor && range) {
       textEditor.revealRange(range, TextEditorRevealType.InCenter);

src/utils/index.ts

@@ -1,3 +1,6 @@
 export * from "./getfileContents";
+export * from "./insertContent";
+export * from "./insertLineByLine";
 export * from "./parseWinPath";
+export * from "./replaceContent";
 export * from "./sleep";

src/utils/insertContent.ts

@@ -0,0 +1,7 @@
+import { Position, Uri, workspace, WorkspaceEdit } from "vscode";
+
+export const insertContent = async (fileUri: Uri, position: Position, content: string) => {
+  const edit = new WorkspaceEdit();
+  edit.insert(fileUri, position, content);
+  await workspace.applyEdit(edit);
+};

src/utils/insertLineByLine.ts

@@ -0,0 +1,29 @@
+import { Position, TextLine, Uri } from "vscode";
+import { sleep } from "./sleep";
+import { insertContent } from ".";
+
+export const insertLineByLine = async (fileUri: Uri, startLine: TextLine, content: string, speed: number) => {
+  const lines = content.split("\n");
+  const totalLines = lines.length;
+  const lastLine = lines[totalLines - 1];
+
+  let crntPosition = new Position(startLine.lineNumber, 0);
+  for (let i = 0; i < totalLines; i++) {
+    let lineContent = lines[i];
+
+    if (totalLines > 1) {
+      if (i === totalLines - 1 && lastLine.trim() === "") {
+        lineContent = `\n`;
+      } else if (i < totalLines - 1) {
+        lineContent = `${lineContent}\n`;
+      } else {
+        lineContent = `${lineContent}`;
+      }
+    }
+
+    await insertContent(fileUri, crntPosition, lineContent);
+
+    crntPosition = new Position(crntPosition.line + 1, 0);
+    await sleep(speed);
+  }
+};

src/utils/replaceContent.ts

@@ -0,0 +1,7 @@
+import { Range, Uri, workspace, WorkspaceEdit } from "vscode";
+
+export const replaceContent = async (fileUri: Uri, range: Range, content: string) => {
+  const edit = new WorkspaceEdit();
+  edit.replace(fileUri, range, content);
+  await workspace.applyEdit(edit);
+};