Make it easier to have unit tests in VSCode packages

Author: pokey

docs/contributing/CONTRIBUTING.md

@@ -76,6 +76,8 @@ Run the `workbench.action.debug.selectandstart` command and then select
 
 See [test-case-recorder.md](./test-case-recorder.md).
 
+It is also possible to write manual tests. When doing so, we have a convention that any test that must be run within a VSCode context (eg because it imports `"vscode"`), should be placed in a file with the suffix `.vscode.test.ts`. All other tests should end with just `.test.ts`. This allows us to run non-VSCode tests locally outside of VSCode using the `Run unit tests` launch config. These tests run much faster than the full VSCode test suite.
+
 ## Parse tree support
 
 ### Adding a new programming language

packages/cursorless-vscode-e2e/src/suite/backwardCompatibility.test.ts renamed to packages/cursorless-vscode-e2e/src/suite/backwardCompatibility.vscode.test.ts

@@ -9,5 +9,5 @@ import { runAllTestsInDir } from "../util/runAllTestsInDir";
  * @returns A promise that resolves when tests have finished running
  */
 export function run(): Promise<void> {
-  return runAllTestsInDir(path.join(getCursorlessRepoRoot(), "packages"));
+  return runAllTestsInDir(path.join(getCursorlessRepoRoot(), "packages"), true);
 }

packages/cursorless-vscode-e2e/src/suite/breakpoints.test.ts renamed to packages/cursorless-vscode-e2e/src/suite/breakpoints.vscode.test.ts

@@ -3,14 +3,15 @@
 
 import { getCursorlessRepoRoot } from "@cursorless/common";
 import * as path from "path";
-import { runAllTestsInDirs } from "../util/runAllTestsInDir";
-
-const testDirectories = ["cursorless-engine", "common"];
+import { runAllTestsInDir } from "../util/runAllTestsInDir";
 
+/**
+ * Runs all tests that don't have to be run within VSCode.
+ * @returns A promise that resolves when tests have finished running
+ */
 export function run(): Promise<void> {
-  return runAllTestsInDirs(
-    testDirectories.map((testDirectory) =>
-      path.resolve(getCursorlessRepoRoot(), `packages/${testDirectory}`),
-    ),
+  return runAllTestsInDir(
+    path.join(getCursorlessRepoRoot(), "packages"),
+    false,
   );
 }

packages/cursorless-vscode-e2e/src/suite/containingTokenTwice.test.ts renamed to packages/cursorless-vscode-e2e/src/suite/containingTokenTwice.vscode.test.ts

@@ -8,10 +8,7 @@ import { launchVscodeAndRunTests } from "../util/launchVscodeAndRunTests";
 
 (async function main() {
   // Note that we run all tests, including unit tests, in VSCode, even though
-  // unit tests could be run separately.  If we wanted to run unit tests
-  // separately, we could instead use `../runners/endToEndOnly` instead of
-  // `../runners/all` and then just call `await runUnitTests()` beforehand to
-  // run the unit tests directly, instead of as part of VSCode runner.
+  // unit tests could be run separately.
   const extensionTestsPath = path.resolve(
     getCursorlessRepoRoot(),
     "packages/test-harness/out/runners/all",

packages/cursorless-vscode-e2e/src/suite/crossCellsSetSelection.test.ts renamed to packages/cursorless-vscode-e2e/src/suite/crossCellsSetSelection.vscode.test.ts

@@ -6,11 +6,17 @@ import { promisify } from "util";
 
 const glob = promisify(globRaw);
 
-export function runAllTestsInDir(testRoot: string) {
-  return runAllTestsInDirs([testRoot]);
+export function runAllTestsInDir(
+  testRoot: string,
+  includeVscodeTests: boolean,
+) {
+  return runAllTestsInDirs([testRoot], includeVscodeTests);
 }
 
-export async function runAllTestsInDirs(testRoots: string[]): Promise<void> {
+export async function runAllTestsInDirs(
+  testRoots: string[],
+  includeVscodeTests: boolean,
+): Promise<void> {
   // Create the mocha test
   const mocha = new Mocha({
     ui: "tdd",
@@ -19,7 +25,11 @@ export async function runAllTestsInDirs(testRoots: string[]): Promise<void> {
   });
 
   for (const testRoot of testRoots) {
-    const files = await glob("**/**.test.js", { cwd: testRoot });
+    let files = await glob("**/**.test.js", { cwd: testRoot });
+
+    if (!includeVscodeTests) {
+      files = files.filter((f) => !f.endsWith("vscode.test.js"));
+    }
 
     // Add files to the test suite
     files.forEach((f) => mocha.addFile(path.resolve(testRoot, f)));