ChiefOfGxBxL/WC3MapTranslator

View on GitHub
src/translators/InfoTranslator.ts

Summary

Maintainability
F
3 days
Test Coverage

Function warToJson has 224 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static warToJson(buffer: Buffer): JsonResult<Info> {
        const result: Info = {
            map: {
                name: '',
                author: '',
Severity: Major
Found in src/translators/InfoTranslator.ts - About 1 day to fix

    File InfoTranslator.ts has 458 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { HexBuffer } from '../HexBuffer';
    import { W3Buffer } from '../W3Buffer';
    import { WarResult, JsonResult } from '../CommonInterfaces'
    
    interface Map {
    Severity: Minor
    Found in src/translators/InfoTranslator.ts - About 7 hrs to fix

      Function jsonToWar has a Cognitive Complexity of 37 (exceeds 5 allowed). Consider refactoring.
      Open

          public static jsonToWar(infoJson: Info): WarResult {
              const outBufferToWar = new HexBuffer();
      
              outBufferToWar.addInt(31); // file version, 0x1F
              outBufferToWar.addInt(infoJson.saves || 0);
      Severity: Minor
      Found in src/translators/InfoTranslator.ts - About 5 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 jsonToWar has 109 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static jsonToWar(infoJson: Info): WarResult {
              const outBufferToWar = new HexBuffer();
      
              outBufferToWar.addInt(31); // file version, 0x1F
              outBufferToWar.addInt(infoJson.saves || 0);
      Severity: Major
      Found in src/translators/InfoTranslator.ts - About 4 hrs to fix

        Function warToJson has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
        Open

            public static warToJson(buffer: Buffer): JsonResult<Info> {
                const result: Info = {
                    map: {
                        name: '',
                        author: '',
        Severity: Minor
        Found in src/translators/InfoTranslator.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

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

                result.gameVersion = {
                    major: outBufferToJSON.readInt(),
                    minor: outBufferToJSON.readInt(),
                    patch: outBufferToJSON.readInt(),
                    build: outBufferToJSON.readInt()
        Severity: Major
        Found in src/translators/InfoTranslator.ts and 1 other location - About 1 hr to fix
        src/translators/InfoTranslator.ts on lines 447..452

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

        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

                result.prologue = {
                    path: outBufferToJSON.readString(),
                    text: outBufferToJSON.readString(),
                    title: outBufferToJSON.readString(),
                    subtitle: outBufferToJSON.readString()
        Severity: Major
        Found in src/translators/InfoTranslator.ts and 1 other location - About 1 hr to fix
        src/translators/InfoTranslator.ts on lines 389..394

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

        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

                for (let ccIndex = 0; ccIndex < 4; ccIndex++) {
                    outBufferToWar.addInt(infoJson.camera.complements[ccIndex]);
                }
        Severity: Minor
        Found in src/translators/InfoTranslator.ts and 1 other location - About 45 mins to fix
        src/translators/InfoTranslator.ts on lines 164..166

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

        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

                for (let cbIndex = 0; cbIndex < 8; cbIndex++) {
                    outBufferToWar.addFloat(infoJson.camera.bounds[cbIndex]);
                }
        Severity: Minor
        Found in src/translators/InfoTranslator.ts and 1 other location - About 45 mins to fix
        src/translators/InfoTranslator.ts on lines 169..171

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

        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