Sign upLogin

Forge-Media/teamspeak-bot

View on GitHub
Star
helpers/steamHelper.js

Summary

Maintainability
B
4 hrs
Test Coverage

File steamHelper.js has 314 lines of code (exceeds 250 allowed). Consider refactoring.
Invalid

/**
 * This is a thin wrapper around Node-Steam and Node-CSGO,
 * which connects to steam and acts as a bot.
 *
 * @version 1.0
Severity: Minor
Found in helpers/steamHelper.js - About 3 hrs to fix

    Function getAuthentication has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Confirmed

        getAuthentication() {
        let loginDetails = this.config;

        // Check SteamLogin details exist
        if (loginDetails.account_name && loginDetails.password) {
    Severity: Minor
    Found in helpers/steamHelper.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

    Function onRelationshipChange has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        onRelationshipChange(steam64id, relationshipStatus) {
        // console.log(`${this.name}: New relationship event from ${steam64id} (relationship=${relationshipStatus})`);

        //Null check
        if (steam64id === undefined || relationshipStatus === undefined) {
    Severity: Minor
    Found in helpers/steamHelper.js - About 1 hr to fix

      Function init has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Invalid

          init() {
        console.info(`${this.name}:`, `Loading Steam Intergration...`);

        const authenticationDetails = this.getAuthentication();
      Severity: Minor
      Found in helpers/steamHelper.js - About 1 hr to fix

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

                this.fs.writeFile(this.serversPath, JSON.stringify(response, null, 2), (err) => {
            if (err) {
                console.error(`${this.name}: Could not save steamServers.json`);
                console.error("ERROR:", err);
            }
        Severity: Major
        Found in helpers/steamHelper.js and 1 other location - About 1 hr to fix
        helpers/steamHelper.js on lines 232..238

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

        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

                this.fs.writeFile(this.sentryPath, response, (err) => {
            if (err) {
                console.error(`${this.name}: Could not save steamSentry file!`);
                console.error("ERROR:", err);
            }
        Severity: Major
        Found in helpers/steamHelper.js and 1 other location - About 1 hr to fix
        helpers/steamHelper.js on lines 269..275

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

        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

                this.CSGOCli.on("ready", () => {
            this.ready = true;
            console.info(`${this.name}: CSGO connection is ready.`);
        });
        Severity: Major
        Found in helpers/steamHelper.js and 1 other location - About 1 hr to fix
        helpers/steamHelper.js on lines 211..214

        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

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

                this.CSGOCli.on("unready", () => {
            this.ready = false;
            console.info(`${this.name}: CSGO connection unready.`);
        });
        Severity: Major
        Found in helpers/steamHelper.js and 1 other location - About 1 hr to fix
        helpers/steamHelper.js on lines 205..208

        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

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

                        } else {
                    console.info(`${invoker.nickname} is already registered!`);
                    invoker.message(`Hi, [color=#0069ff][b]${invoker.nickname}[/b][/color] looks like you're already registered!`);
                    return true;
                }
        Severity: Minor
        Found in helpers/steamHelper.js and 1 other location - About 55 mins to fix
        helpers/steamHelper.js on lines 413..417

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

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

                        if (doc.exists) {
                    console.info(`${invoker.nickname} used steamID belonging to someone else`);
                    invoker.message(`Hi, [color=#0069ff][b]${invoker.nickname}[/b][/color] looks like that steamID belongs to someone else!`);
                    return true;
                } else {
        Severity: Minor
        Found in helpers/steamHelper.js and 1 other location - About 55 mins to fix
        helpers/steamHelper.js on lines 441..445

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

        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