Fix findBuildBinary naming and fix comments

Author: An-Tu

server/src/server.ts

@@ -65,10 +65,10 @@ let codeActionsFromDiagnostics: codeActions.filesCodeActions = {};
 // will be properly defined later depending on the mode (stdio/node-rpc)
 let send: (msg: p.Message) => void = (_) => {};
 
-let findBinary = (projectRootPath: p.DocumentUri) =>
+let findBuildBinary = (projectRootPath: p.DocumentUri) =>
   extensionConfiguration.binaryPath === null
-    ? utils.findNodeBuildOfProjectRoot(projectRootPath)
-    : utils.findBinaryFromConfig(extensionConfiguration.binaryPath);
+    ? utils.findBuildBinaryFromProjectRoot(projectRootPath)
+    : utils.findBuildBinaryFromConfig(extensionConfiguration.binaryPath);
 
 interface CreateInterfaceRequestParams {
   uri: string;
@@ -240,7 +240,7 @@ let openedFile = (fileUri: string, fileContent: string) => {
       // TODO: sometime stale .bsb.lock dangling. bsb -w knows .bsb.lock is
       // stale. Use that logic
       // TODO: close watcher when lang-server shuts down
-      if (findBinary(projectRootPath) != null) {
+      if (findBuildBinary(projectRootPath) != null) {
         let payload: clientSentBuildAction = {
           title: c.startBuildAction,
           projectRootPath: projectRootPath,
@@ -1077,7 +1077,7 @@ function onMessage(msg: p.Message) {
       // TODO: close watcher when lang-server shuts down. However, by Node's
       // default, these subprocesses are automatically killed when this
       // language-server process exits
-      let found = findBinary(projectRootPath);
+      let found = findBuildBinary(projectRootPath);
       if (found != null) {
         let bsbProcess = utils.runBuildWatcherUsingValidBuildPath(
           found.buildPath,

server/src/utils.ts

@@ -83,8 +83,10 @@ let findBscBinFromConfig = (
   return null;
 };
 
+// The function is to check that the build binary file exists
+// and also determine what exactly the user is using ReScript or BuckleScript.
 // TODO: this doesn't handle file:/// scheme
-let findBinaryBase = ({
+let findBuildBinaryBase = ({
   rescriptPath,
   bsbPath,
 }: {
@@ -99,14 +101,14 @@ let findBinaryBase = ({
   return null;
 };
 
-export let findBinaryFromConfig = (pathToBinFromConfig: p.DocumentUri) =>
-  findBinaryBase({
-    rescriptPath: path.join(pathToBinFromConfig, c.rescriptBinName),
-    bsbPath: path.join(pathToBinFromConfig, c.bsbBinName),
+export let findBuildBinaryFromConfig = (pathToBinaryDirFromConfig: p.DocumentUri) =>
+  findBuildBinaryBase({
+    rescriptPath: path.join(pathToBinaryDirFromConfig, c.rescriptBinName),
+    bsbPath: path.join(pathToBinaryDirFromConfig, c.bsbBinName),
   });
 
-export let findNodeBuildOfProjectRoot = (projectRootPath: p.DocumentUri) =>
-  findBinaryBase({
+export let findBuildBinaryFromProjectRoot = (projectRootPath: p.DocumentUri) =>
+  findBuildBinaryBase({
     rescriptPath: path.join(projectRootPath, c.rescriptNodePartialPath),
     bsbPath: path.join(projectRootPath, c.bsbNodePartialPath),
   });