@mongosh/browser-runtime-electron 1.10.1 → 1.10.2

package/.depcheckrc

@@ -0,0 +1,13 @@
+ignores:
+ - '@mongodb-js/eslint-config-mongosh'
+ - '@mongodb-js/tsconfig-mongosh'
+ - '@mongodb-js/prettier-config-devtools'
+ - '@typescript-eslint/parser'
+ - '@typescript-eslint/eslint-plugin'
+ - chai
+ - sinon-chai
+ - sinon
+ - eslint-plugin-mocha
+ - eslint-config-mongodb-js
+ignore-patterns:
+ - .eslintrc.js

package/.eslintrc.js

@@ -1 +1,10 @@
-module.exports = require('../../config/eslintrc.base');
+const { fixCygwinPath } = require('@mongodb-js/eslint-config-mongosh/utils');
+
+module.exports = {
+  root: true,
+  extends: ['@mongodb-js/eslint-config-mongosh'],
+  parserOptions: {
+    tsconfigRootDir: fixCygwinPath(__dirname),
+    project: ['./tsconfig-lint.json'],
+  },
+};

package/.prettierignore

@@ -0,0 +1,6 @@
+**/lib
+**/dist
+**/node_modules
+**/test/fixtures
+**/*.nocov*
+**/*.wxs

package/.prettierrc.json

@@ -0,0 +1 @@
+"@mongodb-js/prettier-config-devtools"

package/AUTHORS

@@ -10,3 +10,4 @@ Michael Rose <michael_rose@gmx.de>
 github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
 Alena Khineika <alenakhineika@users.noreply.github.com>
 Martin Rodriguez Reboredo <yakoyoku@gmail.com>
+Le Roux Bodenstein <lerouxb@gmail.com>

package/README.md

@@ -5,7 +5,7 @@
 `Runtime` implementation that uses Node.js `vm` module as sandbox for
 code execution.
 
-``` js
+```js
 import { ElectronRuntime } from 'mongosh-browser-repl';
 
 const runtime = new ElectronRuntime(serviceProvider);
@@ -13,7 +13,7 @@ const runtime = new ElectronRuntime(serviceProvider);
 
 ##### Example: usage in Compass
 
