feat: trim selected text for export to language (VSCODE-296) (#369)

* feat: trim selected text for export to language (VSCODE-296)

* docs: update readme

* refactor: bump some dependencies

* chore: bump vscode engine

* feat: identify more cases for showing up export to language actions

* feat: do not provide driver syntax link for csharp

Author: alenakhineika

README.md

@@ -24,6 +24,7 @@ MongoDB Playgrounds are the most convenient way to prototype and execute CRUD op
 - Edit documents returned by your playground.
 - Save your playgrounds in your workspace and use them to document how your application interacts with MongoDB.
 - Build aggregations quickly with helpful and well-commented stage snippets.
+- Export your queries and aggregations to one of the supported languages: Java, Node, C#, and Python 3
 
 ![Playgrounds](resources/screenshots/playground.png)
 

package-lock.json

@@ -61,7 +61,7 @@
     "release-draft": "node ./scripts/release-draft.js"
   },
   "engines": {
-    "vscode": "^1.58.1",
+    "vscode": "^1.62.0",
     "node": "^14.17.3",
     "npm": "^7.19.0"
   },
@@ -264,7 +264,7 @@
       },
       {
         "command": "mdb.exportToNode",
-        "title": "MongoDB: Export To Node"
+        "title": "MongoDB: Export To Node.js"
       },
       {
         "command": "mdb.addConnection",
@@ -601,6 +601,22 @@
           "command": "mdb.runAllPlaygroundBlocks",
           "when": "editorLangId == mongodb"
         },
