Refactor: rename progress bar icon names (#1327)

emmercm · Aug 29, 2024 · b403669 · b403669
1 parent 27502fd
commit b403669
Show file tree

Hide file tree

Showing 16 changed files with 26 additions and 26 deletions.
diff --git a/src/console/progressBar.ts b/src/console/progressBar.ts
@@ -13,21 +13,21 @@ export const ProgressBarSymbol = {
   DONE: chalk.green(process.platform === 'win32' ? '√' : '✓'),
   // Files
   FILE_SCANNING: chalk.magenta(process.platform === 'win32' ? '○' : '↻'),
-  FILE_DOWNLOADING: chalk.magenta('↓'),
+  DAT_DOWNLOADING: chalk.magenta('↓'),
   DAT_PARSING: chalk.magenta('Σ'),
+  ROM_HASHING: chalk.magenta('#'),
   ROM_HEADER_DETECTION: chalk.magenta('^'),
-  FILE_HASHING: chalk.magenta('#'),
-  FILE_INDEXING: chalk.magenta('#'),
+  ROM_INDEXING: chalk.magenta('♦'),
   // Processing a single DAT
-  GROUPING_SIMILAR: chalk.cyan('∩'),
-  MERGE_SPLIT: chalk.cyan('↔'),
+  DAT_GROUPING_SIMILAR: chalk.cyan('∩'),
+  DAT_MERGE_SPLIT: chalk.cyan('↔'),
   // Candidates
-  GENERATING: chalk.cyan('Σ'),
-  FILTERING: chalk.cyan('∆'),
-  EXTENSION_CORRECTION: chalk.cyan('.'),
-  CANDIDATE_HASHING: chalk.cyan('#'),
-  VALIDATING: chalk.cyan(process.platform === 'win32' ? '?' : '≟'),
-  COMBINING_ALL: chalk.cyan(process.platform === 'win32' ? 'U' : '∪'),
+  CANDIDATE_GENERATING: chalk.cyan('Σ'),
+  CANDIDATE_FILTERING: chalk.cyan('∆'),
+  CANDIDATE_EXTENSION_CORRECTION: chalk.cyan('.'),
+  CANDIDATE_HASHING: chalk.yellow('#'),
+  CANDIDATE_VALIDATING: chalk.cyan(process.platform === 'win32' ? '?' : '≟'),
+  CANDIDATE_COMBINING: chalk.cyan(process.platform === 'win32' ? 'U' : '∪'),
   TESTING: chalk.yellow(process.platform === 'win32' ? '?' : '≟'),
   WRITING: chalk.yellow(process.platform === 'win32' ? '»' : '✎'),
   RECYCLING: chalk.blue(process.platform === 'win32' ? '»' : '♻'),

diff --git a/src/modules/candidateCombiner.ts b/src/modules/candidateCombiner.ts
@@ -39,7 +39,7 @@ export default class CandidateCombiner extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: generating consolidated candidate`);
-    this.progressBar.setSymbol(ProgressBarSymbol.COMBINING_ALL);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_COMBINING);
     this.progressBar.reset(parentsToCandidates.size);
 
     const game = CandidateCombiner.buildGame(dat, parentsToCandidates);

diff --git a/src/modules/candidateExtensionCorrector.ts b/src/modules/candidateExtensionCorrector.ts
@@ -62,7 +62,7 @@ export default class CandidateExtensionCorrector extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: correcting ${romsThatNeedCorrecting.toLocaleString()} output file extension${romsThatNeedCorrecting !== 1 ? 's' : ''}`);
-    this.progressBar.setSymbol(ProgressBarSymbol.EXTENSION_CORRECTION);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_EXTENSION_CORRECTION);
     this.progressBar.reset(romsThatNeedCorrecting);
 
     const correctedParentsToCandidates = await this.correctExtensions(dat, parentsToCandidates);

diff --git a/src/modules/candidateGenerator.ts b/src/modules/candidateGenerator.ts
@@ -58,7 +58,7 @@ export default class CandidateGenerator extends Module {
     const parents = dat.getParents();
 
     this.progressBar.logTrace(`${dat.getNameShort()}: generating candidates`);
-    this.progressBar.setSymbol(ProgressBarSymbol.GENERATING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_GENERATING);
     this.progressBar.reset(parents.length);
 
     // For each parent, try to generate a parent candidate

diff --git a/src/modules/candidateMergeSplitValidator.ts b/src/modules/candidateMergeSplitValidator.ts
@@ -33,7 +33,7 @@ export default class CandidateMergeSplitValidator extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: validating merged & split ROM sets`);
-    this.progressBar.setSymbol(ProgressBarSymbol.VALIDATING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_VALIDATING);
     this.progressBar.reset(parentsToCandidates.size);
 
     const datGamesIndexed = dat.getGames().reduce((map, game) => {

diff --git a/src/modules/candidatePatchGenerator.ts b/src/modules/candidatePatchGenerator.ts
@@ -36,7 +36,7 @@ export default class CandidatePatchGenerator extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: generating patched candidates`);
-    this.progressBar.setSymbol(ProgressBarSymbol.GENERATING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_GENERATING);
     this.progressBar.reset(parentsToCandidates.size);
 
     const crcToPatches = CandidatePatchGenerator.indexPatchesByCrcBefore(patches);

