OpenHPS/openhps-core

View on GitHub
src/data/Serializer.ts

Summary

Maintainability
D
2 days
Test Coverage

File Serializer.ts has 315 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { Serializer as JSONSerializer } from 'typedjson/lib/cjs/serializer';
import type { ConcreteTypeDescriptor, TypeDescriptor } from 'typedjson/lib/types/type-descriptor';
import {
    ensureTypeDescriptor,
    ArrayTypeDescriptor,
Severity: Minor
Found in src/data/Serializer.ts - About 3 hrs to fix

    Function convertAsObject has 64 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        convertAsObject(
            sourceObject: IndexedObject,
            typeDescriptor: ConcreteTypeDescriptor,
            memberName: string,
            serializer: Serializer,
    Severity: Major
    Found in src/data/Serializer.ts - About 2 hrs to fix

      Function convertAsMap has 46 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          convertAsMap(
              sourceObject: Map<any, any>,
              typeDescriptor: MapTypeDescriptor,
              memberName: string,
              serializer: Serializer,
      Severity: Minor
      Found in src/data/Serializer.ts - About 1 hr to fix

        Function convertAsObject has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
        Open

            convertAsObject(
                sourceObject: IndexedObject,
                typeDescriptor: ConcreteTypeDescriptor,
                memberName: string,
                serializer: Serializer,
        Severity: Minor
        Found in src/data/Serializer.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 _convertSingleValue has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private _convertSingleValue(
                sourceObject: any,
                typeDescriptor: TypeDescriptor,
                memberName?: string,
                memberOptions?: ObjectMemberMetadata,
        Severity: Minor
        Found in src/data/Serializer.ts - About 1 hr to fix

          Function convertAsArray has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              convertAsArray(
                  sourceObject: Array<any>,
                  typeDescriptor: ArrayTypeDescriptor,
                  memberName: string,
                  serializer: Serializer,
          Severity: Minor
          Found in src/data/Serializer.ts - About 1 hr to fix

            Function _convertSingleValue has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                private _convertSingleValue(
                    sourceObject: any,
                    typeDescriptor: TypeDescriptor,
                    memberName?: string,
                    memberOptions?: ObjectMemberMetadata,
            Severity: Minor
            Found in src/data/Serializer.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

            Avoid too many return statements within this function.
            Open

                        return this.convertAsObject(
                            sourceObject,
                            typeDescriptor,
                            memberName,
                            this,
            Severity: Major
            Found in src/data/Serializer.ts - About 30 mins to fix

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

                  protected errorHandler: (error: Error) => void = (e: Error) => {
                      e.message = e.message.replace('@jsonObject', '@SerializableObject()');
                      e.message = e.message.replace('@jsonMember', '@SerializableMember()');
                      e.message = e.message.replace('@jsonSetMember', '@SerializableSetMember()');
                      e.message = e.message.replace('@jsonMapMember', '@SerializableMapMember()');
              Severity: Major
              Found in src/data/Serializer.ts and 1 other location - About 6 hrs to fix
              src/data/Deserializer.ts on lines 20..27

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

              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

                  constructor() {
                      super();
                      this.setSerializationStrategy(Map, this.convertAsMap.bind(this));
                      this.setSerializationStrategy(Array, this.convertAsArray.bind(this));
                      this.setSerializationStrategy(Set, this.convertAsSet.bind(this));
              Severity: Major
              Found in src/data/Serializer.ts and 1 other location - About 3 hrs to fix
              src/data/Deserializer.ts on lines 50..56

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

              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