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 --- 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 -------- 4 files changed, 55 insertions(+), 66 deletions(-) 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 (limited to 'types') 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