tsg-ut/mnemo

View on GitHub
lib/stage.js

Summary

Maintainability
D
2 days
Test Coverage

File stage.js has 469 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/* global ga */

const $ = require('jquery');
const assert = require('assert');
const React = require('react');
Severity: Minor
Found in lib/stage.js - About 7 hrs to fix

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

        constructor({config, onClickExit}) {
            this.config = Object.assign({}, config);
            this.onClickExit = onClickExit;
    
            this.caseIndex = 0;
    Severity: Major
    Found in lib/stage.js - About 4 hrs to fix

      Stage has 25 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class Stage {
          constructor({config, onClickExit}) {
              this.config = Object.assign({}, config);
              this.onClickExit = onClickExit;
      
      
      Severity: Minor
      Found in lib/stage.js - About 2 hrs to fix

        Line 379 exceeds the maximum line length of 100.
        Open

                        ga('send', 'event', 'stage', 'register ranking', 'duplicated', registrationDuration);
        Severity: Minor
        Found in lib/stage.js by eslint

        enforce a maximum line length (max-len)

        Very long lines of code in any language can be difficult to read. In order to aid in readability and maintainability many coders have developed a convention to limit lines of code to X number of characters (traditionally 80 characters).

        var foo = { "bar": "This is a bar.", "baz": { "qux": "This is a qux" }, "difficult": "to read" }; // very long

        Rule Details

        This rule enforces a maximum line length to increase code readability and maintainability. The length of a line is defined as the number of Unicode characters in the line.

        Options

        This rule has a number or object option:

        • "code" (default 80) enforces a maximum line length
        • "tabWidth" (default 4) specifies the character width for tab characters
        • "comments" enforces a maximum line length for comments; defaults to value of code
        • "ignorePattern" ignores lines matching a regular expression; can only match a single line and need to be double escaped when written in YAML or JSON
        • "ignoreComments": true ignores all trailing comments and comments on their own line
        • "ignoreTrailingComments": true ignores only trailing comments
        • "ignoreUrls": true ignores lines that contain a URL
        • "ignoreStrings": true ignores lines that contain a double-quoted or single-quoted string
        • "ignoreTemplateLiterals": true ignores lines that contain a template literal
        • "ignoreRegExpLiterals": true ignores lines that contain a RegExp literal

        code

        Examples of incorrect code for this rule with the default { "code": 80 } option:

        /*eslint max-len: ["error", 80]*/
        
        var foo = { "bar": "This is a bar.", "baz": { "qux": "This is a qux" }, "difficult": "to read" };

        Examples of correct code for this rule with the default { "code": 80 } option:

        /*eslint max-len: ["error", 80]*/
        
        var foo = {
          "bar": "This is a bar.",
          "baz": { "qux": "This is a qux" },
          "easier": "to read"
        };

        tabWidth

        Examples of incorrect code for this rule with the default { "tabWidth": 4 } option:

        /*eslint max-len: ["error", 80, 4]*/
        
        \t  \t  var foo = { "bar": "This is a bar.", "baz": { "qux": "This is a qux" } };

        Examples of correct code for this rule with the default { "tabWidth": 4 } option:

        /*eslint max-len: ["error", 80, 4]*/
        
        \t  \t  var foo = {
        \t  \t  \t  \t  "bar": "This is a bar.",
        \t  \t  \t  \t  "baz": { "qux": "This is a qux" }
        \t  \t  };

        comments

        Examples of incorrect code for this rule with the { "comments": 65 } option:

        /*eslint max-len: ["error", { "comments": 65 }]*/
        
        /**
         * This is a comment that violates the maximum line length we have specified
        **/

        ignoreComments

        Examples of correct code for this rule with the { "ignoreComments": true } option:

        /*eslint max-len: ["error", { "ignoreComments": true }]*/
        
        /**
         * This is a really really really really really really really really really long comment
        **/

        ignoreTrailingComments

        Examples of correct code for this rule with the { "ignoreTrailingComments": true } option:

        /*eslint max-len: ["error", { "ignoreTrailingComments": true }]*/
        
        var foo = 'bar'; // This is a really really really really really really really long comment

        ignoreUrls

        Examples of correct code for this rule with the { "ignoreUrls": true } option:

        /*eslint max-len: ["error", { "ignoreUrls": true }]*/
        
        var url = 'https://www.example.com/really/really/really/really/really/really/really/long';

        ignoreStrings

        Examples of correct code for this rule with the { "ignoreStrings": true } option:

        /*eslint max-len: ["error", { "ignoreStrings": true }]*/
        
        var longString = 'this is a really really really really really long string!';

        ignoreTemplateLiterals

        Examples of correct code for this rule with the { "ignoreTemplateLiterals": true } option:

        /*eslint max-len: ["error", { "ignoreTemplateLiterals": true }]*/
        
        var longTemplateLiteral = `this is a really really really really really long template literal!`;

        ignoreRegExpLiterals

        Examples of correct code for this rule with the { "ignoreRegExpLiterals": true } option:

        /*eslint max-len: ["error", { "ignoreRegExpLiterals": true }]*/
        
        var longRegExpLiteral = /this is a really really really really really long regular expression!/;

        ignorePattern

        Examples of correct code for this rule with the { "ignorePattern": true } option:

        /*eslint max-len: ["error", { "ignorePattern": "^\\s*var\\s.+=\\s*require\\s*\\(/" }]*/
        
        var dep = require('really/really/really/really/really/really/really/really/long/module');

        Related Rules

        • [complexity](complexity.md)
        • [max-depth](max-depth.md)
        • [max-nested-callbacks](max-nested-callbacks.md)
        • [max-params](max-params.md)
        • [max-statements](max-statements.md) Source: http://eslint.org/docs/rules/

        Function updateSaveEntries has 34 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            updateSaveEntries() {
                const entries = this.getSaveEntries();
                this.$savePanel.find('.saved-entries').empty().append(entries.map((entry) => (
                    $('<li/>', {
                        class: 'saved-item',
        Severity: Minor
        Found in lib/stage.js - About 1 hr to fix

          Function onRegister has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              async onRegister(event) {
                  const registrationStartTime = Date.now();
          
                  const name = this.$result.find('.name').val();
                  if (name.length === 0) {
          Severity: Minor
          Found in lib/stage.js - About 1 hr to fix

            Function takeAndPlace has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                takeAndPlace(x, y, blockName) {
                    const oldBlock = this.boardComponent.getBlock(x, y);
                    assert(oldBlock, 'oldBlock is invalid');
            
                    if (!blockName || blockName === oldBlock.config.name) { // rotate the block
            Severity: Minor
            Found in lib/stage.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

            Unexpected 'todo' comment.
            Open

                    // TODO: CSSでテキスト管理したい
            Severity: Minor
            Found in lib/stage.js by eslint

            Disallow Warning Comments (no-warning-comments)

            Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready.

            // TODO: do something
            // FIXME: this is not a good idea

            Rule Details

            This rule reports comments that include any of the predefined terms specified in its configuration.

            Options

            This rule has an options object literal:

            • "terms": optional array of terms to match. Defaults to ["todo", "fixme", "xxx"]. Terms are matched case-insensitive and as whole words: fix would match FIX but not fixing. Terms can consist of multiple words: really bad idea.
            • "location": optional string that configures where in your comments to check for matches. Defaults to "start". The other value is match anywhere in comments.

            Example of incorrect code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

            /*eslint no-warning-comments: "error"*/
            
            function callback(err, results) {
              if (err) {
                console.error(err);
                return;
              }
              // TODO
            }

            Example of correct code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

            /*eslint no-warning-comments: "error"*/
            
            function callback(err, results) {
              if (err) {
                console.error(err);
                return;
              }
              // NOT READY FOR PRIME TIME
              // but too bad, it is not a predefined warning term
            }

            terms and location

            Examples of incorrect code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

            /*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/
            
            // TODO: this
            // todo: this too
            // Even this: TODO
            /* /*
             * The same goes for this TODO comment
             * Or a fixme
             * as well as any other term
             */

            Examples of correct code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

            /*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/
            
            // This is to do
            // even not any other    term
            // any other terminal
            /*
             * The same goes for block comments
             * with any other interesting term
             * or fix me this
             */

            When Not To Use It

            • If you have a large code base that was not developed with a policy to not use such warning terms, you might get hundreds of warnings / errors which might be counter-productive if you can't fix all of them (e.g. if you don't get the time to do it) as you might overlook other warnings / errors or get used to many of them and don't pay attention on it anymore.
            • Same reason as the point above: You shouldn't configure terms that are used very often (e.g. central parts of the native language used in your comments). Source: http://eslint.org/docs/rules/

            Unexpected 'fixme' comment.
            Open

                            const blockType = this.panelComponent.state.selected; // FIXME This is evil :/
            Severity: Minor
            Found in lib/stage.js by eslint

            Disallow Warning Comments (no-warning-comments)

            Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready.

            // TODO: do something
            // FIXME: this is not a good idea

            Rule Details

            This rule reports comments that include any of the predefined terms specified in its configuration.

            Options

            This rule has an options object literal:

            • "terms": optional array of terms to match. Defaults to ["todo", "fixme", "xxx"]. Terms are matched case-insensitive and as whole words: fix would match FIX but not fixing. Terms can consist of multiple words: really bad idea.
            • "location": optional string that configures where in your comments to check for matches. Defaults to "start". The other value is match anywhere in comments.

            Example of incorrect code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

            /*eslint no-warning-comments: "error"*/
            
            function callback(err, results) {
              if (err) {
                console.error(err);
                return;
              }
              // TODO
            }

            Example of correct code for the default { "terms": ["todo", "fixme", "xxx"], "location": "start" } options:

            /*eslint no-warning-comments: "error"*/
            
            function callback(err, results) {
              if (err) {
                console.error(err);
                return;
              }
              // NOT READY FOR PRIME TIME
              // but too bad, it is not a predefined warning term
            }

            terms and location

            Examples of incorrect code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

            /*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/
            
            // TODO: this
            // todo: this too
            // Even this: TODO
            /* /*
             * The same goes for this TODO comment
             * Or a fixme
             * as well as any other term
             */

            Examples of correct code for the { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" } options:

            /*eslint no-warning-comments: ["error", { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }]*/
            
            // This is to do
            // even not any other    term
            // any other terminal
            /*
             * The same goes for block comments
             * with any other interesting term
             * or fix me this
             */

            When Not To Use It

            • If you have a large code base that was not developed with a policy to not use such warning terms, you might get hundreds of warnings / errors which might be counter-productive if you can't fix all of them (e.g. if you don't get the time to do it) as you might overlook other warnings / errors or get used to many of them and don't pay attention on it anymore.
            • Same reason as the point above: You shouldn't configure terms that are used very often (e.g. central parts of the native language used in your comments). Source: http://eslint.org/docs/rules/

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

                renderBoardComponent() {
                    const boardComponent = React.createElement(BoardComponent, this.boardComponentProps);
                    this.boardComponent = ReactDOM.render(boardComponent, $('.board-area').get(0));
                }
            Severity: Major
            Found in lib/stage.js and 1 other location - About 1 hr to fix
            lib/stage.js on lines 199..202

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

            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

                renderPanelComponent() {
                    const panelComponent = React.createElement(PanelComponent, this.panelComponentProps);
                    this.panelComponent = ReactDOM.render(panelComponent, $('.panel-area').get(0));
                }
            Severity: Major
            Found in lib/stage.js and 1 other location - About 1 hr to fix
            lib/stage.js on lines 194..197

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

            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

                    const index = properties.findIndex((property) => (
                        property.stageName === this.config.name &&
                        property.timestamp === timestamp
                    ));
            Severity: Minor
            Found in lib/stage.js and 1 other location - About 35 mins to fix
            lib/stage.js on lines 257..260

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

            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

                    const index = properties.findIndex((property) => (
                        property.stageName === this.config.name &&
                        property.timestamp === timestamp
                    ));
            Severity: Minor
            Found in lib/stage.js and 1 other location - About 35 mins to fix
            lib/stage.js on lines 228..231

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

            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 (data.message === 'user name existing') {
                            this.$result.find('.register').text('すでに登録されています').addClass('success');
                            ga('send', 'event', 'stage', 'register ranking', 'duplicated', registrationDuration);
                        } else {
            Severity: Minor
            Found in lib/stage.js and 1 other location - About 35 mins to fix
            lib/stage.js on lines 380..383

            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

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

                        } else {
                            this.$result.find('.register').text('エラーが発生しました').addClass('error');
                            ga('send', 'event', 'stage', 'register ranking', 'errored', registrationDuration);
                        }
            Severity: Minor
            Found in lib/stage.js and 1 other location - About 35 mins to fix
            lib/stage.js on lines 377..380

            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

            Definition for rule 'getter-return' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            Definition for rule 'semi-style' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            Definition for rule 'switch-colon-spacing' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            Definition for rule 'for-direction' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            Definition for rule 'react/no-will-update-set-state' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            Definition for rule 'no-buffer-constructor' was not found
            Open

            const $ = require('jquery');
            Severity: Minor
            Found in lib/stage.js by eslint

            For more information visit Source: http://eslint.org/docs/rules/

            There are no issues that match your filters.

            Category
            Status