Implement MarkEdit.openFile() (#1218)

Author: cyanzhong

CoreEditor/package.json

@@ -42,7 +42,7 @@
     "glob": "^12.0.0",
     "jest": "^30.2.0",
     "jest-environment-jsdom": "^30.2.0",
-    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.20.0",
+    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.21.0",
     "rollup": "^4.0.0",
     "ts-gyb": "^0.12.0",
     "ts-jest": "^29.4.5",

CoreEditor/src/api/files.ts

@@ -1,5 +1,9 @@
 import { CreateFileOptions, DirectoryType, FileInfo, FileObject } from 'markedit-api';
 
+export async function openFile(path: string): Promise<boolean> {
+  return window.nativeModules.api.openFile({ path });
+}
+
 export async function createFile(options: CreateFileOptions): Promise<boolean> {
   return window.nativeModules.api.createFile({ options });
 }

CoreEditor/src/api/modules.ts

@@ -19,7 +19,7 @@ import { languageModel } from './languageModel';
 
 import { onEditorReady, addExtension, addMarkdownConfig, addCodeLanguage } from './methods';
 import { addMainMenuItem, showContextMenu, showAlert, showTextBox, showSavePanel, runService } from './ui';
-import { createFile, deleteFile, listFiles, getFileContent, getFileObject, getFileInfo, getDirectoryPath } from './files';
+import { openFile, createFile, deleteFile, listFiles, getFileContent, getFileObject, getFileInfo, getDirectoryPath } from './files';
 import { getPasteboardItems, getPasteboardString } from './pasteboard';
 
 export function initMarkEditModules() {
@@ -50,6 +50,7 @@ export function initMarkEditModules() {
   MarkEdit.lezer = lezer;
 
   MarkEdit.onEditorReady = onEditorReady;
+  MarkEdit.openFile = openFile;
   MarkEdit.createFile = createFile;
   MarkEdit.deleteFile = deleteFile;
   MarkEdit.listFiles = listFiles;

CoreEditor/src/bridge/native/api.ts

@@ -9,6 +9,7 @@ import { WebPoint } from '../../@types/WebPoint';
  * @bridgeName NativeBridgeAPI
  */
 export interface NativeModuleAPI extends NativeModule {
+  openFile({ path }: { path: string }): Promise<boolean>;
   createFile({ options }: { options: CreateFileOptions }): Promise<boolean>;
   deleteFile({ path }: { path: string }): Promise<boolean>;
   listFiles({ path }: { path: string }): Promise<string[] | undefined>;

CoreEditor/yarn.lock

@@ -5059,9 +5059,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"markedit-api@https://github.com/MarkEdit-app/MarkEdit-api#v0.20.0":
-  version: 0.20.0
-  resolution: "markedit-api@https://github.com/MarkEdit-app/MarkEdit-api.git#commit=9cba195b6b08b5373ba62eaa4a1f911da1ab14e2"
+"markedit-api@https://github.com/MarkEdit-app/MarkEdit-api#v0.21.0":
+  version: 0.21.0
+  resolution: "markedit-api@https://github.com/MarkEdit-app/MarkEdit-api.git#commit=080e8fbad8cd6de91b958c74e793c0dc34ef6fb2"
   peerDependencies:
     "@codemirror/autocomplete": ^6.0.0
     "@codemirror/commands": ^6.0.0
@@ -5074,7 +5074,7 @@ __metadata:
     "@lezer/highlight": ^1.0.0
     "@lezer/lr": ^1.0.0
     "@lezer/markdown": ^1.0.0
-  checksum: 10c0/95e7cced2c51c39b16b00595bd8ace6fc87f9545316467c8a8af0986d892cc29635f40c0f4ad81284c5af8f6445707996e3d49b17092b655fc95faa9bf6f46b2
+  checksum: 10c0/9e504c5d0d5b0f3ab35771582a0f6a9da756cfd6dc599cf4d67991f3b9764532daf1bd09f9f01c04a2393a0b953d0e23e1bbc364d8be40ea5350422c09daa0bc
   languageName: node
   linkType: hard
 
@@ -5108,7 +5108,7 @@ __metadata:
     jest: "npm:^30.2.0"
     jest-environment-jsdom: "npm:^30.2.0"
     js-yaml: "npm:^4.1.1"
-    markedit-api: "https://github.com/MarkEdit-app/MarkEdit-api#v0.20.0"
+    markedit-api: "https://github.com/MarkEdit-app/MarkEdit-api#v0.21.0"
     rollup: "npm:^4.0.0"
     ts-gyb: "npm:^0.12.0"
     ts-jest: "npm:^29.4.5"

MarkEditKit/Sources/Bridge/Native/Generated/NativeModuleAPI.swift

@@ -12,6 +12,7 @@ import MarkEditCore
 
 @MainActor
 public protocol NativeModuleAPI: NativeModule {
+  func openFile(path: String) async -> Bool
   func createFile(options: CreateFileOptions) async -> Bool
   func deleteFile(path: String) async -> Bool
   func listFiles(path: String) async -> [String]?
@@ -36,6 +37,9 @@ public extension NativeModuleAPI {
 final class NativeBridgeAPI: NativeBridge {
   static let name = "api"
   lazy var methods: [String: NativeMethod] = [
+    "openFile": { [weak self] in
+      await self?.openFile(parameters: $0)
+    },
     "createFile": { [weak self] in
       await self?.createFile(parameters: $0)
     },
@@ -87,6 +91,23 @@ final class NativeBridgeAPI: NativeBridge {
     self.module = module
   }
 
+  private func openFile(parameters: Data) async -> Result<Any?, Error>? {
+    struct Message: Decodable {
+      var path: String
+    }
+
+    let message: Message
+    do {
+      message = try decoder.decode(Message.self, from: parameters)
+    } catch {
+      Logger.assertFail("Failed to decode parameters: \(parameters)")
+      return .failure(error)
+    }
+
+    let result = await module.openFile(path: message.path)
+    return .success(result)
+  }
+
   private func createFile(parameters: Data) async -> Result<Any?, Error>? {
     struct Message: Decodable {
       var options: CreateFileOptions

MarkEditKit/Sources/Bridge/Native/Modules/EditorModuleAPI.swift

@@ -13,6 +13,7 @@ import UniformTypeIdentifiers
 
 @MainActor
 public protocol EditorModuleAPIDelegate: AnyObject {
+  func editorAPIOpenFile(_ sender: EditorModuleAPI, fileURL: URL) -> Bool
   func editorAPIGetFileURL(_ sender: EditorModuleAPI, path: String?) -> URL?
   func editorAPI(_ sender: EditorModuleAPI, addMainMenuItems items: [(String, WebMenuItem)])
   func editorAPI(_ sender: EditorModuleAPI, showContextMenu items: [WebMenuItem], location: WebPoint)
@@ -39,6 +40,10 @@ public final class EditorModuleAPI: NativeModuleAPI {
     self.delegate = delegate
   }
 
+  public func openFile(path: String) async -> Bool {
+    delegate?.editorAPIOpenFile(self, fileURL: URL(filePath: path)) == true
+  }
+
   public func createFile(options: CreateFileOptions) async -> Bool {
     guard let fileURL = delegate?.editorAPIGetFileURL(self, path: options.path) else {
       return false

MarkEditMac/Sources/Editor/Controllers/EditorViewController+Delegate.swift

@@ -288,6 +288,10 @@ extension EditorViewController: EditorModulePreviewDelegate {
 // MARK: - EditorModuleAPIDelegate
 
 extension EditorViewController: EditorModuleAPIDelegate {
+  func editorAPIOpenFile(_ sender: EditorModuleAPI, fileURL: URL) -> Bool {
+    NSWorkspace.shared.openOrReveal(url: fileURL)
+  }
+
   func editorAPIGetFileURL(_ sender: EditorModuleAPI, path: String?) -> URL? {
     guard let path else {
       return document?.fileURL

MarkEditMac/Sources/Main/Application/AppDelegate+Document.swift

@@ -61,6 +61,14 @@ extension AppDelegate {
     }
   }
 
+  func openFile(queryDict: [String: String]?) {
+    if let filePath = queryDict?["path"] {
+      NSWorkspace.shared.openOrReveal(url: URL(filePath: filePath))
+    } else {
+      NSApp.showOpenPanel()
+    }
+  }
+
   func createNewFile(queryDict: [String: String]?) {
     let fileName = queryDict?["filename"]
     let initialContent = queryDict?["initial-content"]

MarkEditMac/Sources/Main/Application/AppDelegate.swift

@@ -152,8 +152,8 @@ extension AppDelegate {
         // markedit://new-file?filename=Untitled&initial-content=Hello
         createNewFile(queryDict: components?.queryDict)
       case "open":
-        // markedit://open
-        application.showOpenPanel()
+        // markedit://open or markedit://open?path=Untitled.md
+        openFile(queryDict: components?.queryDict)
       default:
         break
       }