Sign upLogin

codenautas/self-explain

View on GitHub
Star
lib/self-explain.js

Summary

Maintainability
F
3 days
Test Coverage

File self-explain.js has 551 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"use strict";

(function codenautasModuleDefinition(root, name, factory) {
    /* global define */
    /* istanbul ignore next */
Severity: Major
Found in lib/self-explain.js - About 1 day to fix

    Function differences has 105 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    selfExplain.assert.differences = function differences(a, b, opts, prefix){
    opts = opts || {};
    prefix = prefix || '';
    var delta = opts.delta || 0;
    var format = selfExplain.assert.formatDiff;
    Severity: Major
    Found in lib/self-explain.js - About 4 hrs to fix

      Function assert has 77 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      selfExplain.assert = function assert(value){
    if(value===true){
        return '';
    }
    return (function(stack){
      Severity: Major
      Found in lib/self-explain.js - About 3 hrs to fix

        Function separateParts has 53 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function separateParts(previousResult, expressions){
    var result={changes:false};
    var newParts=[];
    var registerNewNode=function(part){
        // console.log('pre generate',part);
        Severity: Major
        Found in lib/self-explain.js - About 2 hrs to fix

          Function has a complexity of 14.
          Open

              return (function(stack){
          Severity: Minor
          Found in lib/self-explain.js by eslint

          Limit Cyclomatic Complexity (complexity)

          Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.

          function a(x) {
    if (true) {
        return x; // 1st path
    } else if (false) {
        return x+1; // 2nd path
    } else {
        return 4; // 3rd path
    }
}

          Rule Details

          This rule is aimed at reducing code complexity by capping the amount of cyclomatic complexity allowed in a program. As such, it will warn when the cyclomatic complexity crosses the configured threshold (default is 20).

          Examples of incorrect code for a maximum of 2:

          /*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else if (false) {
        return x+1;
    } else {
        return 4; // 3rd path
    }
}

          Examples of correct code for a maximum of 2:

          /*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else {
        return 4;
    }
}

          Options

          Optionally, you may specify a max object property:

          "complexity": ["error", 2]

          is equivalent to

          "complexity": ["error", { "max": 2 }]

          Deprecated: the object property maximum is deprecated. Please use the property max instead.

          When Not To Use It

          If you can't determine an appropriate complexity limit for your code, then it's best to disable this rule.

          Further Reading

          Related Rules

          • [max-depth](max-depth.md)
          • [max-len](max-len.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 has a complexity of 13.
          Open

                      nodeDef.childProperties.forEach(function(childProperty){
          Severity: Minor
          Found in lib/self-explain.js by eslint

          Limit Cyclomatic Complexity (complexity)

          Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.

          function a(x) {
    if (true) {
        return x; // 1st path
    } else if (false) {
        return x+1; // 2nd path
    } else {
        return 4; // 3rd path
    }
}

          Rule Details

          This rule is aimed at reducing code complexity by capping the amount of cyclomatic complexity allowed in a program. As such, it will warn when the cyclomatic complexity crosses the configured threshold (default is 20).

          Examples of incorrect code for a maximum of 2:

          /*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else if (false) {
        return x+1;
    } else {
        return 4; // 3rd path
    }
}

          Examples of correct code for a maximum of 2:

          /*eslint complexity: ["error", 2]*/

function a(x) {
    if (true) {
        return x;
    } else {
        return 4;
    }
}

          Options

          Optionally, you may specify a max object property:

          "complexity": ["error", 2]

          is equivalent to

          "complexity": ["error", { "max": 2 }]

          Deprecated: the object property maximum is deprecated. Please use the property max instead.

          When Not To Use It

          If you can't determine an appropriate complexity limit for your code, then it's best to disable this rule.

          Further Reading

          Related Rules

          • [max-depth](max-depth.md)
          • [max-len](max-len.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 codenautasModuleDefinition has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

          (function codenautasModuleDefinition(root, name, factory) {
    /* global define */
    /* istanbul ignore next */
    if(typeof root.globalModuleName !== 'string'){
        root.globalModuleName = name;
          Severity: Minor
          Found in lib/self-explain.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

          Avoid too many return statements within this function.
          Open

                      return '.substr('+firstDiff+','+maxDiff+'): "'+a.substr(firstDiff, maxDiff)+'" != "'+b.substr(firstDiff,maxDiff)+'"';
          Severity: Major
          Found in lib/self-explain.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                        return ".class: "+constructorName(a)+' != '+constructorName(b);
            Severity: Major
            Found in lib/self-explain.js - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                          return selfExplain.assert.differences(a.split(opts.split), b.split(opts.split), opts, prefix+".split(" + opts.split + ")");
              Severity: Major
              Found in lib/self-explain.js - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                        return format(a-b, prefix);
                Severity: Major
                Found in lib/self-explain.js - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return format(selfExplain.assert.stringify(a)+' != '+selfExplain.assert.stringify(b), prefix);
                  Severity: Major
                  Found in lib/self-explain.js - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return result.length ? result.join("\n") : null;
                    Severity: Major
                    Found in lib/self-explain.js - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              if(Math.abs(a-b)<delta) { return null; }
                      Severity: Major
                      Found in lib/self-explain.js - About 30 mins to fix

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

                        var Precedence = {
    Sequence: 0,
    Yield: 1,
    Await: 1,
    Assignment: 1,
                        Severity: Major
                        Found in lib/self-explain.js and 1 other location - About 4 hrs to fix
                        dist/escodegen.browser.js on lines 94..118

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

                        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(timesDiffer) {
                rv.push(' ');
                rv.push(aas.substr(11, a.getMilliseconds()?12:8));
            }
                        Severity: Minor
                        Found in lib/self-explain.js and 1 other location - About 50 mins to fix
                        lib/self-explain.js on lines 539..542

                        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(timesDiffer) {
                rv.push(' ');
                rv.push(bbs.substr(11, b.getMilliseconds()?12:8));
            }
                        Severity: Minor
                        Found in lib/self-explain.js and 1 other location - About 50 mins to fix
                        lib/self-explain.js on lines 533..536

                        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

                        There are no issues that match your filters.

                        Category
                        Status