Use rescript runtime from configuration if provided

Author: nojaf

README.md

@@ -10,19 +10,20 @@
 
 ## Contents
 
+- [Contents](#contents)
 - [📝 Prerequisite](#-prerequisite)
 - [🌈 Supported Themes](#-supported-themes)
 - [💡 Features](#-features)
 - [📥 Installation](#-installation)
+  - [Pre-release channel](#pre-release-channel)
 - [📦 Commands](#-commands)
 - [🔨 Settings](#-settings)
 - [🚀 Code Analyzer](#-code-analyzer)
   - [Configuring the Code Analyzer](#configuring-the-code-analyzer)
   - [Usage](#usage)
   - [Caveats](#caveats)
-- [🪄 Tips & Tricks](#-tips--tricks)
+- [🪄 Tips \& Tricks](#-tips--tricks)
   - [Hide generated files](#hide-generated-files)
-- [⌨️ Use with Other Editors](#️-use-with-other-editors)
 - [📰 Changelog](#-changelog)
 - [👏 How to Contribute](#-how-to-contribute)
 - [📄 License](#-license)
@@ -102,6 +103,7 @@ You'll find all ReScript specific settings under the scope `rescript.settings`.
 | Prompt to Start Build      | If there's no ReScript build running already in the opened project, the extension will prompt you and ask if you want to start a build automatically. You can turn off this automatic prompt via the setting `rescript.settings.askToStartBuild`.                                                                                                                                                                                                                                                                                |
 | ReScript Binary Path       | The extension will look for the existence of a `node_modules/.bin/rescript` file and use its directory as the `binaryPath`. If it does not find it at the project root (which is where the nearest `rescript.json` resides), it goes up folders in the filesystem recursively until it either finds it (often the case in monorepos) or hits the top level. To override this lookup process, the path can be configured explicitly using the setting `rescript.settings.binaryPath`                                              |
 | ReScript Platform Path     | The extension will look for the existence of a `node_modules/rescript` directory and use the subdirectory corresponding to the current platform as the `platformPath`. If it does not find it at the project root (which is where the nearest `rescript.json` resides), it goes up folders in the filesystem recursively until it either finds it (often the case in monorepos) or hits the top level. To override this lookup process, the path can be configured explicitly using the setting `rescript.settings.platformPath` |
+| ReScript Runtime Path      | The extension will look for the existence of a `node_modules/@rescript/runtime` directory (ReScript v12 beta 11+). To override this lookup process, the path can be configured explicitly using the setting `rescript.settings.runtimePath`.                                                                                                                                                                                                                                                                                     |
 | Inlay Hints (experimental) | This allows an editor to place annotations inline with text to display type hints. Enable using `rescript.settings.inlayHints.enable: true`                                                                                                                                                                                                                                                                                                                                                                                      |
 | Code Lens (experimental)   | This tells the editor to add code lenses to function definitions, showing its full type above the definition. Enable using `rescript.settings.codeLens: true`                                                                                                                                                                                                                                                                                                                                                                    |
 | Signature Help             | This tells the editor to show signature help when you're writing function calls. Enable using `rescript.settings.signatureHelp.enabled: true`                                                                                                                                                                                                                                                                                                                                                                                    |

package.json

@@ -207,6 +207,14 @@
           "default": null,
           "description": "Path to the directory where platform-specific ReScript binaries are. You can use it if you haven't or don't want to use the installed ReScript from node_modules in your project."
         },
+        "rescript.settings.runtimePath": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null,
+          "description": "Optional path to the directory containing the @rescript/runtime package. Set this if your tooling is unable to automatically locate the package in your project."
+        },
         "rescript.settings.compileStatus.enable": {
           "type": "boolean",
           "default": true,
@@ -268,5 +276,6 @@
   },
   "dependencies": {
     "semver": "^7.7.2"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

server/src/bsc-args/rewatch.ts

@@ -7,13 +7,52 @@ import {
   IncrementallyCompiledFileInfo,
 } from "../incrementalCompilation";
 import type { projectFiles } from "../projectFiles";
+import config from "../config";
 import { findRescriptRuntimesInProject } from "../find-runtime";
 
 export type RewatchCompilerArgs = {
   compiler_args: Array<string>;
   parser_args: Array<string>;
 };
 
+async function getRuntimePath(
+  entry: IncrementallyCompiledFileInfo,
+): Promise<string | null> {
+  let rescriptRuntime: string | null =
+    config.extensionConfiguration.runtimePath ?? null;
+
+  if (rescriptRuntime !== null) {
+    if (debug()) {
+      console.log(
+        `Using configured runtime path as RESCRIPT_RUNTIME: ${rescriptRuntime}`,
+      );
+    }
+    return rescriptRuntime;
+  }
+
+  const rescriptRuntimes = await findRescriptRuntimesInProject(
+    entry.project.workspaceRootPath,
+  );
+
+  if (debug()) {
+    if (rescriptRuntimes.length === 0) {
+      console.log(
+        `Did not find @rescript/runtime directory for ${entry.project.workspaceRootPath}`,
+      );
+    } else if (rescriptRuntimes.length > 1) {
+      console.warn(
+        `Found multiple @rescript/runtime directories, using the first one as RESCRIPT_RUNTIME: ${rescriptRuntimes.join(", ")}`,
+      );
+    } else {
+      console.log(
+        `Found @rescript/runtime directory: ${rescriptRuntimes.join(", ")}`,
+      );
+    }
+  }
+
+  return rescriptRuntimes.at(0) ?? null;
+}
+
 export async function getRewatchBscArgs(
   projectsFiles: Map<string, projectFiles>,
   entry: IncrementallyCompiledFileInfo,
@@ -90,31 +129,10 @@ export async function getRewatchBscArgs(
       (env as any)["RESCRIPT_BSC_EXE"] = bscExe;
     }
 
-    // TODO: We should check a potential configured value
-    // Users should be able to provide this themselves if they like.
-
-    const rescriptRuntimes = await findRescriptRuntimesInProject(
-      entry.project.workspaceRootPath,
-    );
-
-    if (debug()) {
-      if (rescriptRuntimes.length === 0) {
-        console.log(
-          `Did not find @rescript/runtime directory for ${entry.project.workspaceRootPath}`,
-        );
-      } else if (rescriptRuntimes.length > 1) {
-        console.warn(
-          `Found multiple @rescript/runtime directories, using the first one as RESCRIPT_RUNTIME: ${rescriptRuntimes.join(", ")}`,
-        );
-      } else {
-        console.log(
-          `Found @rescript/runtime directory: ${rescriptRuntimes.join(", ")}`,
-        );
-      }
-    }
+    let rescriptRuntime: string | null = await getRuntimePath(entry);
 
-    if (rescriptRuntimes.length > 0) {
-      (env as any)["RESCRIPT_RUNTIME"] = rescriptRuntimes[0];
+    if (rescriptRuntime !== null) {
+      (env as any)["RESCRIPT_RUNTIME"] = rescriptRuntime;
     } else {
       // TODO: if no runtime was found, we should let the user know
     }

server/src/config.ts

@@ -11,6 +11,7 @@ export interface extensionConfiguration {
   codeLens?: boolean;
   binaryPath?: string | null;
   platformPath?: string | null;
+  runtimePath?: string | null;
   signatureHelp?: {
     enabled?: boolean;
     forConstructorPayloads?: boolean;