-``` js
+```js
 import { Shell, ElectronRuntime } from 'mongosh-browser-repl';
 
 const runtime = new ElectronRuntime(

package/lib/electron-interpreter-environment.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { Context } from 'vm';
-import { ContextValue, InterpreterEnvironment } from '@mongosh/browser-runtime-core';
+import type { Context } from 'vm';
+import type { ContextValue, InterpreterEnvironment } from '@mongosh/browser-runtime-core';
 export declare class ElectronInterpreterEnvironment implements InterpreterEnvironment {
     private context;
     constructor(context: Context);

package/lib/electron-interpreter-environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"electron-interpreter-environment.js","sourceRoot":"","sources":["../src/electron-interpreter-environment.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAiC;AAOjC,MAAa,8BAA8B;IAGzC,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,YAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,UAAU,CAAC,IAAY;QACrB,OAAO,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAfD,wEAeC"}
+{"version":3,"file":"electron-interpreter-environment.js","sourceRoot":"","sources":["../src/electron-interpreter-environment.ts"],"names":[],"mappings":";;;;;;AACA,4CAAoB;AAOpB,MAAa,8BAA8B;IAGzC,YAAY,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,YAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,UAAU,CAAC,IAAY;QACrB,OAAO,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAfD,wEAeC"}

package/lib/electron-runtime.d.ts

@@ -1,5 +1,5 @@
-import { Runtime, Completion, RuntimeEvaluationListener, RuntimeEvaluationResult } from '@mongosh/browser-runtime-core';
-import { ServiceProvider } from '@mongosh/service-provider-core';
+import type { Runtime, Completion, RuntimeEvaluationListener, RuntimeEvaluationResult } from '@mongosh/browser-runtime-core';
+import type { ServiceProvider } from '@mongosh/service-provider-core';
 import type { MongoshBus } from '@mongosh/types';
 export declare class ElectronRuntime implements Runtime {
     private openContextRuntime;

package/lib/electron-runtime.js

@@ -5,7 +5,9 @@ const electron_interpreter_environment_1 = require("./electron-interpreter-envir
 const browser_runtime_core_1 = require("@mongosh/browser-runtime-core");
 class ElectronRuntime {
     constructor(serviceProvider, messageBus) {
-        const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+        const requireFunc = typeof __webpack_require__ === 'function'
+            ? __non_webpack_require__
+            : require;
         this.openContextRuntime = new browser_runtime_core_1.OpenContextRuntime(serviceProvider, new electron_interpreter_environment_1.ElectronInterpreterEnvironment({ require: requireFunc }), messageBus);
     }
     setEvaluationListener(listener) {

package/lib/electron-runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"electron-runtime.js","sourceRoot":"","sources":["../src/electron-runtime.ts"],"names":[],"mappings":";;;AACA,yFAE4C;AAE5C,wEAMuC;AAQvC,MAAa,eAAe;IAG1B,YAAY,eAAgC,EAAE,UAAuB;QAcnE,MAAM,WAAW,GAAG,OAAO,mBAAmB,KAAK,UAAU,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,OAAO,CAAC;QAElG,IAAI,CAAC,kBAAkB,GAAG,IAAI,yCAAkB,CAC9C,eAAe,EACf,IAAI,iEAA8B,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,EAC5D,UAAU,CACX,CAAC;IACJ,CAAC;IAED,qBAAqB,CAAC,QAAmC;QACvD,OAAO,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAY;QACzB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAY;QAC/B,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC;IACxD,CAAC;CACF;AAzCD,0CAyCC"}
+{"version":3,"file":"electron-runtime.js","sourceRoot":"","sources":["../src/electron-runtime.ts"],"names":[],"mappings":";;;AAAA,yFAAoF;AAQpF,wEAAmE;AAQnE,MAAa,eAAe;IAG1B,YAAY,eAAgC,EAAE,UAAuB;QAcnE,MAAM,WAAW,GACf,OAAO,mBAAmB,KAAK,UAAU;YACvC,CAAC,CAAC,uBAAuB;YACzB,CAAC,CAAC,OAAO,CAAC;QAEd,IAAI,CAAC,kBAAkB,GAAG,IAAI,yCAAkB,CAC9C,eAAe,EACf,IAAI,iEAA8B,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,EAC5D,UAAU,CACX,CAAC;IACJ,CAAC;IAED,qBAAqB,CACnB,QAAmC;QAEnC,OAAO,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAY;QACzB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAY;QAC/B,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAC;IACxD,CAAC;CACF;AA9CD,0CA8CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mongosh/browser-runtime-electron",
-  "version": "1.10.1",
+  "version": "1.10.2",
   "description": "Mongosh browser runtime electron",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -17,11 +17,15 @@
   "scripts": {
     "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register \"./{src,lib}/**/*.spec.ts\"",
     "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
-    "lint": "eslint --report-unused-disable-directives \"./{src,test}/**/*.{js,ts,tsx}\"",
-    "check": "npm run lint && depcheck --skip-missing=true",
+    "eslint": "eslint",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "check": "npm run lint && npm run depcheck",
+    "depcheck": "depcheck",
     "preprepublish": "rimraf ./lib",
-    "prepublish": "npm run compile-ts",
-    "compile-ts": "tsc -p tsconfig.json"
+    "prepublish": "npm run compile",
+    "compile": "tsc -p tsconfig.json",
+    "prettier": "prettier",
+    "reformat": "npm run prettier -- --write . && npm run eslint --fix"
   },
   "author": "",
   "license": "Apache-2.0",
@@ -32,15 +36,21 @@
     "unitTestsOnly": true
   },
   "devDependencies": {
-    "@mongosh/service-provider-server": "1.10.1",
+    "@mongodb-js/eslint-config-mongosh": "1.10.2",
+    "@mongodb-js/prettier-config-devtools": "^1.0.1",
+    "@mongodb-js/tsconfig-mongosh": "1.10.2",
+    "@mongosh/service-provider-server": "1.10.2",
     "@types/sinon": "^7.5.1",
-    "@types/sinon-chai": "^3.2.3",
+    "@types/sinon-chai": "^3.2.4",
+    "depcheck": "^1.4.3",
+    "eslint": "^7.25.0",
+    "prettier": "^2.8.8",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@mongosh/browser-runtime-core": "1.10.1",
-    "@mongosh/service-provider-core": "1.10.1",
-    "@mongosh/types": "1.10.1"
+    "@mongosh/browser-runtime-core": "1.10.2",
+    "@mongosh/service-provider-core": "1.10.2",
+    "@mongosh/types": "1.10.2"
   },
-  "gitHead": "05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7"
+  "gitHead": "9351a54cc24def10a97fe7f8c7b455c02fdce62e"
 }

package/src/electron-interpreter-environment.spec.ts

@@ -1,16 +1,16 @@
 import { ElectronInterpreterEnvironment } from './electron-interpreter-environment';
 import { expect } from 'chai';
 
-describe('IframeRuntime', () => {
-  describe('#sloppyEval', () => {
-    it('evaluates code in context', () => {
+describe('IframeRuntime', function () {
+  describe('#sloppyEval', function () {
+    it('evaluates code in context', function () {
       const env = new ElectronInterpreterEnvironment({ x: 2 });
       expect(env.sloppyEval('x + 1')).to.equal(3);
     });
   });
 
-  describe('#getContextObject', () => {
-    it('returns context', () => {
+  describe('#getContextObject', function () {
+    it('returns context', function () {
       const env = new ElectronInterpreterEnvironment({ x: 2 });
       expect(env.getContextObject().x).to.equal(2);
     });

package/src/electron-interpreter-environment.ts

@@ -1,8 +1,9 @@
-import vm, { Context } from 'vm';
+import type { Context } from 'vm';
+import vm from 'vm';
 
-import {
+import type {
   ContextValue,
-  InterpreterEnvironment
+  InterpreterEnvironment,
 } from '@mongosh/browser-runtime-core';
 
 export class ElectronInterpreterEnvironment implements InterpreterEnvironment {

package/src/electron-runtime.spec.ts

@@ -1,4 +1,5 @@
-import sinon, { SinonStubbedInstance } from 'sinon';
+import type { SinonStubbedInstance } from 'sinon';
+import sinon from 'sinon';
 import chai from 'chai';
 import sinonChai from 'sinon-chai';
 chai.use(sinonChai);
@@ -8,18 +9,20 @@ import { CliServiceProvider } from '@mongosh/service-provider-server';
 import { bson } from '@mongosh/service-provider-core';
 import { ElectronRuntime } from './electron-runtime';
 import { EventEmitter } from 'events';
-import { RuntimeEvaluationListener } from '@mongosh/browser-runtime-core';
+import type { RuntimeEvaluationListener } from '@mongosh/browser-runtime-core';
 
-describe('Electron runtime', function() {
+describe('Electron runtime', function () {
   let serviceProvider: SinonStubbedInstance<CliServiceProvider>;
   let messageBus: SinonStubbedInstance<EventEmitter>;
   let evaluationListener: SinonStubbedInstance<RuntimeEvaluationListener>;
   let electronRuntime: ElectronRuntime;
 
-  beforeEach(() => {
+  beforeEach(function () {
     serviceProvider = sinon.createStubInstance(CliServiceProvider);
     serviceProvider.bsonLibrary = bson;
-    serviceProvider.getConnectionInfo.resolves({ extraInfo: { uri: '' } } as any);
+    serviceProvider.getConnectionInfo.resolves({
+      extraInfo: { uri: '' },
+    } as any);
     messageBus = sinon.createStubInstance(EventEmitter);
     evaluationListener = sinon.createStubInstance(class FakeListener {});
     evaluationListener.onPrint = sinon.stub();
@@ -27,16 +30,16 @@ describe('Electron runtime', function() {
     electronRuntime.setEvaluationListener(evaluationListener as any);
   });
 
-  it('can evaluate simple js', async() => {
+  it('can evaluate simple js', async function () {
     const result = await electronRuntime.evaluate('2 + 2');
     expect(result.printable).to.equal(4);
   });
-  it('prints BSON help correctly', async() => {
+  it('prints BSON help correctly', async function () {
     const result = await electronRuntime.evaluate('ObjectId().help');
     expect(result.type).to.equal('Help');
   });
 
-  it('allows do declare variables', async() => {
+  it('allows do declare variables', async function () {
     await electronRuntime.evaluate('var x = 2');
     expect((await electronRuntime.evaluate('x')).printable).to.equal(2);
     await electronRuntime.evaluate('let y = 2');
@@ -45,82 +48,91 @@ describe('Electron runtime', function() {
     expect((await electronRuntime.evaluate('z')).printable).to.equal(2);
   });
 
-  it('allows do declare functions', async() => {
+  it('allows do declare functions', async function () {
     await electronRuntime.evaluate('function f() { return 2; }');
     expect((await electronRuntime.evaluate('f()')).printable).to.equal(2);
   });
 
-  it('can run help', async() => {
+  it('can run help', async function () {
     const result = await electronRuntime.evaluate('help');
     expect(result.type).to.equal('Help');
   });
 
-  it('can run show dbs', async() => {
+  it('can run show dbs', async function () {
     serviceProvider.listDatabases.resolves({
-      databases: []
+      databases: [],
     });
 
     const result = await electronRuntime.evaluate('show dbs');
     expect(result.type).to.equal('ShowDatabasesResult');
   });
 
-  it('can run show collections', async() => {
+  it('can run show collections', async function () {
     serviceProvider.listCollections.resolves([]);
 
     const result = await electronRuntime.evaluate('show collections');
     expect(result.type).to.equal('ShowCollectionsResult');
   });
 
-  it('allows to use require', async() => {
-    const result = await electronRuntime.evaluate('require("util").types.isDate(new Date())');
+  it('allows to use require', async function () {
+    const result = await electronRuntime.evaluate(
+      'require("util").types.isDate(new Date())'
+    );
     expect(result.printable).to.equal(true);
   });
 
-  it('can switch database', async() => {
-    expect(
-      (await electronRuntime.evaluate('db')).printable
-    ).not.to.equal('db1');
+  it('can switch database', async function () {
+    expect((await electronRuntime.evaluate('db')).printable).not.to.equal(
+      'db1'
+    );
 
     await electronRuntime.evaluate('use db1');
 
-    expect(
-      (await electronRuntime.evaluate('db')).printable
-    ).to.equal('db1');
+    expect((await electronRuntime.evaluate('db')).printable).to.equal('db1');
   });
 
-  it('allows to receive telemetry event passing a message bus', async() => {
+  it('allows to receive telemetry event passing a message bus', async function () {
     await electronRuntime.evaluate('use db1');
     expect(messageBus.emit).to.have.been.calledWith('mongosh:use');
   });
 
-  describe('onPrint', () => {
-    it('allows getting the output of print() statements', async() => {
+  describe('onPrint', function () {
+    it('allows getting the output of print() statements', async function () {
       await electronRuntime.evaluate('print("foo");');
       expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
-        sinon.match((array) => (
-          array.length === 1 &&
-          array[0].type === null &&
-          array[0].printable === 'foo')));
+        sinon.match(
+          (array) =>
+            array.length === 1 &&
+            array[0].type === null &&
+            array[0].printable === 'foo'
+        )
+      );
     });
 
-    it('allows getting the output of console.log() statements', async() => {
+    it('allows getting the output of console.log() statements', async function () {
       await electronRuntime.evaluate('console.log("foo");');
       expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
-        sinon.match((array) => (
-          array.length === 1 &&
-          array[0].type === null &&
-          array[0].printable === 'foo')));
+        sinon.match(
+          (array) =>
+            array.length === 1 &&
+            array[0].type === null &&
+            array[0].printable === 'foo'
+        )
+      );
     });
 
-    it('allows getting the output of multi-arg console.log() statements', async() => {
+    it('allows getting the output of multi-arg console.log() statements', async function () {
       await electronRuntime.evaluate('console.log("foo", "bar");');
       expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
-        sinon.match((array) => (
-          array.length === 2 &&
-          array[0].type === null &&
-          array[0].printable === 'foo' &&
-          array[1].type === null &&
-          array[1].printable === 'bar')));
+        sinon.match(
+          (array) =>
+            array.length === 2 &&
+            array[0].type === null &&
+            array[0].printable === 'foo' &&
+            array[1].type === null &&
+            array[1].printable === 'bar'
+        )
+      );
       expect(evaluationListener.onPrint).to.have.been.calledOnce;
     });
   });

package/src/electron-runtime.ts

@@ -1,17 +1,14 @@
-/* eslint-disable camelcase */
-import {
-  ElectronInterpreterEnvironment
-} from './electron-interpreter-environment';
+import { ElectronInterpreterEnvironment } from './electron-interpreter-environment';
 
-import {
+import type {
   Runtime,
-  OpenContextRuntime,
   Completion,
   RuntimeEvaluationListener,
-  RuntimeEvaluationResult
+  RuntimeEvaluationResult,
 } from '@mongosh/browser-runtime-core';
+import { OpenContextRuntime } from '@mongosh/browser-runtime-core';
 
-import { ServiceProvider } from '@mongosh/service-provider-core';
+import type { ServiceProvider } from '@mongosh/service-provider-core';
 import type { MongoshBus } from '@mongosh/types';
 
 declare const __webpack_require__: any;
@@ -34,7 +31,10 @@ export class ElectronRuntime implements Runtime {
     // changing this line: https://github.com/webpack/webpack/issues/5939 (it
     // seems that checking for `typeof __non_webpack_require__` does not work).
     //
-    const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    const requireFunc =
+      typeof __webpack_require__ === 'function'
+        ? __non_webpack_require__
+        : require;
 
     this.openContextRuntime = new OpenContextRuntime(
       serviceProvider,
@@ -43,7 +43,9 @@ export class ElectronRuntime implements Runtime {
     );
   }
 
-  setEvaluationListener(listener: RuntimeEvaluationListener): RuntimeEvaluationListener | null {
+  setEvaluationListener(
+    listener: RuntimeEvaluationListener
+  ): RuntimeEvaluationListener | null {
     return this.openContextRuntime.setEvaluationListener(listener);
   }
 

package/tsconfig-lint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*"],
+  "exclude": ["node_modules", "dist", "lib"]
+}

package/tsconfig.json

@@ -1,12 +1,8 @@
 {
-  "extends": "../../config/tsconfig.base.json",
+  "extends": "@mongodb-js/tsconfig-mongosh/tsconfig.common.json",
   "compilerOptions": {
     "outDir": "./lib"
   },
-  "include": [
-    "./src/**/*"
-  ],
-  "exclude": [
-    "./src/**/*.spec.*"
-  ]
+  "include": ["src/**/*"],
+  "exclude": ["./src/**/*.spec.*"]
 }

package/tsconfig.lint.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": [
-    "./src/**/*",
-    "./test/**/*"
-  ],
-  "exclude": []
-}