Sign upLogin

exoRift/cyclone-engine

View on GitHub
Star
lib/agent/index.js

Summary

Maintainability
F
3 days
Test Coverage

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

const {
  IgnoredError,
  InputError
} = require('../errors/')
Severity: Minor
Found in lib/agent/index.js - About 6 hrs to fix

    Function buildHelp has a Cognitive Complexity of 32 (exceeds 10 allowed). Consider refactoring.
    Open

      buildHelp (data, page = 1) {
    if (data && !this.app) throw Error('Could not get OAuth app info. Please start the bot with `Agent.connect()`')

    let embed
    let reactInterface
    Severity: Minor
    Found in lib/agent/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 buildHelp has 95 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      buildHelp (data, page = 1) {
    if (data && !this.app) throw Error('Could not get OAuth app info. Please start the bot with `Agent.connect()`')

    let embed
    let reactInterface
    Severity: Major
    Found in lib/agent/index.js - About 3 hrs to fix

      Agent has 28 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class Agent {
  /**
   * Create an Agent
   * @class
   * @param {Object}                       data                                               The agent data
      Severity: Minor
      Found in lib/agent/index.js - About 3 hrs to fix

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

          constructor ({ Eris, token, handlerData = {}, options = {} }) {
    const {
      commands,
      reactCommands,
      replacers,
        Severity: Major
        Found in lib/agent/index.js - About 2 hrs to fix

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

            buildCommandGuide (name) {
    const command = this._handlerData.commands.find((c) => c.name === name.toLowerCase() || c.options.aliases.includes(name.toLowerCase()))

    if (!command) throw Error(`Could not find a command named \`${name}\``)
          Severity: Minor
          Found in lib/agent/index.js - About 1 hr to fix

            Function _initHandlers has 28 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              _initHandlers () {
    if (this._handlerData.commands) {
      console.log('Initializing Command Handler')

      /**
            Severity: Minor
            Found in lib/agent/index.js - About 1 hr to fix

              Function buildCommandGuide has a Cognitive Complexity of 12 (exceeds 10 allowed). Consider refactoring.
              Open

                buildCommandGuide (name) {
    const command = this._handlerData.commands.find((c) => c.name === name.toLowerCase() || c.options.aliases.includes(name.toLowerCase()))

    if (!command) throw Error(`Could not find a command named \`${name}\``)
              Severity: Minor
              Found in lib/agent/index.js - 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

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

                  if (this._handlerData.reactCommands) {
      this.client.on('messageReactionAdd', this._onReaction.bind(this))
      if (this._options.fireOnReactionRemove) this.client.on('messageReactionRemove', this._onReaction.bind(this))
    }
              Severity: Major
              Found in lib/agent/index.js and 1 other location - About 2 hrs to fix
              lib/agent/index.js on lines 248..251

              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

                  if (this._handlerData.commands) {
      this.client.on('messageCreate', this._onMessage.bind(this))
      if (this._options.fireOnEdit) this.client.on('messageUpdate', this._onMessage.bind(this))
    }
              Severity: Major
              Found in lib/agent/index.js and 1 other location - About 2 hrs to fix
              lib/agent/index.js on lines 253..256

              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

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

                              msg.edit({
                  embed: {
                    ...embed,
                    fields: [
                      {
              Severity: Major
              Found in lib/agent/index.js and 1 other location - About 1 hr to fix
              lib/agent/index.js on lines 378..388

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

              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

                              msg.edit({
                  embed: {
                    ...embed,
                    fields: [
                      {
              Severity: Major
              Found in lib/agent/index.js and 1 other location - About 1 hr to fix
              lib/agent/index.js on lines 396..406

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

              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