exoRift/cyclone-engine

View on GitHub
lib/modules/command-handler/index.js

Summary

Maintainability
D
2 days
Test Coverage

Function handle has a Cognitive Complexity of 30 (exceeds 10 allowed). Consider refactoring.
Open

  async handle (msg) {
    // Normalize message content (replacers, prefix, custom prefix, bot mention)
    const normalized = this._normalize(msg)

    // Get Await class if awaited
Severity: Minor
Found in lib/modules/command-handler/index.js - About 3 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 handle has 64 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  async handle (msg) {
    // Normalize message content (replacers, prefix, custom prefix, bot mention)
    const normalized = this._normalize(msg)

    // Get Await class if awaited
Severity: Major
Found in lib/modules/command-handler/index.js - About 2 hrs to fix

    File index.js has 264 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    const BaseHandler = require('../base-handler/')
    
    const {
      InputError
    } = require('../../errors/')
    Severity: Minor
    Found in lib/modules/command-handler/index.js - About 2 hrs to fix

      Function _parseArgs has a Cognitive Complexity of 21 (exceeds 10 allowed). Consider refactoring.
      Open

        _parseArgs (guild, command, chars) {
          const parsed = []
      
          let startingIndex = 0
          for (let arg = 0; arg < command.options.args.length; arg++) {
      Severity: Minor
      Found in lib/modules/command-handler/index.js - 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 resultPromises has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          const resultPromises = commandResults.map(async (commandResult) => {
            if (!commandResult) return
      
            const {
              content,
      Severity: Minor
      Found in lib/modules/command-handler/index.js - About 1 hr to fix

        Function constructor has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          constructor ({ agent, client, commands, replacers, options = {} }) {
            super({ agent, client, options })
        
            /**
             * Various regular expressions used internally
        Severity: Minor
        Found in lib/modules/command-handler/index.js - About 1 hr to fix

          Function _parseArgs has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            _parseArgs (guild, command, chars) {
              const parsed = []
          
              let startingIndex = 0
              for (let arg = 0; arg < command.options.args.length; arg++) {
          Severity: Minor
          Found in lib/modules/command-handler/index.js - About 1 hr to fix

            Function addAwaits has a Cognitive Complexity of 14 (exceeds 10 allowed). Consider refactoring.
            Open

              addAwaits (awaits, { _fallBackChannel, _fallBackUser, _triggerResponse } = {}) {
                if (!Array.isArray(awaits)) awaits = [awaits]
            
                for (const wait of awaits) {
                  if (!(wait instanceof Await)) throw TypeError('Supplied await is not an Await instance:\n' + wait)
            Severity: Minor
            Found in lib/modules/command-handler/index.js - About 55 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 _loadCommand has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
            Open

              _loadCommand (command) {
                if (!(command instanceof Command)) throw TypeError('Supplied command not a Command instance:\n' + command)
            
                if (command.options.args.length) {
                  const lastArg = command.options.args[command.options.args.length - 1]
            Severity: Minor
            Found in lib/modules/command-handler/index.js - 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

            Function _implementResponse has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
            Open

              async _implementResponse ({ msg }, options, response) {
                const {
                  channel,
                  awaits,
                  reactInterface,
            Severity: Minor
            Found in lib/modules/command-handler/index.js - 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

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

                if (deleteAfter) {
                  if (!response || response instanceof Error) throw Error('Cannot delete a non-existent response with a delay of:\n' + deleteAfter)
            
                  if (typeof deleteAfter !== 'number') throw TypeError('Supplied deleteAfter delay is not a number:\n' + deleteAfter)
            
            
            Severity: Major
            Found in lib/modules/command-handler/index.js and 1 other location - About 2 hrs to fix
            lib/modules/reaction-handler/index.js on lines 294..300

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

            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

              loadReplacers (replacers = []) {
                if (Array.isArray(replacers)) {
                  for (const replacer of replacers) this._loadReplacer(replacer)
                } else this._loadReplacer(replacers)
              }
            Severity: Major
            Found in lib/modules/command-handler/index.js and 1 other location - About 1 hr to fix
            lib/modules/command-handler/index.js on lines 336..340

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

            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

              loadCommands (commands = []) {
                if (Array.isArray(commands)) {
                  for (const command of commands) this._loadCommand(command)
                } else this._loadCommand(commands)
              }
            Severity: Major
            Found in lib/modules/command-handler/index.js and 1 other location - About 1 hr to fix
            lib/modules/command-handler/index.js on lines 357..361

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

            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

                  const {
                    content,
                    embed,
                    file,
                    options = {}
            Severity: Minor
            Found in lib/modules/command-handler/index.js and 1 other location - About 50 mins to fix
            lib/modules/reaction-handler/index.js on lines 195..200

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

            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 (!wait.options.channel) {
                    if (!_fallBackChannel) throw Error('An await didn\'t have a defined channel or fallback channel. This can be caused by directly calling CommandHandler.addAwaits')
            
                    wait.options.channel = _fallBackChannel
                  }
            Severity: Minor
            Found in lib/modules/command-handler/index.js and 1 other location - About 30 mins to fix
            lib/modules/command-handler/index.js on lines 135..139

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

            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 (!wait.options.user) {
                    if (!_fallBackChannel) throw Error('An await didn\'t have a defined user or fallback user. This can be caused by directly calling CommandHandler.addAwaits')
            
                    wait.options.user = _fallBackUser
                  }
            Severity: Minor
            Found in lib/modules/command-handler/index.js and 1 other location - About 30 mins to fix
            lib/modules/command-handler/index.js on lines 130..134

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

            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