diff --git a/src/modules/candidatePostProcessor.ts b/src/modules/candidatePostProcessor.ts
@@ -32,7 +32,7 @@ export default class CandidatePostProcessor extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: processing candidates`);
-    this.progressBar.setSymbol(ProgressBarSymbol.GENERATING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_GENERATING);
     this.progressBar.reset(parentsToCandidates.size);
 
     // Get the output basename of every ROM

diff --git a/src/modules/candidatePreferer.ts b/src/modules/candidatePreferer.ts
@@ -45,7 +45,7 @@ export default class CandidatePreferer extends Module {
       return parentsToCandidates;
     }
 
-    this.progressBar.setSymbol(ProgressBarSymbol.FILTERING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_FILTERING);
     this.progressBar.reset(parentsToCandidates.size);
 
     const output = this.sortAndFilter(dat, parentsToCandidates);

diff --git a/src/modules/candidateValidator.ts b/src/modules/candidateValidator.ts
@@ -26,7 +26,7 @@ export default class CandidateValidator extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: validating candidates`);
-    this.progressBar.setSymbol(ProgressBarSymbol.VALIDATING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_VALIDATING);
     this.progressBar.reset(parentsToCandidates.size);
 
     const conflictedOutputPaths = this.validateUniqueOutputPaths(dat, parentsToCandidates);

diff --git a/src/modules/datFilter.ts b/src/modules/datFilter.ts
@@ -28,7 +28,7 @@ export default class DATFilter extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: filtering DAT`);
-    this.progressBar.setSymbol(ProgressBarSymbol.FILTERING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_FILTERING);
     this.progressBar.reset(dat.getGames().length);
 
     const filteredGames = dat.getParents().flatMap((parent) => {

diff --git a/src/modules/datMergerSplitter.ts b/src/modules/datMergerSplitter.ts
@@ -42,7 +42,7 @@ export default class DATMergerSplitter extends Module {
     }, new Map<string, Game>());
 
     this.progressBar.logTrace(`${dat.getNameShort()}: merging & splitting ${dat.getGames().length.toLocaleString()} game${dat.getGames().length !== 1 ? 's' : ''}`);
-    this.progressBar.setSymbol(ProgressBarSymbol.MERGE_SPLIT);
+    this.progressBar.setSymbol(ProgressBarSymbol.DAT_MERGE_SPLIT);
     this.progressBar.reset(dat.getGames().length);
 
     const newGames = dat.getParents()

diff --git a/src/modules/datParentInferrer.ts b/src/modules/datParentInferrer.ts
@@ -32,7 +32,7 @@ export default class DATParentInferrer extends Module {
     }
 
     this.progressBar.logTrace(`${dat.getNameShort()}: inferring parents for ${dat.getGames().length.toLocaleString()} game${dat.getGames().length !== 1 ? 's' : ''}`);
-    this.progressBar.setSymbol(ProgressBarSymbol.GROUPING_SIMILAR);
+    this.progressBar.setSymbol(ProgressBarSymbol.DAT_GROUPING_SIMILAR);
     this.progressBar.reset(dat.getGames().length);
 
     // Group games by their stripped names

diff --git a/src/modules/datScanner.ts b/src/modules/datScanner.ts
@@ -88,7 +88,7 @@ export default class DATScanner extends Scanner {
     }
 
     this.progressBar.logTrace('downloading DATs from URLs');
-    this.progressBar.setSymbol(ProgressBarSymbol.FILE_DOWNLOADING);
+    this.progressBar.setSymbol(ProgressBarSymbol.DAT_DOWNLOADING);
 
     return (await Promise.all(datFiles.map(async (datFile) => {
       if (!datFile.isURL()) {

diff --git a/src/modules/movedRomDeleter.ts b/src/modules/movedRomDeleter.ts
@@ -34,7 +34,7 @@ export default class MovedROMDeleter extends Module {
     }
 
     this.progressBar.logTrace('deleting moved ROMs');
-    this.progressBar.setSymbol(ProgressBarSymbol.FILTERING);
+    this.progressBar.setSymbol(ProgressBarSymbol.CANDIDATE_FILTERING);
     this.progressBar.reset(movedRoms.length);
 
     const fullyConsumedFiles = this.filterOutPartiallyConsumedArchives(movedRoms, inputRoms);

diff --git a/src/modules/romIndexer.ts b/src/modules/romIndexer.ts
@@ -31,7 +31,7 @@ export default class ROMIndexer extends Module {
    */
   index(files: File[]): IndexedFiles {
     this.progressBar.logTrace(`indexing ${files.length.toLocaleString()} file${files.length !== 1 ? 's' : ''}`);
-    this.progressBar.setSymbol(ProgressBarSymbol.FILE_INDEXING);
+    this.progressBar.setSymbol(ProgressBarSymbol.ROM_INDEXING);
     this.progressBar.reset(files.length);
 
     // Index the files

diff --git a/src/modules/romScanner.ts b/src/modules/romScanner.ts
@@ -29,7 +29,7 @@ export default class ROMScanner extends Scanner {
       this.progressBar.incrementTotal(increment);
     });
     this.progressBar.logTrace(`found ${romFilePaths.length.toLocaleString()} ROM file${romFilePaths.length !== 1 ? 's' : ''}`);
-    this.progressBar.setSymbol(ProgressBarSymbol.FILE_HASHING);
+    this.progressBar.setSymbol(ProgressBarSymbol.ROM_HASHING);
     this.progressBar.reset(romFilePaths.length);
 
     const files = await this.getFilesFromPaths(