Sign upLogin

ahbeng/NUSMods

View on GitHub
Star
website/src/utils/planner.ts

Summary

Maintainability
C
1 day
Test Coverage

Function checkPrerequisite has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

export function checkPrerequisite(moduleSet: Set<ModuleCode>, tree: PrereqTree): PrereqTree[] {
  const moduleArray = Array.from(moduleSet);

  function walkTree(fragment: PrereqTree): PrereqTree[] {
    if (typeof fragment === 'string') {
Severity: Minor
Found in website/src/utils/planner.ts - About 2 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 checkPrerequisite has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function checkPrerequisite(moduleSet: Set<ModuleCode>, tree: PrereqTree): PrereqTree[] {
  const moduleArray = Array.from(moduleSet);

  function walkTree(fragment: PrereqTree): PrereqTree[] {
    if (typeof fragment === 'string') {
Severity: Minor
Found in website/src/utils/planner.ts - About 1 hr to fix

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

      function walkTree(fragment: PrereqTree): PrereqTree[] {
    if (typeof fragment === 'string') {
      // Parse a module code requirement as an nOf fragment.
      return walkTree({ nOf: [1, [fragment]] });
    }
    Severity: Minor
    Found in website/src/utils/planner.ts - About 1 hr to fix

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

      export function conflictToText(rootConflict: PrereqTree): string {
  function walkSubtree(conflict: PrereqTree): string {
    const text = walkTree(conflict);
    if (typeof conflict === 'string') return text;
    return `(${text})`;
      Severity: Minor
      Found in website/src/utils/planner.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

      Avoid too many return statements within this function.
      Open

            if (requiredCount === 1 && options.length === 1) return [options[0]];
      Severity: Major
      Found in website/src/utils/planner.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return [fragment];
        Severity: Major
        Found in website/src/utils/planner.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return assertNever(fragment);
          Severity: Major
          Found in website/src/utils/planner.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return assertNever(conflict);
            Severity: Major
            Found in website/src/utils/planner.ts - About 30 mins to fix

              There are no issues that match your filters.

              Category
              Status