Add Shortcuts support (#107)

* Add Shortcuts support

* Better naming

* Improve comments

* Improve README.md

* Update screenshots

Author: cyanzhong

CoreEditor/src/bridge/web/core.ts

@@ -1,5 +1,5 @@
 import { WebModule } from '../webModule';
-import { resetEditor, clearEditor, getEditorText, insertText, markEditorDirty } from '../../core';
+import { ReplaceGranularity, resetEditor, clearEditor, getEditorText, insertText, replaceText, markEditorDirty } from '../../core';
 
 /**
  * @shouldExport true
@@ -11,6 +11,7 @@ export interface WebModuleCore extends WebModule {
   clearEditor(): void;
   getEditorText(): string;
   insertText({ text, from, to }: { text: string; from: CodeGen_Int; to: CodeGen_Int }): void;
+  replaceText({ text, granularity }: { text: string; granularity: ReplaceGranularity }): void;
   markEditorDirty({ isDirty }: { isDirty: boolean }): void;
 }
 
@@ -31,6 +32,10 @@ export class WebModuleCoreImpl implements WebModuleCore {
     insertText(text, from, to);
   }
 
+  replaceText({ text, granularity }: { text: string; granularity: ReplaceGranularity }): void {
+    replaceText(text, granularity);
+  }
+
   markEditorDirty({ isDirty }: { isDirty: boolean }): void {
     markEditorDirty(isDirty);
   }

CoreEditor/src/core.ts

@@ -1,13 +1,19 @@
 import { EditorView } from '@codemirror/view';
 import { extensions } from './extensions';
 import { editingState } from './common/store';
+import replaceSelections from './modules/commands/replaceSelections';
 
 import * as styling from './styling/config';
 import * as themes from './styling/themes';
 import * as history from './modules/history';
 import * as lineEndings from './modules/lineEndings';
 import * as completion from './modules/completion';
 
+export enum ReplaceGranularity {
+  wholeDocument = 'wholeDocument',
+  selection = 'selection',
+}
+
 /**
  * Reset the editor to the initial state.
  *
@@ -93,6 +99,17 @@ export function insertText(text: string, from: number, to: number) {
   });
 }
 
+export function replaceText(text: string, granularity: ReplaceGranularity) {
+  switch (granularity) {
+    case ReplaceGranularity.wholeDocument:
+      insertText(text, 0, window.editor.state.doc.length);
+      break;
+    case ReplaceGranularity.selection:
+      replaceSelections(text);
+      break;
+  }
+}
+
 export function markEditorDirty(isDirty: boolean) {
   editingState.isDirty = isDirty;
 }

MarkEdit.xcodeproj/project.pbxproj

@@ -39,6 +39,12 @@
 		873D6438295FEF220095DEF7 /* Localizable.strings in Resources */ = {isa = PBXBuildFile; fileRef = 873D643A295FEF220095DEF7 /* Localizable.strings */; };
 		874823CE29B0BD980067EC49 /* TextCompletion in Frameworks */ = {isa = PBXBuildFile; productRef = 874823CD29B0BD980067EC49 /* TextCompletion */; };
 		874AAE2E2959F197000E0E84 /* EditorReplacePanel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874AAE2D2959F197000E0E84 /* EditorReplacePanel.swift */; };
+		874BE6F429BB37FA002F83BA /* IntentProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE6F329BB37FA002F83BA /* IntentProvider.swift */; };
+		874BE6F729BB57AC002F83BA /* IntentError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE6F629BB57AC002F83BA /* IntentError.swift */; };
+		874BE6FB29BB5804002F83BA /* AppIntent+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE6FA29BB5804002F83BA /* AppIntent+Extension.swift */; };
+		874BE70229BB5889002F83BA /* GetFileContentIntent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE70129BB5889002F83BA /* GetFileContentIntent.swift */; };
+		874BE70829BB62BA002F83BA /* CreateNewDocumentIntent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE70729BB62BA002F83BA /* CreateNewDocumentIntent.swift */; };
+		874BE70E29BB73CA002F83BA /* UpdateFileContentIntent.swift in Sources */ = {isa = PBXBuildFile; fileRef = 874BE70D29BB73CA002F83BA /* UpdateFileContentIntent.swift */; };
 		8752CEB6295B2F8800BA9D5B /* EditorPanelView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8752CEB5295B2F8800BA9D5B /* EditorPanelView.swift */; };
 		876578FA2993853500A1388A /* index.html in Resources */ = {isa = PBXBuildFile; fileRef = 876578F92993853500A1388A /* index.html */; };
 		8767BBAF295A8BA500BFACAE /* EditorViewController+UI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8767BBAE295A8BA500BFACAE /* EditorViewController+UI.swift */; };
