ChiefOfGxBxL/WC3MapTranslator

View on GitHub
lib/translators/ObjectsTranslator.ts

Summary

Maintainability
C
1 day
Test Coverage

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

    public static warToJson(type: string, buffer: Buffer): JsonResult<ObjectModificationTable> {
        const result = { original: {}, custom: {} };
        const outBufferToJSON = new W3Buffer(buffer);

        const fileVersion = outBufferToJSON.readInt();
Severity: Minor
Found in lib/translators/ObjectsTranslator.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 jsonToWar has 57 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static jsonToWar(type: string, json): WarResult {
        const outBufferToWar = new HexBuffer();

        /*
         * Header
Severity: Major
Found in lib/translators/ObjectsTranslator.ts - About 2 hrs to fix

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

        public static warToJson(type: string, buffer: Buffer): JsonResult<ObjectModificationTable> {
            const result = { original: {}, custom: {} };
            const outBufferToJSON = new W3Buffer(buffer);
    
            const fileVersion = outBufferToJSON.readInt();
    Severity: Major
    Found in lib/translators/ObjectsTranslator.ts - About 2 hrs to fix

      Function generateTableFromJson has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              const generateTableFromJson = (tableType: TableType, tableData) => { // create "original" or "custom" table
                  Object.keys(tableData).forEach((defKey) => {
                      const obj = tableData[defKey];
      
                      // Original and new object ids
      Severity: Minor
      Found in lib/translators/ObjectsTranslator.ts - About 1 hr to fix

        Function readModificationTable has 40 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

                const readModificationTable = (isOriginalTable: boolean) => {
                    const numTableModifications = outBufferToJSON.readInt();
        
                    for (let i = 0; i < numTableModifications; i++) {
                        const objectDefinition = []; // object definition will store one or more modification objects
        Severity: Minor
        Found in lib/translators/ObjectsTranslator.ts - About 1 hr to fix

          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 lib/translators/ObjectsTranslator.ts - About 40 mins to fix

            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 lib/translators/ObjectsTranslator.ts and 1 other location - About 45 mins to fix
            lib/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

            There are no issues that match your filters.

            Category
            Status