Sign upLogin

FarmBot/Farmbot-Web-App

View on GitHub
Star
frontend/farm_designer/map/util.ts

Summary

Maintainability
D
1 day
Test Coverage

File util.ts has 305 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { BotOriginQuadrant } from "../interfaces";
import { McuParams, Xyz } from "farmbot";
import { StepsPerMm } from "../../devices/interfaces";
import {
  CheckedAxisLength, AxisNumberProperty, BotSize, MapTransformProps, Mode,
Severity: Minor
Found in frontend/farm_designer/map/util.ts - About 3 hrs to fix

    Function getMode has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    export const getMode = (): Mode => {
  if (store.getState().resources.consumers.farm_designer.profileOpen) {
    return Mode.profile;
  }
  const panelSlug = Path.getSlug(Path.designer());
    Severity: Minor
    Found in frontend/farm_designer/map/util.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 getMode has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const getMode = (): Mode => {
  if (store.getState().resources.consumers.farm_designer.profileOpen) {
    return Mode.profile;
  }
  const panelSlug = Path.getSlug(Path.designer());
    Severity: Minor
    Found in frontend/farm_designer/map/util.ts - About 1 hr to fix

      Avoid too many return statements within this function.
      Open

        if (panelSlug === "location") { return Mode.locationInfo; }
      Severity: Major
      Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return Mode.boxSelect;
        Severity: Major
        Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                return Mode.createPoint;
          Severity: Major
          Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

              return Mode.none;
            Severity: Major
            Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                    return Mode.createWeed;
              Severity: Major
              Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                    Path.getSlug(Path.cropSearch())) { return Mode.clickToAdd; }
                Severity: Major
                Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return Mode.points;
                  Severity: Major
                  Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                      if (Path.lastChunkIsNum()) { return Mode.editPlant; }
                    Severity: Major
                    Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                          return Mode.weeds;
                      Severity: Major
                      Found in frontend/farm_designer/map/util.ts - About 30 mins to fix

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

                        export const getPanelStatus = (): MapPanelStatus => {
  if (Path.equals(Path.designer())) {
    return isMobile() ? MapPanelStatus.mobileClosed : MapPanelStatus.closed;
  }
  const mode = getMode();
                        Severity: Minor
                        Found in frontend/farm_designer/map/util.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

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

                        const MIRRORED_QUADRANTS: Record<"x" | "y", BotOriginQuadrant[]> = {
  // `4` is shared, i.e. change needed for both axes when it is selected
  x: [1, 4],
  y: [4, 3]
};
                        Severity: Minor
                        Found in frontend/farm_designer/map/util.ts and 1 other location - About 35 mins to fix
                        frontend/farm_designer/map/util.ts on lines 150..154

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

                        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

                        const NORMAL_QUADRANTS: Record<"x" | "y", BotOriginQuadrant[]> = {
  // `2` is shared, i.e. no change needed for either axis when it is selected
  x: [3, 2],
  y: [2, 1]
};
                        Severity: Minor
                        Found in frontend/farm_designer/map/util.ts and 1 other location - About 35 mins to fix
                        frontend/farm_designer/map/util.ts on lines 155..159

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

                        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

                          const axisLengthXY = {
    x: botMcuParams.movement_axis_nr_steps_x || 0,
    y: botMcuParams.movement_axis_nr_steps_y || 0,
    z: botMcuParams.movement_axis_nr_steps_z || 0,
  };
                        Severity: Minor
                        Found in frontend/farm_designer/map/util.ts and 1 other location - About 35 mins to fix
                        frontend/sequences/step_tiles/tile_computed_move/compute.ts on lines 17..21

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

                        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