@@ -140,6 +146,12 @@
 		873D643D295FEF370095DEF7 /* zh-Hans */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "zh-Hans"; path = "zh-Hans.lproj/Localizable.strings"; sourceTree = "<group>"; };
 		8743B26229593B2000F83DAE /* Build.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Build.xcconfig; sourceTree = "<group>"; };
 		874AAE2D2959F197000E0E84 /* EditorReplacePanel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EditorReplacePanel.swift; sourceTree = "<group>"; };
+		874BE6F329BB37FA002F83BA /* IntentProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IntentProvider.swift; sourceTree = "<group>"; };
+		874BE6F629BB57AC002F83BA /* IntentError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IntentError.swift; sourceTree = "<group>"; };
+		874BE6FA29BB5804002F83BA /* AppIntent+Extension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "AppIntent+Extension.swift"; sourceTree = "<group>"; };
+		874BE70129BB5889002F83BA /* GetFileContentIntent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetFileContentIntent.swift; sourceTree = "<group>"; };
+		874BE70729BB62BA002F83BA /* CreateNewDocumentIntent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CreateNewDocumentIntent.swift; sourceTree = "<group>"; };
+		874BE70D29BB73CA002F83BA /* UpdateFileContentIntent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UpdateFileContentIntent.swift; sourceTree = "<group>"; };
 		8752CEB5295B2F8800BA9D5B /* EditorPanelView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EditorPanelView.swift; sourceTree = "<group>"; };
 		876578F92993853500A1388A /* index.html */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.html; name = index.html; path = "CoreEditor/src/@light/dist/index.html"; sourceTree = SOURCE_ROOT; };
 		8767BBAE295A8BA500BFACAE /* EditorViewController+UI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "EditorViewController+UI.swift"; sourceTree = "<group>"; };
@@ -283,6 +295,7 @@
 				873D6403295FD2FF0095DEF7 /* Main */,
 				870A51C429470D830095C7EB /* Editor */,
 				870F1797298577A000003DA7 /* Panels */,
+				874BE6F229BB37D5002F83BA /* Shortcuts */,
 				8780AC0A29822C5500065EF4 /* Settings */,
 				87850C8429482A6A00D1A952 /* Extensions */,
 			);
@@ -354,6 +367,35 @@
 			name = Frameworks;
 			sourceTree = "<group>";
 		};