+        {
+          "command": "mdb.exportToPython",
+          "when": "editorLangId == mongodb"
+        },
+        {
+          "command": "mdb.exportToJava",
+          "when": "editorLangId == mongodb"
+        },
+        {
+          "command": "mdb.exportToCsharp",
+          "when": "editorLangId == mongodb"
+        },
+        {
+          "command": "mdb.exportToNode",
+          "when": "editorLangId == mongodb"
+        },
         {
           "command": "mdb.refreshPlaygroundsFromTreeView",
           "when": "false"
@@ -823,7 +839,7 @@
           "items": {
             "type": "string"
           },
-          "description": "Files and folders to exclude while searching for playground in the the current workspace.",
+          "description": "Files and folders to exclude while searching for playgrounds in the the current workspace.",
           "default": [
             "**/.*",
             "**/_output/**",
@@ -885,68 +901,68 @@
     }
   },
   "dependencies": {
-    "@babel/parser": "^7.15.0",
-    "@babel/traverse": "^7.15.0",
+    "@babel/parser": "^7.16.4",
+    "@babel/traverse": "^7.16.3",
     "@fortawesome/fontawesome-svg-core": "^1.2.36",
     "@fortawesome/free-solid-svg-icons": "^5.15.4",
-    "@fortawesome/react-fontawesome": "^0.1.15",
-    "@iconify-icons/codicon": "^1.1.18",
+    "@fortawesome/react-fontawesome": "^0.1.16",
+    "@iconify-icons/codicon": "^1.1.25",
     "@iconify/react": "^1.1.4",
     "@leafygreen-ui/logo": "^6.1.0",
     "@leafygreen-ui/toggle": "^7.0.4",
-    "@mongosh/browser-runtime-electron": "^1.0.4",
-    "@mongosh/i18n": "^1.0.4",
-    "@mongosh/service-provider-server": "^1.0.4",
-    "@mongosh/shell-api": "^1.0.4",
-    "analytics-node": "^5.0.0",
-    "bson": "^4.4.1",
+    "@mongosh/browser-runtime-electron": "^1.1.2",
+    "@mongosh/i18n": "^1.1.2",
+    "@mongosh/service-provider-server": "^1.1.2",
+    "@mongosh/shell-api": "^1.1.2",
+    "analytics-node": "^5.1.2",
+    "bson": "^4.5.4",
     "bson-transpilers": "^1.2.0",
     "classnames": "^2.3.1",
     "debug": "^4.3.2",
-    "dotenv": "^8.2.0",
+    "dotenv": "^8.6.0",
     "micromatch": "^4.0.4",
-    "mongodb": "^4.1.3",
-    "mongodb-cloud-info": "^1.1.2",
+    "mongodb": "^4.2.0",
+    "mongodb-cloud-info": "^1.1.3",
     "mongodb-connection-model": "^21.5.4",
     "mongodb-data-service": "^21.5.4",
     "mongodb-js-errors": "^0.5.0",
     "mongodb-ns": "^2.2.0",
     "mongodb-schema": "^9.0.0",
     "numeral": "^2.0.6",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
-    "react-redux": "^7.2.4",
-    "redux": "^4.1.1",
-    "ts-log": "^2.2.3",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "react-redux": "^7.2.6",
+    "redux": "^4.1.2",
+    "ts-log": "^2.2.4",
     "uuid": "^8.3.2",
     "vscode-languageclient": "^7.0.0",
     "vscode-languageserver": "^7.0.0",
-    "vscode-languageserver-textdocument": "^1.0.1",
-    "ws": "^7.4.2"
+    "vscode-languageserver-textdocument": "^1.0.2",
+    "ws": "^7.5.5"
   },
   "devDependencies": {
-    "@types/analytics-node": "^3.1.5",
-    "@types/babel__core": "^7.1.15",
+    "@types/analytics-node": "^3.1.7",
+    "@types/babel__core": "^7.1.16",
     "@types/babel__traverse": "^7.14.2",
-    "@types/chai": "^4.2.21",
+    "@types/chai": "^4.2.22",
     "@types/chai-fs": "^2.0.2",
     "@types/chai-json-schema": "^1.4.6",
     "@types/classnames": "^2.3.1",
     "@types/debug": "^4.1.7",
-    "@types/enzyme": "^3.10.9",
-    "@types/glob": "^7.1.4",
+    "@types/enzyme": "^3.10.10",
+    "@types/glob": "^7.2.0",
     "@types/jest": "^26.0.24",
-    "@types/mocha": "^8.2.0",
-    "@types/node": "^14.14.22",
-    "@types/react": "^17.0.15",
-    "@types/react-dom": "^17.0.9",
-    "@types/sinon": "^9.0.10",
-    "@types/uuid": "^8.3.1",
-    "@types/vscode": "^1.58.1",
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^14.17.33",
+    "@types/react": "^17.0.35",
+    "@types/react-dom": "^17.0.11",
+    "@types/sinon": "^9.0.11",
+    "@types/uuid": "^8.3.3",
+    "@types/vscode": "^1.62.0",
     "@types/ws": "^7.4.7",
-    "@typescript-eslint/eslint-plugin": "^4.29.0",
-    "@typescript-eslint/parser": "^4.29.0",
-    "autoprefixer": "^9.7.5",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "autoprefixer": "^9.8.8",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-fs": "^2.0.0",
@@ -955,26 +971,26 @@
     "cli-ux": "^5.6.3",
     "context-map-webpack-plugin": "^0.1.0",
     "cross-env": "^7.0.3",
-    "css-loader": "^3.4.2",
+    "css-loader": "^3.6.0",
     "depcheck": "^1.4.2",
     "download": "^8.0.0",
     "enzyme": "^3.11.0",
     "enzyme-adapter-react-16": "^1.15.6",
     "eslint": "^6.8.0",
     "eslint-config-mongodb-js": "^5.0.3",
-    "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-mocha": "^8.2.0",
     "execa": "^1.0.0",
-    "glob": "^7.1.7",
-    "jest": "^26.5.2",
-    "jest-junit": "^12.2.0",
+    "glob": "^7.2.0",
+    "jest": "^26.6.3",
+    "jest-junit": "^12.3.0",
     "jest-transform-stub": "^2.0.0",
     "less": "^3.13.1",
     "less-loader": "^5.0.0",
     "meow": "^9.0.0",
     "mkdirp": "^1.0.4",
-    "mocha": "^8.2.1",
-    "mocha-junit-reporter": "^2.0.0",
-    "mocha-multi": "^1.1.3",
+    "mocha": "^8.4.0",
+    "mocha-junit-reporter": "^2.0.2",
+    "mocha-multi": "^1.1.5",
     "mongodb-ace-autocompleter": "^0.8.0",
     "mongodb-build-info": "^1.2.0",
     "mongodb-runner": "^4.8.3",
@@ -986,15 +1002,15 @@
     "semver": "^7.3.5",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.7.0",
-    "style-loader": "^1.1.3",
-    "ts-jest": "^26.5.0",
-    "ts-loader": "^8.0.14",
+    "style-loader": "^1.3.0",
+    "ts-jest": "^26.5.6",
+    "ts-loader": "^8.3.0",
     "ts-node": "^9.1.1",
-    "typescript": "^4.3.5",
-    "vsce": "^1.96.1",
+    "typescript": "^4.5.2",
+    "vsce": "^1.103.1",
     "vscode-test": "^1.6.1",
     "webpack": "^4.46.0",
-    "webpack-cli": "^3.3.11",
+    "webpack-cli": "^3.3.12",
     "xvfb-maybe": "^0.2.1",
     "yargs-parser": "^20.2.9"
   },

