sazze/node-pm

View on GitHub
docs/template/publish.js

Summary

Maintainability
F
6 days
Test Coverage

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

exports.publish = function ( taffyData, opts, tutorials ) {
    data = taffyData;

    conf['default'] = conf['default'] || {};

Severity: Major
Found in docs/template/publish.js - About 1 day to fix

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

    "use strict";
    /**
     * @module template/publish
     * @type {*}
     */
    Severity: Minor
    Found in docs/template/publish.js - About 7 hrs to fix

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

      exports.publish = function ( taffyData, opts, tutorials ) {
          data = taffyData;
      
          conf['default'] = conf['default'] || {};
      
      
      Severity: Minor
      Found in docs/template/publish.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 buildNav has 74 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function buildNav( members ) {
      
          var seen = {};
          var nav = navigationMaster;
          if ( members.modules.length ) {
      Severity: Major
      Found in docs/template/publish.js - About 2 hrs to fix

        Function needsSignature has a Cognitive Complexity of 9 (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 docs/template/publish.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

        Function buildNav has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        function buildNav( members ) {
        
            var seen = {};
            var nav = navigationMaster;
            if ( members.modules.length ) {
        Severity: Minor
        Found in docs/template/publish.js - About 45 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

        Function generate has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        function generate( docType, title, docs, filename, resolveLinks ) {
        Severity: Minor
        Found in docs/template/publish.js - About 35 mins to fix

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

              if ( members.modules.length ) {
          
                  members.modules.forEach( function ( m ) {
                      if ( !hasOwnProp.call( seen, m.longname ) ) {
          
          
          Severity: Major
          Found in docs/template/publish.js and 4 other locations - About 3 hrs to fix
          docs/template/publish.js on lines 289..299
          docs/template/publish.js on lines 301..311
          docs/template/publish.js on lines 313..323
          docs/template/publish.js on lines 325..335

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

          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 5 locations. Consider refactoring.
          Open

              if ( members.namespaces.length ) {
          
                  members.namespaces.forEach( function ( n ) {
                      if ( !hasOwnProp.call( seen, n.longname ) ) {
          
          
          Severity: Major
          Found in docs/template/publish.js and 4 other locations - About 3 hrs to fix
          docs/template/publish.js on lines 267..276
          docs/template/publish.js on lines 289..299
          docs/template/publish.js on lines 301..311
          docs/template/publish.js on lines 325..335

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

          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 5 locations. Consider refactoring.
          Open

              if ( members.mixins.length ) {
          
                  members.mixins.forEach( function ( m ) {
                      if ( !hasOwnProp.call( seen, m.longname ) ) {
          
          
          Severity: Major
          Found in docs/template/publish.js and 4 other locations - About 3 hrs to fix
          docs/template/publish.js on lines 267..276
          docs/template/publish.js on lines 289..299
          docs/template/publish.js on lines 301..311
          docs/template/publish.js on lines 313..323

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

          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 5 locations. Consider refactoring.
          Open

              if ( members.events.length ) {
          
                  members.events.forEach( function ( e ) {
                      if ( !hasOwnProp.call( seen, e.longname ) ) {
          
          
          Severity: Major
          Found in docs/template/publish.js and 4 other locations - About 3 hrs to fix
          docs/template/publish.js on lines 267..276
          docs/template/publish.js on lines 289..299
          docs/template/publish.js on lines 313..323
          docs/template/publish.js on lines 325..335

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

          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 5 locations. Consider refactoring.
          Open

              if ( members.classes.length ) {
          
                  members.classes.forEach( function ( c ) {
                      if ( !hasOwnProp.call( seen, c.longname ) ) {
          
          
          Severity: Major
          Found in docs/template/publish.js and 4 other locations - About 3 hrs to fix
          docs/template/publish.js on lines 267..276
          docs/template/publish.js on lines 301..311
          docs/template/publish.js on lines 313..323
          docs/template/publish.js on lines 325..335

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

          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 4 locations. Consider refactoring.
          Open

              if ( view.nav.mixin && view.nav.mixin.members.length ) {
                  generate( 'mixin', view.nav.mixin.title, [
                      {kind : 'sectionIndex', contents : view.nav.mixin}
                  ], navigationMaster.mixin.link );
              }
          Severity: Major
          Found in docs/template/publish.js and 3 other locations - About 2 hrs to fix
          docs/template/publish.js on lines 545..549
          docs/template/publish.js on lines 551..555
          docs/template/publish.js on lines 563..567

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

          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 4 locations. Consider refactoring.
          Open

              if ( view.nav.class && view.nav.class.members.length ) {
                  generate( 'class', view.nav.class.title, [
                      {kind : 'sectionIndex', contents : view.nav.class}
                  ], navigationMaster.class.link );
              }
          Severity: Major
          Found in docs/template/publish.js and 3 other locations - About 2 hrs to fix
          docs/template/publish.js on lines 551..555
          docs/template/publish.js on lines 557..561
          docs/template/publish.js on lines 563..567

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

          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 4 locations. Consider refactoring.
          Open

              if ( view.nav.namespace && view.nav.namespace.members.length ) {
                  generate( 'namespace', view.nav.namespace.title, [
                      {kind : 'sectionIndex', contents : view.nav.namespace}
                  ], navigationMaster.namespace.link );
              }
          Severity: Major
          Found in docs/template/publish.js and 3 other locations - About 2 hrs to fix
          docs/template/publish.js on lines 545..549
          docs/template/publish.js on lines 557..561
          docs/template/publish.js on lines 563..567

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

          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 4 locations. Consider refactoring.
          Open

              if ( view.nav.external && view.nav.external.members.length ) {
                  generate( 'external', view.nav.external.title, [
                      {kind : 'sectionIndex', contents : view.nav.external}
                  ], navigationMaster.external.link );
              }
          Severity: Major
          Found in docs/template/publish.js and 3 other locations - About 2 hrs to fix
          docs/template/publish.js on lines 545..549
          docs/template/publish.js on lines 551..555
          docs/template/publish.js on lines 557..561

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

          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