refactor: Coding conventions

Make sure that files have a default import with the same name as the
file whenever possible to reduce surprise.

Also shuffles around some file names for better legibility.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

3 files changed, 62 insertions, 35 deletions

diff --git a/packages/main/src/infrastructure/impl/FileBasedConfigPersistence.ts b/packages/main/src/infrastructure/config/ConfigFile.ts
index 88d8bf8..193a20d 100644
--- a/packages/main/src/infrastructure/impl/FileBasedConfigPersistence.ts
+++ b/packages/main/src/infrastructure/config/ConfigFile.ts
@@ -17,48 +17,52 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
+
 import { watch } from 'node:fs';
 import { readFile, stat, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 
 import JSON5 from 'json5';
-import throttle from 'lodash-es/throttle';
+import { throttle } from 'lodash-es';
 
 import type { Config } from '../../stores/SharedStore';
 import type Disposer from '../../utils/Disposer';
 import { getLogger } from '../../utils/log';
-import type ConfigPersistence from '../ConfigPersistence';
-import type { ReadConfigResult } from '../ConfigPersistence';
 
-const log = getLogger('fileBasedConfigPersistence');
+import type ConfigRepository from './ConfigRepository';
+import type ReadConfigResult from './ReadConfigResult';
+
+const log = getLogger('ConfigFile');
+
+export default class ConfigFile implements ConfigRepository {
+  readonly #userDataDir: string;
+
+  readonly #configFileName: string;
 
-export default class FileBasedConfigPersistence implements ConfigPersistence {
-  private readonly configFilePath: string;
+  readonly #configFilePath: string;
 
-  private writingConfig = false;
+  #writingConfig = false;
 
-  private timeLastWritten: Date | undefined;
+  #timeLastWritten: Date | undefined;
 
-  constructor(
-    private readonly userDataDir: string,
-    private readonly configFileName: string = 'config.json5',
-  ) {
-    this.configFileName = configFileName;
-    this.configFilePath = path.join(this.userDataDir, this.configFileName);
+  constructor(userDataDir: string, configFileName = 'config.json5') {
+    this.#userDataDir = userDataDir;
+    this.#configFileName = configFileName;
+    this.#configFilePath = path.join(userDataDir, configFileName);
   }
 
   async readConfig(): Promise<ReadConfigResult> {
     let configStr: string;
     try {
-      configStr = await readFile(this.configFilePath, 'utf8');
+      configStr = await readFile(this.#configFilePath, 'utf8');
     } catch (error) {
       if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
-        log.debug('Config file', this.configFilePath, 'was not found');
+        log.debug('Config file', this.#configFilePath, 'was not found');
         return { found: false };
       }
       throw error;
     }
-    log.info('Read config file', this.configFilePath);
+    log.info('Read config file', this.#configFilePath);
     return {
       found: true,
       data: JSON5.parse(configStr),
@@ -69,32 +73,32 @@ export default class FileBasedConfigPersistence implements ConfigPersistence {
     const configJson = JSON5.stringify(configSnapshot, {
       space: 2,
     });
-    this.writingConfig = true;
+    this.#writingConfig = true;
     try {
-      await writeFile(this.configFilePath, configJson, 'utf8');
-      const { mtime } = await stat(this.configFilePath);
-      log.trace('Config file', this.configFilePath, 'last written at', mtime);
-      this.timeLastWritten = mtime;
+      await writeFile(this.#configFilePath, configJson, 'utf8');
+      const { mtime } = await stat(this.#configFilePath);
+      log.trace('Config file', this.#configFilePath, 'last written at', mtime);
+      this.#timeLastWritten = mtime;
     } finally {
-      this.writingConfig = false;
+      this.#writingConfig = false;
     }
-    log.info('Wrote config file', this.configFilePath);
+    log.info('Wrote config file', this.#configFilePath);
   }
 
   watchConfig(callback: () => Promise<void>, throttleMs: number): Disposer {
-    log.debug('Installing watcher for', this.userDataDir);
+    log.debug('Installing watcher for', this.#userDataDir);
 
     const configChanged = throttle(async () => {
       let mtime: Date;
       try {
-        const stats = await stat(this.configFilePath);
+        const stats = await stat(this.#configFilePath);
         mtime = stats.mtime;
         log.trace('Config file last modified at', mtime);
       } catch (error) {
         if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
           log.debug(
             'Config file',
-            this.configFilePath,
+            this.#configFilePath,
             'was deleted after being changed',
           );
           return;
@@ -102,27 +106,27 @@ export default class FileBasedConfigPersistence implements ConfigPersistence {
         throw error;
       }
       if (
-        !this.writingConfig &&
-        (this.timeLastWritten === undefined || mtime > this.timeLastWritten)
+        !this.#writingConfig &&
+        (this.#timeLastWritten === undefined || mtime > this.#timeLastWritten)
       ) {
         log.debug(
           'Found a config file modified at',
           mtime,
           'whish is newer than last written',
-          this.timeLastWritten,
+          this.#timeLastWritten,
         );
         await callback();
       }
     }, throttleMs);
 
-    const watcher = watch(this.userDataDir, {
+    const watcher = watch(this.#userDataDir, {
       persistent: false,
     });
 
     watcher.on('change', (eventType, filename) => {
       if (
         eventType === 'change' &&
-        (filename === this.configFileName || filename === null)
+        (filename === this.#configFileName || filename === null)
       ) {
         configChanged()?.catch((err) => {
           log.error('Unhandled error while listening for config changes', err);
@@ -131,7 +135,7 @@ export default class FileBasedConfigPersistence implements ConfigPersistence {
     });
 
     return () => {
-      log.trace('Removing watcher for', this.configFilePath);
+      log.trace('Removing watcher for', this.#configFilePath);
       watcher.close();
     };
   }
diff --git a/packages/main/src/infrastructure/ConfigPersistence.ts b/packages/main/src/infrastructure/config/ConfigRepository.ts
index 184fa8d..0ce7fc1 100644
--- a/packages/main/src/infrastructure/ConfigPersistence.ts
+++ b/packages/main/src/infrastructure/config/ConfigRepository.ts
@@ -18,8 +18,8 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import type { Config } from '../stores/SharedStore';
-import type Disposer from '../utils/Disposer';
+import type { Config } from '../../stores/SharedStore';
+import type Disposer from '../../utils/Disposer';
 
 export type ReadConfigResult =
   | { found: true; data: unknown }
diff --git a/packages/main/src/infrastructure/config/ReadConfigResult.ts b/packages/main/src/infrastructure/config/ReadConfigResult.ts
new file mode 100644
index 0000000..3b3ee55
--- /dev/null
+++ b/packages/main/src/infrastructure/config/ReadConfigResult.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
+ *
+ * This file is part of Sophie.
+ *
+ * Sophie is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3.
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+type ReadConfigResult = { found: true; data: unknown } | { found: false };
+
+export default ReadConfigResult;