summaryrefslogtreecommitdiff
path: root/ext/js/data/anki-template-util.js
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2024-02-05 06:16:00 -0500
committerGitHub <noreply@github.com>2024-02-05 11:16:00 +0000
commit576dece97e6546aea774d1bac4a05b7854c512a4 (patch)
treef9b9b1c167a0156221ecef275f23d53acf519dae /ext/js/data/anki-template-util.js
parent71c3aff53173cc83a96d7d2715b7918bdbc2d8a5 (diff)
Reduce repeated anki field marker code (#632)
* Unify repeated code for getting anki field markers * Throw because type safety exists * Simplify * Update order * Update test data
Diffstat (limited to 'ext/js/data/anki-template-util.js')
-rw-r--r--ext/js/data/anki-template-util.js93
1 files changed, 93 insertions, 0 deletions
diff --git a/ext/js/data/anki-template-util.js b/ext/js/data/anki-template-util.js
new file mode 100644
index 00000000..686b4af8
--- /dev/null
+++ b/ext/js/data/anki-template-util.js
@@ -0,0 +1,93 @@
+/*
+ * Copyright (C) 2024 Yomitan Authors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Gets a list of field markers from the standard Handlebars template.
+ * @param {import('dictionary').DictionaryEntryType} type What type of dictionary entry to get the fields for.
+ * @returns {string[]} The list of field markers.
+ * @throws {Error}
+ */
+export function getStandardFieldMarkers(type) {
+ switch (type) {
+ case 'term':
+ return [
+ 'audio',
+ 'clipboard-image',
+ 'clipboard-text',
+ 'cloze-body',
+ 'cloze-prefix',
+ 'cloze-suffix',
+ 'conjugation',
+ 'dictionary',
+ 'document-title',
+ 'expression',
+ 'frequencies',
+ 'frequency-harmonic-rank',
+ 'frequency-harmonic-occurrence',
+ 'frequency-average-rank',
+ 'frequency-average-occurrence',
+ 'furigana',
+ 'furigana-plain',
+ 'glossary',
+ 'glossary-brief',
+ 'glossary-no-dictionary',
+ 'part-of-speech',
+ 'pitch-accents',
+ 'pitch-accent-graphs',
+ 'pitch-accent-positions',
+ 'pitch-accent-categories',
+ 'phonetic-transcriptions',
+ 'reading',
+ 'screenshot',
+ 'search-query',
+ 'selection-text',
+ 'sentence',
+ 'sentence-furigana',
+ 'tags',
+ 'url'
+ ];
+ case 'kanji':
+ return [
+ 'character',
+ 'clipboard-image',
+ 'clipboard-text',
+ 'cloze-body',
+ 'cloze-prefix',
+ 'cloze-suffix',
+ 'dictionary',
+ 'document-title',
+ 'frequencies',
+ 'frequency-harmonic-rank',
+ 'frequency-harmonic-occurrence',
+ 'frequency-average-rank',
+ 'frequency-average-occurrence',
+ 'glossary',
+ 'kunyomi',
+ 'onyomi',
+ 'screenshot',
+ 'search-query',
+ 'selection-text',
+ 'sentence',
+ 'sentence-furigana',
+ 'stroke-count',
+ 'tags',
+ 'url'
+ ];
+ default:
+ throw new Error(`Unsupported type: ${type}`);
+ }
+}