Improve the way we update text checking features (#1333)

Author: cyanzhong

CoreEditor/index.ts

@@ -6,7 +6,6 @@ import { WebModuleCoreImpl } from './src/bridge/web/core';
 import { WebModuleCompletionImpl } from './src/bridge/web/completion';
 import { WebModuleHistoryImpl } from './src/bridge/web/history';
 import { WebModuleLineEndingsImpl } from './src/bridge/web/lineEndings';
-import { WebModuleTextCheckerImpl } from './src/bridge/web/textChecker';
 import { WebModuleSelectionImpl } from './src/bridge/web/selection';
 import { WebModuleFormatImpl } from './src/bridge/web/format';
 import { WebModuleSearchImpl } from './src/bridge/web/search';
@@ -66,7 +65,6 @@ window.webModules = {
   completion: new WebModuleCompletionImpl(),
   history: new WebModuleHistoryImpl(),
   lineEndings: new WebModuleLineEndingsImpl(),
-  textChecker: new WebModuleTextCheckerImpl(),
   selection: new WebModuleSelectionImpl(),
   format: new WebModuleFormatImpl(),
   search: new WebModuleSearchImpl(),

CoreEditor/src/bridge/web/textChecker.ts

@@ -17,6 +17,7 @@ import { getLineBreak, normalizeLineBreaks } from './modules/lineEndings';
 import { removeFrontMatter } from './modules/frontMatter';
 import { selectedMainText, scrollIntoView } from './modules/selection';
 import { markContentClean } from './modules/history';
+import { updateTextChecker } from './modules/textChecker';
 
 import { TextEditor } from './api/editor';
 import { editorReadyListeners } from './api/methods';
@@ -104,6 +105,11 @@ export function resetEditor(initialContent: string) {
   const contentDOM = editor.contentDOM;
   contentDOM.addEventListener('blur', handleFocusLost);
 
+  updateTextChecker(contentDOM, {
+    spellcheck: true,
+    autocorrect: true,
+  });
+
   const scrollDOM = editor.scrollDOM;
   scrollDOM.scrollTo({ top: 0 }); // scrollIntoView doesn't work when the app is idle
 

CoreEditor/src/core.ts

@@ -3,8 +3,7 @@ import TextCheckerOptions from './options';
 /**
  * Div level text checker settings.
  */
-export function update(options: TextCheckerOptions) {
-  const contentDOM = window.editor.contentDOM;
+export function updateTextChecker(contentDOM: HTMLElement, options: TextCheckerOptions) {
   contentDOM.setAttribute('spellcheck', options.spellcheck ? 'true' : 'false');
   contentDOM.setAttribute('autocorrect', options.autocorrect ? 'on' : 'off');
 

CoreEditor/src/modules/textChecker/index.ts

@@ -0,0 +1,50 @@
+import { describe, expect, test } from '@jest/globals';
+import { updateTextChecker } from '../src/modules/textChecker';
+
+function createContentDOM(): HTMLElement {
+  const div = document.createElement('div');
+  div.setAttribute('autocomplete', 'on');
+  div.setAttribute('autocapitalize', 'on');
+  return div;
+}
+
+describe('TextChecker test suite', () => {
+  test('test spellcheck and autocorrect enabled', () => {
+    const dom = createContentDOM();
+    updateTextChecker(dom, { spellcheck: true, autocorrect: true });
+
+    expect(dom.getAttribute('spellcheck')).toBe('true');
+    expect(dom.getAttribute('autocorrect')).toBe('on');
+    expect(dom.hasAttribute('autocomplete')).toBe(false);
+    expect(dom.hasAttribute('autocapitalize')).toBe(false);
+  });
+
+  test('test spellcheck and autocorrect disabled', () => {
+    const dom = createContentDOM();
+    updateTextChecker(dom, { spellcheck: false, autocorrect: false });
+
+    expect(dom.getAttribute('spellcheck')).toBe('false');
+    expect(dom.getAttribute('autocorrect')).toBe('off');
+    expect(dom.hasAttribute('autocomplete')).toBe(false);
+    expect(dom.hasAttribute('autocapitalize')).toBe(false);
+  });
+
+  test('test mixed options', () => {
+    const dom = createContentDOM();
+    updateTextChecker(dom, { spellcheck: true, autocorrect: false });
+
+    expect(dom.getAttribute('spellcheck')).toBe('true');
+    expect(dom.getAttribute('autocorrect')).toBe('off');
+  });
+
+  test('test autocomplete and autocapitalize are removed', () => {
+    const dom = createContentDOM();
+    expect(dom.hasAttribute('autocomplete')).toBe(true);
+    expect(dom.hasAttribute('autocapitalize')).toBe(true);
+
+    updateTextChecker(dom, { spellcheck: false, autocorrect: false });
+
+    expect(dom.hasAttribute('autocomplete')).toBe(false);
+    expect(dom.hasAttribute('autocapitalize')).toBe(false);
+  });
+});

CoreEditor/test/textChecker.test.ts

@@ -16,7 +16,6 @@ public struct WebModuleBridge {
   public let completion: WebBridgeCompletion
   public let history: WebBridgeHistory
   public let lineEndings: WebBridgeLineEndings
-  public let textChecker: WebBridgeTextChecker
   public let selection: WebBridgeSelection
   public let format: WebBridgeFormat
   public let search: WebBridgeSearch
@@ -31,7 +30,6 @@ public struct WebModuleBridge {
     self.completion = WebBridgeCompletion(webView: webView)
     self.history = WebBridgeHistory(webView: webView)
     self.lineEndings = WebBridgeLineEndings(webView: webView)
-    self.textChecker = WebBridgeTextChecker(webView: webView)
     self.selection = WebBridgeSelection(webView: webView)
     self.format = WebBridgeFormat(webView: webView)
     self.search = WebBridgeSearch(webView: webView)

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

@@ -320,17 +320,13 @@ extension EditorViewController {
       return
     }
 
-    bridge.core.resetEditor(text: textContent) { _ in
-      self.webView.magnification = 1.0
-      self.bridge.textChecker.update(options: TextCheckerOptions(
-        spellcheck: true,
-        autocorrect: true
-      ))
+    bridge.core.resetEditor(text: textContent) { [weak self] _ in
+      self?.webView.magnification = 1.0
 
       // Initial content from scenarios like "CreateNewDocumentIntent" or "New File from Clipboard"
-      if let text = self.initialContent {
-        self.prependTextContent(text)
-        self.initialContent = nil
+      if let text = self?.initialContent {
+        self?.prependTextContent(text)
+        self?.initialContent = nil
       }
     }