Sign upLogin

aurelia/aurelia

View on GitHub
Star
packages/testing/src/util.ts

Summary

Maintainability
D
2 days
Test Coverage

File util.ts has 447 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// Significant portion of this code is copy-pasted from the node.js source
// Modifications consist primarily of removing dependencies on v8 natives and adding typings

// Original license:
/*
Severity: Minor
Found in packages/testing/src/util.ts - About 6 hrs to fix

    Function createSpy has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

    export function createSpy<
  T extends {} | AnyFunction = VoidFunction,
  K extends keyof T = never,
  F extends AnyFunction = never,
>(instanceOrInnerFn?: T, key?: K, callThroughOrInnerFn?: true | F) {
    Severity: Minor
    Found in packages/testing/src/util.ts - About 2 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 createSpy has 70 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function createSpy<
  T extends {} | AnyFunction = VoidFunction,
  K extends keyof T = never,
  F extends AnyFunction = never,
>(instanceOrInnerFn?: T, key?: K, callThroughOrInnerFn?: true | F) {
    Severity: Major
    Found in packages/testing/src/util.ts - About 2 hrs to fix

      Function escapeAndQuoteString has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
      Open

      export function escapeAndQuoteString(str: string): string {
  let escapeTest = strEscapeSequencesRegExp;
  let escapeReplace = strEscapeSequencesReplacer;
  let singleQuote = 39;
      Severity: Minor
      Found in packages/testing/src/util.ts - About 2 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 escapeAndQuoteString has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export function escapeAndQuoteString(str: string): string {
  let escapeTest = strEscapeSequencesRegExp;
  let escapeReplace = strEscapeSequencesReplacer;
  let singleQuote = 39;
      Severity: Minor
      Found in packages/testing/src/util.ts - About 1 hr to fix

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

        export function isMapIterator(arg: unknown): arg is IterableIterator<[any, any]> {
  return Object_toString(arg) === '[object Map Iterator]';
}
        Severity: Minor
        Found in packages/testing/src/util.ts and 1 other location - About 35 mins to fix
        packages/testing/src/util.ts on lines 170..172

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

        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

        export function isSetIterator(arg: unknown): arg is IterableIterator<[any, any]> {
  return Object_toString(arg) === '[object Set Iterator]';
}
        Severity: Minor
        Found in packages/testing/src/util.ts and 1 other location - About 35 mins to fix
        packages/testing/src/util.ts on lines 158..160

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

        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