add option to scan hyperlink

yomidevs · Sep 17, 2024 · 82d26f1 · 82d26f1
1 parent 547a628
commit 82d26f1
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 2 deletions.
diff --git a/ext/data/schemas/options-schema.json b/ext/data/schemas/options-schema.json
@@ -463,6 +463,7 @@
                                     "length",
                                     "deepDomScan",
                                     "scanAltText",
+                                    "scanHyperlinkText",
                                     "popupNestingMaxDepth",
                                     "enablePopupSearch",
                                     "enableOnPopupExpressions",
@@ -720,6 +721,10 @@
                                         "type": "boolean",
                                         "default": true
                                     },
+                                    "scanHyperlinkText": {
+                                        "type": "boolean",
+                                        "default": true
+                                    },
                                     "popupNestingMaxDepth": {
                                         "type": "integer",
                                         "minimum": 0,

diff --git a/ext/js/app/frontend.js b/ext/js/app/frontend.js
@@ -519,7 +519,11 @@ export class Frontend {
         });
         this._updateTextScannerEnabled();
 
-        if (this._pageType !== 'web') {
+        if (this._pageType === 'web') {
+            if (!scanningOptions.scanHyperlinkText) {
+                this._textScanner.excludeSelector = 'a,a *';
+            }
+        } else {
             const excludeSelectors = ['.scan-disable', '.scan-disable *'];
             if (!scanningOptions.enableOnPopupExpressions) {
                 excludeSelectors.push('.source-text', '.source-text *');

diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
@@ -563,6 +563,7 @@ export class OptionsUtil {
             this._updateVersion49,
             this._updateVersion50,
             this._updateVersion51,
+            this._updateVersion52,
         ];
         /* eslint-enable @typescript-eslint/unbound-method */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
@@ -1487,6 +1488,16 @@ export class OptionsUtil {
         }
     }
 
+    /**
+     * - Added scanning.scanAltText
+     * @type {import('options-util').UpdateFunction}
+     */
+    async _updateVersion52(options) {
+        for (const profile of options.profiles) {
+            profile.options.scanning.scanHyperlinkText = true;
+        }
+    }
+
     /**
      * @param {string} url
      * @returns {Promise<chrome.tabs.Tab>}
@@ -1503,6 +1514,7 @@ export class OptionsUtil {
             });
         });
     }
+
 }
 
 /* eslint-enable @typescript-eslint/no-unsafe-assignment */

diff --git a/ext/js/display/display.js b/ext/js/display/display.js
@@ -465,6 +465,7 @@ export class Display extends EventDispatcher {
                 matchTypePrefix: false,
                 sentenceParsingOptions,
                 scanAltText: scanningOptions.scanAltText,
+                scanHyperlinkText: scanningOptions.scanHyperlinkText,
                 scanWithoutMousemove: scanningOptions.scanWithoutMousemove,
                 scanResolution: scanningOptions.scanResolution,
             },
@@ -2034,6 +2035,7 @@ export class Display extends EventDispatcher {
             preventMiddleMouse: false,
             sentenceParsingOptions,
             scanAltText: scanningOptions.scanAltText,
+            scanHyperlinkText: scanningOptions.scanHyperlinkText,
         });
 
         this._contentTextScanner.setEnabled(true);

diff --git a/ext/settings.html b/ext/settings.html
@@ -486,6 +486,14 @@ <h1>Yomitan Settings</h1>
                 <label class="toggle"><input type="checkbox" data-setting="scanning.scanAltText"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
             </div>
         </div></div>
+        <div class="settings-item"><div class="settings-item-inner">
+            <div class="settings-item-left">
+                <div class="settings-item-label">Scan hyperlink text</div>
+            </div>
+            <div class="settings-item-right">
+                <label class="toggle"><input type="checkbox" data-setting="scanning.scanHyperlinkText"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
+            </div>
+        </div></div>
         <div class="settings-item advanced-only">
             <div class="settings-item-inner">
                 <div class="settings-item-left">

diff --git a/test/options-util.test.js b/test/options-util.test.js
@@ -349,6 +349,7 @@ function createProfileOptionsUpdatedTestData1() {
             hidePopupOnCursorExitDelay: 0,
             normalizeCssZoom: true,
             scanAltText: true,
+            scanHyperlinkText: true,
             preventMiddleMouse: {
                 onWebPages: false,
                 onPopupPages: false,
@@ -645,7 +646,7 @@ function createOptionsUpdatedTestData1() {
             },
         ],
         profileCurrent: 0,
-        version: 51,
+        version: 52,
         global: {
             database: {
                 prefixWildcardsSupported: false,

diff --git a/types/ext/settings.d.ts b/types/ext/settings.d.ts
@@ -15,6 +15,7 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+import type * as TextScanner from './text-scanner';
 import type * as Input from './input';
 
 export type OptionsContextFlag = 'clipboard';
@@ -27,6 +28,7 @@ export type OptionsContext1 = {
     flags?: OptionsContextFlag[];
     modifiers?: Input.Modifier[];
     modifierKeys?: Input.ModifierKey[];
+    pointerType?: TextScanner.PointerType;
 };
 
 export type OptionsContext2 = {
@@ -37,6 +39,7 @@ export type OptionsContext2 = {
     flags?: OptionsContextFlag[];
     modifiers?: Input.Modifier[];
     modifierKeys?: Input.ModifierKey[];
+    pointerType?: TextScanner.PointerType;
 };
 
 export type OptionsContext3 = {
@@ -47,6 +50,7 @@ export type OptionsContext3 = {
     flags?: OptionsContextFlag[];
     modifiers?: Input.Modifier[];
     modifierKeys?: Input.ModifierKey[];
+    pointerType?: TextScanner.PointerType;
 };
 
 export type OptionsContext = OptionsContext1 | OptionsContext2 | OptionsContext3;
@@ -195,6 +199,7 @@ export type ScanningOptions = {
     hidePopupOnCursorExitDelay: number;
     normalizeCssZoom: boolean;
     scanAltText: boolean;
+    scanHyperlinkText: boolean;
     scanWithoutMousemove: boolean;
     scanResolution: string;
 };

diff --git a/types/ext/text-scanner.d.ts b/types/ext/text-scanner.d.ts
@@ -42,6 +42,7 @@ export type Options = {
     matchTypePrefix?: boolean;
     sentenceParsingOptions?: SentenceParsingOptions;
     scanAltText?: boolean;
+    scanHyperlinkText?: boolean;
     scanWithoutMousemove?: boolean;
     scanResolution?: string;
 };