summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.eslintrc.json4
-rw-r--r--dev/jsconfig.json3
-rw-r--r--ext/js/language/en/language-english.js29
-rw-r--r--ext/js/language/ja/japanese-text-preprocessors.js86
-rw-r--r--ext/js/language/ja/language-japanese.js77
-rw-r--r--ext/js/language/language-descriptors.js51
-rwxr-xr-xext/js/language/languages.js14
-rw-r--r--types/ext/language-descriptors.d.ts55
-rw-r--r--types/ext/language-english.d.ts25
-rw-r--r--types/ext/language-japanese.d.ts29
-rw-r--r--types/ext/language.d.ts12
11 files changed, 196 insertions, 189 deletions
diff --git a/.eslintrc.json b/.eslintrc.json
index b8dcaa77..8147659f 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -638,10 +638,10 @@
"ext/js/general/object-property-accessor.js",
"ext/js/general/regex-util.js",
"ext/js/general/text-source-map.js",
- "ext/js/language/en/language-english.js",
+ "ext/js/language/ja/japanese-text-preprocessors.js",
"ext/js/language/ja/japanese-wanakana.js",
"ext/js/language/ja/japanese.js",
- "ext/js/language/ja/language-japanese.js",
+ "ext/js/language/language-descriptors.js",
"ext/js/language/language-transformer.js",
"ext/js/language/languages.js",
"ext/js/language/text-preprocessors.js",
diff --git a/dev/jsconfig.json b/dev/jsconfig.json
index 6a5fb13b..1bef1058 100644
--- a/dev/jsconfig.json
+++ b/dev/jsconfig.json
@@ -29,8 +29,7 @@
"event-listener-collection": ["../types/ext/event-listener-collection"],
"japanese-util": ["../types/ext/japanese-util"],
"language": ["../types/ext/language"],
- "language-english": ["../types/ext/language-english"],
- "language-japanese": ["../types/ext/language-japanese"],
+ "language-descriptors": ["../types/ext/language-descriptors"],
"ext/json-schema": ["../types/ext/json-schema"],
"language-transformer": ["../types/ext/language-transformer"],
"language-transformer-internal": ["../types/ext/language-transformer-internal"],
diff --git a/ext/js/language/en/language-english.js b/ext/js/language/en/language-english.js
deleted file mode 100644
index 8268653f..00000000
--- a/ext/js/language/en/language-english.js
+++ /dev/null
@@ -1,29 +0,0 @@
-/*
- * 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/>.
- */
-
-import {capitalizeFirstLetter, decapitalize} from '../text-preprocessors.js';
-
-/** @type {import('language-english').EnglishLanguageDescriptor} */
-export const descriptor = {
- name: 'English',
- iso: 'en',
- exampleText: 'read',
- textPreprocessors: {
- capitalizeFirstLetter,
- decapitalize
- }
-};
diff --git a/ext/js/language/ja/japanese-text-preprocessors.js b/ext/js/language/ja/japanese-text-preprocessors.js
new file mode 100644
index 00000000..ab4138c3
--- /dev/null
+++ b/ext/js/language/ja/japanese-text-preprocessors.js
@@ -0,0 +1,86 @@
+/*
+ * 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/>.
+ */
+
+import {basicTextPreprocessorOptions} from '../text-preprocessors.js';
+import {convertAlphabeticToKana} from './japanese-wanakana.js';
+import {
+ collapseEmphaticSequences as collapseEmphaticSequencesFunction,
+ convertHalfWidthKanaToFullWidth,
+ convertHiraganaToKatakana as convertHiraganaToKatakanaFunction,
+ convertKatakanaToHiragana as convertKatakanaToHiraganaFunction,
+ convertNumericToFullWidth
+} from './japanese.js';
+
+/** @type {import('language').TextPreprocessor<boolean>} */
+export const convertHalfWidthCharacters = {
+ name: 'Convert half width characters to full width',
+ description: 'ヨミチャン → ヨミチャン',
+ options: basicTextPreprocessorOptions,
+ /** @type {import('language').TextPreprocessorFunction<boolean>} */
+ process: (str, setting, sourceMap) => (setting ? convertHalfWidthKanaToFullWidth(str, sourceMap) : str)
+};
+
+/** @type {import('language').TextPreprocessor<boolean>} */
+export const convertNumericCharacters = {
+ name: 'Convert numeric characters to full width',
+ description: '1234 → 1234',
+ options: basicTextPreprocessorOptions,
+ /** @type {import('language').TextPreprocessorFunction<boolean>} */
+ process: (str, setting) => (setting ? convertNumericToFullWidth(str) : str)
+};
+
+/** @type {import('language').TextPreprocessor<boolean>} */
+export const convertAlphabeticCharacters = {
+ name: 'Convert alphabetic characters to hiragana',
+ description: 'yomichan → よみちゃん',
+ options: basicTextPreprocessorOptions,
+ /** @type {import('language').TextPreprocessorFunction<boolean>} */
+ process: (str, setting, sourceMap) => (setting ? convertAlphabeticToKana(str, sourceMap) : str)
+};
+
+/** @type {import('language').TextPreprocessor<boolean>} */
+export const convertHiraganaToKatakana = {
+ name: 'Convert hiragana to katakana',
+ description: 'よみちゃん → ヨミチャン',
+ options: basicTextPreprocessorOptions,
+ /** @type {import('language').TextPreprocessorFunction<boolean>} */
+ process: (str, setting) => (setting ? convertHiraganaToKatakanaFunction(str) : str)
+};
+
+/** @type {import('language').TextPreprocessor<boolean>} */
+export const convertKatakanaToHiragana = {
+ name: 'Convert katakana to hiragana',
+ description: 'ヨミチャン → よみちゃん',
+ options: basicTextPreprocessorOptions,
+ /** @type {import('language').TextPreprocessorFunction<boolean>} */
+ process: (str, setting) => (setting ? convertKatakanaToHiraganaFunction(str) : str)
+};
+
+/** @type {import('language').TextPreprocessor<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>} */
+export const collapseEmphaticSequences = {
+ name: 'Collapse emphatic character sequences',
+ description: 'すっっごーーい → すっごーい / すごい',
+ options: [[false, false], [true, false], [true, true]],
+ /** @type {import('language').TextPreprocessorFunction<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>} */
+ process: (str, setting, sourceMap) => {
+ const [collapseEmphatic, collapseEmphaticFull] = setting;
+ if (collapseEmphatic) {
+ str = collapseEmphaticSequencesFunction(str, collapseEmphaticFull, sourceMap);
+ }
+ return str;
+ }
+};
diff --git a/ext/js/language/ja/language-japanese.js b/ext/js/language/ja/language-japanese.js
deleted file mode 100644
index ced34bcd..00000000
--- a/ext/js/language/ja/language-japanese.js
+++ /dev/null
@@ -1,77 +0,0 @@
-/*
- * 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/>.
- */
-
-import {basicTextPreprocessorOptions} from '../text-preprocessors.js';
-import {convertAlphabeticToKana} from './japanese-wanakana.js';
-import {collapseEmphaticSequences, convertHalfWidthKanaToFullWidth, convertHiraganaToKatakana, convertKatakanaToHiragana, convertNumericToFullWidth} from './japanese.js';
-
-/** @type {import('language-japanese').JapaneseLanguageDescriptor} */
-export const descriptor = {
- name: 'Japanese',
- iso: 'ja',
- exampleText: '読め',
- textPreprocessors: {
- convertHalfWidthCharacters: {
- name: 'Convert half width characters to full width',
- description: 'ヨミチャン → ヨミチャン',
- options: basicTextPreprocessorOptions,
- /** @type {import('language').TextPreprocessorFunction<boolean>} */
- process: (str, setting, sourceMap) => (setting ? convertHalfWidthKanaToFullWidth(str, sourceMap) : str)
- },
- convertNumericCharacters: {
- name: 'Convert numeric characters to full width',
- description: '1234 → 1234',
- options: basicTextPreprocessorOptions,
- /** @type {import('language').TextPreprocessorFunction<boolean>} */
- process: (str, setting) => (setting ? convertNumericToFullWidth(str) : str)
- },
- convertAlphabeticCharacters: {
- name: 'Convert alphabetic characters to hiragana',
- description: 'yomichan → よみちゃん',
- options: basicTextPreprocessorOptions,
- /** @type {import('language').TextPreprocessorFunction<boolean>} */
- process: (str, setting, sourceMap) => (setting ? convertAlphabeticToKana(str, sourceMap) : str)
- },
- convertHiraganaToKatakana: {
- name: 'Convert hiragana to katakana',
- description: 'よみちゃん → ヨミチャン',
- options: basicTextPreprocessorOptions,
- /** @type {import('language').TextPreprocessorFunction<boolean>} */
- process: (str, setting) => (setting ? convertHiraganaToKatakana(str) : str)
- },
- convertKatakanaToHiragana: {
- name: 'Convert katakana to hiragana',
- description: 'ヨミチャン → よみちゃん',
- options: basicTextPreprocessorOptions,
- /** @type {import('language').TextPreprocessorFunction<boolean>} */
- process: (str, setting) => (setting ? convertKatakanaToHiragana(str) : str)
- },
- collapseEmphaticSequences: {
- name: 'Collapse emphatic character sequences',
- description: 'すっっごーーい → すっごーい / すごい',
- options: [[false, false], [true, false], [true, true]],
- /** @type {import('language').TextPreprocessorFunction<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>} */
- process: (str, setting, sourceMap) => {
- const [collapseEmphatic, collapseEmphaticFull] = setting;
- if (collapseEmphatic) {
- str = collapseEmphaticSequences(str, collapseEmphaticFull, sourceMap);
- }
- return str;
- }
- }
- }
-};
diff --git a/ext/js/language/language-descriptors.js b/ext/js/language/language-descriptors.js
new file mode 100644
index 00000000..ee65a011
--- /dev/null
+++ b/ext/js/language/language-descriptors.js
@@ -0,0 +1,51 @@
+/*
+ * 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/>.
+ */
+
+import {collapseEmphaticSequences, convertAlphabeticCharacters, convertHalfWidthCharacters, convertHiraganaToKatakana, convertKatakanaToHiragana, convertNumericCharacters} from './ja/japanese-text-preprocessors.js';
+import {capitalizeFirstLetter, decapitalize} from './text-preprocessors.js';
+
+/** @type {import('language-descriptors').LanguageDescriptorAny[]} */
+const languageDescriptors = [
+ {
+ iso: 'en',
+ name: 'English',
+ exampleText: 'read',
+ textPreprocessors: {
+ capitalizeFirstLetter,
+ decapitalize
+ }
+ },
+ {
+ iso: 'ja',
+ name: 'Japanese',
+ exampleText: '読め',
+ textPreprocessors: {
+ convertHalfWidthCharacters,
+ convertNumericCharacters,
+ convertAlphabeticCharacters,
+ convertHiraganaToKatakana,
+ convertKatakanaToHiragana,
+ collapseEmphaticSequences
+ }
+ }
+];
+
+/** @type {Map<string, import('language-descriptors').LanguageDescriptorAny>} */
+export const languageDescriptorMap = new Map();
+for (const languageDescriptor of languageDescriptors) {
+ languageDescriptorMap.set(languageDescriptor.iso, languageDescriptor);
+}
diff --git a/ext/js/language/languages.js b/ext/js/language/languages.js
index f51ca163..f964dfec 100755
--- a/ext/js/language/languages.js
+++ b/ext/js/language/languages.js
@@ -15,19 +15,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
-import {descriptor as descriptorEnglish} from './en/language-english.js';
-import {descriptor as descriptorJapanese} from './ja/language-japanese.js';
-
-const languageDescriptors = [
- descriptorEnglish,
- descriptorJapanese
-];
-
-/** @type {Map<string, typeof languageDescriptors[0]>} */
-const languageDescriptorMap = new Map();
-for (const languageDescriptor of languageDescriptors) {
- languageDescriptorMap.set(languageDescriptor.iso, languageDescriptor);
-}
+import {languageDescriptorMap} from './language-descriptors.js';
/**
* @returns {import('language').LanguageSummary[]}
diff --git a/types/ext/language-descriptors.d.ts b/types/ext/language-descriptors.d.ts
new file mode 100644
index 00000000..00a95883
--- /dev/null
+++ b/types/ext/language-descriptors.d.ts
@@ -0,0 +1,55 @@
+/*
+ * 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/>.
+ */
+
+import type {TextPreprocessor} from './language';
+import type {SafeAny} from './core';
+
+type LanguageDescriptor<TIso extends string, TTextPreprocessorDescriptor extends TextPreprocessorDescriptor> = {
+ iso: TIso;
+ name: string;
+ exampleText: string;
+ textPreprocessors: TTextPreprocessorDescriptor;
+};
+
+type TextPreprocessorDescriptor = {
+ [key: string]: TextPreprocessor<SafeAny>;
+};
+
+type LanguageDescriptorObjectMap = {
+ [key in keyof AllTextPreprocessors]: LanguageDescriptor<key, AllTextPreprocessors[key]>;
+};
+
+export type LanguageDescriptorAny = LanguageDescriptorObjectMap[keyof LanguageDescriptorObjectMap];
+
+/**
+ * This is a mapping of the iso tag to all of the preprocessors for that language.
+ * Any new language should be added to this object.
+ */
+type AllTextPreprocessors = {
+ en: {
+ capitalizeFirstLetter: TextPreprocessor<boolean>;
+ decapitalize: TextPreprocessor<boolean>;
+ };
+ ja: {
+ convertHalfWidthCharacters: TextPreprocessor<boolean>;
+ convertNumericCharacters: TextPreprocessor<boolean>;
+ convertAlphabeticCharacters: TextPreprocessor<boolean>;
+ convertHiraganaToKatakana: TextPreprocessor<boolean>;
+ convertKatakanaToHiragana: TextPreprocessor<boolean>;
+ collapseEmphaticSequences: TextPreprocessor<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>;
+ };
+};
diff --git a/types/ext/language-english.d.ts b/types/ext/language-english.d.ts
deleted file mode 100644
index ed501d57..00000000
--- a/types/ext/language-english.d.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-/*
- * 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/>.
- */
-
-import type {LanguageDescriptor, TextPreprocessor} from './language';
-
-export type EnglishTextPreprocessorDescriptor = {
- capitalizeFirstLetter: TextPreprocessor<boolean>;
- decapitalize: TextPreprocessor<boolean>;
-};
-
-export type EnglishLanguageDescriptor = LanguageDescriptor<EnglishTextPreprocessorDescriptor>;
diff --git a/types/ext/language-japanese.d.ts b/types/ext/language-japanese.d.ts
deleted file mode 100644
index 1a627ed1..00000000
--- a/types/ext/language-japanese.d.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-/*
- * 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/>.
- */
-
-import type {LanguageDescriptor, TextPreprocessor} from './language';
-
-export type JapaneseTextPreprocessorDescriptor = {
- convertHalfWidthCharacters: TextPreprocessor<boolean>;
- convertNumericCharacters: TextPreprocessor<boolean>;
- convertAlphabeticCharacters: TextPreprocessor<boolean>;
- convertHiraganaToKatakana: TextPreprocessor<boolean>;
- convertKatakanaToHiragana: TextPreprocessor<boolean>;
- collapseEmphaticSequences: TextPreprocessor<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>;
-};
-
-export type JapaneseLanguageDescriptor = LanguageDescriptor<JapaneseTextPreprocessorDescriptor>;
diff --git a/types/ext/language.d.ts b/types/ext/language.d.ts
index 247c7795..efbb16c6 100644
--- a/types/ext/language.d.ts
+++ b/types/ext/language.d.ts
@@ -16,7 +16,6 @@
*/
import type {TextSourceMap} from '../../ext/js/general/text-source-map.js';
-import type {SafeAny} from './core';
export type TextPreprocessorOptions<T = unknown> = T[];
@@ -44,14 +43,3 @@ export type LanguageSummary = {
iso: string;
exampleText: string;
};
-
-export type LanguageDescriptor<TTextPreprocessorDescriptor extends TextPreprocessorDescriptor> = {
- name: string;
- iso: string;
- exampleText: string;
- textPreprocessors: TTextPreprocessorDescriptor;
-};
-
-export type TextPreprocessorDescriptor = {
- [key: string]: TextPreprocessor<SafeAny>;
-};