VSCODE-181: Move extension commands into a single file in src/commands (#185)

Author: Anemy

src/commands/README.md

@@ -1,70 +1,5 @@
 # Extension Commands
 
-This README contains a list of all of the commands the extension handles.
+The `index.ts` file in this folder contains a list of all of the commands the extension handles.
 
-These commands are defined in `package.json`, registered from `extension.ts` to
-handlers defined in `mdb.ts`.
-Think RPC handlers.
-
-## Connection commands
-
-- `mdb.connect`
-- `mdb.connectWithURI`
-- `mdb.disconnect`
-- `mdb.removeConnection`
-- `mdb.reload`
-- `mdb.refresh`
-
-- `mdb.openMongoDBShell`
-- `mdb.openOverviewPage`
-
-## General database commands
-
-- `mdb.createDatabase`
-- `mdb.createCollection`
-
-- `mdb.createDocument`
-- `mdb.removeDocument`
-- `mdb.updateDocument`
-
-- `mdb.viewCollectionDocuments`
-
-## Query commands (json input fields)
-
-- `mdb.aggregate`
-- `mdb.explainAggregate`
-- `mdb.find`
-- `mdb.findOne`
-- `mdb.findBy` _-> pick(value) -> pick(key) -> show_
-- `mdb.explain` _Uses the active cursor (only possible after a query)_
-- `mdb.getMore` _Uses the active cursor (only possible after a query)_
-
-## Playground commands
-
-- `mdb.playground`
-- `mdb.createPlayground`
-- `mdb.removePlayground`
-- `mdb.runPlaygroundBlock`
-- `mdb.runSelectedPlaygroundBlocks`
-- `mdb.runAllPlaygroundBlocks`
-- `mdb.createNewPlaygroundFromViewAction`
-- `mdb.createNewPlaygroundFromOverviewPage`
-
-## Index commands
-
-- `mdb.createIndex`
-- `mdb.getIndex`
-- `mdb.removeIndex`
-
-## Import/Export commands
-
-- `mdb.importDocument`
-
-- `mdb.import`
-- `mdb.cancelImport`
-- `mdb.export`
-- `mdb.cancelExport`
-
-## CodeLens commands
-
-- `mdb.codeLens.showMoreDocumentsClicked`
+These commands are defined in `package.json` and registered in our extension.

src/commands/index.ts

@@ -0,0 +1,55 @@
+
+enum EXTENSION_COMMANDS {
+  MDB_CONNECT = 'mdb.connect',
+  MDB_CONNECT_WITH_URI = 'mdb.connectWithURI',
+  MDB_OPEN_OVERVIEW_PAGE = 'mdb.openOverviewPage',
+  MDB_DISCONNECT = 'mdb.disconnect',
+  MDB_REMOVE_CONNECTION = 'mdb.removeConnection',
+
+  MDB_OPEN_MDB_SHELL = 'mdb.openMongoDBShell',
+  MDB_OPEN_MDB_SHELL_FROM_TREE_VIEW = 'mdb.treeViewOpenMongoDBShell',
+
+  MDB_CREATE_PLAYGROUND = 'mdb.createPlayground',
+  MDB_CREATE_PLAYGROUND_FROM_OVERVIEW_PAGE = 'mdb.createNewPlaygroundFromOverviewPage',
+  MDB_RUN_SELECTED_PLAYGROUND_BLOCKS = 'mdb.runSelectedPlaygroundBlocks',
+  MDB_RUN_ALL_PLAYGROUND_BLOCKS = 'mdb.runAllPlaygroundBlocks',
+  MDB_RUN_ALL_OR_SELECTED_PLAYGROUND_BLOCKS = 'mdb.runPlayground',
+
+  MDB_CHANGE_ACTIVE_CONNECTION = 'mdb.changeActiveConnection',
+  MDB_REFRESH_PLAYGROUNDS = 'mdb.refreshPlaygrounds',
+  MDB_START_LANGUAGE_STREAM_LOGS = 'mdb.startStreamLanguageServerLogs',
+
+  MDB_CODELENS_SHOW_MORE_DOCUMENTS = 'mdb.codeLens.showMoreDocumentsClicked',
+
+  // Commands from the tree view.
+  MDB_ADD_CONNECTION = 'mdb.addConnection',
+  MDB_ADD_CONNECTION_WITH_URI = 'mdb.addConnectionWithURI',
+  MDB_REFRESH_PLAYGROUNDS_FROM_TREE_VIEW = 'mdb.refreshPlaygroundsFromTreeView',
+  MDB_OPEN_PLAYGROUND_FROM_TREE_VIEW = 'mdb.openPlaygroundFromTreeItem',
+  MDB_CONNECT_TO_CONNECTION_TREE_VIEW = 'mdb.connectToConnectionTreeItem',
+  MDB_CREATE_PLAYGROUND_FROM_VIEW_ACTION = 'mdb.createNewPlaygroundFromViewAction',
+  MDB_CREATE_PLAYGROUND_FROM_PLAYGROUND_EXPLORER = 'mdb.createNewPlaygroundFromPlaygroundExplorer',
+  MDB_DISCONNECT_FROM_CONNECTION_TREE_VIEW = 'mdb.disconnectFromConnectionTreeItem',
+  MDB_REFRESH_CONNECTION = 'mdb.refreshConnection',
+  MDB_COPY_CONNECTION_STRING = 'mdb.copyConnectionString',
+  MDB_REMOVE_CONNECTION_TREE_VIEW = 'mdb.treeItemRemoveConnection',
+  MDB_RENAME_CONNECTION = 'mdb.renameConnection',
+  MDB_ADD_DATABASE = 'mdb.addDatabase',
+  MDB_SEARCH_FOR_DOCUMENTS = 'mdb.searchForDocuments',
+  MDB_COPY_DATABASE_NAME = 'mdb.copyDatabaseName',
+  MDB_DROP_DATABASE = 'mdb.dropDatabase',
+  MDB_REFRESH_DATABASE = 'mdb.refreshDatabase',
+  MDB_ADD_COLLECTION = 'mdb.addCollection',
+  MDB_COPY_COLLECTION_NAME = 'mdb.copyCollectionName',
+  MDB_DROP_COLLECTION = 'mdb.dropCollection',
+  MDB_VIEW_DOCUMENT = 'mdb.viewDocument',
+  MDB_VIEW_COLLECTION_DOCUMENTS = 'mdb.viewCollectionDocuments',
+  MDB_REFRESH_COLLECTION = 'mdb.refreshCollection',
+  MDB_REFRESH_DOCUMENT_LIST = 'mdb.refreshDocumentList',
+  MDB_REFRESH_SCHEMA = 'mdb.refreshSchema',
+  MDB_COPY_SCHEMA_FIELD_NAME = 'mdb.copySchemaFieldName',
+  MDB_REFRESH_INDEXES = 'mdb.refreshIndexes',
+  MDB_CREATE_INDEX_TREE_VIEW = 'mdb.createIndexFromTreeView'
+}
+
+export default EXTENSION_COMMANDS;

src/editors/activeConnectionCodeLensProvider.ts

@@ -1,4 +1,5 @@
 import * as vscode from 'vscode';
+import EXTENSION_COMMANDS from '../commands';
 
 export default class ActiveConnectionCodeLensProvider
   implements vscode.CodeLensProvider {
@@ -35,7 +36,7 @@ export default class ActiveConnectionCodeLensProvider
 
     codeLens.command = {
       title: message,
-      command: 'mdb.changeActiveConnection',
+      command: EXTENSION_COMMANDS.MDB_CHANGE_ACTIVE_CONNECTION,
       arguments: []
     };
 

src/editors/collectionDocumentsCodeLensProvider.ts

@@ -1,5 +1,6 @@
 import { URLSearchParams } from 'url';
 import * as vscode from 'vscode';
+import EXTENSION_COMMANDS from '../commands';
 
 import CollectionDocumentsOperationStore from './collectionDocumentsOperationsStore';
 import {
@@ -88,7 +89,7 @@ export default class CollectionDocumentsCodeLensProvider implements vscode.CodeL
     codeLens.command = {
       title: commandTitle,
       tooltip: commandTooltip,
-      command: 'mdb.codeLens.showMoreDocumentsClicked',
+      command: EXTENSION_COMMANDS.MDB_CODELENS_SHOW_MORE_DOCUMENTS,
       arguments: [{ operationId, connectionId, namespace }]
     };
 

src/editors/partialExecutionCodeLensProvider.ts

@@ -1,4 +1,5 @@
 import * as vscode from 'vscode';
+import EXTENSION_COMMANDS from '../commands';
 
 export default class PartialExecutionCodeLensProvider
   implements vscode.CodeLensProvider {
@@ -33,11 +34,11 @@ export default class PartialExecutionCodeLensProvider
   }
 
   public resolveCodeLens?(codeLens: vscode.CodeLens): vscode.CodeLens {
-    const message = `► Run Selected Lines From Playground`;
+    const message = '► Run Selected Lines From Playground';
 
     codeLens.command = {
       title: message,
-      command: 'mdb.runSelectedPlaygroundBlocks',
+      command: EXTENSION_COMMANDS.MDB_RUN_SELECTED_PLAYGROUND_BLOCKS,
       arguments: [message]
     };
 

src/explorer/explorerTreeController.ts

@@ -8,6 +8,7 @@ import { DOCUMENT_LIST_ITEM, CollectionTypes } from './documentListTreeItem';
 import ConnectionTreeItem from './connectionTreeItem';
 import { SavedConnection } from '../storage/storageController';
 import { sortTreeItemsByLabel } from './treeItemUtils';
+import EXTENSION_COMMANDS from '../commands';
 
 const log = createLogger('explorer controller');
 
@@ -98,7 +99,7 @@ implements vscode.TreeDataProvider<vscode.TreeItem> {
 
         if (selectedItem.contextValue === DOCUMENT_ITEM) {
           vscode.commands.executeCommand(
-            'mdb.viewDocument',
+            EXTENSION_COMMANDS.MDB_VIEW_DOCUMENT,
             event.selection[0]
           );
         }
@@ -108,7 +109,7 @@ implements vscode.TreeDataProvider<vscode.TreeItem> {
           selectedItem.type === CollectionTypes.view
         ) {
           vscode.commands.executeCommand(
-            'mdb.viewCollectionDocuments',
+            EXTENSION_COMMANDS.MDB_VIEW_COLLECTION_DOCUMENTS,
             event.selection[0]
           );
         }

src/explorer/playgroundsTree.ts

@@ -5,6 +5,7 @@ import PlaygroundsTreeHeader from './playgroundsTreeHeader';
 import { PLAYGROUND_ITEM } from './playgroundsTreeItem';
 import { createLogger } from '../logging';
 import PlaygroundsTreeItem from './playgroundsTreeItem';
+import EXTENSION_COMMANDS from '../commands';
 
 const micromatch = require('micromatch');
 const log = createLogger('playgrounds tree controller');
@@ -122,7 +123,7 @@ implements vscode.TreeDataProvider<vscode.TreeItem> {
 
         if (selectedItem.contextValue === PLAYGROUND_ITEM) {
           vscode.commands.executeCommand(
-            'mdb.openPlaygroundFromTreeItem',
+            EXTENSION_COMMANDS.MDB_OPEN_PLAYGROUND_FROM_TREE_VIEW,
             selectedItem
           );
         }