Codibre/chai-callslike

View on GitHub

Showing 9 of 9 total issues

Function compareDeep has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

export function compareDeep(
  actual: any,
  expected: any,
  tab: string,
  references: Set<unknown>,
Severity: Minor
Found in src/lib/compare-deep.ts - About 3 hrs 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 compareDeep has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function compareDeep(
  actual: any,
  expected: any,
  tab: string,
  references: Set<unknown>,
Severity: Minor
Found in src/lib/compare-deep.ts - About 1 hr to fix

    Function match has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    export function match(actual: unknown, expected: unknown) {
      let matchResult: boolean = true;
      try {
        if (actual !== expected) {
          if (shouldFailOnExactCompare(typeof actual, typeof expected)) {
    Severity: Minor
    Found in src/lib/match.ts - About 55 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 deeply nested control flow statements.
    Open

              if (compareResult) {
                deepResult += `${prefix}${key}: {${compareResult},\n${tab}}`;
              }
    Severity: Major
    Found in src/lib/compare-deep.ts - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                if (matchResult) {
                  deepResult += `${prefix}${key}: ${matchResult},`;
                }
      Severity: Major
      Found in src/lib/compare-deep.ts - About 45 mins to fix

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

            if (errors) {
              _chai.assert.fail(info(`On ${ids(actualCalls.name)}${errors}`));
            }
        Severity: Minor
        Found in src/lib/get-some-assert-function.ts and 1 other location - About 35 mins to fix
        src/lib/get-assert-function.ts on lines 16..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

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

            if (errors) {
              _chai.assert.fail(info(`On ${ids(actualCalls.name)}${errors}`));
            }
        Severity: Minor
        Found in src/lib/get-assert-function.ts and 1 other location - About 35 mins to fix
        src/lib/get-some-assert-function.ts on lines 14..16

        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

        Function mustGoDeep has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        export function mustGoDeep(a: unknown, e: unknown, references: Set<unknown>) {
          const result =
            isJsonComparable(a) &&
            isJsonComparable(e) &&
            !references.has(a) &&
        Severity: Minor
        Found in src/lib/must-go-deep.ts - About 25 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 checkSomeCallsError has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        export function checkSomeCallsError(
          actualCall: SinonStub,
          expectedCall: object[][],
          compareFunc: (actual: unknown, expected: unknown) => string,
        ) {
        Severity: Minor
        Found in src/lib/check-some-calls-error.ts - About 25 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

        Severity
        Category
        Status
        Source
        Language