emmercm/igir

View on GitHub
src/types/patches/vcdiffPatch.ts

Summary

Maintainability
D
2 days
Test Coverage

File vcdiffPatch.ts has 439 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// eslint-disable-next-line max-classes-per-file
import FilePoly from '../../polyfill/filePoly.js';
import fsPoly from '../../polyfill/fsPoly.js';
import ExpectedError from '../expectedError.js';
import File from '../files/file.js';
Severity: Minor
Found in src/types/patches/vcdiffPatch.ts - About 6 hrs to fix

    Function applyPatchWindow has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

      private static async applyPatchWindow(
        sourceFile: FilePoly,
        targetFile: FilePoly,
        header: VcdiffHeader,
        copyCache: VcdiffCache,
    Severity: Minor
    Found in src/types/patches/vcdiffPatch.ts - About 1 hr 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

    Function fromFilePoly has 34 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      static async fromFilePoly(patchFile: FilePoly): Promise<VcdiffWindow> {
        const winIndicator = (await patchFile.readNext(1)).readUInt8();
        let sourceSegmentSize = 0;
        let sourceSegmentPosition = 0;
        if (winIndicator & (VcdiffWinIndicator.SOURCE | VcdiffWinIndicator.TARGET)) {
    Severity: Minor
    Found in src/types/patches/vcdiffPatch.ts - About 1 hr to fix

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

        static async fromFilePoly(patchFile: FilePoly): Promise<VcdiffHeader> {
          const header = await patchFile.readNext(3);
          if (!header.equals(VcdiffHeader.FILE_SIGNATURE)) {
            await patchFile.close();
            throw new ExpectedError(`Vcdiff patch header is invalid: ${patchFile.getPathLike()}`);
      Severity: Minor
      Found in src/types/patches/vcdiffPatch.ts - About 1 hr to fix

        Function decode has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          decode(
            copyAddressesData: Buffer,
            copyAddressesOffset: number,
            here: number,
            mode: number,
        Severity: Minor
        Found in src/types/patches/vcdiffPatch.ts - About 1 hr to fix

          Function applyPatchWindow has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            private static async applyPatchWindow(
              sourceFile: FilePoly,
              targetFile: FilePoly,
              header: VcdiffHeader,
              copyCache: VcdiffCache,
          Severity: Minor
          Found in src/types/patches/vcdiffPatch.ts - About 1 hr to fix

            Function fromFilePoly has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

              static async fromFilePoly(patchFile: FilePoly): Promise<VcdiffHeader> {
                const header = await patchFile.readNext(3);
                if (!header.equals(VcdiffHeader.FILE_SIGNATURE)) {
                  await patchFile.close();
                  throw new ExpectedError(`Vcdiff patch header is invalid: ${patchFile.getPathLike()}`);
            Severity: Minor
            Found in src/types/patches/vcdiffPatch.ts - About 45 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

            Function writeCopyData has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

              async writeCopyData(
                sourceFile: FilePoly,
                targetFile: FilePoly,
                targetWindowPosition: number,
                size: number,
            Severity: Minor
            Found in src/types/patches/vcdiffPatch.ts - About 45 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

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

                  entries.push([
                    { type: VcdiffInstruction.COPY, size: 0, mode: copyMode },
                    { type: VcdiffInstruction.NOOP, size: 0, mode: 0 },
                  ]);
            Severity: Minor
            Found in src/types/patches/vcdiffPatch.ts and 1 other location - About 55 mins to fix
            src/types/patches/vcdiffPatch.ts on lines 105..108

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

            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

                  entries.push([
                    { type: VcdiffInstruction.COPY, size: 4, mode: copyMode },
                    { type: VcdiffInstruction.ADD, size: 1, mode: 0 },
                  ]);
            Severity: Minor
            Found in src/types/patches/vcdiffPatch.ts and 1 other location - About 55 mins to fix
            src/types/patches/vcdiffPatch.ts on lines 71..74

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

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

              static patchFrom(file: File): VcdiffPatch {
                const crcBefore = Patch.getCrcFromPath(file.getExtractedFilePath());
                return new VcdiffPatch(file, crcBefore);
              }
            Severity: Major
            Found in src/types/patches/vcdiffPatch.ts and 4 other locations - About 50 mins to fix
            src/types/patches/dpsPatch.ts on lines 14..17
            src/types/patches/ipsPatch.ts on lines 16..19
            src/types/patches/ninjaPatch.ts on lines 33..36
            src/types/patches/ppfPatch.ts on lines 69..72

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

            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