Refactor: sort modules into groups (#1332)

emmercm · Aug 31, 2024 · 6746d8a · 6746d8a
1 parent f7865f7
commit 6746d8a
Show file tree

Hide file tree

Showing 48 changed files with 434 additions and 434 deletions.
diff --git a/src/igir.ts b/src/igir.ts
@@ -10,31 +10,31 @@ import ProgressBar, { ProgressBarSymbol } from './console/progressBar.js';
 import ProgressBarCLI from './console/progressBarCli.js';
 import Package from './globals/package.js';
 import Temp from './globals/temp.js';
-import CandidateArchiveFileHasher from './modules/candidateArchiveFileHasher.js';
-import CandidateCombiner from './modules/candidateCombiner.js';
-import CandidateExtensionCorrector from './modules/candidateExtensionCorrector.js';
-import CandidateGenerator from './modules/candidateGenerator.js';
-import CandidateMergeSplitValidator from './modules/candidateMergeSplitValidator.js';
-import CandidatePatchGenerator from './modules/candidatePatchGenerator.js';
-import CandidatePostProcessor from './modules/candidatePostProcessor.js';
-import CandidatePreferer from './modules/candidatePreferer.js';
-import CandidateValidator from './modules/candidateValidator.js';
-import CandidateWriter from './modules/candidateWriter.js';
-import DATCombiner from './modules/datCombiner.js';
-import DATFilter from './modules/datFilter.js';
-import DATGameInferrer from './modules/datGameInferrer.js';
-import DATMergerSplitter from './modules/datMergerSplitter.js';
-import DATParentInferrer from './modules/datParentInferrer.js';
-import DATScanner from './modules/datScanner.js';
+import CandidateArchiveFileHasher from './modules/candidates/candidateArchiveFileHasher.js';
+import CandidateCombiner from './modules/candidates/candidateCombiner.js';
+import CandidateExtensionCorrector from './modules/candidates/candidateExtensionCorrector.js';
+import CandidateGenerator from './modules/candidates/candidateGenerator.js';
+import CandidateMergeSplitValidator from './modules/candidates/candidateMergeSplitValidator.js';
+import CandidatePatchGenerator from './modules/candidates/candidatePatchGenerator.js';
+import CandidatePostProcessor from './modules/candidates/candidatePostProcessor.js';
+import CandidatePreferer from './modules/candidates/candidatePreferer.js';
+import CandidateValidator from './modules/candidates/candidateValidator.js';
+import CandidateWriter from './modules/candidates/candidateWriter.js';
+import DATCombiner from './modules/dats/datCombiner.js';
+import DATFilter from './modules/dats/datFilter.js';
+import DATGameInferrer from './modules/dats/datGameInferrer.js';
+import DATMergerSplitter from './modules/dats/datMergerSplitter.js';
+import DATParentInferrer from './modules/dats/datParentInferrer.js';
+import DATScanner from './modules/dats/datScanner.js';
 import Dir2DatCreator from './modules/dir2DatCreator.js';
 import DirectoryCleaner from './modules/directoryCleaner.js';
 import FixdatCreator from './modules/fixdatCreator.js';
 import MovedROMDeleter from './modules/movedRomDeleter.js';
 import PatchScanner from './modules/patchScanner.js';
 import ReportGenerator from './modules/reportGenerator.js';
-import ROMHeaderProcessor from './modules/romHeaderProcessor.js';
-import ROMIndexer from './modules/romIndexer.js';
-import ROMScanner from './modules/romScanner.js';
+import ROMHeaderProcessor from './modules/roms/romHeaderProcessor.js';
+import ROMIndexer from './modules/roms/romIndexer.js';
+import ROMScanner from './modules/roms/romScanner.js';
 import StatusGenerator from './modules/statusGenerator.js';
 import ArrayPoly from './polyfill/arrayPoly.js';
 import FsPoly from './polyfill/fsPoly.js';

diff --git a/src/modules/candidateArchiveFileHasher.ts → .../candidates/candidateArchiveFileHasher.ts b/src/modules/candidateArchiveFileHasher.ts → .../candidates/candidateArchiveFileHasher.ts
@@ -1,12 +1,12 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import DriveSemaphore from '../driveSemaphore.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import ArchiveFile from '../types/files/archives/archiveFile.js';
-import FileFactory from '../types/files/fileFactory.js';
-import Options from '../types/options.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import DriveSemaphore from '../../driveSemaphore.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import ArchiveFile from '../../types/files/archives/archiveFile.js';
+import FileFactory from '../../types/files/fileFactory.js';
+import Options from '../../types/options.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 /**
  * Calculate checksums for {@link ArchiveFile}s (which were skipped in {@link CandidateGenerator}).

diff --git a/src/modules/candidateCombiner.ts → src/modules/candidates/candidateCombiner.ts b/src/modules/candidateCombiner.ts → src/modules/candidates/candidateCombiner.ts
@@ -1,14 +1,14 @@
 import path from 'node:path';
 
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import Parent from '../types/dats/parent.js';
-import ROM from '../types/dats/rom.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import Options from '../types/options.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import Parent from '../../types/dats/parent.js';
+import ROM from '../../types/dats/rom.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import Options from '../../types/options.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 /**
  * Combine every {@link Parent} and its {@link ReleaseCandidate}s for a {@link DAT} into a single

diff --git a/src/modules/candidateExtensionCorrector.ts → ...candidates/candidateExtensionCorrector.ts b/src/modules/candidateExtensionCorrector.ts → ...candidates/candidateExtensionCorrector.ts
@@ -2,19 +2,19 @@ import path from 'node:path';
 
 import { Semaphore } from 'async-mutex';
 
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import ROM from '../types/dats/rom.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import Chd from '../types/files/archives/chd/chd.js';
-import FileFactory from '../types/files/fileFactory.js';
-import FileSignature from '../types/files/fileSignature.js';
-import Options, { FixExtension } from '../types/options.js';
-import OutputFactory from '../types/outputFactory.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import ROMWithFiles from '../types/romWithFiles.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import ROM from '../../types/dats/rom.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import Chd from '../../types/files/archives/chd/chd.js';
+import FileFactory from '../../types/files/fileFactory.js';
+import FileSignature from '../../types/files/fileSignature.js';
+import Options, { FixExtension } from '../../types/options.js';
+import OutputFactory from '../../types/outputFactory.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import ROMWithFiles from '../../types/romWithFiles.js';
+import Module from '../module.js';
 
 /**
  * Correct the extensions of output {@link File}s when:

diff --git a/src/modules/candidateGenerator.ts → src/modules/candidates/candidateGenerator.ts b/src/modules/candidateGenerator.ts → src/modules/candidates/candidateGenerator.ts
@@ -2,26 +2,26 @@ import path from 'node:path';
 
 import { Semaphore } from 'async-mutex';
 
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import fsPoly from '../polyfill/fsPoly.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import Parent from '../types/dats/parent.js';
-import Release from '../types/dats/release.js';
-import ROM from '../types/dats/rom.js';
-import Archive from '../types/files/archives/archive.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import ArchiveFile from '../types/files/archives/archiveFile.js';
-import Chd from '../types/files/archives/chd/chd.js';
-import Zip from '../types/files/archives/zip.js';
-import File from '../types/files/file.js';
-import IndexedFiles from '../types/indexedFiles.js';
-import Options from '../types/options.js';
-import OutputFactory, { OutputPath } from '../types/outputFactory.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import ROMWithFiles from '../types/romWithFiles.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import fsPoly from '../../polyfill/fsPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import Parent from '../../types/dats/parent.js';
+import Release from '../../types/dats/release.js';
+import ROM from '../../types/dats/rom.js';
+import Archive from '../../types/files/archives/archive.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import ArchiveFile from '../../types/files/archives/archiveFile.js';
+import Chd from '../../types/files/archives/chd/chd.js';
+import Zip from '../../types/files/archives/zip.js';
+import File from '../../types/files/file.js';
+import IndexedFiles from '../../types/indexedFiles.js';
+import Options from '../../types/options.js';
+import OutputFactory, { OutputPath } from '../../types/outputFactory.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import ROMWithFiles from '../../types/romWithFiles.js';
+import Module from '../module.js';
 
 /**
  * For every {@link Parent} in the {@link DAT}, look for its {@link ROM}s in the scanned ROM list,

diff --git a/src/modules/candidateMergeSplitValidator.ts → ...andidates/candidateMergeSplitValidator.ts b/src/modules/candidateMergeSplitValidator.ts → ...andidates/candidateMergeSplitValidator.ts
@@ -1,12 +1,12 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import Machine from '../types/dats/mame/machine.js';
-import Parent from '../types/dats/parent.js';
-import Options, { MergeMode } from '../types/options.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import Machine from '../../types/dats/mame/machine.js';
+import Parent from '../../types/dats/parent.js';
+import Options, { MergeMode } from '../../types/options.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 /**
  * Validate un-merged, split, and merged ROM sets for playability after all generation and filtering

diff --git a/src/modules/candidatePatchGenerator.ts → ...les/candidates/candidatePatchGenerator.ts b/src/modules/candidatePatchGenerator.ts → ...les/candidates/candidatePatchGenerator.ts
@@ -1,17 +1,17 @@
 import path from 'node:path';
 
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import Parent from '../types/dats/parent.js';
-import Release from '../types/dats/release.js';
-import ROM from '../types/dats/rom.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import File from '../types/files/file.js';
-import Patch from '../types/patches/patch.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import ROMWithFiles from '../types/romWithFiles.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import Parent from '../../types/dats/parent.js';
+import Release from '../../types/dats/release.js';
+import ROM from '../../types/dats/rom.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import File from '../../types/files/file.js';
+import Patch from '../../types/patches/patch.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import ROMWithFiles from '../../types/romWithFiles.js';
+import Module from '../module.js';
 
 /**
  * For each {@link Patch} that matches a {@link ROM}, generate a new {@link Parent} and

diff --git a/src/modules/candidatePostProcessor.ts → ...ules/candidates/candidatePostProcessor.ts b/src/modules/candidatePostProcessor.ts → ...ules/candidates/candidatePostProcessor.ts
@@ -1,11 +1,11 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import Options from '../types/options.js';
-import OutputFactory from '../types/outputFactory.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import ROMWithFiles from '../types/romWithFiles.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import Options from '../../types/options.js';
+import OutputFactory from '../../types/outputFactory.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import ROMWithFiles from '../../types/romWithFiles.js';
+import Module from '../module.js';
 
 /**
  * Perform any {@link Parent} and {@link ReleaseCandidate} manipulations needed after candidates

diff --git a/src/modules/candidatePreferer.ts → src/modules/candidates/candidatePreferer.ts b/src/modules/candidatePreferer.ts → src/modules/candidates/candidatePreferer.ts
@@ -1,10 +1,10 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import fsPoly from '../polyfill/fsPoly.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import Options, { PreferRevision } from '../types/options.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import fsPoly from '../../polyfill/fsPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import Options, { PreferRevision } from '../../types/options.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 /**
  * Apply any specified preference options to the {@link ReleaseCandidate}s for each

diff --git a/src/modules/candidateValidator.ts → src/modules/candidates/candidateValidator.ts b/src/modules/candidateValidator.ts → src/modules/candidates/candidateValidator.ts
@@ -1,9 +1,9 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 /**
  * Validate candidates for write-ability after all generation and filtering has happened.

diff --git a/src/modules/candidateWriter.ts → src/modules/candidates/candidateWriter.ts b/src/modules/candidateWriter.ts → src/modules/candidates/candidateWriter.ts
@@ -2,21 +2,21 @@ import path from 'node:path';
 
 import { Semaphore } from 'async-mutex';
 
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import ElasticSemaphore from '../elasticSemaphore.js';
-import Defaults from '../globals/defaults.js';
-import KeyedMutex from '../keyedMutex.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import fsPoly from '../polyfill/fsPoly.js';
-import DAT from '../types/dats/dat.js';
-import Parent from '../types/dats/parent.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import Zip from '../types/files/archives/zip.js';
-import File from '../types/files/file.js';
-import { ChecksumBitmask } from '../types/files/fileChecksums.js';
-import Options from '../types/options.js';
-import ReleaseCandidate from '../types/releaseCandidate.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import ElasticSemaphore from '../../elasticSemaphore.js';
+import Defaults from '../../globals/defaults.js';
+import KeyedMutex from '../../keyedMutex.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import fsPoly from '../../polyfill/fsPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Parent from '../../types/dats/parent.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import Zip from '../../types/files/archives/zip.js';
+import File from '../../types/files/file.js';
+import { ChecksumBitmask } from '../../types/files/fileChecksums.js';
+import Options from '../../types/options.js';
+import ReleaseCandidate from '../../types/releaseCandidate.js';
+import Module from '../module.js';
 
 export interface CandidateWriterResults {
   wrote: File[];

diff --git a/src/modules/datCombiner.ts → src/modules/dats/datCombiner.ts b/src/modules/datCombiner.ts → src/modules/dats/datCombiner.ts
@@ -1,12 +1,12 @@
 import moment from 'moment';
 
-import ProgressBar from '../console/progressBar.js';
-import Package from '../globals/package.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import DAT from '../types/dats/dat.js';
-import Header from '../types/dats/logiqx/header.js';
-import LogiqxDAT from '../types/dats/logiqx/logiqxDat.js';
-import Module from './module.js';
+import ProgressBar from '../../console/progressBar.js';
+import Package from '../../globals/package.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Header from '../../types/dats/logiqx/header.js';
+import LogiqxDAT from '../../types/dats/logiqx/logiqxDat.js';
+import Module from '../module.js';
 
 /**
  * Combine every {@link DAT} into a single {@link DAT}.

diff --git a/src/modules/datFilter.ts → src/modules/dats/datFilter.ts b/src/modules/datFilter.ts → src/modules/dats/datFilter.ts
@@ -1,10 +1,10 @@
-import ProgressBar, { ProgressBarSymbol } from '../console/progressBar.js';
-import fsPoly from '../polyfill/fsPoly.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import LogiqxDAT from '../types/dats/logiqx/logiqxDat.js';
-import Options from '../types/options.js';
-import Module from './module.js';
+import ProgressBar, { ProgressBarSymbol } from '../../console/progressBar.js';
+import fsPoly from '../../polyfill/fsPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import LogiqxDAT from '../../types/dats/logiqx/logiqxDat.js';
+import Options from '../../types/options.js';
+import Module from '../module.js';
 
 /**
  * Apply any specified filter options to the {@link Game}s in a {@link DAT}.

diff --git a/src/modules/datGameInferrer.ts → src/modules/dats/datGameInferrer.ts b/src/modules/datGameInferrer.ts → src/modules/dats/datGameInferrer.ts
@@ -5,19 +5,19 @@ import util from 'node:util';
 import { parse } from '@gplane/cue';
 import moment from 'moment';
 
-import ProgressBar from '../console/progressBar.js';
-import Package from '../globals/package.js';
-import ArrayPoly from '../polyfill/arrayPoly.js';
-import DAT from '../types/dats/dat.js';
-import Game from '../types/dats/game.js';
-import Header from '../types/dats/logiqx/header.js';
-import LogiqxDAT from '../types/dats/logiqx/logiqxDat.js';
-import ROM from '../types/dats/rom.js';
-import Archive from '../types/files/archives/archive.js';
-import ArchiveEntry from '../types/files/archives/archiveEntry.js';
-import File from '../types/files/file.js';
-import Options from '../types/options.js';
-import Module from './module.js';
+import ProgressBar from '../../console/progressBar.js';
+import Package from '../../globals/package.js';
+import ArrayPoly from '../../polyfill/arrayPoly.js';
+import DAT from '../../types/dats/dat.js';
+import Game from '../../types/dats/game.js';
+import Header from '../../types/dats/logiqx/header.js';
+import LogiqxDAT from '../../types/dats/logiqx/logiqxDat.js';
+import ROM from '../../types/dats/rom.js';
+import Archive from '../../types/files/archives/archive.js';
+import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
+import File from '../../types/files/file.js';
+import Options from '../../types/options.js';
+import Module from '../module.js';
 
 /**
  * If no {@link DAT}s are provided, implicitly create some. A {@link DAT} will be created for every