From 4da4827bcbcdd1ef163f635d9b29416ff272b0bb Mon Sep 17 00:00:00 2001
From: toasted-nutbread <toasted-nutbread@users.noreply.github.com>
Date: Mon, 27 Nov 2023 12:48:14 -0500
Subject: Add JSDoc type annotations to project (rebased)

---
 ext/js/accessibility/accessibility-controller.js | 14 +++++++-
 ext/js/accessibility/google-docs-util.js         | 46 +++++++++++++++++++-----
 ext/js/accessibility/google-docs.js              | 14 ++++++--
 3 files changed, 62 insertions(+), 12 deletions(-)

(limited to 'ext/js/accessibility')

diff --git a/ext/js/accessibility/accessibility-controller.js b/ext/js/accessibility/accessibility-controller.js
index e9a24880..a4239947 100644
--- a/ext/js/accessibility/accessibility-controller.js
+++ b/ext/js/accessibility/accessibility-controller.js
@@ -28,15 +28,19 @@ export class AccessibilityController {
      * @param {ScriptManager} scriptManager An instance of the `ScriptManager` class.
      */
     constructor(scriptManager) {
+        /** @type {ScriptManager} */
         this._scriptManager = scriptManager;
+        /** @type {?import('core').TokenObject} */
         this._updateGoogleDocsAccessibilityToken = null;
+        /** @type {?Promise<void>} */
         this._updateGoogleDocsAccessibilityPromise = null;
+        /** @type {boolean} */
         this._forceGoogleDocsHtmlRenderingAny = false;
     }
 
     /**
      * Updates the accessibility handlers.
-     * @param {object} fullOptions The full options object from the `Backend` instance.
+     * @param {import('settings').Options} fullOptions The full options object from the `Backend` instance.
      *   The value is treated as read-only and is not modified.
      */
     async update(fullOptions) {
@@ -53,8 +57,12 @@ export class AccessibilityController {
 
     // Private
 
+    /**
+     * @param {boolean} forceGoogleDocsHtmlRenderingAny
+     */
     async _updateGoogleDocsAccessibility(forceGoogleDocsHtmlRenderingAny) {
         // Reentrant token
+        /** @type {?import('core').TokenObject} */
         const token = {};
         this._updateGoogleDocsAccessibilityToken = token;
 
@@ -72,6 +80,9 @@ export class AccessibilityController {
         this._updateGoogleDocsAccessibilityPromise = null;
     }
 
+    /**
+     * @param {boolean} forceGoogleDocsHtmlRenderingAny
+     */
     async _updateGoogleDocsAccessibilityInner(forceGoogleDocsHtmlRenderingAny) {
         if (this._forceGoogleDocsHtmlRenderingAny === forceGoogleDocsHtmlRenderingAny) { return; }
 
@@ -81,6 +92,7 @@ export class AccessibilityController {
         try {
             if (forceGoogleDocsHtmlRenderingAny) {
                 if (await this._scriptManager.isContentScriptRegistered(id)) { return; }
+                /** @type {import('script-manager').RegistrationDetails} */
                 const details = {
                     allFrames: true,
                     matchAboutBlank: true,
diff --git a/ext/js/accessibility/google-docs-util.js b/ext/js/accessibility/google-docs-util.js
index e170f334..9db45cc1 100644
--- a/ext/js/accessibility/google-docs-util.js
+++ b/ext/js/accessibility/google-docs-util.js
@@ -29,8 +29,8 @@ export class GoogleDocsUtil {
      * Coordinates are provided in [client space](https://developer.mozilla.org/en-US/docs/Web/CSS/CSSOM_View/Coordinate_systems).
      * @param {number} x The x coordinate to search at.
      * @param {number} y The y coordinate to search at.
-     * @param {GetRangeFromPointOptions} options Options to configure how element detection is performed.
-     * @returns {?TextSourceRange|TextSourceElement} A range for the hovered text or element, or `null` if no applicable content was found.
+     * @param {import('document-util').GetRangeFromPointOptions} options Options to configure how element detection is performed.
+     * @returns {?TextSourceRange} A range for the hovered text or element, or `null` if no applicable content was found.
      */
     static getRangeFromPoint(x, y, {normalizeCssZoom}) {
         const styleNode = this._getStyleNode();
@@ -46,10 +46,13 @@ export class GoogleDocsUtil {
         return null;
     }
 
+    /**
+     * @returns {HTMLStyleElement}
+     */
     static _getStyleNode() {
         // This <style> node is necessary to force the SVG <rect> elements to have a fill,
         // which allows them to be included in document.elementsFromPoint's return value.
-        if (this._styleNode === null) {
+        if (typeof this._styleNode === 'undefined') {
             const style = document.createElement('style');
             style.textContent = [
                 '.kix-canvas-tile-content{pointer-events:none!important;}',
@@ -64,21 +67,34 @@ export class GoogleDocsUtil {
         return this._styleNode;
     }
 
+    /**
+     * @param {Element} element
+     * @param {string} text
+     * @param {number} x
+     * @param {number} y
+     * @param {boolean} normalizeCssZoom
+     * @returns {TextSourceRange}
+     */
     static _createRange(element, text, x, y, normalizeCssZoom) {
         // Create imposter
         const content = document.createTextNode(text);
         const svgText = document.createElementNS('http://www.w3.org/2000/svg', 'text');
         const transform = element.getAttribute('transform') || '';
         const font = element.getAttribute('data-font-css') || '';
-        svgText.setAttribute('x', element.getAttribute('x'));
-        svgText.setAttribute('y', element.getAttribute('y'));
+        const elementX = element.getAttribute('x');
+        const elementY = element.getAttribute('y');
+        if (typeof elementX === 'string') { svgText.setAttribute('x', elementX); }
+        if (typeof elementY === 'string') { svgText.setAttribute('y', elementY); }
         svgText.appendChild(content);
         const textStyle = svgText.style;
         this._setImportantStyle(textStyle, 'all', 'initial');
         this._setImportantStyle(textStyle, 'transform', transform);
         this._setImportantStyle(textStyle, 'font', font);
         this._setImportantStyle(textStyle, 'text-anchor', 'start');
-        element.parentNode.appendChild(svgText);
+        const {parentNode} = element;
+        if (parentNode !== null) {
+            parentNode.appendChild(svgText);
+        }
 
         // Adjust offset
         const elementRect = element.getBoundingClientRect();
@@ -93,6 +109,13 @@ export class GoogleDocsUtil {
         return TextSourceRange.createFromImposter(range, svgText, element);
     }
 
+    /**
+     * @param {Text} textNode
+     * @param {number} x
+     * @param {number} y
+     * @param {boolean} normalizeCssZoom
+     * @returns {Range}
+     */
     static _getRangeWithPoint(textNode, x, y, normalizeCssZoom) {
         if (normalizeCssZoom) {
             const scale = DocumentUtil.computeZoomScale(textNode);
@@ -101,7 +124,7 @@ export class GoogleDocsUtil {
         }
         const range = document.createRange();
         let start = 0;
-        let end = textNode.nodeValue.length;
+        let end = /** @type {string} */ (textNode.nodeValue).length;
         while (end - start > 1) {
             const mid = Math.floor((start + end) / 2);
             range.setStart(textNode, mid);
@@ -117,9 +140,16 @@ export class GoogleDocsUtil {
         return range;
     }
 
+    /**
+     * @param {CSSStyleDeclaration} style
+     * @param {string} propertyName
+     * @param {string} value
+     */
     static _setImportantStyle(style, propertyName, value) {
         style.setProperty(propertyName, value, 'important');
     }
 }
+
+/** @type {HTMLStyleElement|undefined} */
 // eslint-disable-next-line no-underscore-dangle
-GoogleDocsUtil._styleNode = null;
+GoogleDocsUtil._styleNode = void 0;
diff --git a/ext/js/accessibility/google-docs.js b/ext/js/accessibility/google-docs.js
index f9290078..da6ab994 100644
--- a/ext/js/accessibility/google-docs.js
+++ b/ext/js/accessibility/google-docs.js
@@ -18,9 +18,17 @@
 
 (async () => {
     // Reentrant check
+    // @ts-ignore : Checking a property to the global object
     if (self.googleDocsAccessibilitySetup) { return; }
+    // @ts-ignore : Adding a property to the global object
     self.googleDocsAccessibilitySetup = true;
 
+    /**
+     * @template [TReturn=unknown]
+     * @param {string} action
+     * @param {import('core').SerializableObject} params
+     * @returns {Promise<TReturn>}
+     */
     const invokeApi = (action, params) => {
         return new Promise((resolve, reject) => {
             chrome.runtime.sendMessage({action, params}, (response) => {
@@ -37,6 +45,7 @@
     };
 
     const optionsContext = {depth: 0, url: location.href};
+    /** @type {import('api').OptionsGetResult} */
     let options;
     try {
         options = await invokeApi('optionsGet', {optionsContext});
@@ -48,9 +57,8 @@
 
     // The extension ID below is on an allow-list that is used on the Google Docs webpage.
     /* eslint-disable */
-    const inject = () => {
-        window._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami';
-    };
+    // @ts-ignore : Adding a property to the global object
+    const inject = () => { window._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami'; };
     /* eslint-enable */
 
     let parent = document.head;
-- 
cgit v1.2.3


From aabd761ee9064f6a46703f234e016f31f6441fa0 Mon Sep 17 00:00:00 2001
From: toasted-nutbread <toasted-nutbread@users.noreply.github.com>
Date: Mon, 27 Nov 2023 13:36:04 -0500
Subject: Remove unneeded references

---
 ext/js/accessibility/accessibility-controller.js  |  5 ++---
 ext/js/accessibility/google-docs-util.js          |  1 -
 ext/js/app/frontend.js                            |  6 ++----
 ext/js/app/popup-proxy.js                         | 14 ++++++--------
 ext/js/app/popup-window.js                        |  9 ++++-----
 ext/js/background/backend.js                      |  1 -
 ext/js/comm/anki-connect.js                       |  1 -
 ext/js/dom/document-util.js                       |  1 -
 ext/js/dom/text-source-element.js                 |  1 -
 ext/js/dom/text-source-range.js                   |  1 -
 ext/js/language/dictionary-worker-handler.js      |  1 -
 ext/js/language/dictionary-worker-media-loader.js |  2 +-
 ext/js/language/translator.js                     |  1 -
 ext/js/templates/template-renderer-proxy.js       |  2 +-
 14 files changed, 16 insertions(+), 30 deletions(-)

(limited to 'ext/js/accessibility')

diff --git a/ext/js/accessibility/accessibility-controller.js b/ext/js/accessibility/accessibility-controller.js
index a4239947..8250b369 100644
--- a/ext/js/accessibility/accessibility-controller.js
+++ b/ext/js/accessibility/accessibility-controller.js
@@ -16,7 +16,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {ScriptManager} from '../background/script-manager.js';
 import {log} from '../core.js';
 
 /**
@@ -25,10 +24,10 @@ import {log} from '../core.js';
 export class AccessibilityController {
     /**
      * Creates a new instance.
-     * @param {ScriptManager} scriptManager An instance of the `ScriptManager` class.
+     * @param {import('../background/script-manager.js').ScriptManager} scriptManager An instance of the `ScriptManager` class.
      */
     constructor(scriptManager) {
-        /** @type {ScriptManager} */
+        /** @type {import('../background/script-manager.js').ScriptManager} */
         this._scriptManager = scriptManager;
         /** @type {?import('core').TokenObject} */
         this._updateGoogleDocsAccessibilityToken = null;
diff --git a/ext/js/accessibility/google-docs-util.js b/ext/js/accessibility/google-docs-util.js
index 9db45cc1..4321f082 100644
--- a/ext/js/accessibility/google-docs-util.js
+++ b/ext/js/accessibility/google-docs-util.js
@@ -17,7 +17,6 @@
  */
 
 import {DocumentUtil} from '../dom/document-util.js';
-import {TextSourceElement} from '../dom/text-source-element.js';
 import {TextSourceRange} from '../dom/text-source-range.js';
 
 /**
diff --git a/ext/js/app/frontend.js b/ext/js/app/frontend.js
index fec933f8..628c504e 100644
--- a/ext/js/app/frontend.js
+++ b/ext/js/app/frontend.js
@@ -21,10 +21,8 @@ import {EventListenerCollection, invokeMessageHandler, log, promiseAnimationFram
 import {DocumentUtil} from '../dom/document-util.js';
 import {TextSourceElement} from '../dom/text-source-element.js';
 import {TextSourceRange} from '../dom/text-source-range.js';
-import {HotkeyHandler} from '../input/hotkey-handler.js';
 import {TextScanner} from '../language/text-scanner.js';
 import {yomitan} from '../yomitan.js';
-import {PopupFactory} from './popup-factory.js';
 
 /**
  * This is the main class responsible for scanning and handling webpage content.
@@ -50,7 +48,7 @@ export class Frontend {
     }) {
         /** @type {import('frontend').PageType} */
         this._pageType = pageType;
-        /** @type {PopupFactory} */
+        /** @type {import('./popup-factory.js').PopupFactory} */
         this._popupFactory = popupFactory;
         /** @type {number} */
         this._depth = depth;
@@ -70,7 +68,7 @@ export class Frontend {
         this._allowRootFramePopupProxy = allowRootFramePopupProxy;
         /** @type {boolean} */
         this._childrenSupported = childrenSupported;
-        /** @type {HotkeyHandler} */
+        /** @type {import('../input/hotkey-handler.js').HotkeyHandler} */
         this._hotkeyHandler = hotkeyHandler;
         /** @type {?import('popup').PopupAny} */
         this._popup = null;
diff --git a/ext/js/app/popup-proxy.js b/ext/js/app/popup-proxy.js
index 9b5b0214..924175e2 100644
--- a/ext/js/app/popup-proxy.js
+++ b/ext/js/app/popup-proxy.js
@@ -16,10 +16,8 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {FrameOffsetForwarder} from '../comm/frame-offset-forwarder.js';
 import {EventDispatcher, log} from '../core.js';
 import {yomitan} from '../yomitan.js';
-import {Popup} from './popup.js';
 
 /**
  * This class is a proxy for a Popup that is hosted in a different frame.
@@ -44,7 +42,7 @@ export class PopupProxy extends EventDispatcher {
         this._depth = depth;
         /** @type {number} */
         this._frameId = frameId;
-        /** @type {?FrameOffsetForwarder} */
+        /** @type {?import('../comm/frame-offset-forwarder.js').FrameOffsetForwarder} */
         this._frameOffsetForwarder = frameOffsetForwarder;
 
         /** @type {number} */
@@ -70,7 +68,7 @@ export class PopupProxy extends EventDispatcher {
     /**
      * The parent of the popup, which is always `null` for `PopupProxy` instances,
      * since any potential parent popups are in a different frame.
-     * @type {?Popup}
+     * @type {?import('./popup.js').Popup}
      */
     get parent() {
         return null;
@@ -78,7 +76,7 @@ export class PopupProxy extends EventDispatcher {
 
     /**
      * Attempts to set the parent popup.
-     * @param {Popup} _value The parent to assign.
+     * @param {import('./popup.js').Popup} _value The parent to assign.
      * @throws {Error} Throws an error, since this class doesn't support a direct parent.
      */
     set parent(_value) {
@@ -88,7 +86,7 @@ export class PopupProxy extends EventDispatcher {
     /**
      * The popup child popup, which is always null for `PopupProxy` instances,
      * since any potential child popups are in a different frame.
-     * @type {?Popup}
+     * @type {?import('./popup.js').Popup}
      */
     get child() {
         return null;
@@ -96,7 +94,7 @@ export class PopupProxy extends EventDispatcher {
 
     /**
      * Attempts to set the child popup.
-     * @param {Popup} _child The child to assign.
+     * @param {import('./popup.js').Popup} _child The child to assign.
      * @throws {Error} Throws an error, since this class doesn't support children.
      */
     set child(_child) {
@@ -354,7 +352,7 @@ export class PopupProxy extends EventDispatcher {
      * @param {number} now
      */
     async _updateFrameOffsetInner(now) {
-        this._frameOffsetPromise = /** @type {FrameOffsetForwarder} */ (this._frameOffsetForwarder).getOffset();
+        this._frameOffsetPromise = /** @type {import('../comm/frame-offset-forwarder.js').FrameOffsetForwarder} */ (this._frameOffsetForwarder).getOffset();
         try {
             const offset = await this._frameOffsetPromise;
             if (offset !== null) {
diff --git a/ext/js/app/popup-window.js b/ext/js/app/popup-window.js
index af1ac1e4..9a0f8011 100644
--- a/ext/js/app/popup-window.js
+++ b/ext/js/app/popup-window.js
@@ -18,7 +18,6 @@
 
 import {EventDispatcher} from '../core.js';
 import {yomitan} from '../yomitan.js';
-import {Popup} from './popup.js';
 
 /**
  * This class represents a popup that is hosted in a new native window.
@@ -54,7 +53,7 @@ export class PopupWindow extends EventDispatcher {
     }
 
     /**
-     * @type {?Popup}
+     * @type {?import('./popup.js').Popup}
      */
     get parent() {
         return null;
@@ -63,7 +62,7 @@ export class PopupWindow extends EventDispatcher {
     /**
      * The parent of the popup, which is always `null` for `PopupWindow` instances,
      * since any potential parent popups are in a different frame.
-     * @param {Popup} _value The parent to assign.
+     * @param {import('./popup.js').Popup} _value The parent to assign.
      * @throws {Error} Throws an error, since this class doesn't support children.
      */
     set parent(_value) {
@@ -73,7 +72,7 @@ export class PopupWindow extends EventDispatcher {
     /**
      * The popup child popup, which is always null for `PopupWindow` instances,
      * since any potential child popups are in a different frame.
-     * @type {?Popup}
+     * @type {?import('./popup.js').Popup}
      */
     get child() {
         return null;
@@ -81,7 +80,7 @@ export class PopupWindow extends EventDispatcher {
 
     /**
      * Attempts to set the child popup.
-     * @param {Popup} _value The child to assign.
+     * @param {import('./popup.js').Popup} _value The child to assign.
      * @throws Throws an error, since this class doesn't support children.
      */
     set child(_value) {
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
index a8683b3f..14877cf1 100644
--- a/ext/js/background/backend.js
+++ b/ext/js/background/backend.js
@@ -25,7 +25,6 @@ import {Mecab} from '../comm/mecab.js';
 import {clone, deferPromise, generateId, invokeMessageHandler, isObject, log, promiseTimeout} from '../core.js';
 import {ExtensionError} from '../core/extension-error.js';
 import {AnkiUtil} from '../data/anki-util.js';
-import {JsonSchema} from '../data/json-schema.js';
 import {OptionsUtil} from '../data/options-util.js';
 import {PermissionsUtil} from '../data/permissions-util.js';
 import {ArrayBufferUtil} from '../data/sandbox/array-buffer-util.js';
diff --git a/ext/js/comm/anki-connect.js b/ext/js/comm/anki-connect.js
index 3262af41..b876703f 100644
--- a/ext/js/comm/anki-connect.js
+++ b/ext/js/comm/anki-connect.js
@@ -16,7 +16,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {isObject} from '../core.js';
 import {AnkiUtil} from '../data/anki-util.js';
 
 /**
diff --git a/ext/js/dom/document-util.js b/ext/js/dom/document-util.js
index f53d55fd..cf58d39f 100644
--- a/ext/js/dom/document-util.js
+++ b/ext/js/dom/document-util.js
@@ -16,7 +16,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {EventListenerCollection} from '../core.js';
 import {DOMTextScanner} from './dom-text-scanner.js';
 import {TextSourceElement} from './text-source-element.js';
 import {TextSourceRange} from './text-source-range.js';
diff --git a/ext/js/dom/text-source-element.js b/ext/js/dom/text-source-element.js
index fbe89a61..47c18e30 100644
--- a/ext/js/dom/text-source-element.js
+++ b/ext/js/dom/text-source-element.js
@@ -18,7 +18,6 @@
 
 import {StringUtil} from '../data/sandbox/string-util.js';
 import {DocumentUtil} from './document-util.js';
-import {TextSourceRange} from './text-source-range.js';
 
 /**
  * This class represents a text source that is attached to a HTML element, such as an <img>
diff --git a/ext/js/dom/text-source-range.js b/ext/js/dom/text-source-range.js
index 5c3d4184..5dbbd636 100644
--- a/ext/js/dom/text-source-range.js
+++ b/ext/js/dom/text-source-range.js
@@ -18,7 +18,6 @@
 
 import {DocumentUtil} from './document-util.js';
 import {DOMTextScanner} from './dom-text-scanner.js';
-import {TextSourceElement} from './text-source-element.js';
 
 /**
  * This class represents a text source that comes from text nodes in the document.
diff --git a/ext/js/language/dictionary-worker-handler.js b/ext/js/language/dictionary-worker-handler.js
index 8ac342b2..3a85cb71 100644
--- a/ext/js/language/dictionary-worker-handler.js
+++ b/ext/js/language/dictionary-worker-handler.js
@@ -16,7 +16,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {serializeError} from '../core.js';
 import {DictionaryDatabase} from './dictionary-database.js';
 import {DictionaryImporter} from './dictionary-importer.js';
 import {DictionaryWorkerMediaLoader} from './dictionary-worker-media-loader.js';
diff --git a/ext/js/language/dictionary-worker-media-loader.js b/ext/js/language/dictionary-worker-media-loader.js
index 9e3fd67e..2701389e 100644
--- a/ext/js/language/dictionary-worker-media-loader.js
+++ b/ext/js/language/dictionary-worker-media-loader.js
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {deserializeError, generateId} from '../core.js';
+import {generateId} from '../core.js';
 
 /**
  * Class used for loading and validating media from a worker thread
diff --git a/ext/js/language/translator.js b/ext/js/language/translator.js
index 9b01c1ff..67cc53c6 100644
--- a/ext/js/language/translator.js
+++ b/ext/js/language/translator.js
@@ -19,7 +19,6 @@
 import {RegexUtil} from '../general/regex-util.js';
 import {TextSourceMap} from '../general/text-source-map.js';
 import {Deinflector} from './deinflector.js';
-import {DictionaryDatabase} from './dictionary-database.js';
 
 /**
  * Class which finds term and kanji dictionary entries for text.
diff --git a/ext/js/templates/template-renderer-proxy.js b/ext/js/templates/template-renderer-proxy.js
index 6d019d14..e67b715a 100644
--- a/ext/js/templates/template-renderer-proxy.js
+++ b/ext/js/templates/template-renderer-proxy.js
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-import {deserializeError, generateId} from '../core.js';
+import {generateId} from '../core.js';
 
 export class TemplateRendererProxy {
     constructor() {
-- 
cgit v1.2.3


From dcddbee07e20163ae167dd67fe58f0776f9acb64 Mon Sep 17 00:00:00 2001
From: toasted-nutbread <toasted-nutbread@users.noreply.github.com>
Date: Mon, 4 Dec 2023 18:20:05 -0500
Subject: Update how ts comments are handled

---
 .eslintrc.json                             |  9 ++++++++-
 dev/translator-vm.js                       |  2 +-
 ext/js/accessibility/google-docs.js        |  6 +++---
 ext/js/app/popup.js                        |  2 +-
 ext/js/background/offscreen-proxy.js       |  8 ++++----
 ext/js/comm/frame-ancestry-handler.js      |  4 ++--
 ext/js/dom/document-util.js                | 14 ++++++-------
 ext/js/dom/dom-text-scanner.js             |  5 ++---
 ext/js/dom/simple-dom-parser.js            |  3 +--
 ext/js/pages/settings/backup-controller.js |  4 ++--
 ext/js/yomitan.js                          |  4 ++--
 test/cache-map.test.js                     |  2 +-
 test/data/html/test-document2-script.js    | 30 ++++++++++++++--------------
 test/object-property-accessor.test.js      |  6 +++---
 test/profile-conditions-util.test.js       | 32 +++++++++++++++---------------
 vitest.config.js                           |  2 +-
 16 files changed, 69 insertions(+), 64 deletions(-)

(limited to 'ext/js/accessibility')

diff --git a/.eslintrc.json b/.eslintrc.json
index a46aff4b..83e7ffe6 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -350,7 +350,14 @@
                 "allowAllPropertiesOnSameLine": true
             }
         ],
-        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/ban-ts-comment": [
+            "error",
+            {
+                "ts-expect-error": {
+                    "descriptionFormat": "^ - .+$"
+                }
+            }
+        ],
         "@typescript-eslint/ban-types": [
             "error",
             {
diff --git a/dev/translator-vm.js b/dev/translator-vm.js
index 4022d465..7fdda879 100644
--- a/dev/translator-vm.js
+++ b/dev/translator-vm.js
@@ -42,7 +42,7 @@ export class TranslatorVM {
                 }
             }
         };
-        // @ts-ignore - Overwriting a global
+        // @ts-expect-error - Overwriting a global
         global.chrome = chrome;
 
         /** @type {?JapaneseUtil} */
diff --git a/ext/js/accessibility/google-docs.js b/ext/js/accessibility/google-docs.js
index da6ab994..27841b6d 100644
--- a/ext/js/accessibility/google-docs.js
+++ b/ext/js/accessibility/google-docs.js
@@ -18,9 +18,9 @@
 
 (async () => {
     // Reentrant check
-    // @ts-ignore : Checking a property to the global object
+    // @ts-expect-error - Checking a property to the global object
     if (self.googleDocsAccessibilitySetup) { return; }
-    // @ts-ignore : Adding a property to the global object
+    // @ts-expect-error - Adding a property to the global object
     self.googleDocsAccessibilitySetup = true;
 
     /**
@@ -57,7 +57,7 @@
 
     // The extension ID below is on an allow-list that is used on the Google Docs webpage.
     /* eslint-disable */
-    // @ts-ignore : Adding a property to the global object
+    // @ts-expect-error : Adding a property to the global object
     const inject = () => { window._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami'; };
     /* eslint-enable */
 
diff --git a/ext/js/app/popup.js b/ext/js/app/popup.js
index 4f201fc3..7419785b 100644
--- a/ext/js/app/popup.js
+++ b/ext/js/app/popup.js
@@ -745,7 +745,7 @@ export class Popup extends EventDispatcher {
         if (
             fullscreenElement === null ||
             fullscreenElement.shadowRoot ||
-            // @ts-ignore - openOrClosedShadowRoot is available to Firefox 63+ for WebExtensions
+            // @ts-expect-error - openOrClosedShadowRoot is available to Firefox 63+ for WebExtensions
             fullscreenElement.openOrClosedShadowRoot
         ) {
             return defaultParent;
diff --git a/ext/js/background/offscreen-proxy.js b/ext/js/background/offscreen-proxy.js
index 7b504855..63f619fa 100644
--- a/ext/js/background/offscreen-proxy.js
+++ b/ext/js/background/offscreen-proxy.js
@@ -54,16 +54,16 @@ export class OffscreenProxy {
      */
     async _hasOffscreenDocument() {
         const offscreenUrl = chrome.runtime.getURL('offscreen.html');
-        // @ts-ignore - API not defined yet
+        // @ts-expect-error - API not defined yet
         if (!chrome.runtime.getContexts) { // chrome version below 116
             // Clients: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/clients
-            // @ts-ignore - Types not set up for service workers yet
+            // @ts-expect-error - Types not set up for service workers yet
             const matchedClients = await clients.matchAll();
-            // @ts-ignore - Types not set up for service workers yet
+            // @ts-expect-error - Types not set up for service workers yet
             return await matchedClients.some((client) => client.url === offscreenUrl);
         }
 
-        // @ts-ignore - API not defined yet
+        // @ts-expect-error - API not defined yet
         const contexts = await chrome.runtime.getContexts({
             contextTypes: ['OFFSCREEN_DOCUMENT'],
             documentUrls: [offscreenUrl]
diff --git a/ext/js/comm/frame-ancestry-handler.js b/ext/js/comm/frame-ancestry-handler.js
index 687ec368..e4d08f28 100644
--- a/ext/js/comm/frame-ancestry-handler.js
+++ b/ext/js/comm/frame-ancestry-handler.js
@@ -295,7 +295,7 @@ export class FrameAncestryHandler {
             while (walker.nextNode()) {
                 const element = /** @type {Element} */ (walker.currentNode);
 
-                // @ts-ignore - this is more simple to elide any type checks or casting
+                // @ts-expect-error - this is more simple to elide any type checks or casting
                 if (element.contentWindow === contentWindow) {
                     return element;
                 }
@@ -303,7 +303,7 @@ export class FrameAncestryHandler {
                 /** @type {?ShadowRoot|undefined} */
                 const shadowRoot = (
                     element.shadowRoot ||
-                    // @ts-ignore - openOrClosedShadowRoot is available to Firefox 63+ for WebExtensions
+                    // @ts-expect-error - openOrClosedShadowRoot is available to Firefox 63+ for WebExtensions
                     element.openOrClosedShadowRoot
                 );
                 if (shadowRoot) {
diff --git a/ext/js/dom/document-util.js b/ext/js/dom/document-util.js
index 549a8195..b2aa8f81 100644
--- a/ext/js/dom/document-util.js
+++ b/ext/js/dom/document-util.js
@@ -210,7 +210,7 @@ export class DocumentUtil {
      */
     static computeZoomScale(node) {
         if (this._cssZoomSupported === null) {
-            // @ts-ignore - zoom is a non-standard property that exists in Chromium-based browsers
+            // @ts-expect-error - zoom is a non-standard property that exists in Chromium-based browsers
             this._cssZoomSupported = (typeof document.createElement('div').style.zoom === 'string');
         }
         if (!this._cssZoomSupported) { return 1; }
@@ -387,11 +387,11 @@ export class DocumentUtil {
     static getFullscreenElement() {
         return (
             document.fullscreenElement ||
-            // @ts-ignore - vendor prefix
+            // @ts-expect-error - vendor prefix
             document.msFullscreenElement ||
-            // @ts-ignore - vendor prefix
+            // @ts-expect-error - vendor prefix
             document.mozFullScreenElement ||
-            // @ts-ignore - vendor prefix
+            // @ts-expect-error - vendor prefix
             document.webkitFullscreenElement ||
             null
         );
@@ -808,7 +808,7 @@ export class DocumentUtil {
             return document.caretRangeFromPoint(x, y);
         }
 
-        // @ts-ignore - caretPositionFromPoint is non-standard
+        // @ts-expect-error - caretPositionFromPoint is non-standard
         if (typeof document.caretPositionFromPoint === 'function') {
             // Firefox
             return this._caretPositionFromPoint(x, y);
@@ -824,7 +824,7 @@ export class DocumentUtil {
      * @returns {?Range}
      */
     static _caretPositionFromPoint(x, y) {
-        // @ts-ignore - caretPositionFromPoint is non-standard
+        // @ts-expect-error - caretPositionFromPoint is non-standard
         const position = /** @type {(x: number, y: number) => ?{offsetNode: Node, offset: number}} */ (document.caretPositionFromPoint)(x, y);
         if (position === null) {
             return null;
@@ -876,7 +876,7 @@ export class DocumentUtil {
                     nextElement.style.setProperty('user-select', 'text', 'important');
                 }
 
-                // @ts-ignore - caretPositionFromPoint is non-standard
+                // @ts-expect-error - caretPositionFromPoint is non-standard
                 const position = /** @type {(x: number, y: number) => ?{offsetNode: Node, offset: number}} */ (document.caretPositionFromPoint)(x, y);
                 if (position === null) {
                     return null;
diff --git a/ext/js/dom/dom-text-scanner.js b/ext/js/dom/dom-text-scanner.js
index 3a785680..42e0acc9 100644
--- a/ext/js/dom/dom-text-scanner.js
+++ b/ext/js/dom/dom-text-scanner.js
@@ -520,11 +520,10 @@ export class DOMTextScanner {
     static isStyleSelectable(style) {
         return !(
             style.userSelect === 'none' ||
-            // @ts-ignore - vendor prefix
             style.webkitUserSelect === 'none' ||
-            // @ts-ignore - vendor prefix
+            // @ts-expect-error - vendor prefix
             style.MozUserSelect === 'none' ||
-            // @ts-ignore - vendor prefix
+            // @ts-expect-error - vendor prefix
             style.msUserSelect === 'none'
         );
     }
diff --git a/ext/js/dom/simple-dom-parser.js b/ext/js/dom/simple-dom-parser.js
index a1f63890..bca1cd88 100644
--- a/ext/js/dom/simple-dom-parser.js
+++ b/ext/js/dom/simple-dom-parser.js
@@ -27,7 +27,7 @@ export class SimpleDOMParser {
      */
     constructor(content) {
         /** @type {import('parse5')} */
-        // @ts-ignore - parse5 global is not defined in typescript declaration
+        // @ts-expect-error - parse5 global is not defined in typescript declaration
         this._parse5Lib = /** @type {import('parse5')} */ (parse5);
         /** @type {import('parse5').TreeAdapter<import('parse5').DefaultTreeAdapterMap>} */
         this._treeAdapter = this._parse5Lib.defaultTreeAdapter;
@@ -131,7 +131,6 @@ export class SimpleDOMParser {
      * @returns {boolean}
      */
     static isSupported() {
-        // @ts-ignore - parse5 global is not defined in typescript declaration
         return typeof parse5 !== 'undefined';
     }
 
diff --git a/ext/js/pages/settings/backup-controller.js b/ext/js/pages/settings/backup-controller.js
index 52c5f418..bf44bb90 100644
--- a/ext/js/pages/settings/backup-controller.js
+++ b/ext/js/pages/settings/backup-controller.js
@@ -165,9 +165,9 @@ export class BackupController {
     _saveBlob(blob, fileName) {
         if (
             typeof navigator === 'object' && navigator !== null &&
-            // @ts-ignore - call for legacy Edge
+            // @ts-expect-error - call for legacy Edge
             typeof navigator.msSaveBlob === 'function' &&
-            // @ts-ignore - call for legacy Edge
+            // @ts-expect-error - call for legacy Edge
             navigator.msSaveBlob(blob)
         ) {
             return;
diff --git a/ext/js/yomitan.js b/ext/js/yomitan.js
index 3c0f7cb9..7cf67aec 100644
--- a/ext/js/yomitan.js
+++ b/ext/js/yomitan.js
@@ -37,7 +37,7 @@ if ((() => {
     }
     return (hasBrowser && !hasChrome);
 })()) {
-    // @ts-ignore - objects should have roughly the same interface
+    // @ts-expect-error - objects should have roughly the same interface
     chrome = browser;
 }
 
@@ -182,7 +182,7 @@ export class Yomitan extends EventDispatcher {
      */
     sendMessage(...args) {
         try {
-            // @ts-ignore - issue with type conversion, somewhat difficult to resolve in pure JS
+            // @ts-expect-error - issue with type conversion, somewhat difficult to resolve in pure JS
             chrome.runtime.sendMessage(...args);
         } catch (e) {
             this.triggerExtensionUnloaded();
diff --git a/test/cache-map.test.js b/test/cache-map.test.js
index 3e7def1f..df891188 100644
--- a/test/cache-map.test.js
+++ b/test/cache-map.test.js
@@ -30,7 +30,7 @@ function testConstructor() {
             [true,  () => new CacheMap(1.5)],
             [true,  () => new CacheMap(Number.NaN)],
             [true,  () => new CacheMap(Number.POSITIVE_INFINITY)],
-            // @ts-ignore - Ignore because it should throw an error
+            // @ts-expect-error - Ignore because it should throw an error
             [true,  () => new CacheMap('a')]
         ];
 
diff --git a/test/data/html/test-document2-script.js b/test/data/html/test-document2-script.js
index 5a6ad4d1..f6082802 100644
--- a/test/data/html/test-document2-script.js
+++ b/test/data/html/test-document2-script.js
@@ -22,17 +22,17 @@
 function requestFullscreen(element) {
     if (element.requestFullscreen) {
         element.requestFullscreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (element.mozRequestFullScreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         element.mozRequestFullScreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (element.webkitRequestFullscreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         element.webkitRequestFullscreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (element.msRequestFullscreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         element.msRequestFullscreen();
     }
 }
@@ -41,17 +41,17 @@ function requestFullscreen(element) {
 function exitFullscreen() {
     if (document.exitFullscreen) {
         document.exitFullscreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (document.mozCancelFullScreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.mozCancelFullScreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (document.webkitExitFullscreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.webkitExitFullscreen();
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
     } else if (document.msExitFullscreen) {
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.msExitFullscreen();
     }
 }
@@ -62,11 +62,11 @@ function exitFullscreen() {
 function getFullscreenElement() {
     return (
         document.fullscreenElement ||
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.msFullscreenElement ||
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.mozFullScreenElement ||
-        // @ts-ignore - Browser compatibility
+        // @ts-expect-error - Browser compatibility
         document.webkitFullscreenElement ||
         null
     );
diff --git a/test/object-property-accessor.test.js b/test/object-property-accessor.test.js
index 4f1fa87b..4d50b1e9 100644
--- a/test/object-property-accessor.test.js
+++ b/test/object-property-accessor.test.js
@@ -334,7 +334,7 @@ function testGetPathString2() {
         ];
 
         for (const [pathArray, message] of data) {
-            // @ts-ignore - Throwing is expected
+            // @ts-expect-error - Throwing is expected
             expect(() => ObjectPropertyAccessor.getPathString(pathArray)).toThrow(message);
         }
     });
@@ -424,7 +424,7 @@ function testHasProperty() {
         ];
 
         for (const [object, property, expected] of data) {
-            // @ts-ignore - Ignore potentially property types
+            // @ts-expect-error - Ignore potentially property types
             expect(ObjectPropertyAccessor.hasProperty(object, property)).toStrictEqual(expected);
         }
     });
@@ -449,7 +449,7 @@ function testIsValidPropertyType() {
         ];
 
         for (const [object, property, expected] of data) {
-            // @ts-ignore - Ignore potentially property types
+            // @ts-expect-error - Ignore potentially property types
             expect(ObjectPropertyAccessor.isValidPropertyType(object, property)).toStrictEqual(expected);
         }
     });
diff --git a/test/profile-conditions-util.test.js b/test/profile-conditions-util.test.js
index 30052b34..62b21555 100644
--- a/test/profile-conditions-util.test.js
+++ b/test/profile-conditions-util.test.js
@@ -637,9 +637,9 @@ function testSchemas() {
                     {expected: true,  context: {depth: 0, url: ''}},
                     {expected: true,  context: {depth: 0, url: '', flags: []}},
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -673,9 +673,9 @@ function testSchemas() {
                     {expected: false, context: {depth: 0, url: ''}},
                     {expected: false, context: {depth: 0, url: '', flags: []}},
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -711,9 +711,9 @@ function testSchemas() {
                     {expected: false, context: {depth: 0, url: ''}},
                     {expected: false, context: {depth: 0, url: '', flags: []}},
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -753,9 +753,9 @@ function testSchemas() {
                     {expected: true,  context: {depth: 0, url: ''}},
                     {expected: true,  context: {depth: 0, url: '', flags: []}},
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -784,9 +784,9 @@ function testSchemas() {
                     {expected: true,  context: {depth: 0, url: ''}},
                     {expected: true,  context: {depth: 0, url: '', flags: []}},
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -819,9 +819,9 @@ function testSchemas() {
                     {expected: false, context: {depth: 0, url: ''}},
                     {expected: false, context: {depth: 0, url: '', flags: []}},
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -849,9 +849,9 @@ function testSchemas() {
                     {expected: true,  context: {depth: 0, url: ''}},
                     {expected: true,  context: {depth: 0, url: '', flags: []}},
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: true,  context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
@@ -885,9 +885,9 @@ function testSchemas() {
                     {expected: true,  context: {depth: 0, url: ''}},
                     {expected: true,  context: {depth: 0, url: '', flags: []}},
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2']}},
-                    // @ts-ignore - Ignore type for string flag for testing purposes
+                    // @ts-expect-error - Ignore type for string flag for testing purposes
                     {expected: false, context: {depth: 0, url: '', flags: ['clipboard', 'test2', 'test3']}}
                 ]
             },
diff --git a/vitest.config.js b/vitest.config.js
index 3b6cdde0..025eec17 100644
--- a/vitest.config.js
+++ b/vitest.config.js
@@ -24,7 +24,7 @@ export default defineConfig({
             'test/playwright/**'
         ],
         environment: 'jsdom',
-        // @ts-ignore - Appears to not be defined in the type definitions (https://vitest.dev/advanced/pool)
+        // @ts-expect-error - Appears to not be defined in the type definitions (https://vitest.dev/advanced/pool)
         poolOptions: {
             threads: {
                 useAtomics: true
-- 
cgit v1.2.3