Command to open compiled file

Author: fhammerschmidt

client/src/commands.ts

@@ -1,40 +1,12 @@
-import * as fs from "fs";
-import { window, DiagnosticCollection } from "vscode";
-import { LanguageClient, RequestType } from "vscode-languageclient/node";
+import { DiagnosticCollection } from "vscode";
+
 import {
   DiagnosticsResultCodeActionsMap,
   runDeadCodeAnalysisWithReanalyze,
 } from "./commands/dead_code_analysis";
 
-interface CreateInterfaceRequestParams {
-  uri: string;
-}
-
-let createInterfaceRequest = new RequestType<
-  CreateInterfaceRequestParams,
-  string,
-  void
->("rescript-vscode.create_interface");
-
-export const createInterface = (client: LanguageClient) => {
-  if (!client) {
-    return window.showInformationMessage("Language server not running");
-  }
-
-  const editor = window.activeTextEditor;
-
-  if (!editor) {
-    return window.showInformationMessage("No active editor");
-  }
-
-  if (fs.existsSync(editor.document.uri.fsPath + "i")) {
-    return window.showInformationMessage("Interface file already exists");
-  }
-
-  client.sendRequest(createInterfaceRequest, {
-    uri: editor.document.uri.toString(),
-  });
-};
+export { createInterface } from "./commands/create_interface";
+export { openCompiled } from "./commands/open_compiled";
 
 export const deadCodeAnalysisWithReanalyze = (
   targetDir: string | null,

client/src/commands/create_interface.ts

@@ -0,0 +1,33 @@
+import * as fs from "fs";
+import { LanguageClient, RequestType } from "vscode-languageclient/node";
+import { window } from "vscode";
+
+interface CreateInterfaceRequestParams {
+  uri: string;
+}
+
+let createInterfaceRequest = new RequestType<
+  CreateInterfaceRequestParams,
+  string,
+  void
+>("rescript-vscode.create_interface");
+
+export const createInterface = (client: LanguageClient) => {
+  if (!client) {
+    return window.showInformationMessage("Language server not running");
+  }
+
+  const editor = window.activeTextEditor;
+
+  if (!editor) {
+    return window.showInformationMessage("No active editor");
+  }
+
+  if (fs.existsSync(editor.document.uri.fsPath + "i")) {
+    return window.showInformationMessage("Interface file already exists");
+  }
+
+  client.sendRequest(createInterfaceRequest, {
+    uri: editor.document.uri.toString(),
+  });
+};

client/src/commands/open_compiled.ts

@@ -0,0 +1,45 @@
+import * as fs from "fs";
+import { window, Uri, ViewColumn } from "vscode";
+import { LanguageClient, RequestType } from "vscode-languageclient/node";
+
+interface OpenCompiledFileRequestParams {
+  uri: string;
+}
+
+interface OpenCompiledFileResponseParams {
+  uri: string;
+}
+
+let openCompiledFileRequest = new RequestType<
+  OpenCompiledFileRequestParams,
+  OpenCompiledFileResponseParams,
+  void
+>("rescript-vscode.open_compiled");
+
+export const openCompiled = (client: LanguageClient) => {
+  if (!client) {
+    return window.showInformationMessage("Language server not running");
+  }
+
+  const editor = window.activeTextEditor;
+
+  if (!editor) {
+    return window.showInformationMessage("No active editor");
+  }
+
+  if (!fs.existsSync(editor.document.uri.fsPath)) {
+    return window.showInformationMessage("Compiled file does not exist");
+  }
+
+  client
+    .sendRequest(openCompiledFileRequest, {
+      uri: editor.document.uri.toString(),
+    })
+    .then((response) => {
+      const document = Uri.file(response.uri);
+
+      return window.showTextDocument(document, {
+        viewColumn: ViewColumn.Beside,
+      });
+    });
+};

client/src/extension.ts

@@ -146,6 +146,10 @@ export function activate(context: ExtensionContext) {
     customCommands.createInterface(client);
   });
 
