Fixing misc. bugs

Author: lostintangent

CHANGELOG.md

@@ -4,6 +4,11 @@
 - Automatically set the "pattern" record mode when you create a new tour, and select `None` for the git ref
 - Added support for opening a `*.tour` file in the VS Code notebook editor (Insiders only)
 
+## v0.0.59 (03/24/2022)
+
+- Tours are now written to the `CodeTour: Custom Tour Directory` directory, when that property is set
+- Fixed a performance issue with large codebases
+
 ## v0.0.58 (07/08/2021)
 
 - The "Tours available!" prompt is now suppressed when opening a [CodeSwing](https://aka.ms/codeswing) workspace

package-lock.json

@@ -3,7 +3,7 @@
   "displayName": "CodeTour",
   "description": "VS Code extension that allows you to record and playback guided tours of codebases, directly within the editor",
   "publisher": "vsls-contrib",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "author": {
     "name": "Microsoft Corporation"
   },
@@ -18,7 +18,7 @@
   "license": "MIT",
   "icon": "images/icon.png",
   "engines": {
-    "vscode": "^1.48.0"
+    "vscode": "^1.60.0"
   },
   "categories": [
     "Other"
@@ -31,7 +31,8 @@
     "workspace"
   ],
   "activationEvents": [
-    "*",
+    "onStartupFinished",
+    "onView:codetour.tours",
     "onNotebookEditor:codetour"
   ],
   "main": "./dist/extension-node.js",
@@ -651,7 +652,7 @@
     "@types/axios": "^0.14.0",
     "@types/node": "^8.10.66",
     "@types/throttle-debounce": "^2.1.0",
-    "@types/vscode": "~1.48.0",
+    "@types/vscode": "^1.60.0",
     "ts-loader": "^7.0.4",
     "tslint": "^5.8.0",
     "typescript": "^3.1.4",

package.json

@@ -7,9 +7,12 @@ import { CodeTour } from "../store";
 import { getStepFileUri, getWorkspaceUri } from "../utils";
 
 class CodeTourNotebookProvider implements vscode.NotebookSerializer {
-  originalContent: Uint8Array = new TextEncoder().encode('');
+  originalContent: Uint8Array = new TextEncoder().encode("");
 
-  async deserializeNotebook(content: Uint8Array, token: any): Promise<vscode.NotebookData> {
+  async deserializeNotebook(
+    content: Uint8Array,
+    token: any
+  ): Promise<vscode.NotebookData> {
     this.originalContent = content;
     let contents = new TextDecoder().decode(content);
 
@@ -21,8 +24,8 @@ class CodeTourNotebookProvider implements vscode.NotebookSerializer {
       const uri = await getStepFileUri(item, workspaceRoot, tour.ref);
       const document = await vscode.workspace.openTextDocument(uri);
 
-      const startLine = (item.line! > 10) ? item.line! - 10 : 0;
-      const endLine = (item.line! > 1) ? item.line! - 1 : 0;
+      const startLine = item.line! > 10 ? item.line! - 10 : 0;
+      const endLine = item.line! > 1 ? item.line! - 1 : 0;
       const contents = document.getText(
         new vscode.Range(
           new vscode.Position(startLine, 0),
@@ -40,24 +43,39 @@ class CodeTourNotebookProvider implements vscode.NotebookSerializer {
     let cells: vscode.NotebookCellData[] = [];
 
     // Title cell
-    cells.push(new vscode.NotebookCellData(1,
-      `## ![Icon](${SMALL_ICON_URL})&nbsp;&nbsp; CodeTour (${tour.title}) - ${steps.length} steps\n\n${tour.description === undefined ? '' : tour.description}`,
-      'markdown'))
+    cells.push(
+      new vscode.NotebookCellData(
+        1,
+        `## ![Icon](${SMALL_ICON_URL})&nbsp;&nbsp; CodeTour (${tour.title}) - ${
+          steps.length
+        } steps\n\n${tour.description === undefined ? "" : tour.description}`,
+        "markdown"
+      )
+    );
 
     steps.forEach((step, index) => {
-      cells.push(new vscode.NotebookCellData(2,
-        step.contents,
-        step.language,
-        [new vscode.NotebookCellOutput([
-          new vscode.NotebookCellOutputItem('text/markdown', `_Step #${index + 1} of ${steps.length}:_ ${step.description} ([View File](${step.uri}))`)
-        ])]
-      ))
-    })
+      const cell = new vscode.NotebookCellData(2, step.contents, step.language);
+      cell.outputs = [
+        new vscode.NotebookCellOutput([
+          new vscode.NotebookCellOutputItem(
+            new TextEncoder().encode(
+              `_Step #${index + 1} of ${steps.length}:_ ${
+                step.description
+              } ([View File](${step.uri}))`
+            ),
+            "text/markdown"
+          )
+        ])
+      ];
+    });
 
-    return new vscode.NotebookData(cells, new vscode.NotebookDocumentMetadata(true))
+    return new vscode.NotebookData(cells);
   }
 
-  async serializeNotebook(data: vscode.NotebookData, token: any): Promise<Uint8Array> {
+  async serializeNotebook(
+    data: vscode.NotebookData,
+    token: any
+  ): Promise<Uint8Array> {
     return this.originalContent;
   }
 }

src/notebook/index.ts

@@ -43,14 +43,19 @@ export function registerRecorderCommands() {
     const file = title
       .toLocaleLowerCase()
       .replace(/\s/g, "-")
-      .replace(/[^\w\d-_]/g, "");
+      .replace(/[^\w\d\-_]/g, "");
 
     const prefix = workspaceRoot.path.endsWith("/")
       ? workspaceRoot.path
       : `${workspaceRoot.path}/`;
 
+    const customTourDirectory = vscode.workspace
+      .getConfiguration(EXTENSION_NAME)
+      .get("customTourDirectory", null);
+    const tourDirectory = customTourDirectory || ".tours";
+
     return workspaceRoot.with({
-      path: `${prefix}.tours/${file}.tour`
+      path: `${prefix}${tourDirectory}/${file}.tour`
     });
   }
 
@@ -257,9 +262,8 @@ export function registerRecorderCommands() {
         }
       };
 
-      const previousStep = store.activeTour!.tour.steps[
-        store.activeTour!.step - 1
-      ];
+      const previousStep =
+        store.activeTour!.tour.steps[store.activeTour!.step - 1];
 
       // Check whether the end-user forgot to "reset"
       // the selection from the previous step, and if so,