engine-bay/admin-portal

View on GitHub
EngineBay.AdminPortal/AdminPortal/src/lib/imports/generateBlueprintsFromCells.ts

Summary

Maintainability
D
3 days
Test Coverage

Function generateBlueprintsFromCells has a Cognitive Complexity of 69 (exceeds 5 allowed). Consider refactoring.
Open

export const generateBlueprintsFromCells = (wb: SheetJSWorkbook, worksheetName: string, allCells: Cell[], cells: Cell[]) => {

    const blueprints: Blueprint[] = [];
    const expressionBlueprints: ExpressionBlueprint[] = [];
    const dataVariableBlueprints: DataVariableBlueprint[] = [];

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 generateBlueprintsFromCells has 189 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const generateBlueprintsFromCells = (wb: SheetJSWorkbook, worksheetName: string, allCells: Cell[], cells: Cell[]) => {

    const blueprints: Blueprint[] = [];
    const expressionBlueprints: ExpressionBlueprint[] = [];
    const dataVariableBlueprints: DataVariableBlueprint[] = [];

    Avoid deeply nested control flow statements.
    Open

                        for (const dataTableBlueprint of dataTableBlueprints) {
                            localOnlyCellValue = localOnlyCellValue.replace(dataTableBlueprint.name, '');
                        }

      Avoid deeply nested control flow statements.
      Open

                          for (const globalDataVariableBlueprint of allDataVariableBlueprints) {
                              localOnlyCellValue = localOnlyCellValue.replace(globalDataVariableBlueprint.name, '');
                          }

        Avoid deeply nested control flow statements.
        Open

                            for (let i = start.c; i <= end.c; i++) {
                                const key = utils.encode_range({ s: { c: i, r: j }, e: { c: i, r: j } })
                                const cellObject = wb.Sheets[worksheetName][key];
                                const value = cellObject.w;
                                dataTableRowBlueprint.dataTableCellBlueprints.push({

          Avoid deeply nested control flow statements.
          Open

                              if (localOnlyCellValue.includes(dataVariableBlueprint.name)) {
                                  inputDataVariableBlueprints.push({
                                      name: dataVariableBlueprint.name,
                                      namespace: dataVariableBlueprint.namespace,
                                      type: dataVariableBlueprint.type

            Consider simplifying this complex logical expression.
            Open

                    if (cell.isDynamic && cell.value.includes(":")) {
                        console.log("Cell has a range in it:")
                        console.log(cell)
                        const parts = cell.value.split(':');
                        const pairs = parts.length / 2;

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

                          dataVariableBlueprints.push({
                              name: cell.cellReference,
                              namespace: cell.namespace,
                              description: `Part of the evaluation of ${cell.formula}`,
                              type: cell.type
              EngineBay.AdminPortal/AdminPortal/src/lib/imports/generateBlueprintsFromCells.ts on lines 123..128

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

              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

                              dataVariableBlueprints.push({
                                  name: dataTableBlueprint.name,
                                  namespace: dataTableBlueprint.namespace,
                                  description: `Data variable to access or reference the data table ${dataTableBlueprint.name}`,
                                  type: DataVariableType.DATATABLE
              EngineBay.AdminPortal/AdminPortal/src/lib/imports/generateBlueprintsFromCells.ts on lines 41..46

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

              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