nus-mtp/sashimi-note

View on GitHub
sashimi-webapp/src/logic/renderer/core.js

Summary

Maintainability
C
7 hrs
Test Coverage

Function shouldPageBreak has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

const shouldPageBreak = function shouldPageBreak(eleHeightArray, index, page) {
  const BREAK_PAGE = true;
  const DO_NOTHING = false;

  const element = eleHeightArray[index].ele;
Severity: Minor
Found in sashimi-webapp/src/logic/renderer/core.js - 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 updateReferenceFrame has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  updateReferenceFrame: function updateReferenceFrame(pageRenderer) {
    const rf = pageRenderer.referenceFrame;
    rf.innerHTML = pageRenderer.sourceHTML;

    const pPPFs = pageRenderer.postProcessPromiseFns;
Severity: Minor
Found in sashimi-webapp/src/logic/renderer/core.js - About 1 hr to fix

    Function shouldPageBreak has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const shouldPageBreak = function shouldPageBreak(eleHeightArray, index, page) {
      const BREAK_PAGE = true;
      const DO_NOTHING = false;
    
      const element = eleHeightArray[index].ele;
    Severity: Minor
    Found in sashimi-webapp/src/logic/renderer/core.js - About 1 hr to fix

      Function addElementToPage has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

      const addElementToPage = function addElementToPage(page, book, eleArray, index) {
        const element = eleArray[index];
        try {
          if (shouldPageBreak(eleArray, index, page)) {
            // Create a new page if page should be broken here
      Severity: Minor
      Found in sashimi-webapp/src/logic/renderer/core.js - 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

      Avoid too many return statements within this function.
      Open

          return DO_NOTHING;
      Severity: Major
      Found in sashimi-webapp/src/logic/renderer/core.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return BREAK_PAGE;
        Severity: Major
        Found in sashimi-webapp/src/logic/renderer/core.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return (element.getAttribute('page') === '');
          Severity: Major
          Found in sashimi-webapp/src/logic/renderer/core.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

              return DO_NOTHING;
            Severity: Major
            Found in sashimi-webapp/src/logic/renderer/core.js - About 30 mins to fix

              TODO found
              Open

                      // TODO: Need to reject promise after timeout

              TODO found
              Open

                      // TODO: Consider breaking element into smaller chunk

              There are no issues that match your filters.

              Category
              Status