euberdeveloper/byteify

View on GitHub
source/modules/serialize.ts

Summary

Maintainability
D
1 day
Test Coverage
A
100%

Function serialize has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function serialize(value: number | bigint, nativeType: NativeType, options: ByteifyOptions): number[] {
    const essence: Essence = ESSENCE[nativeType];
    const max = MAX[nativeType];
    const min = MIN[nativeType];

Severity: Minor
Found in source/modules/serialize.ts - About 1 hr to fix

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

    function serialize(value: number | bigint, nativeType: NativeType, options: ByteifyOptions): number[] {
        const essence: Essence = ESSENCE[nativeType];
        const max = MAX[nativeType];
        const min = MIN[nativeType];
    
    
    Severity: Minor
    Found in source/modules/serialize.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

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

    export function serializeUint8(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.UINT8, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 207..212
    source/modules/serialize.ts on lines 233..238

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

    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 serializeInt64(
        value: bigint,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.INT64, options);
    Severity: Major
    Found in source/modules/serialize.ts and 1 other location - About 1 hr to fix
    source/modules/serialize.ts on lines 168..173

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

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

    export function serializeInt32(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.INT32, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 233..238

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

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

    export function serializeFloat32(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.FLOAT32, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 207..212

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

    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 serializeUint64(
        value: bigint,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.UINT64, options);
    Severity: Major
    Found in source/modules/serialize.ts and 1 other location - About 1 hr to fix
    source/modules/serialize.ts on lines 220..225

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

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

    export function serializeInt16(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.INT16, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 207..212
    source/modules/serialize.ts on lines 233..238

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

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

    export function serializeUint32(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.UINT32, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 207..212
    source/modules/serialize.ts on lines 233..238

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

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

    export function serializeUint16(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.UINT16, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 181..186
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 207..212
    source/modules/serialize.ts on lines 233..238

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

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

    export function serializeInt8(
        value: number,
        options: ByteifyOptions = { endianess: ByteifyEndianess.LITTLE_ENDIAN }
    ): number[] {
        return serialize(value, NativeType.INT8, options);
    Severity: Major
    Found in source/modules/serialize.ts and 6 other locations - About 1 hr to fix
    source/modules/serialize.ts on lines 129..134
    source/modules/serialize.ts on lines 142..147
    source/modules/serialize.ts on lines 155..160
    source/modules/serialize.ts on lines 194..199
    source/modules/serialize.ts on lines 207..212
    source/modules/serialize.ts on lines 233..238

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

    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