Sign upLogin

ahbeng/NUSMods

View on GitHub
Star
packages/nusmoderator/src/academicCalendar.ts

Summary

Maintainability
B
5 hrs
Test Coverage

Function getAcadWeekInfo has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function getAcadWeekInfo(date: Date): AcadWeekInfo {
  const currentAcad = getAcadYear(date);
  const acadYear = currentAcad.year;
  const acadYearStartDate = getAcadYearStartDate(acadYear);
Severity: Minor
Found in packages/nusmoderator/src/academicCalendar.ts - About 1 hr to fix

    Function getAcadWeekName has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function getAcadWeekName(acadWeekNumber: number): AcadWeek | null {
  switch (acadWeekNumber) {
    case 7:
      return {
        weekType: 'Recess',
    Severity: Minor
    Found in packages/nusmoderator/src/academicCalendar.ts - About 1 hr to fix

      Function getAcadWeekInfo has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      export function getAcadWeekInfo(date: Date): AcadWeekInfo {
  const currentAcad = getAcadYear(date);
  const acadYear = currentAcad.year;
  const acadYearStartDate = getAcadYearStartDate(acadYear);
      Severity: Minor
      Found in packages/nusmoderator/src/academicCalendar.ts - About 35 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

      Avoid too many return statements within this function.
      Open

        if (acadWeekNumber <= lastWeekOfSpecialSem2) return special2;
      Severity: Major
      Found in packages/nusmoderator/src/academicCalendar.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

          return null;
        Severity: Major
        Found in packages/nusmoderator/src/academicCalendar.ts - About 30 mins to fix

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

          export function getAcadWeekName(acadWeekNumber: number): AcadWeek | null {
  switch (acadWeekNumber) {
    case 7:
      return {
        weekType: 'Recess',
          Severity: Minor
          Found in packages/nusmoderator/src/academicCalendar.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

          There are no issues that match your filters.

          Category
          Status