Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: remove "concurrently" language from module comments #1164

Merged
merged 2 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/modules/candidateCombiner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ import Module from './module.js';
/**
* Combine every {@link Parent} and its {@link ReleaseCandidate}s for a {@link DAT} into a single
* {@link Parent}.
*
* This class may be run concurrently with other classes.
*/
export default class CandidateCombiner extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/candidateMergeSplitValidator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ import Module from './module.js';
/**
* Validate un-merged, split, and merged ROM sets for playability after all generation and filtering
* has happened.
*
* This class may be run concurrently with other classes.
*/
export default class CandidateMergeSplitValidator extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/candidatePatchGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ import Module from './module.js';
/**
* For each {@link Patch} that matches a {@link ROM}, generate a new {@link Parent} and
* {@link ReleaseCandidate} of that {@link Game}.
*
* This class may be run concurrently with other classes.
*/
export default class CandidatePatchGenerator extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/candidatePostProcessor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import Module from './module.js';
/**
* Perform any {@link Parent} and {@link ReleaseCandidate} manipulations needed after candidates
* have had patches attached and have been filtered.
*
* This class may be run concurrently with other classes.
*/
export default class CandidatePostProcessor extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/candidatePreferer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import Module from './module.js';
/**
* Apply any specified preference options to the {@link ReleaseCandidate}s for each
* {@link Parent}.
*
* This class may be run concurrently with other classes.
*/
export default class CandidatePreferer extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/candidateWriter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ export interface CandidateWriterResults {

/**
* Copy or move output ROM files, if applicable.
*
* This class may be run concurrently with other classes.
*/
export default class CandidateWriter extends Module {
private static readonly THREAD_SEMAPHORE = new Semaphore(Number.MAX_SAFE_INTEGER);
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datCombiner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import Module from './module.js';

/**
* Combine every {@link DAT} into a single {@link DAT}.
*
* This class may be run concurrently with other classes.
*/
export default class DATCombiner extends Module {
constructor(progressBar: ProgressBar) {
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datFilter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import Module from './module.js';

/**
* Apply any specified filter options to the {@link Game}s in a {@link DAT}.
*
* This class may be run concurrently with other classes.
*/
export default class DATFilter extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datGameInferrer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ import Module from './module.js';
* If no {@link DAT}s are provided, implicitly create some. A {@link DAT} will be created for every
* subdirectory that contains files, and {@link Game}s will be named after each file's extracted
* path (without the extension).
*
* This class will not be run concurrently with any other class.
*/
export default class DATGameInferrer extends Module {
private static readonly DEFAULT_DAT_NAME = Constants.COMMAND_NAME;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datMergerSplitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ import Module from './module.js';

/**
* Process a {@link DAT} with the ROM merge mode specified.
*
* This class may be run concurrently with other classes.
*/
export default class DATMergerSplitter extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datParentInferrer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import Module from './module.js';

/**
* Infer {@link Parent}s for all {@link DAT}s, even those that already have some parents.
*
* This class may be run concurrently with other classes.
*/
export default class DATParentInferrer extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/datScanner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ type SmdbRow = {
/**
* Scan the {@link OptionsProps.dat} input directory for DAT files and return the internal model
* representation.
*
* This class will not be run concurrently with any other class.
*/
export default class DATScanner extends Scanner {
constructor(options: Options, progressBar: ProgressBar) {
Expand Down
2 changes: 0 additions & 2 deletions src/modules/directoryCleaner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ import Module from './module.js';

/**
* Recycle any unknown files in the {@link OptionsProps.output} directory, if applicable.
*
* This class will not be run concurrently with any other class.
*/
export default class DirectoryCleaner extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/endOfLifeChecker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import ProgressBarCLI from '../console/progressBarCli.js';

/**
* Check if the current Node.js version has reached EOL and log if it has.
*
* This class will not be run concurrently with any other class.
*/
export default class EndOfLifeChecker {
private static readonly END_OF_LIFE_DATES = [
Expand Down
2 changes: 0 additions & 2 deletions src/modules/movedRomDeleter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import Module from './module.js';
* After all output {@link File}s have been written, delete any input {@link File}s that were
* "moved." This needs to happen after all writing has finished in order to guarantee we're done
* reading input {@link File}s from disk.
*
* This class will not be run concurrently with any other class.
*/
export default class MovedROMDeleter extends Module {
constructor(progressBar: ProgressBar) {
Expand Down
2 changes: 0 additions & 2 deletions src/modules/patchScanner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import Scanner from './scanner.js';

/**
* Scan for {@link Patch}es and parse them into the correct supported type.
*
* This class will not be run concurrently with any other class.
*/
export default class PatchScanner extends Scanner {
constructor(options: Options, progressBar: ProgressBar) {
Expand Down
2 changes: 0 additions & 2 deletions src/modules/reportGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import Module from './module.js';

/**
* Generate a single report file with information about every DAT processed.
*
* This class will not be run concurrently with any other class.
*/
export default class ReportGenerator extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/romHeaderProcessor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import Module from './module.js';
/**
* For every input {@link ROM} file found, attempt to find a matching {@link Header} and resolve its
* header-less checksum.
*
* This class will not be run concurrently with any other class.
*/
export default class ROMHeaderProcessor extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/romScanner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import Scanner from './scanner.js';
/**
* Scan the {@link OptionsProps.input} input directory for ROM files and return the internal model
* representation.
*
* This class will not be run concurrently with any other class.
*/
export default class ROMScanner extends Scanner {
constructor(options: Options, progressBar: ProgressBar) {
Expand Down
2 changes: 0 additions & 2 deletions src/modules/statusGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import Module from './module.js';

/**
* Generate the status for a DAT, and print a short status to the progress bar.
*
* This class may be run concurrently with other classes.
*/
export default class StatusGenerator extends Module {
private readonly options: Options;
Expand Down
2 changes: 0 additions & 2 deletions src/modules/updateChecker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import BufferPoly from '../polyfill/bufferPoly.js';

/**
* Check for a newer version and log if one is found.
*
* This class will not be run concurrently with any other class.
*/
export default class UpdateChecker {
private readonly logger: Logger;
Expand Down
Loading