mar10/fancytree

View on GitHub
bin/jsdoc3-moogle/publish.js

Summary

Maintainability
D
2 days
Test Coverage

Function publish has 218 lines of code (exceeds 25 allowed). Consider refactoring.
Open

exports.publish = function(taffyData, opts, tutorials) {
    var classes;
    var conf;
    var externals;
    var files;
Severity: Major
Found in bin/jsdoc3-moogle/publish.js - About 1 day to fix

    File publish.js has 505 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    'use strict';
    
    var doop = require('jsdoc/util/doop');
    var env = require('jsdoc/env');
    var fs = require('jsdoc/fs');
    Severity: Major
    Found in bin/jsdoc3-moogle/publish.js - About 1 day to fix

      Function needsSignature has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

      function needsSignature(doclet) {
          var needsSig = false;
      
          // function and class definitions always get a signature
          if (doclet.kind === 'function' || doclet.kind === 'class') {
      Severity: Minor
      Found in bin/jsdoc3-moogle/publish.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 buildNav has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function buildNav(members) {
          var globalNav;
          var nav = '<h2><a href="index.html">Home</a></h2>';
          var seen = {};
          var seenTutorials = {};
      Severity: Minor
      Found in bin/jsdoc3-moogle/publish.js - About 1 hr to fix

        Function publish has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

        exports.publish = function(taffyData, opts, tutorials) {
            var classes;
            var conf;
            var externals;
            var files;
        Severity: Minor
        Found in bin/jsdoc3-moogle/publish.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

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

            else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names &&
                doclet.type.names.length) {
        Severity: Minor
        Found in bin/jsdoc3-moogle/publish.js and 1 other location - About 30 mins to fix
        bin/jsdoc3-moogle/publish.js on lines 71..72

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

        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 if (doclet.kind === 'namespace' && doclet.meta && doclet.meta.code &&
                doclet.meta.code.type && doclet.meta.code.type.match(/[Ff]unction/)) {
        Severity: Minor
        Found in bin/jsdoc3-moogle/publish.js and 1 other location - About 30 mins to fix
        bin/jsdoc3-moogle/publish.js on lines 60..61

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

        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