WIP: Format code in workspace

Author: znorman-harris

libs/shared/src/lib/idl-commands.interface.ts

@@ -59,6 +59,8 @@ export const IDL_COMMANDS = {
     ADD_DOCS_TO_FILE: `${BASE_CODE}addDocsToFile`,
     /** Formats a file */
     FORMAT_FILE: `${BASE_CODE}formatFile`,
+    /** Formats all files in a workspace */
+    FORMAT_WORKSPACE: `${BASE_CODE}formatWorkspace`,
     /** Generate task file */
     GENERATE_TASK: `${BASE_CODE}generateTask`,
     /** Migrate PRO code to the ENVI DL 3.0 API */

libs/translation/src/lib/languages/en/en.ts

@@ -48,6 +48,7 @@ export const EN: ITranslation = {
         disableProblemSetting: 'IDL: Disable Problem Code via Setting',
         fixProblem: 'IDL: Fix Problem for Code Action',
         formatFile: 'IDL: Format File',
+        formatWorkspace: 'IDL: Format Files in Workspace',
         generateTask: 'IDL: Generate ENVI or IDL Task',
         migrateToDL30API: 'IDL: Migrate Code to ENVI Deep Learning 3.0 API',
       },
@@ -112,6 +113,7 @@ export const EN: ITranslation = {
           'Error while disabling problem code via settings',
         fixProblem: 'Error while fixing problem from code action',
         formatFile: 'Error while formatting file',
+        formatWorkspace: 'Error while formatting workspace',
         generateTask: 'Error while generating task',
         migrateToDL30API: 'Error while migrating code',
       },
@@ -162,6 +164,12 @@ export const EN: ITranslation = {
       },
     },
     notifications: {
+      formatWorkspace: {
+        notAllFilesFormatted:
+          'Some files were not formatted, see logs for more details',
+        pickWorkspace:
+          'Specify the open workspace to format all IDL files for (Task and PRO)',
+      },
       initConfig: {
         noWorkspaceOpen: 'No currently open workspaces',
         allWorkspacesHaveConfig:
@@ -629,6 +637,7 @@ export const EN: ITranslation = {
       onDocumentFormatting: 'Problem formatting file',
       onDocumentFormattingProblemCode:
         'Unable to format code due to syntax error or problem in file',
+      onWorkspaceFormatting: 'Error while formatting files in workspace',
       onHover: 'Problem resolving hover help',
       onAddDocs: 'Problem adding/updating routine docs for file',
       onDidClose: 'Problem when closing file',
@@ -663,6 +672,9 @@ export const EN: ITranslation = {
       startDocsServer:
         'Error while starting local docs server, is the port already in use?',
     },
+    progress: {
+      formatWorkspace: 'Formatting workspace...',
+    },
     types: {
       unknown: {
         function: 'Unknown function',

libs/translation/src/lib/translation.interface.ts

@@ -27,6 +27,8 @@ export interface ICommandTranslation {
     addDocsToFile: string;
     /** Format file */
     formatFile: string;
+    /** Format all code in a workspace */
+    formatWorkspace: string;
     /** Generates a task file */
     generateTask: string;
     /** Migrate PRO code to the ENVI DL 3.0 API */
@@ -314,6 +316,13 @@ export interface ITranslation {
         /** Title of the dialog for picking workspace folders to initialize config files for */
         dialogTitle: string;
       };
+      /** Messages when formatting the workspace */
+      formatWorkspace: {
+        /** Title of the dialog for picking workspace to format files in */
+        pickWorkspace: string;
+        /** When there are files we failed to format */
+        notAllFilesFormatted: string;
+      };
     };
   };
   /** Translations related to configuring the extension */
@@ -453,6 +462,8 @@ export interface ITranslation {
       onDefinition: string;
       /** Error formatting */
       onDocumentFormatting: string;
+      /** Error formatting workspace */
+      onWorkspaceFormatting: string;
       /** Unable to format because of syntax error */
       onDocumentFormattingProblemCode: string;
       /** Auto-complete */
@@ -511,6 +522,11 @@ export interface ITranslation {
       /** Error when starting the docs server because of a port conflict */
       startDocsServer: string;
     };
+    /** Titles for progress messages */
+    progress: {
+      /** Progress for formatting workspace */
+      formatWorkspace: string;
+    };
     /** Messages for types */
     types: {
       /** When we encounter unknown things */

libs/vscode/client/src/lib/register-code-commands.ts

@@ -1,6 +1,6 @@
 import { MIGRATION_TYPE_LOOKUP } from '@idl/assembling/migrators-types';
 import { IDL_COMMAND_LOG } from '@idl/logger';
-import { IDL_COMMANDS, IDL_LANGUAGE_NAME } from '@idl/shared';
+import { CleanPath, IDL_COMMANDS, IDL_LANGUAGE_NAME } from '@idl/shared';
 import { IDL_TRANSLATION } from '@idl/translation';
 import { IAutoFixIDLDiagnostic } from '@idl/types/diagnostic';
 import {
@@ -18,6 +18,7 @@ import {
   ReplaceDocumentContent,
   VSCodeTelemetryLogger,
 } from '@idl/vscode/shared';
+import { basename } from 'path';
 import { ExtensionContext } from 'vscode';
 import * as vscode from 'vscode';
 
@@ -314,6 +315,85 @@ export function RegisterCodeCommands(ctx: ExtensionContext) {
     })
   );
 
+  ctx.subscriptions.push(
+    vscode.commands.registerCommand(
+      IDL_COMMANDS.CODE.FORMAT_WORKSPACE,
+      async (): Promise<boolean> => {
+        try {
+          LogCommandInfo('Format workspace');
+
+          /**
+           * Get workspace folders
+           */
+          const folders = vscode.workspace.workspaceFolders;
+
+          // make sure we have workspace folders
+          if (folders === undefined) {
+            vscode.window.showInformationMessage(
+              IDL_TRANSLATION.commands.notifications.initConfig.noWorkspaceOpen
+            );
+            return false;
+          }
+          // filter out folders that have existing idl.json
+          const checkFolders = folders.map((folder) =>
+            CleanPath(folder.uri.fsPath)
+          );
+
+          // target is what we return
+          const res = await vscode.window.showQuickPick(
+            checkFolders.map((folder) => {
+              return {
+                label: basename(folder),
+                description: folder,
+                target: folder, // return value
+              };
+            }),
+            {
+              title:
+                IDL_TRANSLATION.commands.notifications.formatWorkspace
+                  .pickWorkspace,
+              canPickMany: false,
+            }
+          );
+
+          // make sure we have a folder
+          if (res !== undefined) {
+            VSCodeTelemetryLogger(USAGE_METRIC_LOOKUP.RUN_COMMAND, {
+              idl_command: IDL_COMMANDS.CODE.FORMAT_WORKSPACE,
+            });
+
+            // format and get response
+            const resp = await LANGUAGE_SERVER_MESSENGER.sendRequest(
+              LANGUAGE_SERVER_MESSAGE_LOOKUP.FORMAT_WORKSPACE,
+              { folders: [res.target] }
+            );
+
+            // if we have failures alert user
+            if (resp.failures.length > 0) {
+              IDL_LOGGER.log({
+                type: 'warn',
+                content: [
+                  IDL_TRANSLATION.commands.notifications.formatWorkspace
+                    .notAllFilesFormatted,
+                  resp.failures,
+                ],
+                alert:
+                  IDL_TRANSLATION.commands.notifications.formatWorkspace
+                    .notAllFilesFormatted,
+              });
+            }
+          }
+        } catch (err) {
+          LogCommandError(
+            'Error while executing command to format files in workspace',
+            err,
+            cmdErrors.code.formatWorkspace
+          );
+        }
+      }
+    )
+  );
+
   ctx.subscriptions.push(
     vscode.commands.registerCommand(
       IDL_COMMANDS.CODE.GENERATE_TASK,

libs/vscode/events/messages/src/index.ts

@@ -1,12 +1,13 @@
+export * from './lib/lsp-messages.interface';
+export * from './lib/message-name-normalizer';
 export * from './lib/messages/folder-delete.message.interface';
+export * from './lib/messages/formatting-messages.interface';
 export * from './lib/messages/generate-task.message.interface';
 export * from './lib/messages/indexing.message.interface';
-export * from './lib/lsp-messages.interface';
-export * from './lib/message-name-normalizer';
 export * from './lib/messages/migrate-code.message.interface';
 export * from './lib/messages/notebook-to-pro-code.message.interface';
-export * from './lib/parse-server-message';
 export * from './lib/messages/rename.message.interface';
 export * from './lib/messages/retrieve-docs.message.interface';
-export * from './lib/serialize-server-message';
 export * from './lib/messages/workspace-config.message.interface';
+export * from './lib/parse-server-message';
+export * from './lib/serialize-server-message';

libs/vscode/events/messages/src/lib/lsp-messages.interface.ts

@@ -9,6 +9,9 @@ import {
 import {
   AddDocsMessage,
   FormatFileMessage,
+  FormatWorkspaceMessage,
+  FormatWorkspacePayload,
+  FormatWorkspaceResponse,
 } from './messages/formatting-messages.interface';
 import {
   GenerateTaskMessage,
@@ -29,6 +32,10 @@ import {
   INotebookToProCodeResponse,
   NotebookToProCodeMessage,
 } from './messages/notebook-to-pro-code.message.interface';
+import {
+  ProgressMessage,
+  ProgressMessagePayload,
+} from './messages/progress.message.interface';
 import {
   FileRenameMessage,
   IFileRenamePayload,
@@ -51,13 +58,15 @@ export type LanguageServerMessage =
   | AddDocsMessage
   | FileRenameMessage
   | FormatFileMessage
+  | FormatWorkspaceMessage
   | FolderDeleteMessage
   | GenerateTaskMessage
   | IndexingMessage
   | InitWorkspaceConfigMessage
   | LoggingMessage
   | MigrateCodeLSPMessage
   | NotebookToProCodeMessage
+  | ProgressMessage
   | RetrieveDocsMessage
   | UsageMetricLSPMessage
   | WorkspaceConfigMessage;
@@ -72,6 +81,8 @@ export type LanguageServerPayload<T extends LanguageServerMessage> =
     ? IFolderDeletePayload
     : T extends FormatFileMessage
     ? DocumentFormattingParams
+    : T extends FormatWorkspaceMessage
+    ? FormatWorkspacePayload
     : T extends GenerateTaskMessage
     ? IGenerateTaskPayload
     : T extends IndexingMessage
@@ -86,6 +97,8 @@ export type LanguageServerPayload<T extends LanguageServerMessage> =
     ? INotebookToProCodePayload
     : T extends RetrieveDocsMessage
     ? IRetrieveDocsPayload
+    : T extends ProgressMessage
+    ? ProgressMessagePayload
     : T extends UsageMetricLSPMessage
     ? IUsageMetricAndPayload<UsageMetric>
     : T extends WorkspaceConfigMessage
@@ -94,12 +107,14 @@ export type LanguageServerPayload<T extends LanguageServerMessage> =
 
 /** Strictly typed payloads to/from the language server */
 export type LanguageServerResponse<T extends LanguageServerMessage> =
-  T extends RetrieveDocsMessage
-    ? IRetrieveDocsResponse
+  T extends FormatWorkspaceMessage
+    ? FormatWorkspaceResponse
     : T extends MigrateCodeLSPMessage
     ? MigrateCodeLSPResponse
     : T extends NotebookToProCodeMessage
     ? INotebookToProCodeResponse
+    : T extends RetrieveDocsMessage
+    ? IRetrieveDocsResponse
     : any;
 
 /** Strictly typed lookup of language server messages */
@@ -112,6 +127,8 @@ export interface ILanguageServerMessages {
   FOLDER_DELETE: FolderDeleteMessage;
   /** Message to specify that we are formatting a file */
   FORMAT_FILE: FormatFileMessage;
+  /** Message to specify that we are formatting files in a workspace */
+  FORMAT_WORKSPACE: FormatWorkspaceMessage;
   /** Message for generating tasks */
   GENERATE_TASK: GenerateTaskMessage;
   /** When we index or finish indexing folders */
@@ -124,6 +141,8 @@ export interface ILanguageServerMessages {
   MIGRATE_CODE: MigrateCodeLSPMessage;
   /** Convert notebooks to PRO code */
   NOTEBOOK_TO_PRO_CODE: NotebookToProCodeMessage;
+  /** Progress message */
+  PROGRESS: ProgressMessage;
   /** Message to retrieve docs */
   RETRIEVE_DOCS: RetrieveDocsMessage;
   /** Message to update workspace config */
@@ -143,12 +162,14 @@ export const LANGUAGE_SERVER_MESSAGE_LOOKUP: ILanguageServerMessages = {
   FILE_RENAME: 'textDocument/didRename',
   FOLDER_DELETE: 'will-delete-folders',
   FORMAT_FILE: 'format-file',
+  FORMAT_WORKSPACE: 'format-workspace',
   GENERATE_TASK: 'generate/task',
   INDEXING: 'indexing',
   INIT_WORKSPACE_CONFIG: 'init-workspace-config',
   LOG: 'log',
   MIGRATE_CODE: 'migrate-code',
   NOTEBOOK_TO_PRO_CODE: 'notebook/to-pro-code',
+  PROGRESS: 'progress',
   RETRIEVE_DOCS: 'retrieve-docs',
   USAGE_METRIC: 'usage-metric-lsp',
   WORKSPACE_CONFIG: 'workspace-config',

libs/vscode/events/server/src/lib/vscode-server-event-manager.ts

@@ -27,7 +27,7 @@ export class VSCodeServerEventManager {
   }
 
   /**
-   * Send message to the language server
+   * Send message to the VSCode Client
    */
   sendNotification<T extends LanguageServerMessage>(
     message: T,