Rename all the config types

sillsdev · Nov 14, 2024 · 3f20fb9 · 3f20fb9
1 parent 7db575c
commit 3f20fb9
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/config/index.d.ts b/config/index.d.ts
@@ -1,6 +1,6 @@
 type HTML = string;
 
-export type BookCollectionAudioData = {
+export type BookCollectionAudioConfig = {
     num: number;
     src: string;
     len?: number;
@@ -9,7 +9,7 @@ export type BookCollectionAudioData = {
     timingFile: string;
 };
 
-export type StyleData = {
+export type StyleConfig = {
     font: string;
     textSize: number;
     lineHeight: number;
@@ -18,7 +18,7 @@ export type StyleData = {
     verseNumbers: string;
 };
 
-export type BookData = {
+export type BookConfig = {
     id: string;
     type?: string;
     format?: string;
@@ -34,11 +34,11 @@ export type BookData = {
     chaptersN: string; // 1-34
     fonts: string[];
     file: string;
-    audio: BookCollectionAudioData[];
+    audio: BookCollectionAudioConfig[];
     features: any;
     quizFeatures?: any;
     footer?: HTML;
-    style?: StyleData;
+    style?: StyleConfig;
     styles?: {
         name: string;
         category?: string;
@@ -48,11 +48,11 @@ export type BookData = {
     }[];
 };
 
-export type BookCollectionData = {
+export type BookCollectionConfig = {
     id: string;
     features: any;
-    books: BookData[];
-    style?: StyleData;
+    books: BookConfig[];
+    style?: StyleConfig;
     fonts: string[];
     languageCode: string;
     languageName?: string;
@@ -73,7 +73,7 @@ export type BookCollectionData = {
     collectionDescription?: string;
 };
 
-export type AudioData = {
+export type AudioConfig = {
     sources: {
         [key: string]: {
             type: string;
@@ -149,7 +149,7 @@ export type AppConfig = {
 
 export type ScriptureConfig = AppConfig & {
     traits?: any;
-    bookCollections?: BookCollectionData[];
+    bookCollections?: BookCollectionConfig[];
     interfaceLanguages?: {
         useSystemLanguage: boolean;
         writingSystems: {
@@ -174,7 +174,7 @@ export type ScriptureConfig = AppConfig & {
             };
         }[];
     };
-    audio?: AudioData;
+    audio?: AudioConfig;
     videos?: {
         id: string;
         src?: string;

diff --git a/convert/convertBooks.ts b/convert/convertBooks.ts
@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference
 ///<reference path="./proskomma.d.ts"/>
 
-import type { ScriptureConfig, BookData } from '$config';
+import type { ScriptureConfig, BookConfig } from '$config';
 import type { ConfigTaskOutput } from './convertConfig';
 import { TaskOutput, Task, Promisable } from './Task';
 import * as fs from 'fs';
@@ -428,7 +428,7 @@ export type Quiz = {
     passScore?: number; //\pm
 };
 
-function convertHtmlBook(context: ConvertBookContext, book: BookData, files: any[]) {
+function convertHtmlBook(context: ConvertBookContext, book: BookConfig, files: any[]) {
     const srcFile = path.join(context.dataDir, 'books', context.bcId, book.file);
     const dstFile = path.join('static', 'collections', context.bcId, book.file);
 
@@ -440,7 +440,7 @@ function convertHtmlBook(context: ConvertBookContext, book: BookData, files: any
     });
 }
 
-function convertQuizBook(context: ConvertBookContext, book: BookData): Quiz {
+function convertQuizBook(context: ConvertBookContext, book: BookConfig): Quiz {
     if (context.verbose) {
         console.log('Converting QuizBook:', book.id);
     }
@@ -568,7 +568,7 @@ function updateExplanation(
 function convertScriptureBook(
     pk: SABProskomma,
     context: ConvertBookContext,
-    book: BookData,
+    book: BookConfig,
     bcGlossary: string[],
     docs: Promise<void>[],
     files: string[]

diff --git a/convert/convertConfig.ts b/convert/convertConfig.ts
@@ -6,9 +6,9 @@ import { convertMarkdownsToHTML } from './convertMarkdown';
 import { splitVersion } from './stringUtils';
 import type {
     ScriptureConfig,
-    BookCollectionData,
-    BookCollectionAudioData,
-    StyleData,
+    BookCollectionConfig,
+    BookCollectionAudioConfig,
+    StyleConfig,
     DictionaryConfig
 } from '$config';
 
@@ -74,7 +74,7 @@ function parseStyles(stylesTag: Element, verbose: number) {
 
     return styles;
 }
-function parseStylesInfo(stylesInfoTag: Element, verbose: number): StyleData {
+function parseStylesInfo(stylesInfoTag: Element, verbose: number): StyleConfig {
     return {
         font: stylesInfoTag.getElementsByTagName('text-font')[0].attributes.getNamedItem('family')!
             .value,
@@ -473,11 +473,11 @@ function parseBookCollections(document: Document, verbose: number) {
                 feature.attributes.getNamedItem('value')!.value
             );
         }
-        const books: BookCollectionData['books'] = [];
+        const books: BookCollectionConfig['books'] = [];
         const bookTags = tag.getElementsByTagName('book');
         for (const book of bookTags) {
             if (verbose >= 2) console.log(`. book: ${book.id}`);
-            const audio: BookCollectionAudioData[] = [];
+            const audio: BookCollectionAudioConfig[] = [];
             for (const page of book.getElementsByTagName('page')) {
                 if (verbose >= 2) console.log(`.. page: ${page.attributes[0].value}`);
                 const audioTag = page.getElementsByTagName('audio')[0];