tadashi-aikawa/owlmixin

View on GitHub
docs/_static/sphinx_highlight.js

Summary

Maintainability
B
5 hrs
Test Coverage

Function _highlight has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const _highlight = (node, addItems, text, className) => {
  if (node.nodeType === Node.TEXT_NODE) {
    const val = node.nodeValue;
    const parent = node.parentNode;
    const pos = val.toLowerCase().indexOf(text);
Severity: Minor
Found in docs/_static/sphinx_highlight.js - About 1 hr to fix

    Function _highlight has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    const _highlight = (node, addItems, text, className) => {
      if (node.nodeType === Node.TEXT_NODE) {
        const val = node.nodeValue;
        const parent = node.parentNode;
        const pos = val.toLowerCase().indexOf(text);
    Severity: Minor
    Found in docs/_static/sphinx_highlight.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 highlightSearchWords has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      highlightSearchWords: () => {
        if (!SPHINX_HIGHLIGHT_ENABLED) return;  // bail if no highlight
    
        // get and clear terms from localstorage
        const url = new URL(window.location);
    Severity: Minor
    Found in docs/_static/sphinx_highlight.js - About 1 hr to fix

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

        initEscapeListener: () => {
          // only install a listener if it is really needed
          if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
      
          document.addEventListener("keydown", (event) => {
      Severity: Minor
      Found in docs/_static/sphinx_highlight.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

      There are no issues that match your filters.

      Category
      Status