chore: add ability to run tests in VSCode UI with Mocha Test Explorer

.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "spec": ["testing/dummy.spec.ts"],
+  "exclude": ["packages/**", "node_modules/**"],
+  "node-option": ["no-experimental-strip-types=true"]
+}

CONTRIBUTING.md

@@ -15,6 +15,9 @@ MongoDB welcomes community contributions! If you’re interested in making a con
 1. Add comments around your new code that explain what's happening
 1. Commit and push your changes to your branch then submit a pull request
 
+## Running Tests on VSCode
+You can use the `mongosh.code-workspace` file along with the [Mocha Test Explorer](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-mocha-test-adapter) to run and debug tests in VSCode UI.
+
 ## Bugs
 
 You can report new bugs by

mongosh.code-workspace

@@ -0,0 +1,141 @@
+{
+  "folders": [
+    {
+      "name": "mongosh",
+      "path": "."
+    },
+    {
+      "name": "📦 @mongodb-js/eslint-config-mongosh",
+      "path": "configs/eslint-config-mongosh"
+    },
+    {
+      "name": "📦 @mongodb-js/tsconfig-mongosh",
+      "path": "configs/tsconfig-mongosh"
+    },
+    {
+      "name": "📦 @mongosh/docker-build-scripts",
+      "path": "scripts/docker"
+    },
+    {
+      "name": "📦 @mongosh/async-rewriter2",
+      "path": "packages/async-rewriter2"
+    },
+    {
+      "name": "📦 @mongosh/build",
+      "path": "packages/build"
+    },
+    {
+      "name": "📦 @mongosh/errors",
+      "path": "packages/errors"
+    },
+    {
+      "name": "📦 @mongosh/history",
+      "path": "packages/history"
+    },
+    {
+      "name": "📦 @mongosh/java-shell",
+      "path": "packages/java-shell"
+    },
+    {
+      "name": "📦 @mongosh/js-multiline-to-singleline",
+      "path": "packages/js-multiline-to-singleline"
+    },
+    {
+      "name": "📦 @mongosh/types",
+      "path": "packages/types"
+    },
+    {
+      "name": "📦 @mongosh/i18n",
+      "path": "packages/i18n"
+    },
+    {
+      "name": "📦 @mongosh/logging",
+      "path": "packages/logging"
+    },
+    {
+      "name": "📦 @mongosh/shell-bson",
+      "path": "packages/shell-bson"
+    },
+    {
+      "name": "📦 @mongosh/arg-parser",
+      "path": "packages/arg-parser"
+    },
+    {
+      "name": "📦 @mongosh/service-provider-core",
+      "path": "packages/service-provider-core"
+    },
+    {
+      "name": "📦 @mongosh/service-provider-node-driver",
+      "path": "packages/service-provider-node-driver"
+    },
+    {
+      "name": "📦 @mongosh/shell-api",
+      "path": "packages/shell-api"
+    },
+    {
+      "name": "📦 @mongosh/autocomplete",
+      "path": "packages/autocomplete"
+    },
+    {
+      "name": "📦 @mongosh/shell-evaluator",
+      "path": "packages/shell-evaluator"
+    },
+    {
+      "name": "📦 @mongosh/snippet-manager",
+      "path": "packages/snippet-manager"
+    },
+    {
+      "name": "📦 @mongosh/browser-runtime-core",
+      "path": "packages/browser-runtime-core"
+    },
+    {
+      "name": "📦 @mongosh/editor",
+      "path": "packages/editor"
+    },
+    {
+      "name": "📦 @mongosh/browser-runtime-electron",
+      "path": "packages/browser-runtime-electron"
+    },
+    {
+      "name": "📦 @mongosh/cli-repl",
+      "path": "packages/cli-repl"
+    },
+    {
+      "name": "📦 @mongosh/e2e-tests",
+      "path": "packages/e2e-tests"
+    },
+    {
+      "name": "📦 mongosh",
+      "path": "packages/mongosh"
+    },
+    {
+      "name": "📦 @mongosh/node-runtime-worker-thread",
+      "path": "packages/node-runtime-worker-thread"
+    },
+    {
+      "name": "📦 @mongosh/browser-repl",
+      "path": "packages/browser-repl"
+    },
+    {
+      "name": "📦 @mongosh/connectivity-tests",
+      "path": "packages/connectivity-tests"
+    }
+  ],
+  "settings": {
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "mochaExplorer.configFile": ".mocharc.json",
+    "mochaExplorer.timeout": 60000,
+    "mochaExplorer.files": "",
+    "mochaExplorer.ui": "bdd",
+    "mochaExplorer.esmLoader": false,
+    "mochaExplorer.monkeyPatch": true,
+    "mochaExplorer.autoload": true,
+    "testExplorer.codeLens": true,
+    "testExplorer.gutterDecoration": true
+  },
+  "extensions": {
+    "recommendations": [
+      "hbenl.vscode-mocha-test-adapter"
+    ]
+  }
+}

