Merge branch 'master' into ui-updates

yomidevs · Jan 21, 2024 · e986858 · e986858
2 parents 667a82c + 6ba1ffe
commit e986858
Show file tree

Hide file tree

Showing 357 changed files with 4,323 additions and 2,293 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -594,7 +594,7 @@
                     "error",
                     "block",
                     {
-                        "pattern": " \\* Copyright \\(C\\) (\\d+-)?2023  Yomitan Authors(\n \\* Copyright \\(C\\) (\\d+-)?2022  Yomichan Authors)?\n \\*\n \\* This program is free software: you can redistribute it and/or modify\n \\* it under the terms of the GNU General Public License as published by\n \\* the Free Software Foundation, either version 3 of the License, or\n \\* \\(at your option\\) any later version\\.\n \\*\n \\* This program is distributed in the hope that it will be useful,\n \\* but WITHOUT ANY WARRANTY; without even the implied warranty of\n \\* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\\.  See the\n \\* GNU General Public License for more details\\.\n \\*\n \\* You should have received a copy of the GNU General Public License\n \\* along with this program\\.  If not, see <https://www\\.gnu\\.org/licenses/>\\.\n "
+                        "pattern": " \\* Copyright \\(C\\) (2023-)?2024  Yomitan Authors(\n \\* Copyright \\(C\\) (20(16|17|18|19|20|21)-)?2022  Yomichan Authors)?\n \\*\n \\* This program is free software: you can redistribute it and/or modify\n \\* it under the terms of the GNU General Public License as published by\n \\* the Free Software Foundation, either version 3 of the License, or\n \\* \\(at your option\\) any later version\\.\n \\*\n \\* This program is distributed in the hope that it will be useful,\n \\* but WITHOUT ANY WARRANTY; without even the implied warranty of\n \\* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\\.  See the\n \\* GNU General Public License for more details\\.\n \\*\n \\* You should have received a copy of the GNU General Public License\n \\* along with this program\\.  If not, see <https://www\\.gnu\\.org/licenses/>\\.\n "
                     }
                 ]
             }

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -17,4 +17,4 @@ assignees: ''
 (e.g. 20.11.1.1)
 
 **Exported settings file**
-(If you think it might be relevant, create a settings export file using the _Export Settings_ button on the settings page; zip or rename the resulting file to .txt to attach to the issue.)
+(If you think it might be relevant, create a settings export file using the _Export Settings_ button on the settings page and attach it to this issue.)
diff --git a/README.md b/README.md
diff --git a/dev/bin/build-libs.js b/dev/bin/build-libs.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/bin/build.js b/dev/bin/build.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/bin/dictionary-validate.js b/dev/bin/dictionary-validate.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/bin/generate-css-json.js b/dev/bin/generate-css-json.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/bin/schema-validate.js b/dev/bin/schema-validate.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/build-libs.js b/dev/build-libs.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/data-error.js b/dev/data-error.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/data/display-pronunciation-overrides.css b/dev/data/display-pronunciation-overrides.css
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2021-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/data/structured-content-overrides.css b/dev/data/structured-content-overrides.css
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2021-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/dictionary-validate.js b/dev/dictionary-validate.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify
@@ -23,6 +23,7 @@ import {performance} from 'perf_hooks';
 import {fileURLToPath} from 'url';
 import {parseJson} from './json.js';
 import {createJsonSchema} from './schema-validate.js';
