Add command to create interface files (#90)

Author: fhammerschmidt

client/src/commands.ts

@@ -0,0 +1,29 @@
+import * as fs from 'fs'
+import { window } from 'vscode';
+import { LanguageClient, RequestType } from 'vscode-languageclient/node';
+
+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/extension.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { workspace, ExtensionContext } from "vscode";
+import { workspace, ExtensionContext, commands } from "vscode";
 
 import {
 	LanguageClient,
@@ -8,6 +8,8 @@ import {
 	TransportKind,
 } from "vscode-languageclient/node";
 
+import * as customCommands from './commands';
+
 let client: LanguageClient;
 
 // let taskProvider = tasks.registerTaskProvider('Run ReScript build', {
@@ -96,6 +98,11 @@ export function activate(context: ExtensionContext) {
 		clientOptions
 	);
 
+	// Register custom commands
+	commands.registerCommand('rescript-vscode.create_interface', () => {
+        customCommands.createInterface(client);
+    });
+
 	// Start the client. This will also launch the server
 	client.start();
 }

package.json

@@ -34,6 +34,12 @@
 				"url": "https://raw.githubusercontent.com/rescript-lang/rescript-compiler/master/docs/docson/build-schema.json"
 			}
 		],
+		"commands": [
+			{
+				"command": "rescript-vscode.create_interface",
+				"title": "ReScript: Create an interface file for this implementation file."
+			}
+		],
 		"snippets": [
 			{
 				"language": "rescript",

server/src/constants.ts

@@ -39,7 +39,9 @@ export let bsbNodePartialPath = path.join("node_modules", ".bin", "bsb");
 
 export let bsbLock = ".bsb.lock";
 export let bsconfigPartialPath = "bsconfig.json";
+export let compilerDirPartialPath = path.join("lib", "bs");
 export let compilerLogPartialPath = path.join("lib", "bs", ".compiler.log");
 export let resExt = ".res";
 export let resiExt = ".resi";
+export let cmiExt = ".cmi";
 export let startBuildAction = "Start Build";

server/src/server.ts

@@ -42,6 +42,12 @@ let projectsFiles: Map<
 // will be properly defined later depending on the mode (stdio/node-rpc)
 let send: (msg: m.Message) => void = (_) => { };
 
+interface CreateInterfaceRequestParams {
+	uri: string;
+};
+
+let createInterfaceRequest = new v.RequestType<CreateInterfaceRequestParams, string, void>("rescript-vscode.create_interface");
+
 let sendUpdatedDiagnostics = () => {
   projectsFiles.forEach(({ filesWithDiagnostics }, projectRootPath) => {
     let content = fs.readFileSync(
@@ -514,6 +520,82 @@ function onMessage(msg: m.Message) {
           }
         }
       }
+    } else if (msg.method === createInterfaceRequest.method) {
+      let params = msg.params as CreateInterfaceRequestParams;
+      let extension = path.extname(params.uri);
+      let filePath = fileURLToPath(params.uri);
+      let bscNativePath = utils.findBscNativeOfFile(filePath);
+      let projDir = utils.findProjectRootOfFile(filePath);
+
+      if (bscNativePath === null || projDir === null) {
+        let params: p.ShowMessageParams = {
+          type: p.MessageType.Error,
+          message: `Cannot find a nearby bsc.exe to generate the interface file.`,
+        };
+
+        let response: m.NotificationMessage = {
+          jsonrpc: c.jsonrpcVersion,
+          method: "window/showMessage",
+          params: params,
+        };
+
+        send(response);
+      } else if (extension !== c.resExt) {
+        let params: p.ShowMessageParams = {
+          type: p.MessageType.Error,
+          message: `Not a ${c.resExt} file. Cannot create an interface for it.`,
+        };
+
+        let response: m.NotificationMessage = {
+          jsonrpc: c.jsonrpcVersion,
+          method: "window/showMessage",
+          params: params,
+        };
+
+        send(response);
+      } else {
+        let cmiPartialPath = utils.replaceFileExtension(filePath.split(projDir)[1], c.cmiExt);
+        let cmiPath = path.join(projDir, c.compilerDirPartialPath, cmiPartialPath);
+        let cmiAvailable = fs.existsSync(cmiPath);
+        
+        if (!cmiAvailable) {
+          let params: p.ShowMessageParams = {
+            type: p.MessageType.Error,
+            message: `No compiled interface file found. Please compile your project first.`
+          };
+          
+          let response: m.NotificationMessage = {
+            jsonrpc: c.jsonrpcVersion,
+            method: "window/showMessage",
+            params,
+          };
+          
+          send(response);
+        } else {
+          let intfResult = utils.createInterfaceFileUsingValidBscExePath(filePath, cmiPath, bscNativePath)
+  
+          if (intfResult.kind === "success") {
+            let response: m.ResponseMessage = {
+              jsonrpc: c.jsonrpcVersion,
+              id: msg.id,
+              result: intfResult.result,
+            };
+  
+            send(response);
+          } else {
+            let response: m.ResponseMessage = {
+              jsonrpc: c.jsonrpcVersion,
+              id: msg.id,
+              error: { 
+                code: m.ErrorCodes.InternalError,
+                message: "Unable to create interface file."
+              }
+            };
+
+            send(response);
+          }
+        }
+      }
     } else {
       let response: m.ResponseMessage = {
         jsonrpc: c.jsonrpcVersion,

server/src/utils.ts

@@ -144,6 +144,37 @@ export let runAnalysisAfterSanityCheck = (
   return JSON.parse(stdout.toString());
 };
 
+export let replaceFileExtension = (filePath: string, ext: string): string => {
+  let name = path.basename(filePath, path.extname(filePath));
+  return path.format({ dir: path.dirname(filePath), name, ext })
+};
+
+export let createInterfaceFileUsingValidBscExePath = (
+  filePath: string,
+  cmiPath: string,
+  bscExePath: p.DocumentUri
+): execResult => {
+  try {
+    let resiString = childProcess.execFileSync(
+      bscExePath,
+      ["-color", "never", cmiPath]
+    );
+
+    let resiPath = replaceFileExtension(filePath, c.resiExt)
+    fs.writeFileSync(resiPath, resiString, { encoding: "utf-8"});
+
+    return {
+      kind: "success",
+      result: "Interface successfully created.",
+    };
+  } catch (e) {
+    return {
+      kind: "error",
+      error: e.message,
+    };
+  }
+};
+
 export let runBuildWatcherUsingValidBuildPath = (
   buildPath: p.DocumentUri,
   isRescript: boolean,