emmercm/igir

View on GitHub
src/modules/roms/romIndexer.ts

Summary

Maintainability
B
5 hrs
Test Coverage

Function sortMap has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  private sortMap(checksumsToFiles: ChecksumsToFiles): void {
    const outputDir = path.resolve(this.options.getOutputDirRoot());
    const outputDirDisk = FsPoly.diskResolved(outputDir);

    [...checksumsToFiles.values()].forEach((files) =>
Severity: Minor
Found in src/modules/roms/romIndexer.ts - About 1 hr to fix

    Function archiveEntryPriority has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

      private static archiveEntryPriority(file: File): number {
        if (!(file instanceof ArchiveEntry)) {
          return 0;
        }
        if (file.getArchive() instanceof Zip) {
    Severity: Minor
    Found in src/modules/roms/romIndexer.ts - About 35 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid too many return statements within this function.
    Open

          return 4;
    Severity: Major
    Found in src/modules/roms/romIndexer.ts - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

            return 5;
      Severity: Major
      Found in src/modules/roms/romIndexer.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return 6;
        Severity: Major
        Found in src/modules/roms/romIndexer.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return 99;
          Severity: Major
          Found in src/modules/roms/romIndexer.ts - About 30 mins to fix

            Similar blocks of code found in 8 locations. Consider refactoring.
            Open

                this.progressBar.logTrace(
                  `indexing ${files.length.toLocaleString()} file${files.length !== 1 ? 's' : ''}`,
                );
            Severity: Major
            Found in src/modules/roms/romIndexer.ts and 7 other locations - About 55 mins to fix
            src/modules/dats/datScanner.ts on lines 61..63
            src/modules/dats/datScanner.ts on lines 119..121
            src/modules/directoryCleaner.ts on lines 57..59
            src/modules/directoryCleaner.ts on lines 82..84
            src/modules/movedRomDeleter.ts on lines 59..61
            src/modules/patchScanner.ts on lines 30..32
            src/modules/roms/romScanner.ts on lines 31..33

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 53.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Similar blocks of code found in 13 locations. Consider refactoring.
            Open

              constructor(options: Options, progressBar: ProgressBar) {
                super(progressBar, ROMIndexer.name);
                this.options = options;
              }
            Severity: Major
            Found in src/modules/roms/romIndexer.ts and 12 other locations - About 35 mins to fix
            src/modules/candidates/candidateCombiner.ts on lines 20..23
            src/modules/candidates/candidateMergeSplitValidator.ts on lines 18..21
            src/modules/candidates/candidatePostProcessor.ts on lines 17..20
            src/modules/candidates/candidatePreferer.ts on lines 16..19
            src/modules/dats/datFilter.ts on lines 15..18
            src/modules/dats/datMergerSplitter.ts on lines 18..21
            src/modules/dats/datParentInferrer.ts on lines 15..18
            src/modules/dir2DatCreator.ts on lines 20..23
            src/modules/directoryCleaner.ts on lines 22..25
            src/modules/fixdatCreator.ts on lines 24..27
            src/modules/reportGenerator.ts on lines 16..19
            src/modules/statusGenerator.ts on lines 15..18

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 47.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            There are no issues that match your filters.

            Category
            Status