Add single frequency handlebars (#2045)

* Add single frequency handlebars

* Add handlebars update

* Add documentation for single frequency handlebars

* Write tests

Author: Kuuuube

ext/data/templates/anki-field-templates-upgrade-v67.handlebars

@@ -0,0 +1,47 @@
+{{<<<<<<<}}
+{{#*inline "frequencies"}}
+    {{~#if (op ">" definition.frequencies.length 0)~}}
+        <ul style="text-align: left;">
+        {{~#each definition.frequencies~}}
+            <li>
+            {{~#if (op "!==" ../definition.type "kanji")~}}
+                {{~#if (op "||" (op ">" ../uniqueExpressions.length 1) (op ">" ../uniqueReadings.length 1))~}}(
+                    {{~furigana expression reading~}}
+                ) {{/if~}}
+            {{~/if~}}
+            {{~dictionaryAlias}}: {{frequency~}}
+            </li>
+        {{~/each~}}
+        </ul>
+    {{~/if~}}
+{{/inline}}
+{{=======}}
+{{#*inline "frequencies"}}
+    {{~#if (op ">" definition.frequencies.length 0)~}}
+        <ul style="text-align: left;">
+        {{~#each definition.frequencies~}}
+            {{~#unless (op "&&" ../selectedDictionary (op "!=" ../selectedDictionary dictionary))~}}
+                <li>
+                {{~#if (op "!==" ../definition.type "kanji")~}}
+                    {{~#if (op "||" (op ">" ../uniqueExpressions.length 1) (op ">" ../uniqueReadings.length 1))~}}(
+                        {{~furigana expression reading~}}
+                    ) {{/if~}}
+                {{~/if~}}
+                {{~dictionaryAlias}}: {{frequency~}}
+                </li>
+            {{~/unless~}}
+        {{~/each~}}
+        </ul>
+    {{~/if~}}
+{{/inline}}
+{{>>>>>>>}}
+
+{{#*inline "single-frequency-number"}}
+    {{~#if (op ">" definition.frequencyNumbers.length 0)~}}
+        {{~#each definition.frequencyNumbers~}}
+            {{~#unless (op "&&" ../selectedDictionary (op "!=" ../selectedDictionary dictionary))~}}
+                    {{frequency~}}
+            {{~/unless~}}
+        {{~/each~}}
+    {{/if}}
+{{/inline}}

ext/data/templates/default-anki-field-templates.handlebars

@@ -358,19 +358,31 @@
     {{~#if (op ">" definition.frequencies.length 0)~}}
         <ul style="text-align: left;">
         {{~#each definition.frequencies~}}
-            <li>
-            {{~#if (op "!==" ../definition.type "kanji")~}}
-                {{~#if (op "||" (op ">" ../uniqueExpressions.length 1) (op ">" ../uniqueReadings.length 1))~}}(
-                    {{~furigana expression reading~}}
-                ) {{/if~}}
-            {{~/if~}}
-            {{~dictionaryAlias}}: {{frequency~}}
-            </li>
+            {{~#unless (op "&&" ../selectedDictionary (op "!=" ../selectedDictionary dictionary))~}}
+                <li>
+                {{~#if (op "!==" ../definition.type "kanji")~}}
+                    {{~#if (op "||" (op ">" ../uniqueExpressions.length 1) (op ">" ../uniqueReadings.length 1))~}}(
+                        {{~furigana expression reading~}}
+                    ) {{/if~}}
+                {{~/if~}}
+                {{~dictionaryAlias}}: {{frequency~}}
+                </li>
+            {{~/unless~}}
         {{~/each~}}
         </ul>
     {{~/if~}}
 {{/inline}}
 
+{{#*inline "single-frequency-number"}}
+    {{~#if (op ">" definition.frequencyNumbers.length 0)~}}
+        {{~#each definition.frequencyNumbers~}}
+            {{~#unless (op "&&" ../selectedDictionary (op "!=" ../selectedDictionary dictionary))~}}
+                    {{frequency~}}
+            {{~/unless~}}
+        {{~/each~}}
+    {{/if}}
+{{/inline}}
+
 {{#*inline "frequency-harmonic-rank"}}
     {{~#if (op "===" definition.frequencyHarmonic -1) ~}}
         9999999

ext/js/data/anki-note-data-creator.js

@@ -171,7 +171,7 @@ function getPublicContext(context) {
 
 /**
  * @param {import('dictionary').TermDictionaryEntry|import('dictionary').KanjiDictionaryEntry} dictionaryEntry
- * @returns {number[]}
+ * @returns {import('anki-templates').FrequencyNumber[]}
  */
 function getFrequencyNumbers(dictionaryEntry) {
     let previousDictionary;
@@ -187,13 +187,13 @@ function getFrequencyNumbers(dictionaryEntry) {
             if (frequencyMatch !== null) {
                 const frequencyParsed = Number.parseInt(frequencyMatch[0], 10);
                 if (frequencyParsed > 0) {
-                    frequencies.push(frequencyParsed);
+                    frequencies.push({dictionary: dictionary, frequency: frequencyParsed});
                     continue;
                 }
             }
         }
         if (frequency > 0) {
-            frequencies.push(frequency);
+            frequencies.push({dictionary: dictionary, frequency: frequency});
         }
     }
     return frequencies;
@@ -212,7 +212,7 @@ function getFrequencyHarmonic(dictionaryEntry) {
 
     let total = 0;
     for (const frequency of frequencies) {
-        total += 1 / frequency;
+        total += 1 / frequency.frequency;
     }
     return Math.floor(frequencies.length / total);
 }
@@ -230,7 +230,7 @@ function getFrequencyAverage(dictionaryEntry) {
 
     let total = 0;
     for (const frequency of frequencies) {
-        total += frequency;
+        total += frequency.frequency;
     }
     return Math.floor(total / frequencies.length);
 }
@@ -441,6 +441,7 @@ function getTermDefinition(dictionaryEntry, context, resultOutputMode, dictionar
     const termTags = createCachedValue(getTermTags.bind(null, dictionaryEntry, type));
     const expressions = createCachedValue(getTermExpressions.bind(null, dictionaryEntry));
     const frequencies = createCachedValue(getTermFrequencies.bind(null, dictionaryEntry));
+    const frequencyNumbers = createCachedValue(getFrequencyNumbers.bind(null, dictionaryEntry));
     const frequencyHarmonic = createCachedValue(getFrequencyHarmonic.bind(null, dictionaryEntry));
     const frequencyAverage = createCachedValue(getFrequencyAverage.bind(null, dictionaryEntry));
     const pitches = createCachedValue(getTermPitches.bind(null, dictionaryEntry));
@@ -483,6 +484,7 @@ function getTermDefinition(dictionaryEntry, context, resultOutputMode, dictionar
         get termTags() { return getCachedValue(termTags); },
         get definitions() { return getCachedValue(commonInfo).definitions; },
         get frequencies() { return getCachedValue(frequencies); },
+        get frequencyNumbers() { return getCachedValue(frequencyNumbers); },
         get frequencyHarmonic() { return getCachedValue(frequencyHarmonic); },
         get frequencyAverage() { return getCachedValue(frequencyAverage); },
         get pitches() { return getCachedValue(pitches); },

ext/js/data/anki-template-util.js

@@ -122,8 +122,8 @@ export function getDynamicTemplates(options, dictionaryInfo) {
         const currentDictionaryInfo = dictionaryInfo.find(({title}) => title === dictionary.name);
         if (!dictionary.enabled) { continue; }
         const totalTerms = currentDictionaryInfo?.counts?.terms?.total;
-        if (!totalTerms || totalTerms === 0) { continue; }
-        dynamicTemplates += `
+        if (totalTerms && totalTerms > 0) {
+            dynamicTemplates += `
 {{#*inline "single-glossary-${getKebabCase(dictionary.name)}"}}
     {{~> glossary selectedDictionary='${escapeDictName(dictionary.name)}'}}
 {{/inline}}
@@ -144,6 +144,18 @@ export function getDynamicTemplates(options, dictionaryInfo) {
     {{~> glossary-plain-no-dictionary selectedDictionary='${escapeDictName(dictionary.name)}' noDictionaryTag=true}}
 {{/inline}}
 `;
+        }
+        const totalMeta = currentDictionaryInfo?.counts?.termMeta;
+        if (totalMeta && totalMeta.freq && totalMeta.freq > 0) {
+            dynamicTemplates += `
+{{#*inline "single-frequency-number-${getKebabCase(dictionary.name)}"}}
+    {{~> single-frequency-number selectedDictionary='${escapeDictName(dictionary.name)}'}}
+{{/inline}}
+{{#*inline "single-frequency-${getKebabCase(dictionary.name)}"}}
+    {{~> frequencies selectedDictionary='${escapeDictName(dictionary.name)}'}}
+{{/inline}}
+`;
+        }
     }
     return dynamicTemplates;
 }
@@ -159,8 +171,13 @@ export function getDynamicFieldMarkers(dictionaries, dictionaryInfo) {
         const currentDictionaryInfo = dictionaryInfo.find(({title}) => title === dictionary.name);
         if (!dictionary.enabled) { continue; }
         const totalTerms = currentDictionaryInfo?.counts?.terms?.total;
-        if (!totalTerms || totalTerms === 0) { continue; }
-        markers.push(`single-glossary-${getKebabCase(dictionary.name)}`);
+        if (totalTerms && totalTerms > 0) {
+            markers.push(`single-glossary-${getKebabCase(dictionary.name)}`);
+        }
+        const totalMeta = currentDictionaryInfo?.counts?.termMeta;
+        if (totalMeta && totalMeta.freq && totalMeta.freq > 0) {
+            markers.push(`single-frequency-number-${getKebabCase(dictionary.name)}`);
+        }
     }
     return markers;
 }

ext/js/data/options-util.js

@@ -578,6 +578,7 @@ export class OptionsUtil {
             this._updateVersion64,
             this._updateVersion65,
             this._updateVersion66,
+            this._updateVersion67,
         ];
         /* eslint-enable @typescript-eslint/unbound-method */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
@@ -1745,6 +1746,14 @@ export class OptionsUtil {
         await this._applyAnkiFieldTemplatesPatch(options, '/data/templates/anki-field-templates-upgrade-v66.handlebars');
     }
 
+    /**
+     * - Added dynamic handlebars for single frequency dictionaries.
+     *  @type {import('options-util').UpdateFunction}
+     */
+    async _updateVersion67(options) {
+        await this._applyAnkiFieldTemplatesPatch(options, '/data/templates/anki-field-templates-upgrade-v67.handlebars');
+    }
+
     /**
      * @param {string} url
      * @returns {Promise<chrome.tabs.Tab>}

ext/templates-modals.html

@@ -1171,6 +1171,14 @@ <h1 class="modal-title">Pronunciation Dictionaries</h1>
                             Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term or kanji usage.
                         </td>
                     </tr>
+                    <tr>
+                        <td><code class="anki-field-marker">{single-frequency-DICT-NAME}</code></td>
+                        <td>All frequencies from the selected dictionary put in a list.</td>
+                    </tr>
+                    <tr>
+                        <td><code class="anki-field-marker">{single-frequency-number-DICT-NAME}</code></td>
+                        <td>A single frequency number from the selected dictionary with no formatting data.</td>
+                    </tr>
                     <tr>
                         <td><code class="anki-field-marker">{screenshot}</code></td>
                         <td>Screenshot of the web page taken at the time the term or kanji was added.</td>