Sign upLogin

nus-mtp/sashimi-note

View on GitHub
Star
sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js

Summary

Maintainability
F
3 days
Test Coverage

Function hideShowBlock has a Cognitive Complexity of 37 (exceeds 5 allowed). Consider refactoring.
Open

function hideShowBlock(state, startLine, endLine, silent) {
  let nextLine; // next line counter, to keep track of line number
  let token;  // token for use to pass into renderer to generate HTML
  let category = ''; // variable to store conditional hiding for different document types
  let hasCategory = false;
Severity: Minor
Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 5 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 hideShowBlock has 84 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function hideShowBlock(state, startLine, endLine, silent) {
  let nextLine; // next line counter, to keep track of line number
  let token;  // token for use to pass into renderer to generate HTML
  let category = ''; // variable to store conditional hiding for different document types
  let hasCategory = false;
Severity: Major
Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 3 hrs to fix

    Function hideShowInline has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    function hideShowInline(state, silent) {
  const max = state.posMax;
  const start = state.pos;
  let found;
    Severity: Minor
    Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.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 hideShowInline has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function hideShowInline(state, silent) {
  const max = state.posMax;
  const start = state.pos;
  let found;
    Severity: Minor
    Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 1 hr to fix

      Consider simplifying this complex logical expression.
      Open

            if (state.src.charCodeAt(pos) === 61  /* = */&&
      state.src.charCodeAt(pos + 1) === 61  /* = */&&
      state.src.charCodeAt(pos + 2) === 62 /* > */ &&
      state.src.charCodeAt(pos + 3) === 104 /* h */ &&
      state.src.charCodeAt(pos + 4) === 105 /* i */ &&
      Severity: Major
      Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 1 hr to fix

        Consider simplifying this complex logical expression.
        Open

          if (state.src.charCodeAt(pos + 1) !== 61  /* = */||
      state.src.charCodeAt(pos + 2) !== 62 /* > */ ||
      state.src.charCodeAt(pos + 3) !== 104 /* h */ ||
      state.src.charCodeAt(pos + 4) !== 105 /* i */ ||
      state.src.charCodeAt(pos + 5) !== 100 /* d */ ||
        Severity: Major
        Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 40 mins to fix

          Consider simplifying this complex logical expression.
          Open

            if (state.src.charCodeAt(start) !== 61 /* = */ ||
      state.src.charCodeAt(start + 1) !== 62 /* > */ ||
      state.src.charCodeAt(start + 2) !== 104 /* h */ ||
      state.src.charCodeAt(start + 3) !== 105 /* i */ ||
      state.src.charCodeAt(start + 4) !== 100 /* d */ ||
          Severity: Major
          Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 40 mins to fix

            Avoid too many return statements within this function.
            Open

                    return true;
            Severity: Major
            Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                return true;
              Severity: Major
              Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                        return false;
                Severity: Major
                Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return false;
                  Severity: Major
                  Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return false;
                    Severity: Major
                    Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                        return true;
                      Severity: Major
                      Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                return false;
                        Severity: Major
                        Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js - About 30 mins to fix

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

                                if (state.src.charCodeAt(pos) === 61  /* = */&&
      state.src.charCodeAt(pos + 1) === 61  /* = */&&
      state.src.charCodeAt(pos + 2) === 62 /* > */ &&
      state.src.charCodeAt(pos + 3) === 104 /* h */ &&
      state.src.charCodeAt(pos + 4) === 105 /* i */ &&
                          Severity: Major
                          Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js and 1 other location - About 6 hrs to fix
                          sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js on lines 33..38

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

                          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 (state.src.charCodeAt(start) !== 61 /* = */ ||
      state.src.charCodeAt(start + 1) !== 62 /* > */ ||
      state.src.charCodeAt(start + 2) !== 104 /* h */ ||
      state.src.charCodeAt(start + 3) !== 105 /* i */ ||
      state.src.charCodeAt(start + 4) !== 100 /* d */ ||
                          Severity: Major
                          Found in sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js and 1 other location - About 6 hrs to fix
                          sashimi-webapp/src/logic/documentPackager/plugins/conditionalProcessor.js on lines 138..143

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

                          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