Refactor to handle field migration

yomidevs · Jul 12, 2024 · 629d820 · 629d820
1 parent 7bee89a
commit 629d820
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 151 deletions.
diff --git a/ext/data/templates/anki-field-templates-upgrade-v13.handlebars b/ext/data/templates/anki-field-templates-upgrade-v13.handlebars
@@ -2,10 +2,6 @@
     {{~#if (hasMedia "selectionText")}}{{#getMedia "selectionText"}}{{/getMedia}}{{/if~}}
 {{/inline}}
 
-{{#*inline "popup-selection-text"}}
-    {{~#if (hasMedia "selectionText")}}{{#getMedia "selectionText"}}{{/getMedia}}{{/if~}}
-{{/inline}}
-
 {{#*inline "sentence-furigana"}}
     {{~#if definition.cloze~}}
         {{~#if (hasMedia "textFurigana" definition.cloze.sentence)~}}

diff --git a/ext/data/templates/anki-field-templates-upgrade-v33.handlebars b/ext/data/templates/anki-field-templates-upgrade-v33.handlebars
@@ -67,13 +67,3 @@
     {{~#if (hasMedia "selectionText")}}{{{getMedia "selectionText"}}}{{/if~}}
 {{/inline}}
 {{>>>>>>>}}
-
-{{<<<<<<<}}
-{{#*inline "popup-selection-text"}}
-    {{~#if (hasMedia "selectionText")}}{{getMedia "selectionText"}}{{/if~}}
-{{/inline}}
-{{=======}}
-{{#*inline "popup-selection-text"}}
-    {{~#if (hasMedia "selectionText")}}{{{getMedia "selectionText"}}}{{/if~}}
-{{/inline}}
-{{>>>>>>>}}
diff --git a/ext/data/templates/anki-field-templates-upgrade-v45.handlebars b/ext/data/templates/anki-field-templates-upgrade-v45.handlebars
@@ -0,0 +1,9 @@
+{{<<<<<<<}}
+{{#*inline "selection-text"}}
+    {{~#if (hasMedia "selectionText")}}{{{getMedia "selectionText"}}}{{/if~}}
+{{/inline}}
+{{=======}}
+{{#*inline "popup-selection-text"}}
+    {{~#if (hasMedia "selectionText")}}{{getMedia "selectionText"}}{{/if~}}
+{{/inline}}
+{{>>>>>>>}}
diff --git a/ext/data/templates/default-anki-field-templates.handlebars b/ext/data/templates/default-anki-field-templates.handlebars
@@ -454,10 +454,6 @@
     {{~#multiLine}}{{context.fullQuery}}{{/multiLine~}}
 {{/inline}}
 
-{{#*inline "selection-text"}}
-    {{~#if (hasMedia "selectionText")}}{{{getMedia "selectionText"}}}{{/if~}}
-{{/inline}}
-
 {{#*inline "popup-selection-text"}}
     {{~#if (hasMedia "selectionText")}}{{{getMedia "selectionText"}}}{{/if~}}
 {{/inline}}

diff --git a/ext/js/data/anki-template-util.js b/ext/js/data/anki-template-util.js
@@ -59,7 +59,6 @@ export function getStandardFieldMarkers(type) {
                 'reading',
                 'screenshot',
                 'search-query',
-                'selection-text',
                 'popup-selection-text',
                 'sentence',
                 'sentence-furigana',
@@ -87,7 +86,6 @@ export function getStandardFieldMarkers(type) {
                 'onyomi-hiragana',
                 'screenshot',
                 'search-query',
-                'selection-text',
                 'popup-selection-text',
                 'sentence',
                 'sentence-furigana',
@@ -100,13 +98,6 @@ export function getStandardFieldMarkers(type) {
     }
 }
 
-/**
- * @returns {string[]}
- */
-export function getDeprecatedFieldMarkers() {
-    return ['selection-text'];
-}
-
 /**
  * @param {import('settings').ProfileOptions} options
  * @returns {string}

diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
@@ -556,6 +556,7 @@ export class OptionsUtil {
             this._updateVersion42,
             this._updateVersion43,
             this._updateVersion44,
+            this._updateVersion45,
         ];
         /* eslint-enable @typescript-eslint/unbound-method */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
@@ -1389,6 +1390,21 @@ export class OptionsUtil {
         }
     }
 
+    /**
+     * - Rename `selection-text` to `popup-selection-text`
+     * @type {import('options-util').UpdateFunction}
+     */
+    async _updateVersion45(options) {
+        await this._applyAnkiFieldTemplatesPatch(options, '/data/templates/anki-field-templates-upgrade-v45.handlebars');
+        for (const profile of options.profiles) {
+            const fields = profile.options.anki.terms.fields;
+            for (const key in fields) {
+                const regex = new RegExp('{selection-text}', 'g');
+                fields[key] = fields[key].replace(regex, '{popup-selection-text}');
+            }
+        }
+    }
+
     /**
      * @param {string} url
      * @returns {Promise<chrome.tabs.Tab>}

diff --git a/ext/js/pages/settings/anki-controller.js b/ext/js/pages/settings/anki-controller.js
@@ -21,7 +21,7 @@ import {EventListenerCollection} from '../../core/event-listener-collection.js';
 import {ExtensionError} from '../../core/extension-error.js';
 import {log} from '../../core/log.js';
 import {toError} from '../../core/to-error.js';
-import {getDeprecatedFieldMarkers, getDynamicFieldMarkers, getStandardFieldMarkers} from '../../data/anki-template-util.js';
+import {getDynamicFieldMarkers, getStandardFieldMarkers} from '../../data/anki-template-util.js';
 import {stringContainsAnyFieldMarker} from '../../data/anki-util.js';
 import {getRequiredPermissionsForAnkiFieldValue, hasPermissions, setPermissionsGranted} from '../../data/permissions-util.js';
 import {querySelectorNotNull} from '../../dom/query-selector.js';
@@ -341,7 +341,6 @@ export class AnkiController {
             if (types.includes('term')) {
                 markers.push(...getDynamicFieldMarkers(dictionaries));
             }
-            markers = markers.filter((marker) => !getDeprecatedFieldMarkers().includes(marker));
             markers = [...new Set(markers.sort())];
 
             const fragment = document.createDocumentFragment();