+		874BE6F229BB37D5002F83BA /* Shortcuts */ = {
+			isa = PBXGroup;
+			children = (
+				874BE6FD29BB581E002F83BA /* Intents */,
+				874BE6F929BB57FA002F83BA /* Extensions */,
+				874BE6F629BB57AC002F83BA /* IntentError.swift */,
+				874BE6F329BB37FA002F83BA /* IntentProvider.swift */,
+			);
+			path = Shortcuts;
+			sourceTree = "<group>";
+		};
+		874BE6F929BB57FA002F83BA /* Extensions */ = {
+			isa = PBXGroup;
+			children = (
+				874BE6FA29BB5804002F83BA /* AppIntent+Extension.swift */,
+			);
+			path = Extensions;
+			sourceTree = "<group>";
+		};
+		874BE6FD29BB581E002F83BA /* Intents */ = {
+			isa = PBXGroup;
+			children = (
+				874BE70729BB62BA002F83BA /* CreateNewDocumentIntent.swift */,
+				874BE70129BB5889002F83BA /* GetFileContentIntent.swift */,
+				874BE70D29BB73CA002F83BA /* UpdateFileContentIntent.swift */,
+			);
+			path = Intents;
+			sourceTree = "<group>";
+		};
 		8767BBAC295A893200BFACAE /* Controllers */ = {
 			isa = PBXGroup;
 			children = (
@@ -590,18 +632,23 @@
 			buildActionMask = 2147483647;
 			files = (
 				8725E0822977EF46006A4961 /* EditorViewController+Toolbar.swift in Sources */,
+				874BE6F429BB37FA002F83BA /* IntentProvider.swift in Sources */,
+				874BE70E29BB73CA002F83BA /* UpdateFileContentIntent.swift in Sources */,
 				8780AC202982A2DD00065EF4 /* WindowSettingsView.swift in Sources */,
 				87BD071229699A290053EF5F /* EditorViewController+Preview.swift in Sources */,
 				873D6402295FCC3E0095DEF7 /* AppResources.swift in Sources */,
 				870A51BC294702AF0095C7EB /* AppDelegate.swift in Sources */,
 				8780AC1E2982A2C900065EF4 /* EditorSettingsView.swift in Sources */,
 				8767BBB5295AD62700BFACAE /* EditorReplaceButtons.swift in Sources */,
 				87BDF6E42976C97100548079 /* EditorViewController+GotoLine.swift in Sources */,
+				874BE6FB29BB5804002F83BA /* AppIntent+Extension.swift in Sources */,
 				87F2B5F429ACF56E0027103E /* EditorViewController+Completion.swift in Sources */,
 				8772E385294AC60D00111E83 /* EditorReusePool.swift in Sources */,
 				8709C69E29B4412F009EABB5 /* AssistantSettingsView.swift in Sources */,
+				874BE70229BB5889002F83BA /* GetFileContentIntent.swift in Sources */,
 				870F17662984D2C000003DA7 /* EditorViewController+LineEndings.swift in Sources */,
 				8790B6EC297036B2000DFC1A /* EditorWindow.swift in Sources */,
+				874BE6F729BB57AC002F83BA /* IntentError.swift in Sources */,
 				87AA1224296560AE00BE4719 /* EditorViewController+HyperLink.swift in Sources */,
 				8725E0802977EEB3006A4961 /* EditorToolbarItems.swift in Sources */,
 				870A51B9294702AF0095C7EB /* EditorViewController.swift in Sources */,
@@ -625,6 +672,7 @@
 				8767BBAF295A8BA500BFACAE /* EditorViewController+UI.swift in Sources */,
 				87AAEDF52958258C00C8E61C /* EditorFindPanel+UI.swift in Sources */,
 				87A73AB5294C4B48006A710E /* EditorFindPanel.swift in Sources */,
+				874BE70829BB62BA002F83BA /* CreateNewDocumentIntent.swift in Sources */,
 				870A51BD294702AF0095C7EB /* EditorDocument.swift in Sources */,
 				8780AC182982554800065EF4 /* SettingTabs.swift in Sources */,
 				87F2B61429AF2F3A0027103E /* NSSpellChecker+Extension.swift in Sources */,

MarkEditKit/Sources/Bridge/Web/Generated/WebBridgeCore.swift

@@ -57,6 +57,20 @@ public final class WebBridgeCore {
     webView?.invoke(path: "webModules.core.insertText", message: message, completion: completion)
   }
 
+  public func replaceText(text: String, granularity: ReplaceGranularity, completion: ((Result<Void, WKWebView.InvokeError>) -> Void)? = nil) {
+    struct Message: Encodable {
+      let text: String
+      let granularity: ReplaceGranularity
+    }
+
+    let message = Message(
+      text: text,
+      granularity: granularity
+    )
+
+    webView?.invoke(path: "webModules.core.replaceText", message: message, completion: completion)
+  }
+
   public func markEditorDirty(isDirty: Bool, completion: ((Result<Void, WKWebView.InvokeError>) -> Void)? = nil) {
     struct Message: Encodable {
       let isDirty: Bool
@@ -69,3 +83,8 @@ public final class WebBridgeCore {
     webView?.invoke(path: "webModules.core.markEditorDirty", message: message, completion: completion)
   }
 }
+
+public enum ReplaceGranularity: String, Codable {
+  case wholeDocument = "wholeDocument"
+  case selection = "selection"
+}

MarkEditMac/Resources/zh-Hans.lproj/Localizable.strings

@@ -52,12 +52,21 @@
 /* Label for word completion options */
 "Completion:" = "单词补全：";
 
+/* No comment provided by engineer. */
+"Content" = "内容";
+
 /* Phrase used in CodeMirror to indicate control character */
 "Control Character" = "控制字符";
 
 /* Toolbar item to copy pandoc command */
 "Copy Pandoc Command" = "拷贝 Pandoc 指令";
 
+/* No comment provided by engineer. */
+"Create a new document, with an optional parameter to specify the initial content." = "新建一个文档，可通过一个可选参数来指定初始内容。";
+
+/* No comment provided by engineer. */
+"Create New Document" = "创建新文档";
+
 /* Always use dark mode for the app */
 "Dark" = "深色";
 
@@ -106,9 +115,18 @@
 /* Window title for general settings */
 "General" = "通用";
 
+/* No comment provided by engineer. */
+"Get File Content" = "获取文件内容";
+
+/* No comment provided by engineer. */
+"Get file content of the active document, throws an error if no editor is opened." = "获取当前活跃文档的内容，没有打开的编辑器时将抛出异常。";
+
 /* Placeholder text for goto line window */
 "Go to Line" = "跳转到行";
 
+/* No comment provided by engineer. */
+"Granularity" = "粒度";
+
 /* Option for guessed words suggestion */
 "Guessed words" = "猜测的单词";
 
@@ -124,6 +142,9 @@
 /* Press tab key to indent more */
 "Indents more" = "增加缩进";
 
+/* No comment provided by engineer. */
+"Initial Content" = "初始内容";
+
 /* Toolbar item to insert code */
 "Insert Code" = "插入代码";
 
@@ -172,12 +193,18 @@
 /* Line endings used on macOS and Unix */
 "macOS / Unix (LF)" = "macOS / Unix (LF)";
 
+/* No comment provided by engineer. */
+"Missing active document to proceed." = "没有活跃的文档来进行下一步。";
+
 /* Never show invisibles */
 "Never" = "从不";
 
 /* Menu item: create a new document */
 "New Document" = "新建文档";
 
+/* No comment provided by engineer. */
+"New Document with ${initialContent}" = "使用 ${initialContent} 新建文档";
+
 /* Behavior when creating new windows */
 "New Window Behavior:" = "新窗口行为：";
 
@@ -235,6 +262,9 @@
 /* Replace mode in search menu */
 "Replace" = "替换";
 
+/* No comment provided by engineer. */
+"Save Changes" = "保存改动";
+
 /* Menu item: select all occurrences */
 "Select All Occurrences" = "选择所有相同项";
 
@@ -319,6 +349,18 @@
 /* Phrase used in CodeMirror to indicate unfolded lines */
 "Unfolded Lines" = "展开的行";
 
+/* No comment provided by engineer. */
+"Update File Content" = "更新文件内容";
+
+/* No comment provided by engineer. */
+"Update file content of the active document, throws an error if no editor is opened." = "更新当前活跃文档的内容，没有打开的编辑器时将抛出异常。";
+
+/* No comment provided by engineer. */
+"Update file with ${content}" = "使用 ${content} 更新文件";
+
+/* No comment provided by engineer. */
+"Whole Document" = "整个文档";
+
 /* Toggle whole word search */
 "Whole Word" = "整词查找";
 

MarkEditMac/Resources/zh-Hant.lproj/Localizable.strings

@@ -52,12 +52,21 @@
 /* Label for word completion options */
 "Completion:" = "單字補全：";
 
+/* No comment provided by engineer. */
+"Content" = "內容";
+
 /* Phrase used in CodeMirror to indicate control character */
 "Control Character" = "控制字元";
 
 /* Toolbar item to copy pandoc command */
 "Copy Pandoc Command" = "拷貝 Pandoc 指令";
 
+/* No comment provided by engineer. */
+"Create a new document, with an optional parameter to specify the initial content." = "新建一個文件，可透過一個可選變數來指定初始內容。";
+
+/* No comment provided by engineer. */
+"Create New Document" = "建立新文件";
+
 /* Always use dark mode for the app */
 "Dark" = "深色";
 
@@ -106,9 +115,18 @@
 /* Window title for general settings */
 "General" = "一般";
 
+/* No comment provided by engineer. */
+"Get File Content" = "獲取文件內容";
+
+/* No comment provided by engineer. */
+"Get file content of the active document, throws an error if no editor is opened." = "獲取當前活躍文件的內容，沒有開啟的編輯器時將丟擲異常。";
+
 /* Placeholder text for goto line window */
 "Go to Line" = "跳轉到行";
 
+/* No comment provided by engineer. */
+"Granularity" = "粒度";
+
 /* Option for guessed words suggestion */
 "Guessed words" = "猜測的單字";
 
@@ -124,6 +142,9 @@
 /* Press tab key to indent more */
 "Indents more" = "增加縮排";
 
+/* No comment provided by engineer. */
+"Initial Content" = "初始內容";
+
 /* Toolbar item to insert code */
 "Insert Code" = "插入程式碼";
 
@@ -172,12 +193,18 @@
 /* Line endings used on macOS and Unix */
 "macOS / Unix (LF)" = "macOS / Unix (LF)";
 
+/* No comment provided by engineer. */
+"Missing active document to proceed." = "沒有活躍的文件來進行下一步。";
+
 /* Never show invisibles */
 "Never" = "從不";
 
 /* Menu item: create a new document */
 "New Document" = "新增文件";
 
+/* No comment provided by engineer. */
+"New Document with ${initialContent}" = "使用 ${initialContent} 新增文件";
+
 /* Behavior when creating new windows */
 "New Window Behavior:" = "新視窗行為：";
 
@@ -235,6 +262,9 @@
 /* Replace mode in search menu */
 "Replace" = "取代";
 
+/* No comment provided by engineer. */
+"Save Changes" = "儲存改動";
+
 /* Menu item: select all occurrences */
 "Select All Occurrences" = "選擇所有相同項";
 
@@ -319,6 +349,18 @@
 /* Phrase used in CodeMirror to indicate unfolded lines */
 "Unfolded Lines" = "展開的行";
 
+/* No comment provided by engineer. */
+"Update File Content" = "更新文件內容";
+
+/* No comment provided by engineer. */
+"Update file content of the active document, throws an error if no editor is opened." = "更新當前活躍文件的內容，沒有開啟的編輯器時將丟擲異常。";
+
+/* No comment provided by engineer. */
+"Update file with ${content}" = "使用 ${content} 更新文件";
+
+/* No comment provided by engineer. */
+"Whole Document" = "整個文件";
+
 /* Toggle whole word search */
 "Whole Word" = "整詞尋找";