From c48cd6ff6d8dcced7baf1b27ce3ac2449944f5d7 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sun, 18 Feb 2024 08:09:42 -0500 Subject: Language descriptors organization (#704) * Move languageDescriptorMap * Move text preprocessors * Merge into language-descriptors.js * Merge typescript * Initialize inline * Move types * Update types * Update eslint * Update jsconfig reference * Rename --- .eslintrc.json | 4 +- dev/jsconfig.json | 3 +- ext/js/language/en/language-english.js | 29 -------- ext/js/language/ja/japanese-text-preprocessors.js | 86 +++++++++++++++++++++++ ext/js/language/ja/language-japanese.js | 77 -------------------- ext/js/language/language-descriptors.js | 51 ++++++++++++++ ext/js/language/languages.js | 14 +--- types/ext/language-descriptors.d.ts | 55 +++++++++++++++ types/ext/language-english.d.ts | 25 ------- types/ext/language-japanese.d.ts | 29 -------- types/ext/language.d.ts | 12 ---- 11 files changed, 196 insertions(+), 189 deletions(-) delete mode 100644 ext/js/language/en/language-english.js create mode 100644 ext/js/language/ja/japanese-text-preprocessors.js delete mode 100644 ext/js/language/ja/language-japanese.js create mode 100644 ext/js/language/language-descriptors.js create mode 100644 types/ext/language-descriptors.d.ts delete mode 100644 types/ext/language-english.d.ts delete mode 100644 types/ext/language-japanese.d.ts 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 . - */ - -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 . + */ + +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} */ +export const convertHalfWidthCharacters = { + name: 'Convert half width characters to full width', + description: 'ﾖﾐﾁｬﾝ → ヨミチャン', + options: basicTextPreprocessorOptions, + /** @type {import('language').TextPreprocessorFunction} */ + process: (str, setting, sourceMap) => (setting ? convertHalfWidthKanaToFullWidth(str, sourceMap) : str) +}; + +/** @type {import('language').TextPreprocessor} */ +export const convertNumericCharacters = { + name: 'Convert numeric characters to full width', + description: '1234 → １２３４', + options: basicTextPreprocessorOptions, + /** @type {import('language').TextPreprocessorFunction} */ + process: (str, setting) => (setting ? convertNumericToFullWidth(str) : str) +}; + +/** @type {import('language').TextPreprocessor} */ +export const convertAlphabeticCharacters = { + name: 'Convert alphabetic characters to hiragana', + description: 'yomichan → よみちゃん', + options: basicTextPreprocessorOptions, + /** @type {import('language').TextPreprocessorFunction} */ + process: (str, setting, sourceMap) => (setting ? convertAlphabeticToKana(str, sourceMap) : str) +}; + +/** @type {import('language').TextPreprocessor} */ +export const convertHiraganaToKatakana = { + name: 'Convert hiragana to katakana', + description: 'よみちゃん → ヨミチャン', + options: basicTextPreprocessorOptions, + /** @type {import('language').TextPreprocessorFunction} */ + process: (str, setting) => (setting ? convertHiraganaToKatakanaFunction(str) : str) +}; + +/** @type {import('language').TextPreprocessor} */ +export const convertKatakanaToHiragana = { + name: 'Convert katakana to hiragana', + description: 'ヨミチャン → よみちゃん', + options: basicTextPreprocessorOptions, + /** @type {import('language').TextPreprocessorFunction} */ + 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 . - */ - -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} */ - process: (str, setting, sourceMap) => (setting ? convertHalfWidthKanaToFullWidth(str, sourceMap) : str) - }, - convertNumericCharacters: { - name: 'Convert numeric characters to full width', - description: '1234 → １２３４', - options: basicTextPreprocessorOptions, - /** @type {import('language').TextPreprocessorFunction} */ - process: (str, setting) => (setting ? convertNumericToFullWidth(str) : str) - }, - convertAlphabeticCharacters: { - name: 'Convert alphabetic characters to hiragana', - description: 'yomichan → よみちゃん', - options: basicTextPreprocessorOptions, - /** @type {import('language').TextPreprocessorFunction} */ - process: (str, setting, sourceMap) => (setting ? convertAlphabeticToKana(str, sourceMap) : str) - }, - convertHiraganaToKatakana: { - name: 'Convert hiragana to katakana', - description: 'よみちゃん → ヨミチャン', - options: basicTextPreprocessorOptions, - /** @type {import('language').TextPreprocessorFunction} */ - process: (str, setting) => (setting ? convertHiraganaToKatakana(str) : str) - }, - convertKatakanaToHiragana: { - name: 'Convert katakana to hiragana', - description: 'ヨミチャン → よみちゃん', - options: basicTextPreprocessorOptions, - /** @type {import('language').TextPreprocessorFunction} */ - 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 . + */ + +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} */ +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 . */ -import {descriptor as descriptorEnglish} from './en/language-english.js'; -import {descriptor as descriptorJapanese} from './ja/language-japanese.js'; - -const languageDescriptors = [ - descriptorEnglish, - descriptorJapanese -]; - -/** @type {Map} */ -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 . + */ + +import type {TextPreprocessor} from './language'; +import type {SafeAny} from './core'; + +type LanguageDescriptor = { + iso: TIso; + name: string; + exampleText: string; + textPreprocessors: TTextPreprocessorDescriptor; +}; + +type TextPreprocessorDescriptor = { + [key: string]: TextPreprocessor; +}; + +type LanguageDescriptorObjectMap = { + [key in keyof AllTextPreprocessors]: LanguageDescriptor; +}; + +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; + decapitalize: TextPreprocessor; + }; + ja: { + convertHalfWidthCharacters: TextPreprocessor; + convertNumericCharacters: TextPreprocessor; + convertAlphabeticCharacters: TextPreprocessor; + convertHiraganaToKatakana: TextPreprocessor; + convertKatakanaToHiragana: TextPreprocessor; + 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 . - */ - -import type {LanguageDescriptor, TextPreprocessor} from './language'; - -export type EnglishTextPreprocessorDescriptor = { - capitalizeFirstLetter: TextPreprocessor; - decapitalize: TextPreprocessor; -}; - -export type EnglishLanguageDescriptor = LanguageDescriptor; 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 . - */ - -import type {LanguageDescriptor, TextPreprocessor} from './language'; - -export type JapaneseTextPreprocessorDescriptor = { - convertHalfWidthCharacters: TextPreprocessor; - convertNumericCharacters: TextPreprocessor; - convertAlphabeticCharacters: TextPreprocessor; - convertHiraganaToKatakana: TextPreprocessor; - convertKatakanaToHiragana: TextPreprocessor; - collapseEmphaticSequences: TextPreprocessor<[collapseEmphatic: boolean, collapseEmphaticFull: boolean]>; -}; - -export type JapaneseLanguageDescriptor = LanguageDescriptor; 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[]; @@ -44,14 +43,3 @@ export type LanguageSummary = { iso: string; exampleText: string; }; - -export type LanguageDescriptor = { - name: string; - iso: string; - exampleText: string; - textPreprocessors: TTextPreprocessorDescriptor; -}; - -export type TextPreprocessorDescriptor = { - [key: string]: TextPreprocessor; -}; -- cgit v1.2.3