ChiefOfGxBxL/WC3MapTranslator

View on GitHub

Showing 40 of 40 total issues

Function jsonToWar has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static jsonToWar(doodadsJson: Doodad[]): WarResult {
        const outBufferToWar = new HexBuffer();
        /*
         * Header
         */
Severity: Minor
Found in src/translators/DoodadsTranslator.ts - About 1 hr to fix

    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

            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

    Function jsonToWar has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static jsonToWar(regionsJson: Region[]): WarResult {
            const outBufferToWar = new HexBuffer();
    
            /*
             * Header
    Severity: Minor
    Found in src/translators/RegionsTranslator.ts - About 1 hr to fix

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

          public readShort(): number {
              const int: number = this._buffer.readInt16LE(this._offset);
              this._offset += 2;
              return int;
          }
      Severity: Minor
      Found in src/W3Buffer.ts and 1 other location - About 55 mins to fix
      src/W3Buffer.ts on lines 12..16

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

      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

          public readInt(): number {
              const int: number = this._buffer.readInt32LE(this._offset);
              this._offset += 4;
              return int;
          }
      Severity: Minor
      Found in src/W3Buffer.ts and 1 other location - About 55 mins to fix
      src/W3Buffer.ts on lines 18..22

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

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

                      for (let k = 0; k < numDroppableItems; k++) {
                          outBufferToJSON.readChars(4); // Item ID
                          outBufferToJSON.readInt(); // % chance to drop
                      }
      Severity: Major
      Found in src/translators/UnitsTranslator.ts and 2 other locations - About 45 mins to fix
      src/translators/DoodadsTranslator.ts on lines 152..155
      src/translators/UnitsTranslator.ts on lines 243..246

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

                      for (let k = 0; k < numDiffAvailUnits; k++) {
                          outBufferToJSON.readChars(4); // Unit ID
                          outBufferToJSON.readInt(); // % chance
                      }
      Severity: Major
      Found in src/translators/UnitsTranslator.ts and 2 other locations - About 45 mins to fix
      src/translators/DoodadsTranslator.ts on lines 152..155
      src/translators/UnitsTranslator.ts on lines 188..191

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

                      for (let k = 0; k < numberOfItems; k++) {
                          outBufferToJSON.readChars(4); // Item ID
                          outBufferToJSON.readInt(); // % chance to drop
                      }
      Severity: Major
      Found in src/translators/DoodadsTranslator.ts and 2 other locations - About 45 mins to fix
      src/translators/UnitsTranslator.ts on lines 188..191
      src/translators/UnitsTranslator.ts on lines 243..246

      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

                          if (tableType === TableType.original) {
                              // Original objects are ended with their base id (e.g. hfoo)
                              outBufferToWar.addChars(defKey);
                          } else {
                              // Custom objects are ended with 0000 bytes
      Severity: Minor
      Found in src/translators/ObjectsTranslator.ts and 1 other location - About 45 mins to fix
      src/translators/RegionsTranslator.ts on lines 47..55

      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

                  if (region.weatherEffect) {
                      outBufferToWar.addChars(region.weatherEffect); // Weather effect is optional - defaults to 0000 for "none"
                  } else {
                      // We can't put a string "0000", because ASCII 0's differ from 0x0 bytes
                      outBufferToWar.addByte(0);
      Severity: Minor
      Found in src/translators/RegionsTranslator.ts and 1 other location - About 45 mins to fix
      src/translators/ObjectsTranslator.ts on lines 144..153

      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

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

          public static warToJson(buffer: Buffer): JsonResult<Doodad[]> {
              const result = [];
              const outBufferToJSON = new W3Buffer(buffer);
      
              const fileId = outBufferToJSON.readChars(4); // W3do for doodad file
      Severity: Minor
      Found in src/translators/DoodadsTranslator.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

      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

      Consider simplifying this complex logical expression.
      Open

                          if (type === ObjectType.Doodads || type === ObjectType.Abilities || type === ObjectType.Upgrades) {
      
                              // Level or variation
                              // We need to check if hasOwnProperty because these could be explititly
                              // set to 0, but JavaScript's truthiness evaluates to false to it was defaulting
      Severity: Major
      Found in src/translators/ObjectsTranslator.ts - About 40 mins to fix

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

            public static jsonToWar(terrainJson: Terrain): WarResult {
                const outBufferToWar = new HexBuffer();
        
                /*
                 * Header
        Severity: Minor
        Found in src/translators/TerrainTranslator.ts - About 25 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

        trailing whitespace
        Open

            InfoTranslator, 
        Severity: Minor
        Found in src/index.ts by tslint

        Rule: no-trailing-whitespace

        Disallows trailing whitespace at the end of a line.

        Rationale

        Keeps version control diffs clean as it prevents accidental whitespace from being committed.

        Notes
        • Has Fix

        Config

        Possible settings are:

        • "ignore-template-strings": Allows trailing whitespace in template strings.
        • "ignore-comments": Allows trailing whitespace in comments.
        • "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
        • "ignore-blank-lines": Allows trailing whitespace on empty lines.
        Examples
        "no-trailing-whitespace": true
        "no-trailing-whitespace": true,ignore-comments
        "no-trailing-whitespace": true,ignore-jsdoc
        Schema
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ignore-comments",
              "ignore-jsdoc",
              "ignore-template-strings",
              "ignore-blank-lines"
            ]
          }
        }

        For more information see this page.

        TODO found
        Open

                // TODO what kind of binary? Do we use a BigInt or a node provided type from Buffer?
        Severity: Minor
        Found in src/W3Buffer.ts by fixme

        TODO found
        Open

            "no-warning-comments": [2,{"terms":["TODO","FIXME"],"location":"anywhere"}],
        Severity: Minor
        Found in .eslintrc by fixme

        FIXME found
        Open

            "no-warning-comments": [2,{"terms":["TODO","FIXME"],"location":"anywhere"}],
        Severity: Minor
        Found in .eslintrc by fixme
        Severity
        Category
        Status
        Source
        Language