packages/arg-parser/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/arg-parser/package.json

@@ -11,7 +11,7 @@
     "unsafe-perm": true
   },
   "scripts": {
-    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\" --reporter \"../../configs/mocha-config-mongosh/reporter.ts\"",
+    "test": "mocha",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
     "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
     "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",

packages/async-rewriter2/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/async-rewriter2/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "pretest": "npm run compile",
     "benchmark": "node -r ts-node/register benchmark/index.ts",
-    "test": "mocha --experimental-vm-modules -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\" --reporter \"../../configs/mocha-config-mongosh/reporter.ts\"",
+    "test": "mocha --experimental-vm-modules",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
     "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
     "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",

packages/autocomplete/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/autocomplete/package.json

@@ -17,7 +17,7 @@
     "node": ">=14.15.1"
   },
   "scripts": {
-    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\" --reporter \"../../configs/mocha-config-mongosh/reporter.ts\"",
+    "test": "mocha",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
     "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
     "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",

packages/browser-repl/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/browser-repl/src/iframe-runtime/iframe-runtime.spec.ts

@@ -4,12 +4,12 @@ import type { ServiceProvider } from '@mongosh/service-provider-core';
 import * as bson from 'bson';
 
 describe('IframeRuntime', function () {
-  let runtime;
-  let serviceProvider;
+  let runtime: IframeRuntime;
+  let serviceProvider: ServiceProvider;
 
   beforeEach(function () {
     document.body.innerHTML = '';
-    serviceProvider = { bsonLibrary: bson };
+    serviceProvider = { bsonLibrary: bson } as unknown as ServiceProvider;
     runtime = new IframeRuntime(serviceProvider);
   });
 
@@ -21,8 +21,10 @@ describe('IframeRuntime', function () {
 
       const iframe = document.querySelector('iframe');
       expect(iframe).to.exist;
-      expect(iframe.style.display).to.equal('none');
-      expect(iframe.sandbox.value).to.equal('allow-same-origin');
+      expect((iframe as HTMLIFrameElement).style.display).to.equal('none');
+      expect((iframe as HTMLIFrameElement).sandbox.value).to.equal(
+        'allow-same-origin'
+      );
     });
   });
 
@@ -47,7 +49,9 @@ describe('IframeRuntime', function () {
     });
 
     it('does not interfere with other instances', async function () {
-      const other = new IframeRuntime({ bsonLibrary: bson } as ServiceProvider);
+      const other = new IframeRuntime({
+        bsonLibrary: bson,
+      } as unknown as ServiceProvider);
       await runtime.evaluate('x = 1');
       await other.evaluate('x = 2');
 

packages/browser-runtime-core/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/browser-runtime-core/package.json

@@ -15,7 +15,7 @@
     "url": "git://github.com/mongodb-js/mongosh.git"
   },
   "scripts": {
-    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\" --reporter \"../../configs/mocha-config-mongosh/reporter.ts\"",
+    "test": "mocha",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
     "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
     "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",

packages/browser-runtime-electron/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 60000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./{src,lib}/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}

packages/browser-runtime-electron/package.json

@@ -15,7 +15,7 @@
     "url": "git://github.com/mongodb-js/mongosh.git"
   },
   "scripts": {
-    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\" --reporter \"../../configs/mocha-config-mongosh/reporter.ts\"",
+    "test": "mocha",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
     "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
     "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",

packages/build/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "require": ["../../scripts/import-expansions.js", "ts-node/register"],
+  "timeout": 30000,
+  "reporter": "../../configs/mocha-config-mongosh/reporter.ts",
+  "spec": ["./src/**/*.spec.ts"],
+  "exclude": ["**/node_modules/**"]
+}