Lichess4545/Chesster

View on GitHub
src/commands/availability.ts

Summary

Maintainability
F
4 days
Test Coverage

File availability.ts has 454 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// -----------------------------------------------------------------------------
// Commands related to availability
// -----------------------------------------------------------------------------
import winston from 'winston'
import _ from 'lodash'
Severity: Minor
Found in src/commands/availability.ts - About 6 hrs to fix

    Function assignAlternate has 132 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function assignAlternate(bot: SlackBot, message: LeagueCommandMessage) {
        const alternateOptions = message.league.config.alternate
        if (
            !alternateOptions ||
            !_.isEqual(message.channel.id, alternateOptions.channelId)
    Severity: Major
    Found in src/commands/availability.ts - About 5 hrs to fix

      Function updateAvailability has 115 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export function updateAvailability(
          bot: SlackBot,
          message: LeagueCommandMessage
      ) {
          const heltourOptions = message.league.config.heltour
      Severity: Major
      Found in src/commands/availability.ts - About 4 hrs to fix

        Function unassignAlternate has 88 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export function unassignAlternate(
            bot: SlackBot,
            message: LeagueCommandMessage
        ) {
            const alternateOptions = message.league?.config.alternate
        Severity: Major
        Found in src/commands/availability.ts - About 3 hrs to fix

          Function updateAvailability has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
          Open

          export function updateAvailability(
              bot: SlackBot,
              message: LeagueCommandMessage
          ) {
              const heltourOptions = message.league.config.heltour
          Severity: Minor
          Found in src/commands/availability.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 assignAlternate has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
          Open

          export function assignAlternate(bot: SlackBot, message: LeagueCommandMessage) {
              const alternateOptions = message.league.config.alternate
              if (
                  !alternateOptions ||
                  !_.isEqual(message.channel.id, alternateOptions.channelId)
          Severity: Minor
          Found in src/commands/availability.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 unassignAlternate has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

          export function unassignAlternate(
              bot: SlackBot,
              message: LeagueCommandMessage
          ) {
              const alternateOptions = message.league?.config.alternate
          Severity: Minor
          Found in src/commands/availability.ts - About 45 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

          Function formatReplyUpdatedAvailability has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              bot: SlackBot,
              message: CommandMessage,
              playerName: string,
              available: boolean,
              roundNumber: number
          Severity: Minor
          Found in src/commands/availability.ts - About 35 mins to fix

            Function replyMisunderstood has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                bot: SlackBot,
                message: CommandMessage,
                command: string,
                syntax: string,
                syntaxHints?: string
            Severity: Minor
            Found in src/commands/availability.ts - About 35 mins to fix

              Avoid too many return statements within this function.
              Open

                      return
              Severity: Major
              Found in src/commands/availability.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                        return
                Severity: Major
                Found in src/commands/availability.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                              return heltour
                                  .setAvailability(
                                      heltourOptions,
                                      playerName,
                                      available,
                  Severity: Major
                  Found in src/commands/availability.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                return
                    Severity: Major
                    Found in src/commands/availability.ts - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              return
                      Severity: Major
                      Found in src/commands/availability.ts - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                            return heltour
                                .assignAlternate(
                                    heltourOptions,
                                    roundNumber,
                                    team.number,
                        Severity: Major
                        Found in src/commands/availability.ts - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                  return heltour
                                      .assignAlternate(
                                          heltourOptions,
                                          roundNumber,
                                          team.number,
                          Severity: Major
                          Found in src/commands/availability.ts - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                        return
                            Severity: Major
                            Found in src/commands/availability.ts - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                              return
                              Severity: Major
                              Found in src/commands/availability.ts - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                            return
                                Severity: Major
                                Found in src/commands/availability.ts - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                              return
                                  Severity: Major
                                  Found in src/commands/availability.ts - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                                    return
                                    Severity: Major
                                    Found in src/commands/availability.ts - About 30 mins to fix

                                      Avoid too many return statements within this function.
                                      Open

                                                  return
                                      Severity: Major
                                      Found in src/commands/availability.ts - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                                return
                                        Severity: Major
                                        Found in src/commands/availability.ts - About 30 mins to fix

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

                                                  } else if (error instanceof commands.InvalidTypeValueError) {
                                                      winston.debug(
                                                          `[ASSIGNMENT] Couldn't understand: ${JSON.stringify(error)}`
                                                      )
                                                      replyMisunderstoodAlternateAssignment(bot, message)
                                          Severity: Major
                                          Found in src/commands/availability.ts and 1 other location - About 1 hr to fix
                                          src/commands/messageForwarding.ts on lines 77..100

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

                                          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

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

                                                  if (
                                                      error instanceof commands.TooFewTokensError ||
                                                      error instanceof commands.InvalidChoiceError ||
                                                      error instanceof commands.InvalidConstantError ||
                                                      error instanceof commands.InvalidTypeValueError
                                          Severity: Minor
                                          Found in src/commands/availability.ts and 1 other location - About 35 mins to fix
                                          src/commands/messageForwarding.ts on lines 77..100

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

                                          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