emmercm/igir

View on GitHub
src/types/files/fileCache.ts

Summary

Maintainability
F
4 days
Test Coverage

Function getOrComputeArchiveChecksums has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  async getOrComputeArchiveChecksums<T extends Archive>(
    archive: T,
    checksumBitmask: number,
  ): Promise<ArchiveEntry<Archive>[]> {
    // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
Severity: Minor
Found in src/types/files/fileCache.ts - About 1 hr to fix

    Function getOrComputeFileHeader has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async getOrComputeFileHeader(file: File): Promise<ROMHeader | undefined> {
        // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
        const stats = await FsPoly.stat(file.getFilePath());
        if (stats.size === 0) {
          // An empty file can't have a header
    Severity: Minor
    Found in src/types/files/fileCache.ts - About 1 hr to fix

      Function getOrComputeFileSignature has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        async getOrComputeFileSignature(file: File): Promise<FileSignature | undefined> {
          // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
          const stats = await FsPoly.stat(file.getFilePath());
          if (stats.size === 0) {
            // An empty file can't have a signature
      Severity: Minor
      Found in src/types/files/fileCache.ts - About 1 hr to fix

        Function getOrComputeFileChecksums has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          async getOrComputeFileChecksums(filePath: string, checksumBitmask: number): Promise<File> {
            // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
            const stats = await FsPoly.stat(filePath);
            const cacheKey = await this.getCacheKey(filePath, undefined, ValueType.FILE_CHECKSUMS);
        
        
        Severity: Minor
        Found in src/types/files/fileCache.ts - About 1 hr to fix

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

            async loadFile(cacheFilePath: string): Promise<void> {
              this.cache = await new Cache<CacheValue>({
                filePath: cacheFilePath,
                fileFlushMillis: 60_000,
                saveOnExit: true,
          Severity: Minor
          Found in src/types/files/fileCache.ts - About 1 hr to fix

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

              async getOrComputeFileHeader(file: File): Promise<ROMHeader | undefined> {
                // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
                const stats = await FsPoly.stat(file.getFilePath());
                if (stats.size === 0) {
                  // An empty file can't have a header
            Severity: Major
            Found in src/types/files/fileCache.ts and 1 other location - About 1 day to fix
            src/types/files/fileCache.ts on lines 249..289

            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 336.

            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 2 locations. Consider refactoring.
            Open

              async getOrComputeFileSignature(file: File): Promise<FileSignature | undefined> {
                // NOTE(cemmer): we're explicitly not catching ENOENT errors here, we want it to bubble up
                const stats = await FsPoly.stat(file.getFilePath());
                if (stats.size === 0) {
                  // An empty file can't have a signature
            Severity: Major
            Found in src/types/files/fileCache.ts and 1 other location - About 1 day to fix
            src/types/files/fileCache.ts on lines 207..247

            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 336.

            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