Open editor in specific line from traceback

Took editor arguments snippet from my srcview package. Can potentially extract that specific tidbit to a reusable function.

Author: yairchu

frontend/src/components/editor/output/MarimoTracebackOutput.tsx

@@ -216,7 +216,10 @@ export const replaceTracebackFilenames = (domNode: DOMNode) => {
       <div
         className="inline-block cursor-pointer text-destructive hover:underline"
         onClick={(_) => {
-          getRequestClient().openFile({ path: info.filePath });
+          getRequestClient().openFile({
+            path: info.filePath,
+            lineNumber: info.lineNumber,
+          });
         }}
       >
         <span className="nb">"{info.filePath}"</span>

frontend/src/core/network/types.ts

@@ -142,7 +142,7 @@ export interface EditRequests {
     request: PreviewDataSourceConnectionRequest,
   ) => Promise<null>;
   validateSQL: (request: ValidateSQLRequest) => Promise<null>;
-  openFile: (request: { path: string }) => Promise<null>;
+  openFile: (request: { path: string; lineNumber?: number }) => Promise<null>;
   getUsageStats: () => Promise<UsageResponse>;
   // Debugger
   sendPdb: (request: PdbRequest) => Promise<null>;

marimo/_server/api/endpoints/file_explorer.py

@@ -253,7 +253,7 @@ async def open_file(
     body = await parse_request(request, cls=FileOpenRequest)
     try:
         file_system.get_details(body.path)
-        success = file_system.open_in_editor(body.path)
+        success = file_system.open_in_editor(body.path, body.line_number)
         return SuccessResponse(success=success)
     except Exception as e:
         LOGGER.error(f"Error opening file: {e}")

marimo/_server/files/os_file_system.py

@@ -319,7 +319,7 @@ def sort_key(file_info: FileInfo) -> tuple[int, str]:
         results.sort(key=sort_key)
         return results[:limit]
 
-    def open_in_editor(self, path: str) -> bool:
+    def open_in_editor(self, path: str, line_number: int | None) -> bool:
         try:
             # First try to get editor from environment variable
             editor = os.environ.get("EDITOR")
@@ -328,9 +328,17 @@ def open_in_editor(self, path: str) -> bool:
             # otherwise it silently opens the terminal in the same window that is
             # running marimo.
             if editor and not _is_terminal_editor(editor):
+                args = (
+                    [path]
+                    if line_number is None
+                    else editor_open_file_in_line_args(
+                        editor, path, line_number
+                    )
+                )
+
                 try:
                     # For GUI editors
-                    subprocess.run([editor, path])
+                    subprocess.run([editor, *args])
                     return True
                 except Exception as e:
                     LOGGER.error(f"Error opening with EDITOR: {e}")
@@ -350,6 +358,17 @@ def open_in_editor(self, path: str) -> bool:
             return False
 
 
+def editor_open_file_in_line_args(
+    editor: str, path: str, line_number: int
+) -> list[str]:
+    if editor == "code":
+        return ["--goto", f"{path}:{line_number}"]
+    elif editor == "subl":
+        return [f"{path}:{line_number}"]
+    else:
+        return [f"+{line_number}", path]
+
+
 def natural_sort_file(file: FileInfo) -> list[Union[int, str]]:
     return natural_sort(file.name)
 

marimo/_server/models/files.py

@@ -32,6 +32,7 @@ class FileDetailsRequest(msgspec.Struct, rename="camel"):
 class FileOpenRequest(msgspec.Struct, rename="camel"):
     # The path of the file to open
     path: str
+    line_number: Optional[int] = None
 
 
 class FileTreeRequest(msgspec.Struct, rename="camel"):

packages/openapi/api.yaml

@@ -1400,6 +1400,11 @@ components:
       type: object
     FileOpenRequest:
       properties:
+        lineNumber:
+          anyOf:
+          - type: integer
+          - type: 'null'
+          default: null
         path:
           type: string
       required:

packages/openapi/src/api.ts

@@ -3391,6 +3391,8 @@ export interface components {
     };
     /** FileOpenRequest */
     FileOpenRequest: {
+      /** @default null */
+      lineNumber?: number | null;
       path: string;
     };
     /** FileSearchRequest */