Add configurable working directory for Shiny app launch (#102)

Author: gadenbuie

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 - In Positron, the Viewer pane now shows an interrupt button when running Shiny apps, allowing you to stop the app directly from the Viewer. ([#103](https://github.com/posit-dev/shiny-vscode/pull/103))
 
+New `shiny.runFrom` option can be used to run Shiny apps from the `"projectRoot"` (default) or the `"appDirectory"`. This can also be overridden at the app-level with a workspace `shiny.runFromOverride` setting. Use the new "Shiny: Run this app from..." command on an open Shiny app file to configure this setting for a specific app. (#102)
+
 ## 1.1.0
 
 - In Positron, the extension now uses the selected R runtime for Shiny for R apps. In VS Code, the extension also now consults the `r.rpath.mac`, `r.rpath.windows` or `r.rpath.linux` settings to find the R executable, before falling back to system settings. These settings are part of the [R Debugger extension](https://marketplace.visualstudio.com/items?itemName=RDebugger.r-debugger) ([#64](https://github.com/posit-dev/shiny-vscode/pull/64))

README.md

@@ -54,3 +54,34 @@ Note that there is no setting for Python executable path or virtual environment.
 - `shiny.includeHeader`: Include the "Shiny" header in the Shinylive link when opening in app mode?
 - `shiny.shinylive.openAction`: What action should be taken when opening a Shinylive link? Options are `"open"` to open the link in an external browser, `"copy"` the link to the clipboard, or `"ask"`. The default is `"ask"`, which prompts you each time you create a Shinylive link.
 - `shiny.shinylive.host`: The Shinylive host used when creating a Shinylive link. The default is `"https://shinylive.io"`, which uses the latest released version of Shiny in Python or R. Or `"https://posit-dev.github.io/shinylive"`, which uses the latest development version of Shiny in Python or R.
+
+### Working Directory Configuration
+
+By default, Shiny apps run from the workspace root directory. This works well for most projects, but you may need apps to run from a different directory—for example, when using renv in a subfolder or organizing apps in a monorepo structure.
+
+The extension provides two settings to control the working directory:
+
+- `shiny.runFrom`: Global default for all apps in the workspace
+  - `"projectRoot"` (default): Run apps from the workspace root
+  - `"appDirectory"`: Run apps from the directory containing the app file
+
+- `shiny.runFromOverrides`: Per-app overrides for specific files
+  - For specific app paths (relative to the project root), choose which root-relative path the app is run from.
+  - Empty string `""` means project root
+  - This is a workspace-only setting
+
+**Example configuration** for a project with apps in subfolders using renv:
+
+```json
+{
+  "shiny.runFrom": "appDirectory",
+  "shiny.runFromOverrides": {
+    "src/apps/main/app.py": "",
+    "src/r-apps/dashboard/app.R": "src/r-apps"
+  }
+}
+```
+
+**Setting overrides via Command Palette:**
+
+Instead of editing `settings.json` manually, you can use the **"Shiny: Run this app from..."** command to set the run from override for an open app file.

package.json

@@ -90,6 +90,12 @@
         "command": "shiny.stopApp",
         "title": "Stop Shiny App",
         "icon": "$(debug-stop)"
+      },
+      {
+        "category": "Shiny",
+        "command": "shiny.setRunFromOverride",
+        "title": "Run this app from...",
+        "enablement": "(editorLangId == python || editorLangId == r) && workspaceFolderCount > 0"
       }
     ],
     "menus": {
@@ -154,6 +160,7 @@
       "title": "Shiny",
       "properties": {
         "shiny.previewType": {
+          "order": 1,
           "scope": "window",
           "type": "string",
           "description": "Where should the Shiny app preview open?",
@@ -172,36 +179,40 @@
           ]
         },
         "shiny.timeoutOpenBrowser": {
+          "order": 2,
           "type": "integer",
           "default": 10,
           "description": "Maximum wait time (in seconds) for the Shiny app to be ready before opening the browser."
         },
-        "shiny.python.port": {
-          "type": "integer",
-          "default": 0,
-          "description": "The port number Shiny should listen on when running a Shiny for Python app. (Use 0 to choose a random port.)"
-        },
-        "shiny.python.autoreloadPort": {
-          "type": "integer",
-          "default": 0,
-          "description": "The port number Shiny should use for a supplemental WebSocket channel it uses to support reload-on-save. (Use 0 to choose a random port.)"
-        },
-        "shiny.python.debugJustMyCode": {
-          "type": "boolean",
-          "default": true,
-          "description": "When running the \"Debug Shiny App\" command, only step through user-written code. Disable this to allow stepping through library code."
-        },
-        "shiny.r.port": {
-          "type": "integer",
-          "default": 0,
-          "description": "The port number Shiny should listen on when running a Shiny for R app. (Use 0 to choose a random port.)"
+        "shiny.runFrom": {
+          "order": 3,
+          "scope": "window",
+          "type": "string",
+          "description": "Default working directory for running Shiny apps",
+          "enum": [
+            "projectRoot",
+            "appDirectory"
+          ],
+          "default": "projectRoot",
+          "enumDescriptions": [
+            "Run apps from the workspace root directory",
+            "Run apps from the directory containing the app file"
+          ]
         },
-        "shiny.r.devmode": {
-          "type": "boolean",
-          "default": true,
-          "markdownDescription": "Enable dev mode when running a Shiny for R app by running `shiny::devmode()` before launching the app."
+        "shiny.runFromOverrides": {
+          "order": 4,
+          "scope": "resource",
+          "type": "object",
+          "description": "Override working directory for specific app files. This setting maps workspace-relative file paths (using forward slashes) to workspace-relative directory paths. You can use an empty string (`\"\"`) to run an app from the project root. Note that you can use the \"Run this app from...\" command from an active app file to configure this setting for that app.",
+          "default": {},
+          "patternProperties": {
+            "^.*\\.(py|R)$": {
+              "type": "string"
+            }
+          }
         },
         "shiny.shinylive.appMode": {
+          "order": 5,
           "type": "string",
           "default": "ask",
           "description": "Which Shinylive mode to use when creating a Shinylive app.",
@@ -217,6 +228,7 @@
           ]
         },
         "shiny.shinylive.openAction": {
+          "order": 6,
           "type": "string",
           "default": "ask",
           "description": "Choose the default action upon creating a Shinylive link.",
@@ -232,11 +244,13 @@
           ]
         },
         "shiny.shinylive.includeHeader": {
+          "order": 7,
           "type": "boolean",
           "default": true,
           "description": "Include the Shiny header when creating Shinylive app links. Only relevant for app mode Shinylive links."
         },
         "shiny.shinylive.host": {
+          "order": 8,
           "type": "string",
           "default": "https://shinylive.io",
           "description": "The default Shinylive host to use when creating Shinylive app links.",
@@ -248,6 +262,36 @@
             "Uses the latest released version of Shiny in Python or R.",
             "Uses the latest development version of Shiny in Python or R."
           ]
+        },
+        "shiny.python.port": {
+          "order": 9,
+          "type": "integer",
+          "default": 0,
+          "description": "The port number Shiny should listen on when running a Shiny for Python app. (Use 0 to choose a random port.)"
+        },
+        "shiny.python.autoreloadPort": {
+          "order": 10,
+          "type": "integer",
+          "default": 0,
+          "description": "The port number Shiny should use for a supplemental WebSocket channel it uses to support reload-on-save. (Use 0 to choose a random port.)"
+        },
+        "shiny.python.debugJustMyCode": {
+          "order": 11,
+          "type": "boolean",
+          "default": true,
+          "description": "When running the \"Debug Shiny App\" command, only step through user-written code. Disable this to allow stepping through library code."
+        },
+        "shiny.r.port": {
+          "order": 12,
+          "type": "integer",
+          "default": 0,
+          "description": "The port number Shiny should listen on when running a Shiny for R app. (Use 0 to choose a random port.)"
+        },
+        "shiny.r.devmode": {
+          "order": 13,
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable dev mode when running a Shiny for R app by running `shiny::devmode()` before launching the app."
         }
       }
     },

src/extension.ts

@@ -11,6 +11,7 @@ import {
   setAppRunningStateChangeCallback,
   stopApp,
 } from "./run";
+import { setRunFromOverride } from "./set-run-from-override-command";
 import {
   shinyliveCreateFromActiveEditor,
   shinyliveCreateFromExplorer,
@@ -24,6 +25,10 @@ export async function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand("shiny.python.debugApp", pyDebugApp),
     vscode.commands.registerCommand("shiny.r.runApp", rRunApp),
     vscode.commands.registerCommand("shiny.stopApp", stopApp),
+    vscode.commands.registerCommand(
+      "shiny.setRunFromOverride",
+      setRunFromOverride
+    ),
     vscode.commands.registerCommand(
       "shiny.shinylive.createFromActiveEditor",
       shinyliveCreateFromActiveEditor

src/run.ts

@@ -15,6 +15,7 @@ import {
   envVarsForShell as envVarsForTerminal,
   escapeCommandForTerminal,
 } from "./shell-utils";
+import { resolveWorkingDirectory } from "./working-directory";
 
 const DEBUG_NAME = "Debug Shiny app";
 
@@ -98,8 +99,11 @@ export async function pyRunApp(): Promise<void> {
   const port = await getAppPort("run", "python");
   const autoreloadPort = await getAutoreloadPort("run");
 
+  const cwd = await resolveWorkingDirectory(path);
+
   const terminal = await createTerminalAndCloseOthersWithSameName({
     name: "Shiny",
+    cwd: cwd,
     env: {
       // We store the Python path here so we know whether the terminal can be
       // reused by us in the future (yes if the selected Python interpreter has
@@ -200,12 +204,15 @@ export async function pyDebugApp(): Promise<void> {
     .getConfiguration("shiny.python")
     .get("debugJustMyCode", true);
 
+  const cwd = await resolveWorkingDirectory(path);
+
   await vscode.debug.startDebugging(undefined, {
     type: "python",
     name: DEBUG_NAME,
     request: "launch",
     module: "shiny",
     args: ["run", "--port", port.toString(), path],
+    cwd: cwd,
     jinja: true,
     justMyCode,
     stopOnEntry: false,
@@ -231,8 +238,11 @@ export async function rRunApp(): Promise<void> {
   // TODO: Is this needed for Shiny for R too?
   // const autoreloadPort = await getAutoreloadPort("run");
 
+  const cwd = await resolveWorkingDirectory(pathFile);
+
   const terminal = await createTerminalAndCloseOthersWithSameName({
     name: "Shiny",
+    cwd: cwd,
     env: {
       // We save this here so escapeCommandForTerminal knows what shell
       // semantics to use when escaping arguments. A bit magical, but oh well.