Sign upLogin

Forge-Media/teamspeak-bot

View on GitHub
Star
plugins/createClan.js

Summary

Maintainability
A
45 mins
Test Coverage

Function onMessage has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
Invalid

exports.onMessage = function(msg, jarvis) {
    const message = msg.toLowerCase();
    let client = jarvis.invoker;
    let clid = client.clid;
Severity: Minor
Found in plugins/createClan.js - About 4 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 onMessage has 71 lines of code (exceeds 25 allowed). Consider refactoring.
Wontfix

exports.onMessage = function(msg, jarvis) {
    const message = msg.toLowerCase();
    let client = jarvis.invoker;
    let clid = client.clid;
Severity: Major
Found in plugins/createClan.js - About 2 hrs to fix

    Function run has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Invalid

    exports.run = (helpers, jarvis) => {
    async.forever(function(next) {
        setTimeout(function() {
            // Max user session time in millseconds (3min)
            const maxTime = 180000;
    Severity: Minor
    Found in plugins/createClan.js - 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 deeply nested control flow statements.
    Confirmed

            if (msg.length > 4 || msg.length < 2) {
            client.message(jarvis.error_message.sanitation);
            return;
        }
    Severity: Major
    Found in plugins/createClan.js - About 45 mins to fix

      Avoid too many return statements within this function.
      Invalid

                  return;
      Severity: Major
      Found in plugins/createClan.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Invalid

                    return;
        Severity: Major
        Found in plugins/createClan.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Invalid

                      return;
          Severity: Major
          Found in plugins/createClan.js - About 30 mins to fix

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

            exports.run = (helpers, jarvis) => {
    async.forever(function(next) {
        setTimeout(function() {
            // Max user session time in millseconds (3min)
            const maxTime = 180000;
            Severity: Major
            Found in plugins/createClan.js and 1 other location - About 1 day to fix
            plugins/joinMe.js on lines 197..220

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

            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 3 locations. Consider refactoring.
            Invalid

                        if (!config.owners.some(r => jarvis.groups.indexOf(r) >= 0)) {
                client.message(jarvis.error_message.forbidden);
                return;
            }
            Severity: Major
            Found in plugins/createClan.js and 2 other locations - About 1 hr to fix
            plugins/joinMe.js on lines 83..86
            plugins/purgeVerified.js on lines 49..52

            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

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

                            setChannelPermissions(jarvis)
                    .then(res => {
                        client.message(res);
                        client.message("[b]Create Clan Group?[/b] (default = No) [!y/!n]");
                        currentlyCreating[clid].processid = 2;
            Severity: Major
            Found in plugins/createClan.js and 1 other location - About 1 hr to fix
            plugins/createClan.js on lines 121..142

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

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

                    constructChannels(jarvis)
            .then(res => {
                client.message(res);
                setChannelPermissions(jarvis)
                    .then(res => {
            Severity: Major
            Found in plugins/createClan.js and 1 other location - About 1 hr to fix
            plugins/createClan.js on lines 124..135

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

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

                        await jarvis.ts
                .channelCreate(c.name, c.properties)
                .then(response => {
                    // Store created channels ID for permissions
                    c.cid = response.cid;
            Severity: Major
            Found in plugins/createClan.js and 1 other location - About 1 hr to fix
            plugins/createClan.js on lines 232..236

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

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

                    await jarvis.ts.channelSetPerms(c.cid, permissions).catch(err => {
            // CAUGHT: External error
            result = jarvis.error_message.external + err.message;
            console.error("CATCHED", err.message, "ON", c.name);
        });
            Severity: Major
            Found in plugins/createClan.js and 1 other location - About 1 hr to fix
            plugins/createClan.js on lines 191..201

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

            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