Add projectRootDir for monorepo connection sequences

CHANGELOG.md

@@ -3,6 +3,7 @@
 Changes to Calva.
 
 ## [Unreleased]
+- [Add option to specify project root directory](https://github.com/BetterThanTomorrow/calva/issues/579)
 
 ## [2.0.184] - 2021-04-02
 - Fix: [Calva not detecting tests with aliased clojure.test namespace](https://github.com/BetterThanTomorrow/calva/issues/1086)

docs/site/connect-sequences.md

@@ -15,6 +15,7 @@ A connect sequence configures the following:
 * `projectType`: (required) This is either "Leiningen”, ”deps.edn”, ”shadow-cljs”, ”lein-shadow”, or ”generic".
 * `nReplPortFile`: An array of path segments with the project root-relative path to the nREPL port file for this connect sequence. E.g. For shadow-cljs this would be `[".shadow-cljs", "nrepl.port"]`.
 * `afterCLJReplJackInCode`: Here you can give Calva some Clojure code to evaluate in the CLJ REPL, once it has been created.
+* `projectRootDir`: The root directory to execute the Jack-in command from.  This will override the default behavior for determining the root directory relative to the current open file.  This is useful for working in monorepos. Accepts absolute paths or paths relative to the workspace root.
 * `cljsType`: This can be either "Figwheel Main", "lein-figwheel", "shadow-cljs", "Nashorn", "none", or a dictionary configuring a custom type. If set to "none", Calva will skip connecting a ClojureScript repl. A custom type has the following fields:
     * `dependsOn`: (required) Calva will use this to determine which dependencies it will add when starting the project (Jacking in). This can be either "Figwheel Main", "lein-figwheel", "shadow-cljs", "Nashorn", or ”User provided”. If it is "User provided", then you need to provide the dependencies in the project or launch with an alias (deps.edn), profile (Leiningen), or build (shadow-cljs) that provides the dependencies needed.
     * `isStarted`: Boolean. For CLJS REPLs that Calva does not need to start, set this to true. (If you base your custom cljs repl on a shadow-cljs workflow, for instance.)

package.json

@@ -3,7 +3,7 @@
     "displayName": "Calva: Clojure & ClojureScript Interactive Programming",
     "description": "Integrated REPL, formatter, Paredit, and more. Powered by cider-nrepl and clojure-lsp.",
     "icon": "assets/calva.png",
-    "version": "2.0.185",
+    "version": "2.0.185-monorepo-proj-root-dir",
     "publisher": "betterthantomorrow",
     "author": {
         "name": "Better Than Tomorrow",
@@ -373,6 +373,11 @@
                                     "description": "Here you can give Calva some Clojure code to evaluate in the CLJ REPL, once it has been created.",
                                     "required": false
                                 },
+                                "projectRootDir": {
+                                    "type": "string",
+                                    "descripion": "The root directory to execute the Jack-in command from.  This will override the default behavior for determining the root directory relative to the current open file.  This is useful for working in monorepos.",
+                                    "required": false
+                                },
                                 "menuSelections": {
                                     "type": "object",
                                     "description": "Pre-selected menu options. If a selection is made here. Calva won't prompt for it.",

src/nrepl/connectSequence.ts

@@ -46,6 +46,7 @@ interface ReplConnectSequence {
     name: string,
     projectType: ProjectTypes,
     afterCLJReplJackInCode?: string,
+    projectRootDir?: string,
     cljsType: CljsTypes | CljsTypeConfig,
     menuSelections?: MenuSelections,
     nReplPortFile?: string[]
@@ -208,7 +209,10 @@ function getConnectSequences(projectTypes: string[]): ReplConnectSequence[] {
     const customSequences = getCustomConnectSequences();
     const defSequences = projectTypes.reduce((seqs, projectType) => seqs.concat(defaultSequences[projectType]), []);
     const defSequenceProjectTypes = [...new Set(defSequences.map(s => s.projectType))];
-    const sequences = customSequences.filter(customSequence => defSequenceProjectTypes.includes(customSequence.projectType)).concat(defSequences);
+  const sequences = customSequences.filter(customSequence =>
+      !!customSequence.projectRootDir
+      || defSequenceProjectTypes.includes(customSequence.projectType)
+  ).concat(defSequences);
     return sequences;
 }
 

src/nrepl/jack-in.ts

@@ -212,16 +212,22 @@ export async function jackIn(connectSequence: ReplConnectSequence, cb?: Function
             return;
         }
     }
-    if (projectConnectSequence) {
-        const terminalJackInOptions = await getJackInTerminalOptions(projectConnectSequence);
-        if (terminalJackInOptions) {
-            await executeJackInTask(terminalJackInOptions, projectConnectSequence, cb);
-        }
-    } else {
+
+    if (!projectConnectSequence) {
         vscode.window.showInformationMessage('No supported project types detected. Maybe try starting your project manually and use the Connect command?');
         return;
     }
 
+    if (projectConnectSequence.projectRootDir) {
+      const rootDirPath = state.resolvePath(projectConnectSequence.projectRootDir);
+      await state.initProjectDir(vscode.Uri.parse(rootDirPath))
+    }
+
+    const terminalJackInOptions = await getJackInTerminalOptions(projectConnectSequence);
+    if (terminalJackInOptions) {
+        await executeJackInTask(terminalJackInOptions, projectConnectSequence, cb);
+    }
+
     liveShareSupport.didJackIn();
 }