async-worker/aiologger

View on GitHub
docs/_static/doctools.js

Summary

Maintainability
D
2 days
Test Coverage

Function initOnKeyListeners has a Cognitive Complexity of 46 (exceeds 5 allowed). Consider refactoring.
Open

  initOnKeyListeners: function() {
    // only install a listener if it is really needed
    if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
        !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
        return;
Severity: Minor
Found in docs/_static/doctools.js - About 7 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 highlightText has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

jQuery.fn.highlightText = function(text, className) {
  function highlight(node, addItems) {
    if (node.nodeType === 3) {
      var val = node.nodeValue;
      var pos = val.toLowerCase().indexOf(text);
Severity: Minor
Found in docs/_static/doctools.js - About 2 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 highlightText has 48 lines of code (exceeds 25 allowed). Consider refactoring.
Open

jQuery.fn.highlightText = function(text, className) {
  function highlight(node, addItems) {
    if (node.nodeType === 3) {
      var val = node.nodeValue;
      var pos = val.toLowerCase().indexOf(text);
Severity: Minor
Found in docs/_static/doctools.js - About 1 hr to fix

    Function initOnKeyListeners has 45 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      initOnKeyListeners: function() {
        // only install a listener if it is really needed
        if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
            !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
            return;
    Severity: Minor
    Found in docs/_static/doctools.js - About 1 hr to fix

      Consider simplifying this complex logical expression.
      Open

      if (!jQuery.browser) {
        jQuery.uaMatch = function(ua) {
          ua = ua.toLowerCase();
      
          var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
      Severity: Critical
      Found in docs/_static/doctools.js - About 1 hr to fix

        Function highlight has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          function highlight(node, addItems) {
            if (node.nodeType === 3) {
              var val = node.nodeValue;
              var pos = val.toLowerCase().indexOf(text);
              if (pos >= 0 &&
        Severity: Minor
        Found in docs/_static/doctools.js - About 1 hr to fix

          Avoid too many return statements within this function.
          Open

                      return false;
          Severity: Major
          Found in docs/_static/doctools.js - About 30 mins to fix

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

                $('dt[id]').each(function() {
                  $('<a class="headerlink">\u00B6</a>').
                  attr('href', '#' + this.id).
                  attr('title', _('Permalink to this definition')).
                  appendTo(this);
            Severity: Major
            Found in docs/_static/doctools.js and 1 other location - About 1 hr to fix
            docs/_static/doctools.js on lines 194..199

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

            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

                $('div[id] > :header:first').each(function() {
                  $('<a class="headerlink">\u00B6</a>').
                  attr('href', '#' + this.id).
                  attr('title', _('Permalink to this headline')).
                  appendTo(this);
            Severity: Major
            Found in docs/_static/doctools.js and 1 other location - About 1 hr to fix
            docs/_static/doctools.js on lines 200..205

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

            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

                          case 'ArrowRight':
                            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
                              break;
                            var nextHref = $('link[rel="next"]').prop('href');
                            if (nextHref) {
            Severity: Major
            Found in docs/_static/doctools.js and 1 other location - About 1 hr to fix
            docs/_static/doctools.js on lines 314..322

            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

                          case 'ArrowLeft':
                            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
                              break;
                            var prevHref = $('link[rel="prev"]').prop('href');
                            if (prevHref) {
            Severity: Major
            Found in docs/_static/doctools.js and 1 other location - About 1 hr to fix
            docs/_static/doctools.js on lines 323..331

            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

            There are no issues that match your filters.

            Category
            Status