Refactor: split constants into two classes (#1189)

emmercm · Jun 28, 2024 · 860693d · 860693d
1 parent f34f9d4
commit 860693d
Show file tree

Hide file tree

Showing 52 changed files with 257 additions and 251 deletions.
diff --git a/index.ts b/index.ts
@@ -7,7 +7,7 @@ import semver from 'semver';
 
 import Logger from './src/console/logger.js';
 import ProgressBarCLI from './src/console/progressBarCli.js';
-import Constants from './src/constants.js';
+import Package from './src/constants/package.js';
 import Igir from './src/igir.js';
 import ArgumentsParser from './src/modules/argumentsParser.js';
 import EndOfLifeChecker from './src/modules/endOfLifeChecker.js';
@@ -21,14 +21,14 @@ gracefulFs.gracefulify(realFs);
   const logger = new Logger();
   logger.printHeader();
 
-  if (!semver.satisfies(process.version, Constants.ENGINES_NODE)) {
-    logger.error(`${Constants.COMMAND_NAME} requires a Node.js version of ${Constants.ENGINES_NODE}`);
+  if (!semver.satisfies(process.version, Package.ENGINES_NODE)) {
+    logger.error(`${Package.NAME} requires a Node.js version of ${Package.ENGINES_NODE}`);
     process.exit(1);
   }
 
   process.once('SIGINT', async () => {
     logger.newLine();
-    logger.notice(`Exiting ${Constants.COMMAND_NAME} early`);
+    logger.notice(`Exiting ${Package.NAME} early`);
     await ProgressBarCLI.stop();
     process.exit(0);
     // TODO(cemmer): does exit here cause cleanup not to happen?

diff --git a/package.ts b/package.ts
@@ -10,7 +10,7 @@ import yargs from 'yargs';
 
 import Logger from './src/console/logger.js';
 import LogLevel from './src/console/logLevel.js';
-import Constants from './src/constants.js';
+import Package from './src/constants/package.js';
 import FsPoly from './src/polyfill/fsPoly.js';
 
 interface FileFilter extends GlobOptions {
@@ -61,7 +61,7 @@ const fileFilter = (filters: FileFilter[]): string[] => {
     .positional('output', {
       description: 'output file',
       type: 'string',
-      default: Constants.COMMAND_NAME + (process.platform === 'win32' ? '.exe' : ''),
+      default: Package.NAME + (process.platform === 'win32' ? '.exe' : ''),
     }).argv;
 
   const input = path.resolve(argv.input);

diff --git a/src/console/logger.ts b/src/console/logger.ts
@@ -5,7 +5,7 @@ import chalk from 'chalk';
 import figlet from 'figlet';
 import moment from 'moment';
 
-import Constants from '../constants.js';
+import Package from '../constants/package.js';
 import LogLevel from './logLevel.js';
 import ProgressBar, { ProgressBarSymbol } from './progressBar.js';
 import ProgressBarCLI from './progressBarCli.js';
@@ -119,16 +119,16 @@ export default class Logger {
    * Print the CLI header.
    */
   printHeader(): void {
-    const logo = figlet.textSync(Constants.COMMAND_NAME.toUpperCase(), {
+    const logo = figlet.textSync(Package.NAME.toUpperCase(), {
       font: 'Big Money-se',
     }).trimEnd();
 
     const logoSplit = logo.split('\n');
     const midLine = Math.min(Math.ceil(logoSplit.length / 2), logoSplit.length - 1);
     const maxLineLen = logoSplit.reduce((max, line) => Math.max(max, line.length), 0);
     logoSplit[midLine - 2] = `${logoSplit[midLine - 1].padEnd(maxLineLen, ' ')}   ROM collection manager`;
-    logoSplit[midLine - 1] = `${logoSplit[midLine - 1].padEnd(maxLineLen, ' ')}   ${Constants.HOMEPAGE}`;
-    logoSplit[midLine + 1] = `${logoSplit[midLine + 1].padEnd(maxLineLen, ' ')}   v${Constants.COMMAND_VERSION}`;
+    logoSplit[midLine - 1] = `${logoSplit[midLine - 1].padEnd(maxLineLen, ' ')}   ${Package.HOMEPAGE}`;
+    logoSplit[midLine + 1] = `${logoSplit[midLine + 1].padEnd(maxLineLen, ' ')}   v${Package.VERSION}`;
 
     this.print(LogLevel.ALWAYS, `${logoSplit.join('\n')}\n\n`);
   }
@@ -143,7 +143,7 @@ export default class Logger {
         .replace(/^(Usage:.+)/, chalk.bold('$1'))
 
         .replace(/(\[commands\.*\])/g, chalk.magenta('$1'))
-        .replace(new RegExp(`(${Constants.COMMAND_NAME}) (( ?[a-z0-9])+)`, 'g'), `$1 ${chalk.magenta('$2')}`)
+        .replace(new RegExp(`(${Package.NAME}) (( ?[a-z0-9])+)`, 'g'), `$1 ${chalk.magenta('$2')}`)
 
         .replace(/(\[options\.*\])/g, chalk.cyan('$1'))
         .replace(/([^a-zA-Z0-9-])(-[a-zA-Z0-9]([a-zA-Z0-9]|\n[ \t]*)*)/g, `$1${chalk.cyanBright('$2')}`)
@@ -157,7 +157,7 @@ export default class Logger {
 
         .replace(/(\{[a-zA-Z]+\})/g, chalk.yellow('$1'))
 
-        .replace(new RegExp(` (${Constants.COMMAND_NAME}) `, 'g'), ` ${chalk.blueBright('$1')} `),
+        .replace(new RegExp(` (${Package.NAME}) `, 'g'), ` ${chalk.blueBright('$1')} `),
     );
   }
 

diff --git a/src/constants.ts → src/constants/defaults.ts b/src/constants.ts → src/constants/defaults.ts
@@ -1,39 +1,10 @@
-import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import url from 'node:url';
 
-import fsPoly from './polyfill/fsPoly.js';
+import fsPoly from '../polyfill/fsPoly.js';
+import Package from './package.js';
 
-/**
- * Search for a {@link fileName} in {@link filePath} or any of its parent directories.
- */
-function scanUpPathForFile(filePath: string, fileName: string): string | undefined {
-  const fullPath = path.join(filePath, fileName);
-  if (fs.existsSync(fullPath)) {
-    return fullPath;
-  }
-
-  const parentPath = path.dirname(filePath);
-  if (parentPath !== filePath) {
-    return scanUpPathForFile(path.dirname(filePath), fileName);
-  }
-
-  return undefined;
-}
-
-const PACKAGE_JSON_PATH = scanUpPathForFile(
-  url.fileURLToPath(new URL('.', import.meta.url)),
-  'package.json',
-) as string;
-const PACKAGE_JSON = JSON.parse(
-  fs.readFileSync(PACKAGE_JSON_PATH).toString(),
-);
-const COMMAND_NAME = PACKAGE_JSON.name;
-
-const ROOT_DIR = path.dirname(PACKAGE_JSON_PATH);
-
-const GLOBAL_TEMP_DIR = fsPoly.mkdtempSync(path.join(os.tmpdir(), COMMAND_NAME));
+const GLOBAL_TEMP_DIR = fsPoly.mkdtempSync(path.join(os.tmpdir(), Package.NAME));
 process.once('beforeExit', async () => {
   // WARN: Jest won't call this: https://github.com/jestjs/jest/issues/10927
   await fsPoly.rm(GLOBAL_TEMP_DIR, {
@@ -45,17 +16,7 @@ process.once('beforeExit', async () => {
 /**
  * A static class of constants that are determined at startup, to be used widely.
  */
-export default class Constants {
-  static readonly ROOT_DIR = ROOT_DIR;
-
-  static readonly COMMAND_NAME = COMMAND_NAME;
-
-  static readonly HOMEPAGE = PACKAGE_JSON.homepage;
-
-  static readonly COMMAND_VERSION = PACKAGE_JSON.version;
-
-  static readonly ENGINES_NODE = PACKAGE_JSON.engines?.node ?? '*';
-
+export default class Defaults {
   static readonly GLOBAL_TEMP_DIR = GLOBAL_TEMP_DIR;
 
   /**

diff --git a/src/constants/package.ts b/src/constants/package.ts
@@ -0,0 +1,43 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
+
+/**
+ * Search for a {@link fileName} in {@link filePath} or any of its parent directories.
+ */
+function scanUpPathForFile(filePath: string, fileName: string): string | undefined {
+  const fullPath = path.join(filePath, fileName);
+  if (fs.existsSync(fullPath)) {
+    return fullPath;
+  }
+
+  const parentPath = path.dirname(filePath);
+  if (parentPath !== filePath) {
+    return scanUpPathForFile(path.dirname(filePath), fileName);
+  }
+
+  return undefined;
+}
+
+const PACKAGE_JSON_PATH = scanUpPathForFile(
+  url.fileURLToPath(new URL('.', import.meta.url)),
+  'package.json',
+) as string;
+const PACKAGE_JSON = JSON.parse(
+  fs.readFileSync(PACKAGE_JSON_PATH).toString(),
+);
+
+/**
+ * A static class of constants that are parsed from `package.json` at startup, to be used widely.
+ */
+export default class Package {
+  static readonly DIRECTORY = path.dirname(PACKAGE_JSON_PATH);
+
+  static readonly NAME = PACKAGE_JSON.name;
+
+  static readonly HOMEPAGE = PACKAGE_JSON.homepage;
+
+  static readonly VERSION = PACKAGE_JSON.version;
+
+  static readonly ENGINES_NODE = PACKAGE_JSON.engines?.node ?? '*';
+}
diff --git a/src/driveSemaphore.ts b/src/driveSemaphore.ts
@@ -3,7 +3,7 @@ import path from 'node:path';
 import async, { AsyncResultCallback } from 'async';
 import { Mutex, Semaphore } from 'async-mutex';
 
-import Constants from './constants.js';
+import Defaults from './constants/defaults.js';
 import FsPoly from './polyfill/fsPoly.js';
 import File from './types/files/file.js';
 
@@ -37,7 +37,7 @@ export default class DriveSemaphore {
     // Limit the number of ongoing threads to something reasonable
     return async.mapLimit(
       files,
-      Constants.MAX_FS_THREADS,
+      Defaults.MAX_FS_THREADS,
       async (file, callback: AsyncResultCallback<V, Error>) => {
         try {
           const val = await this.processFile(file, runnable, disks);

diff --git a/src/igir.ts b/src/igir.ts
@@ -8,7 +8,8 @@ import isAdmin from 'is-admin';
 import Logger from './console/logger.js';
 import ProgressBar, { ProgressBarSymbol } from './console/progressBar.js';
 import ProgressBarCLI from './console/progressBarCli.js';
-import Constants from './constants.js';
+import Defaults from './constants/defaults.js';
+import Package from './constants/package.js';
 import CandidateArchiveFileHasher from './modules/candidateArchiveFileHasher.js';
 import CandidateCombiner from './modules/candidateCombiner.js';
 import CandidateGenerator from './modules/candidateGenerator.js';
@@ -72,11 +73,11 @@ export default class Igir {
       && process.platform === 'win32'
     ) {
       this.logger.trace('checking Windows for symlink permissions');
-      if (!await FsPoly.canSymlink(Constants.GLOBAL_TEMP_DIR)) {
+      if (!await FsPoly.canSymlink(Defaults.GLOBAL_TEMP_DIR)) {
         if (!await isAdmin()) {
-          throw new Error(`${Constants.COMMAND_NAME} does not have permissions to create symlinks, please try running as administrator`);
+          throw new Error(`${Package.NAME} does not have permissions to create symlinks, please try running as administrator`);
         }
-        throw new Error(`${Constants.COMMAND_NAME} does not have permissions to create symlinks`);
+        throw new Error(`${Package.NAME} does not have permissions to create symlinks`);
       }
       this.logger.trace('Windows has symlink permissions');
     }
@@ -208,7 +209,7 @@ export default class Igir {
   }
 
   private async getCachePath(): Promise<string | undefined> {
-    const defaultFileName = `${Constants.COMMAND_NAME}.cache`;
+    const defaultFileName = `${Package.NAME}.cache`;
 
     // Try to use the provided path
     let cachePath = this.options.getCachePath();
@@ -225,7 +226,7 @@ export default class Igir {
 
     // Otherwise, use a default path
     return [
-      path.join(path.resolve(Constants.ROOT_DIR), defaultFileName),
+      path.join(path.resolve(Package.DIRECTORY), defaultFileName),
       path.join(os.homedir(), defaultFileName),
       path.join(process.cwd(), defaultFileName),
     ]

diff --git a/src/modules/argumentsParser.ts b/src/modules/argumentsParser.ts
@@ -3,7 +3,8 @@ import fs from 'node:fs';
 import yargs, { Argv } from 'yargs';
 
 import Logger from '../console/logger.js';
-import Constants from '../constants.js';
+import Defaults from '../constants/defaults.js';
+import Package from '../constants/package.js';
 import ArrayPoly from '../polyfill/arrayPoly.js';
 import ConsolePoly from '../polyfill/consolePoly.js';
 import { ChecksumBitmask } from '../types/files/fileChecksums.js';
@@ -165,7 +166,7 @@ export default class ArgumentsParser {
         'boolean-negation': false,
       })
       .locale('en')
-      .scriptName(Constants.COMMAND_NAME)
+      .scriptName(Package.NAME)
       .usage('Usage: $0 [commands..] [options]')
       .updateStrings({
         'Commands:': 'Commands (can specify multiple):',
@@ -768,7 +769,7 @@ export default class ArgumentsParser {
         type: 'string',
         coerce: ArgumentsParser.getLastValue, // don't allow string[] values
         requiresArg: true,
-        default: `./${Constants.COMMAND_NAME}_%YYYY-%MM-%DDT%HH:%mm:%ss.csv`,
+        default: `./${Package.NAME}_%YYYY-%MM-%DDT%HH:%mm:%ss.csv`,
       })
 
       .option('dat-threads', {
@@ -777,23 +778,23 @@ export default class ArgumentsParser {
         type: 'number',
         coerce: (val: number) => Math.max(val, 1),
         requiresArg: true,
-        default: Constants.DAT_DEFAULT_THREADS,
+        default: Defaults.DAT_DEFAULT_THREADS,
       })
       .option('reader-threads', {
         group: groupHelpDebug,
         description: 'Maximum number of ROMs to read in parallel per disk',
         type: 'number',
         coerce: (val: number) => Math.max(val, 1),
         requiresArg: true,
-        default: Constants.FILE_READER_DEFAULT_THREADS,
+        default: Defaults.FILE_READER_DEFAULT_THREADS,
       })
       .option('writer-threads', {
         group: groupHelpDebug,
         description: 'Maximum number of ROMs to write in parallel',
         type: 'number',
         coerce: (val: number) => Math.max(val, 1),
         requiresArg: true,
-        default: Constants.ROM_WRITER_DEFAULT_THREADS,
+        default: Defaults.ROM_WRITER_DEFAULT_THREADS,
       })
       .middleware((middlewareArgv) => {
         if (middlewareArgv.zipDatName) {
@@ -807,7 +808,7 @@ export default class ArgumentsParser {
         type: 'number',
         coerce: (val: number) => Math.max(val, 0),
         requiresArg: true,
-        default: Constants.ROM_WRITER_ADDITIONAL_RETRIES,
+        default: Defaults.ROM_WRITER_ADDITIONAL_RETRIES,
       })
       .option('disable-cache', {
         group: groupHelpDebug,

diff --git a/src/modules/candidateWriter.ts b/src/modules/candidateWriter.ts
@@ -3,7 +3,7 @@ import path from 'node:path';
 import { Semaphore } from 'async-mutex';
 
 import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import Constants from '../constants.js';
+import Defaults from '../constants/defaults.js';
 import ElasticSemaphore from '../elasticSemaphore.js';
 import ArrayPoly from '../polyfill/arrayPoly.js';
 import fsPoly from '../polyfill/fsPoly.js';
@@ -31,7 +31,7 @@ export default class CandidateWriter extends Module {
   // WARN(cemmer): there is an undocumented semaphore max value that can be used, the full
   //  4,700,372,992 bytes of a DVD+R will cause runExclusive() to never run or return.
   private static readonly FILESIZE_SEMAPHORE = new ElasticSemaphore(
-    Constants.MAX_READ_WRITE_CONCURRENT_KILOBYTES,
+    Defaults.MAX_READ_WRITE_CONCURRENT_KILOBYTES,
   );
 
   private readonly options: Options;

diff --git a/src/modules/datCombiner.ts b/src/modules/datCombiner.ts
@@ -1,7 +1,7 @@
 import moment from 'moment';
 
 import ProgressBar from '../console/progressBar.js';
-import Constants from '../constants.js';
+import Package from '../constants/package.js';
 import DAT from '../types/dats/dat.js';
 import Header from '../types/dats/logiqx/header.js';
 import LogiqxDAT from '../types/dats/logiqx/logiqxDat.js';
@@ -38,10 +38,10 @@ export default class DATCombiner extends Module {
       description: datName,
       version: date,
       date,
-      author: Constants.COMMAND_NAME,
-      url: Constants.HOMEPAGE,
+      author: Package.NAME,
+      url: Package.HOMEPAGE,
       comment: [
-        `Combined DAT generated by ${Constants.COMMAND_NAME} v${Constants.COMMAND_VERSION}`,
+        `Combined DAT generated by ${Package.NAME} v${Package.VERSION}`,
         ...dats.map((dat) => dat.getName()),
       ].join('\n'),
     });

diff --git a/src/modules/datGameInferrer.ts b/src/modules/datGameInferrer.ts
@@ -3,7 +3,7 @@ import path from 'node:path';
 import moment from 'moment';
 
 import ProgressBar from '../console/progressBar.js';
-import Constants from '../constants.js';
+import Package from '../constants/package.js';
 import ArrayPoly from '../polyfill/arrayPoly.js';
 import DAT from '../types/dats/dat.js';
 import Game from '../types/dats/game.js';
@@ -21,7 +21,7 @@ import Module from './module.js';
  * path (without the extension).
  */
 export default class DATGameInferrer extends Module {
-  private static readonly DEFAULT_DAT_NAME = Constants.COMMAND_NAME;
+  private static readonly DEFAULT_DAT_NAME = Package.NAME;
 
   private readonly options: Options;
 
@@ -71,10 +71,10 @@ export default class DATGameInferrer extends Module {
       description: datName,
       version: date,
       date,
-      author: Constants.COMMAND_NAME,
-      url: Constants.HOMEPAGE,
+      author: Package.NAME,
+      url: Package.HOMEPAGE,
       comment: [
-        `dir2dat generated by ${Constants.COMMAND_NAME} v${Constants.COMMAND_VERSION}`,
+        `dir2dat generated by ${Package.NAME} v${Package.VERSION}`,
         `Input path: ${inputPath}`,
       ].join('\n'),
     });