package.json

@@ -51,7 +51,8 @@ const cli = meow(
     ui.succeed(
       `Downloaded to ${path.join(cli.flags.dest as string, 'mongodb.tmLanguage.json')}`
     );
-  } catch (err) {
-    ui.fail(`Download failed: ${err.message}`);
+  } catch (error) {
+    const printableError = error as { message: string };
+    ui.fail(`Download failed: ${printableError.message}`);
   }
 })();

scripts/update-grammar.ts

@@ -210,7 +210,8 @@ export default class ConnectionController {
     try {
       return this.addNewConnectionStringAndConnect(connectionString);
     } catch (error) {
-      void vscode.window.showErrorMessage(error.message);
+      const printableError = error as { message: string };
+      void vscode.window.showErrorMessage(printableError.message);
 
       return false;
     }
@@ -384,7 +385,7 @@ export default class ConnectionController {
     // Override the default connection `appname`.
     connectionModel.appname = `${name} ${version}`;
 
-    const newDataService: DataServiceType = new DataService(connectionModel);
+    const newDataService: any = new DataService(connectionModel);
     const _connect = promisify(newDataService.connect.bind(newDataService));
     let connectError;
 
@@ -463,7 +464,8 @@ export default class ConnectionController {
 
       return connectResult.successfullyConnected;
     } catch (error) {
-      void vscode.window.showErrorMessage(error.message);
+      const printableError = error as { message: string };
+      void vscode.window.showErrorMessage(printableError.message);
 
       return false;
     }

src/connectionController.ts

@@ -64,11 +64,11 @@ export default class CodeActionProvider implements vscode.CodeActionProvider {
       };
       codeActions.push(exportToCsharpCommand);
 
-      const exportToJSCommand = new vscode.CodeAction('Export To Node', vscode.CodeActionKind.Empty);
+      const exportToJSCommand = new vscode.CodeAction('Export To Node.js', vscode.CodeActionKind.Empty);
       exportToJSCommand.command = {
         command: EXTENSION_COMMANDS.MDB_EXPORT_TO_NODE,
-        title: 'Export To Node',
-        tooltip: 'Export To Node'
+        title: 'Export To Node.js',
+        tooltip: 'Export To Node.js'
       };
       codeActions.push(exportToJSCommand);
     }

src/editors/codeActionProvider.ts

@@ -53,15 +53,17 @@ implements vscode.CodeLensProvider {
     };
     exportToLanguageCodeLenses.push(importStatementsCodeLens);
 
-    driverSyntaxCodeLens.command = {
-      title: this._exportToLanguageAddons.driverSyntax ? 'Exclude Driver Syntax' : 'Include Driver Syntax',
-      command: EXTENSION_COMMANDS.MDB_CHANGE_EXPORT_TO_LANGUAGE_ADDONS,
-      arguments: [{
-        ...this._exportToLanguageAddons,
-        driverSyntax: !this._exportToLanguageAddons.driverSyntax
-      }]
-    };
-    exportToLanguageCodeLenses.push(driverSyntaxCodeLens);
+    if (this._exportToLanguageAddons.language !== ExportToLanguages.CSHARP) {
+      driverSyntaxCodeLens.command = {
+        title: this._exportToLanguageAddons.driverSyntax ? 'Exclude Driver Syntax' : 'Include Driver Syntax',
+        command: EXTENSION_COMMANDS.MDB_CHANGE_EXPORT_TO_LANGUAGE_ADDONS,
+        arguments: [{
+          ...this._exportToLanguageAddons,
+          driverSyntax: !this._exportToLanguageAddons.driverSyntax
+        }]
+      };
+      exportToLanguageCodeLenses.push(driverSyntaxCodeLens);
+    }
 
     if (
       this._exportToLanguageAddons.language === ExportToLanguages.JAVA &&

src/editors/exportToLanguageCodeLensProvider.ts

@@ -315,7 +315,7 @@ export default class PlaygroundController {
   }
 
   _getAllText(): string {
-    return this._activeTextEditor?.document.getText() || '';
+    return this._activeTextEditor?.document.getText().trim() || '';
   }
 
   _getSelectedText(selection: vscode.Range): string {

src/editors/playgroundController.ts

@@ -317,11 +317,12 @@ export default class CollectionTreeItem extends vscode.TreeItem
       this._dataService.estimatedCount(
         this.namespace,
         {}, // No options.
-        (err: Error | undefined, count: number) => {
-          if (err) {
+        (error: Error | undefined, count: number) => {
+          if (error) {
+            const printableError = error as { message: string };
             return reject(
               new Error(
-                `Unable to get collection document count: ${err.message}`
+                `Unable to get collection document count: ${printableError.message}`
               )
             );
           }
@@ -373,9 +374,9 @@ export default class CollectionTreeItem extends vscode.TreeItem
           return null;
         }
       });
-    } catch (e) {
+    } catch (error) {
       return Promise.reject(
-        new Error(`An error occured parsing the collection name: ${e}`)
+        new Error(`An error occured parsing the collection name: ${error}`)
       );
     }
 
@@ -386,10 +387,11 @@ export default class CollectionTreeItem extends vscode.TreeItem
     return new Promise((resolve) => {
       this._dataService.dropCollection(
         `${this.databaseName}.${collectionName}`,
-        (err: Error | null, successfullyDroppedCollection = false) => {
-          if (err) {
+        (error: Error | null, successfullyDroppedCollection = false) => {
+          if (error) {
+            const printableError = error as { message: string };
             void vscode.window.showErrorMessage(
-              `Drop collection failed: ${err.message}`
+              `Drop collection failed: ${printableError.message}`
             );
 
             return resolve(false);

src/explorer/collectionTreeItem.ts

@@ -139,13 +139,13 @@ export default class ConnectionTreeItem extends vscode.TreeItem
       const runListDatabases = promisify(dataService.listDatabases.bind(dataService));
       const dbs = await runListDatabases();
       return dbs.map(dbItem => dbItem.name);
-    } catch (err) {
-      if (isNotAuthorized(err)) {
+    } catch (error) {
+      if (isNotAuthorized(error)) {
         // Check for which databases privilages this user has, and list those.
         return this.listDatabasesUserHasAccessTo(dataService.client.client);
       }
-
-      throw new Error(`Unable to list databases: ${err.message}`);
+      const printableError = error as { message: string };
+      throw new Error(`Unable to list databases: ${printableError.message}`);
     }
   }