+  commands.registerCommand("rescript-vscode.open_compiled", () => {
+    customCommands.openCompiled(client);
+  });
+
   // Starts the dead code analysis mode.
   commands.registerCommand("rescript-vscode.start_dead_code_analysis", () => {
     // Save the directory this first ran from, and re-use that when continuously

package.json

@@ -39,11 +39,26 @@
 				"command": "rescript-vscode.create_interface",
 				"title": "ReScript: Create an interface file for this implementation file."
 			},
+			{
+				"command": "rescript-vscode.open_compiled",
+				"category": "ReScript",
+				"title": "Open the compiled JS file for this implementation file.",
+				"icon": "$(output)"
+			},
 			{
 				"command": "rescript-vscode.start_dead_code_analysis",
 				"title": "ReScript: Start dead code analysis."
 			}
 		],
+		"menus": {
+			"editor/title": [
+				{
+					"command": "rescript-vscode.open_compiled",
+					"when": "editorLangId == rescript",
+					"group": "navigation"
+				}
+			]
+		},
 		"snippets": [
 			{
 				"language": "rescript",

server/src/constants.ts

@@ -45,3 +45,7 @@ export let resExt = ".res";
 export let resiExt = ".resi";
 export let cmiExt = ".cmi";
 export let startBuildAction = "Start Build";
+
+// bsconfig defaults according configuration schema (https://rescript-lang.org/docs/manual/latest/build-configuration-schema)
+export let bsconfigModuleDefault = "commonjs";
+export let bsconfigSuffixDefault = ".js";

server/src/server.ts

@@ -50,6 +50,16 @@ let createInterfaceRequest =
     string,
     void>("rescript-vscode.create_interface");
 
+interface OpenCompiledFileParams {
+  uri: string;
+}
+
+let openCompiledFileRequest = new v.RequestType<
+  OpenCompiledFileParams,
+  OpenCompiledFileParams,
+  void
+>("rescript-vscode.open_compiled");
+
 let sendUpdatedDiagnostics = () => {
   projectsFiles.forEach(({ filesWithDiagnostics }, projectRootPath) => {
     let content = fs.readFileSync(
@@ -120,7 +130,7 @@ let sendCompilationFinishedMessage = () => {
     jsonrpc: c.jsonrpcVersion,
     method: "rescript/compilationFinished",
   };
-  
+
   send(notification);
 };
 
@@ -548,7 +558,7 @@ function createInterface(msg: p.RequestMessage): m.Message {
     return response;
   }
 
-  let namespace = namespaceResult.result
+  let namespace = namespaceResult.result;
   let suffixToAppend = namespace.length > 0 ? "-" + namespace : "";
 
   let cmiPartialPath = path.join(
@@ -602,6 +612,56 @@ function createInterface(msg: p.RequestMessage): m.Message {
   }
 }
 
+function openCompiledFile(msg: p.RequestMessage): m.Message {
+  let params = msg.params as OpenCompiledFileParams;
+  let filePath = fileURLToPath(params.uri);
+  let projDir = utils.findProjectRootOfFile(filePath);
+
+  if (projDir === null) {
+    let params: p.ShowMessageParams = {
+      type: p.MessageType.Error,
+      message: `Cannot locate project directory.`,
+    };
+
+    let response: m.NotificationMessage = {
+      jsonrpc: c.jsonrpcVersion,
+      method: "window/showMessage",
+      params: params,
+    };
+
+    return response;
+  }
+
+  let compiledFilePath = utils.getCompiledFilePath(filePath, projDir);
+
+  if (compiledFilePath.kind === "error" || !fs.existsSync(compiledFilePath.result)) {
+    let params: p.ShowMessageParams = {
+      type: p.MessageType.Error,
+      message: `No compiled file found. Please compile your project first.`,
+    };
+
+    let response: m.NotificationMessage = {
+      jsonrpc: c.jsonrpcVersion,
+      method: "window/showMessage",
+      params,
+    };
+
+    return response;
+  }
+
+  let result: OpenCompiledFileParams = {
+    uri: compiledFilePath.result,
+  };
+
+  let response: m.ResponseMessage = {
+    jsonrpc: c.jsonrpcVersion,
+    id: msg.id,
+    result,
+  };
+
+  return response;
+}
+
 function onMessage(msg: m.Message) {
   if (m.isNotificationMessage(msg)) {
     // notification message, aka the client ends it and doesn't want a reply
@@ -734,6 +794,8 @@ function onMessage(msg: m.Message) {
       responses.forEach((response) => send(response));
     } else if (msg.method === createInterfaceRequest.method) {
       send(createInterface(msg));
+    } else if (msg.method === openCompiledFileRequest.method) {
+      send(openCompiledFile(msg));
     } else {
       let response: m.ResponseMessage = {
         jsonrpc: c.jsonrpcVersion,

server/src/utils.ts

@@ -186,16 +186,20 @@ export const toCamelCase = (text: string): string => {
     .replace(/(\s|-)+/g, "");
 };
 
+const readBsConfig = (projDir: p.DocumentUri) => {
+  let bsconfigFile = fs.readFileSync(
+    path.join(projDir, c.bsconfigPartialPath),
+    { encoding: "utf-8" }
+  );
+
+  return JSON.parse(bsconfigFile);
+};
+
 export const getNamespaceNameFromBsConfig = (
   projDir: p.DocumentUri
 ): execResult => {
   try {
-    let bsconfigFile = fs.readFileSync(
-      path.join(projDir, c.bsconfigPartialPath),
-      { encoding: "utf-8" }
-    );
-
-    let bsconfig = JSON.parse(bsconfigFile);
+    let bsconfig = readBsConfig(projDir);
     let result = "";
 
     if (bsconfig.namespace === true) {
@@ -243,6 +247,60 @@ export let createInterfaceFileUsingValidBscExePath = (
   }
 };
 
+export let getCompiledFilePath = (
+  filePath: string,
+  projDir: string
+): execResult => {
+  try {
+    let bsConfig = readBsConfig(projDir);
+
+    let pkgSpecs = bsConfig["package-specs"];
+    let pathFragment = "";
+    let moduleFormatObj: any = {};
+
+    let module = c.bsconfigModuleDefault;
+    let suffix = c.bsconfigSuffixDefault;
+
+    if (pkgSpecs && pkgSpecs.module) {
+      moduleFormatObj = pkgSpecs;
+    } else if (pkgSpecs && pkgSpecs[0]) {
+      if (typeof pkgSpecs[0] === "string") {
+        module = pkgSpecs[0];
+      } else {
+        moduleFormatObj = pkgSpecs[0];
+      }
+    }
+
+    if (moduleFormatObj["module"]) {
+      module = moduleFormatObj["module"];
+    }
+
+    if (!moduleFormatObj["in-source"]) {
+      pathFragment = "lib/" + module.replace("-", "_");
+    }
+
+    if (moduleFormatObj.suffix) {
+      suffix = moduleFormatObj.suffix;
+    } else if (bsConfig.suffix) {
+      suffix = bsConfig.suffix;
+    }
+
+    let partialFilePath = filePath.split(projDir)[1];
+    let compiledPartialPath = replaceFileExtension(partialFilePath, suffix);
+    let result = path.join(projDir, pathFragment, compiledPartialPath);
+
+    return {
+      kind: "success",
+      result,
+    };
+  } catch (e) {
+    return {
+      kind: "error",
+      error: e instanceof Error ? e.message : String(e),
+    };
+  }
+};
+
 export let runBuildWatcherUsingValidBuildPath = (
   buildPath: p.DocumentUri,
   isRescript: boolean,