Add description for recommended dictionaries

* Add description for recommended dictionaries * Update ext/data/recommended-dictionaries.json Co-authored-by: James Maa <[email protected]> Signed-off-by: Khai Truong <[email protected]> * Add attribution url * rename attributionUrl to homepage * lint * Apply suggestions from code review Co-authored-by: marv <[email protected]> Signed-off-by: Khai Truong <[email protected]> * update json schema --------- Signed-off-by: Khai Truong <[email protected]> Co-authored-by: James Maa <[email protected]> Co-authored-by: marv <[email protected]> <rikaitan.link>Y2FiNzc5M2VkYzNlMzIyMmU3MmI5OGYwYTQ4NjJjNDJiMTc3NDg1Mwo=</rikaitan.link>
Ajatt-Tools · Sep 2, 2024 · cf478c9 · cf478c9
1 parent 0c0fe1a
commit cf478c9
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 25 deletions.
diff --git a/ext/data/recommended-dictionaries.json b/ext/data/recommended-dictionaries.json
@@ -1,13 +1,28 @@
 {
     "ja": {
         "terms": [
-            {"name": "JMdict (Jp->En)", "url": "https://github.com/Ajatt-Tools/jmdict-rikaitan/releases/latest/download/JMdict_english.zip"}
+            {
+                "name": "JMdict (Jp->En)",
+                "downloadUrl": "https://github.com/Ajatt-Tools/jmdict-rikaitan/releases/latest/download/JMdict_english.zip",
+                "description": "A free and openly licensed Japanese-to-English dictionary with example sentences, usage notes, etymology notes, cross references, antonyms, definition notes.",
+                "homepage": "https://github.com/Ajatt-Tools/jmdict-rikaitan/"
+            }
         ],
         "kanji": [
-            {"name": "KANJIDIC (Jp->En)", "url": "https://github.com/Ajatt-Tools/jmdict-rikaitan/releases/latest/download/KANJIDIC_english.zip"}
+            {
+                "name": "KANJIDIC (Jp->En)",
+                "downloadUrl": "https://github.com/Ajatt-Tools/jmdict-rikaitan/releases/latest/download/KANJIDIC_english.zip",
+                "description": "An English dictionary with readings, meanings, stroke order diagrams, frequency, grade level, JLPT level and frequency of kanji characters.",
+                "homepage": "https://github.com/Ajatt-Tools/jmdict-rikaitan/"
+            }
         ],
         "frequency": [
-            {"name": "BCCWJ frequency list", "url": "https://github.com/Ajatt-Tools/yomichan-bccwj-frequency-dictionary/releases/download/1.0.1/BCCWJ-LUW.zip"}
+            {
+                "name": "BCCWJ frequency list",
+                "downloadUrl": "https://github.com/Ajatt-Tools/yomichan-bccwj-frequency-dictionary/releases/download/1.0.1/BCCWJ-LUW.zip",
+                "description": "Based on the Balanced Corpus of Contemporary Written Japanese covering books, magazines, newspapers, blogs, forums, textbooks, and legal documents among others.",
+                "homepage": "https://github.com/Ajatt-Tools/yomichan-bccwj-frequency-dictionary/"
+            }
         ],
         "grammar": [],
         "pronunciation": []

diff --git a/ext/data/schemas/recommended-dictionaries-schema.json b/ext/data/schemas/recommended-dictionaries-schema.json
@@ -13,14 +13,23 @@
                         "type": "object",
                         "required": [
                             "name",
-                            "url"
+                            "downloadUrl",
+                            "description"
                         ],
                         "properties": {
                             "name": {
                                 "type": "string",
                                 "minLength": 2
                             },
-                            "url": {
+                            "downloadUrl": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "description": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "homepage": {
                                 "type": "string",
                                 "minLength": 2
                             }
@@ -33,14 +42,23 @@
                         "type": "object",
                         "required": [
                             "name",
-                            "url"
+                            "downloadUrl",
+                            "description"
                         ],
                         "properties": {
                             "name": {
                                 "type": "string",
                                 "minLength": 2
                             },
-                            "url": {
+                            "downloadUrl": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "description": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "homepage": {
                                 "type": "string",
                                 "minLength": 2
                             }
@@ -53,14 +71,23 @@
                         "type": "object",
                         "required": [
                             "name",
-                            "url"
+                            "downloadUrl",
+                            "description"
                         ],
                         "properties": {
                             "name": {
                                 "type": "string",
                                 "minLength": 2
                             },
-                            "url": {
+                            "downloadUrl": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "description": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "homepage": {
                                 "type": "string",
                                 "minLength": 2
                             }
@@ -73,14 +100,23 @@
                         "type": "object",
                         "required": [
                             "name",
-                            "url"
+                            "downloadUrl",
+                            "description"
                         ],
                         "properties": {
                             "name": {
                                 "type": "string",
                                 "minLength": 2
                             },
-                            "url": {
+                            "downloadUrl": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "description": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "homepage": {
                                 "type": "string",
                                 "minLength": 2
                             }
@@ -93,14 +129,23 @@
                         "type": "object",
                         "required": [
                             "name",
-                            "url"
+                            "downloadUrl",
+                            "description"
                         ],
                         "properties": {
                             "name": {
                                 "type": "string",
                                 "minLength": 2
                             },
-                            "url": {
+                            "downloadUrl": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "description": {
+                                "type": "string",
+                                "minLength": 2
+                            },
+                            "homepage": {
                                 "type": "string",
                                 "minLength": 2
                             }

diff --git a/ext/js/pages/settings/dictionary-import-controller.js b/ext/js/pages/settings/dictionary-import-controller.js
@@ -207,7 +207,7 @@ export class DictionaryImportController {
 
     /**
      *
-     * @param {import('dictionary-recommended.js').Dictionary[]} recommendedDictionaries
+     * @param {import('dictionary-recommended.js').RecommendedDictionary[]} recommendedDictionaries
      * @param {HTMLElement} dictionariesList
      * @param {Set<string>} installedDictionaryNames
      * @param {Set<string>} installedDictionaryDownloadUrls
@@ -222,15 +222,25 @@ export class DictionaryImportController {
                 }
                 const template = this._settingsController.instantiateTemplate('recommended-dictionaries-list-item');
                 const label = querySelectorNotNull(template, '.settings-item-label');
+                const description = querySelectorNotNull(template, '.description');
+                /** @type {HTMLAnchorElement} */
+                const homepage = querySelectorNotNull(template, '.homepage');
                 /** @type {HTMLButtonElement} */
                 const button = querySelectorNotNull(template, '.action-button[data-action=import-recommended-dictionary]');
-                button.disabled = installedDictionaryNames.has(dictionary.name) || installedDictionaryDownloadUrls.has(dictionary.url);
+                button.disabled = installedDictionaryNames.has(dictionary.name) || installedDictionaryDownloadUrls.has(dictionary.downloadUrl);
 
                 const urlAttribute = document.createAttribute('data-import-url');
-                urlAttribute.value = dictionary.url;
+                urlAttribute.value = dictionary.downloadUrl;
                 button.attributes.setNamedItem(urlAttribute);
 
                 label.textContent = dictionary.name;
+                description.textContent = dictionary.description;
+                if (dictionary.homepage) {
+                    homepage.target = '_blank';
+                    homepage.href = dictionary.homepage;
+                } else {
+                    homepage.remove();
+                }
 
                 dictionariesList.append(template);
             }

diff --git a/ext/templates-settings.html b/ext/templates-settings.html
@@ -124,6 +124,10 @@
         <div class="settings-item-inner">
             <div class="settings-item-left">
                 <strong><div class="settings-item-label"></div></strong>
+                <div class="settings-item-description description"></div>
+                <div class="settings-item-description">
+                    <a class="homepage">Homepage</a>
+                </div>
             </div>
             <div class="settings-item-right">
                 <button type="button" class="action-button" data-action="import-recommended-dictionary" data-import-url="">Download</button>

diff --git a/types/ext/dictionary-recommended.d.ts b/types/ext/dictionary-recommended.d.ts
@@ -16,20 +16,22 @@
  */
 
 export type RecommendedDictionaries = {
-    [key: string]: LanguageDictionaries;
+    [key: string]: LanguageRecommendedDictionaries;
 };
 
-export type LanguageDictionaries = {
-    terms: Dictionary[];
-    kanji: Dictionary[];
-    frequency: Dictionary[];
-    grammar: Dictionary[];
-    pronunciation: Dictionary[];
+export type LanguageRecommendedDictionaries = {
+    terms: RecommendedDictionary[];
+    kanji: RecommendedDictionary[];
+    frequency: RecommendedDictionary[];
+    grammar: RecommendedDictionary[];
+    pronunciation: RecommendedDictionary[];
 };
 
-export type Dictionary = {
+export type RecommendedDictionary = {
     name: string;
-    url: string;
+    downloadUrl: string;
+    description: string;
+    homepage?: string;
 };
 
 export type RecommendedDictionariesTest = {