Feature/integrate eslint

convert/convertBooks.ts

@@ -149,7 +149,7 @@ function handleNoCaptionFigures(text: string, _bcId: string, _bookId: string): s
         const parts = figContent.split('|');
 
         // Extract the image caption
-        let imageCaption = parts[0];
+        const imageCaption = parts[0];
 
         // Check if the image caption is missing
         if (!imageCaption) {
@@ -236,7 +236,7 @@ function moveFigureToNextNonVerseMarker(text: string): string {
     let carryOverFigures: string[] = [];
 
     const lines = text.split('\n');
-    for (let line of lines) {
+    for (const line of lines) {
         // Add any figures that were carried over from the previous lines
         if (carryOverFigures.length > 0) {
             if (!line.startsWith('\\v ') && !line.startsWith('\\fig')) {

convert/convertConfig.ts

@@ -893,7 +893,7 @@ export function parseDictionaryWritingSystem(
 
 export function parseMenuLocalizations(document: Document, verbose: number) {
     const translationMappingsTags = document.getElementsByTagName('translation-mappings');
-    let translationMappings: {
+    const translationMappings: {
         defaultLang: string;
         mappings: Record<string, Record<string, string>>;
     } = {
@@ -987,7 +987,7 @@ export function parseAnalytics(document: Document, verbose: number) {
 
 export function parseFirebase(document: Document, verbose: number) {
     const firebaseElements = document.getElementsByTagName('firebase');
-    let firebase: { features: { [key: string]: any } } = { features: {} };
+    const firebase: { features: { [key: string]: any } } = { features: {} };
 
     // Iterate over firebaseElements and update data.firebase.features
     for (const firebaseElement of firebaseElements) {
@@ -1161,7 +1161,7 @@ export function parseIllustrations(document: Document, verbose: number) {
 
 export function parseLayouts(document: Document, bookCollections: any, verbose: number) {
     const layoutRoot = document.getElementsByTagName('layouts')[0];
-    let defaultLayout = layoutRoot?.getAttribute('default');
+    const defaultLayout = layoutRoot?.getAttribute('default');
     const layouts = [];
 
     const layoutTags = layoutRoot?.getElementsByTagName('layout');

convert/convertReverseIndex.ts

@@ -146,7 +146,7 @@ export class ConvertReverseIndex extends Task {
             throw new Error('No writing systems found in config data');
         }
 
-        let files: FileContent[] = [];
+        const files: FileContent[] = [];
         for (const lang in configOutput.data.writingSystems) {
             const writingSystem = configOutput.data.writingSystems[lang];
 

convert/tests/sab/convertConfigSAB.test.ts

@@ -105,7 +105,8 @@ if (programType === 'DAB') {
             expect(bc.books).not.toHaveLength(0);
             for (const bk in bc.books) {
                 const bkk = bc.books[bk];
-                expect(bkk.chapters).not.toBe(0 || undefined);
+                expect(bkk.chapters).not.toBe(0);
+                expect(bkk.chapters).toBeDefined();
                 expect(bkk.chaptersN).not.toSatisfy((r) => r === '' || r === undefined);
                 expect(bkk.id).not.toSatisfy((r) => r === '' || r === undefined);
                 expect(bkk.name).not.toSatisfy((r) => r === '' || r === undefined);

eslint.config.js

@@ -1,4 +1,66 @@
-export default [
+// eslint.config.js
+
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat'; // If you want to use eslint --inspect-config, rewrite as `flat.js`.
+import svelte from 'eslint-plugin-svelte';
+import globals from 'globals';
+import ts from 'typescript-eslint';
+import svelteConfig from './svelte.config.js';
+
+export default ts.config(
+    js.configs.recommended,
+    ...ts.configs.recommended,
+    ...svelte.configs.recommended,
+    ...svelte.configs.prettier,
+    eslintConfigPrettier,
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node
+            }
+        }
+    },
+    {
+        files: ['**/*.svelte', '**/*.svelte.ts', '**/*.svelte.js'],
+        // See more details at: https://typescript-eslint.io/packages/parser/
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+                extraFileExtensions: ['.svelte'], // Add support for additional file extensions, such as .svelte
+                parser: ts.parser,
+                // Specify a parser for each language, if needed:
+                // parser: {
+                //   ts: ts.parser,
+                //   js: espree,    // Use espree for .js files (add: import espree from 'espree')
+                //   typescript: ts.parser
+                // },
+
+                // We recommend importing and specifying svelte.config.js.
+                // By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly.
+                // While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it,
+                // explicitly specifying it ensures better compatibility and functionality.
+                svelteConfig
+            }
+        }
+    },
+    {
+        rules: {
+            // Override or add rule settings here, such as:
+            // 'svelte/rule-name': 'error'
+            'svelte/no-navigation-without-base': 'error', // Necessary since hash-based navigation.
+            'svelte/no-dupe-style-properties': 'off', // Height is duplicated with dvh and vh for compatibility.
+            'svelte/require-each-key': 'off', // Most each-blocks in this app do not have keys, and do not seem to need them.
+            'svelte/no-unused-svelte-ignore': 'off', // Svelte ignores that are unused by eslint may be used by LSP.
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-non-null-assertion': 'off',
+            'no-tabs': 'error',
+            'no-undef': 'off', // Covered by TS, and eslint false flags some globals
+            'no-inner-declarations': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            'no-self-assign': 'off'
+        }
+    },
     {
         ignores: [
             '.DS_Store',
@@ -18,5 +80,13 @@ export default [
             'package-lock.json',
             'yarn.lock'
         ]
+    },
+
+    // Ignore certain rules for typescript config
+    {
+        files: ['tailwind.config.cjs'],
+        rules: {
+            '@typescript-eslint/no-require-imports': 'off'
+        }
     }
-];
+);

example/index.ts

@@ -22,10 +22,11 @@ const getExecutionCommand = (program: string): string => {
         javaPath = path.join(process.env['JAVA_HOME'], 'bin', 'java');
     }
     switch (os.platform()) {
-        case 'darwin':
+        case 'darwin': {
             const appPath = `/Applications/${appName}.app/Contents`;
             javaPath = `"${appPath}/Plugins/zulu-17.jdk/Contents/Home/jre/bin/java"`;
             return `${javaPath} -jar "${appPath}/Resources/Java/bin/${jarName}"`;
+        }
         case 'win32': {
             const programFilesX86 = process.env['ProgramFiles(x86)'];
             if (!programFilesX86) {