reissbaker/structural

View on GitHub
lib/checks/struct.ts

Summary

Maintainability
D
2 days
Test Coverage
B
86%

File struct.ts has 467 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Err, Result } from "../result";
import { Type, CustomCommutativeAndType, Either, DefaultIntersect, Comment } from "../type";
import { GetType } from "../get-type";

/*
Severity: Minor
Found in lib/checks/struct.ts - About 7 hrs to fix

    Function checkFields has a Cognitive Complexity of 25 (exceeds 6 allowed). Consider refactoring.
    Open

      private checkFields(val: any, checkFn: (t: Type<any>, val: any) => Result<any>, collect?: (key: string, val: any) => any): string[] {
        const errs: string[] = [];
        for(const prop in this.definition) {
          const field = this.definition[prop]
          if(!(prop in val)) {
    Severity: Minor
    Found in lib/checks/struct.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 mergeStructs has a Cognitive Complexity of 22 (exceeds 6 allowed). Consider refactoring.
    Open

      private mergeStructs(l: Struct<any>, r: Struct<any>) {
        const definition: { [key: string]: FieldDef } = {};
    
        for(const prop in l.definition) {
          definition[prop] = l.definition[prop];
    Severity: Minor
    Found in lib/checks/struct.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 mergeStructs has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      private mergeStructs(l: Struct<any>, r: Struct<any>) {
        const definition: { [key: string]: FieldDef } = {};
    
        for(const prop in l.definition) {
          definition[prop] = l.definition[prop];
    Severity: Minor
    Found in lib/checks/struct.ts - About 1 hr to fix

      Function checkFields has 26 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        private checkFields(val: any, checkFn: (t: Type<any>, val: any) => Result<any>, collect?: (key: string, val: any) => any): string[] {
          const errs: string[] = [];
          for(const prop in this.definition) {
            const field = this.definition[prop]
            if(!(prop in val)) {
      Severity: Minor
      Found in lib/checks/struct.ts - About 1 hr to fix

        Function and has a Cognitive Complexity of 9 (exceeds 6 allowed). Consider refactoring.
        Open

          and<Incoming>(type: Type<Incoming>): Type<T & Incoming> {
            if(type instanceof MergeableType) {
              // @ts-ignore
              return new MergeIntersect(this, type);
            }
        Severity: Minor
        Found in lib/checks/struct.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 handleNested has a Cognitive Complexity of 8 (exceeds 6 allowed). Consider refactoring.
        Open

        function handleNested(kind: NestedType): Type<any> {
          if(kind instanceof Struct) {
            if(hasNested(kind)) return deepPartial(kind);
            return new PartialStruct(kind);
          }
        Severity: Minor
        Found in lib/checks/struct.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

        There are no issues that match your filters.

        Category
        Status