+import {toError} from './to-error.js';
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -39,35 +40,33 @@ function readSchema(relativeFileName) {
 /**
  * @param {import('dev/schema-validate').ValidateMode} mode
  * @param {import('jszip')} zip
- * @param {string} fileNameFormat
- * @param {import('dev/dictionary-validate').Schema} schema
+ * @param {import('dev/dictionary-validate').SchemasDetails} schemasDetails
  */
-async function validateDictionaryBanks(mode, zip, fileNameFormat, schema) {
-    let jsonSchema;
-    try {
-        jsonSchema = createJsonSchema(mode, schema);
-    } catch (e) {
-        const e2 = e instanceof Error ? e : new Error(`${e}`);
-        e2.message += `\n(in file ${fileNameFormat})}`;
-        throw e2;
-    }
-    let index = 1;
-    while (true) {
-        const fileName = fileNameFormat.replace(/\?/, `${index}`);
+async function validateDictionaryBanks(mode, zip, schemasDetails) {
+    for (const [fileName, file] of Object.entries(zip.files)) {
+        for (const [fileNameFormat, schema] of schemasDetails) {
+            if (!fileNameFormat.test(fileName)) { continue; }
 
-        const file = zip.files[fileName];
-        if (!file) { break; }
+            let jsonSchema;
+            try {
+                jsonSchema = createJsonSchema(mode, schema);
+            } catch (e) {
+                const e2 = toError(e);
+                e2.message += `\n(in file ${fileName})}`;
+                throw e2;
+            }
 
-        const data = parseJson(await file.async('string'));
-        try {
-            jsonSchema.validate(data);
-        } catch (e) {
-            const e2 = e instanceof Error ? e : new Error(`${e}`);
-            e2.message += `\n(in file ${fileName})}`;
-            throw e2;
-        }
+            const data = parseJson(await file.async('string'));
 
-        ++index;
+            try {
+                jsonSchema.validate(data);
+            } catch (e) {
+                const e2 = toError(e);
+                e2.message += `\n(in file ${fileName})}`;
+                throw e2;
+            }
+            break;
+        }
     }
 }
 
@@ -92,16 +91,21 @@ export async function validateDictionary(mode, archive, schemas) {
         const jsonSchema = createJsonSchema(mode, schemas.index);
         jsonSchema.validate(index);
     } catch (e) {
-        const e2 = e instanceof Error ? e : new Error(`${e}`);
+        const e2 = toError(e);
         e2.message += `\n(in file ${indexFileName})}`;
         throw e2;
     }
 
-    await validateDictionaryBanks(mode, archive, 'term_bank_?.json', version === 1 ? schemas.termBankV1 : schemas.termBankV3);
-    await validateDictionaryBanks(mode, archive, 'term_meta_bank_?.json', schemas.termMetaBankV3);
-    await validateDictionaryBanks(mode, archive, 'kanji_bank_?.json', version === 1 ? schemas.kanjiBankV1 : schemas.kanjiBankV3);
-    await validateDictionaryBanks(mode, archive, 'kanji_meta_bank_?.json', schemas.kanjiMetaBankV3);
-    await validateDictionaryBanks(mode, archive, 'tag_bank_?.json', schemas.tagBankV3);
+    /** @type {import('dev/dictionary-validate').SchemasDetails} */
+    const schemasDetails = [
+        [/^term_bank_(\d+)\.json$/, version === 1 ? schemas.termBankV1 : schemas.termBankV3],
+        [/^term_meta_bank_(\d+)\.json$/, schemas.termMetaBankV3],
+        [/^kanji_bank_(\d+)\.json$/, version === 1 ? schemas.kanjiBankV1 : schemas.kanjiBankV3],
+        [/^kanji_meta_bank_(\d+)\.json$/, schemas.kanjiMetaBankV3],
+        [/^tag_bank_(\d+)\.json$/, schemas.tagBankV3]
+    ];
+
+    await validateDictionaryBanks(mode, archive, schemasDetails);
 }
 
 /**

diff --git a/dev/generate-css-json.js b/dev/generate-css-json.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2021-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/json.js b/dev/json.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/dexie.js b/dev/lib/dexie.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/handlebars.js b/dev/lib/handlebars.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/parse5.js b/dev/lib/parse5.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/ucs2length.js b/dev/lib/ucs2length.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/wanakana.js b/dev/lib/wanakana.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/z-worker.js b/dev/lib/z-worker.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/lib/zip.js b/dev/lib/zip.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-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

diff --git a/dev/manifest-util.js b/dev/manifest-util.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2021-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/schema-validate.js b/dev/schema-validate.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/dev/to-error.js b/dev/to-error.js
@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2023-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/>.
+ */
+
+export {toError} from '../ext/js/core/to-error.js';
diff --git a/dev/util.js b/dev/util.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023  Yomitan Authors
+ * Copyright (C) 2023-2024  Yomitan Authors
  * Copyright (C) 2020-2022  Yomichan Authors
  *
  * This program is free software: you can redistribute it and/or modify

diff --git a/docs/advanced-options.md b/docs/advanced-options.md
@@ -0,0 +1,10 @@
+## Advanced Options
+
+Click the `Advanced` toggle switch in the bottom left corner of the Settings page to enable advanced options.
+
+### Parse sentences using MeCab
+
+[MeCab](https://taku910.github.io/mecab/) is a third-party program which uses its own dictionaries and parsing algorithm to decompose sentences into individual words. MeCab may provide more accurate parsing results than Yomitan's internal parser.
+
+In order for Yomitan to use it, both MeCab and a native messaging component must be installed.
+A setup guide can be found [here](https://github.com/themoeway/yomitan-mecab-installer/blob/master/README.md).