BookStackApp/BookStack

View on GitHub
resources/js/wysiwyg/lexical/html/index.ts

Summary

Maintainability
F
3 days
Test Coverage

Function $createNodesFromDOM has a Cognitive Complexity of 44 (exceeds 5 allowed). Consider refactoring.
Open

function $createNodesFromDOM(
  node: Node,
  editor: LexicalEditor,
  allArtificialNodes: Array<ArtificialNode__DO_NOT_USE>,
  hasBlockAncestorLexicalNode: boolean,
Severity: Minor
Found in resources/js/wysiwyg/lexical/html/index.ts - About 6 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 $createNodesFromDOM has 90 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function $createNodesFromDOM(
  node: Node,
  editor: LexicalEditor,
  allArtificialNodes: Array<ArtificialNode__DO_NOT_USE>,
  hasBlockAncestorLexicalNode: boolean,
Severity: Major
Found in resources/js/wysiwyg/lexical/html/index.ts - About 3 hrs to fix

    File index.ts has 311 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    /**
     * Copyright (c) Meta Platforms, Inc. and affiliates.
     *
     * This source code is licensed under the MIT license found in the
     * LICENSE file in the root directory of this source tree.
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/html/index.ts - About 3 hrs to fix

      Function $appendNodesToHTML has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
      Open

      function $appendNodesToHTML(
        editor: LexicalEditor,
        currentNode: LexicalNode,
        parentElement: HTMLElement | DocumentFragment,
        selection: BaseSelection | null = null,
      Severity: Minor
      Found in resources/js/wysiwyg/lexical/html/index.ts - About 3 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 $appendNodesToHTML has 58 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function $appendNodesToHTML(
        editor: LexicalEditor,
        currentNode: LexicalNode,
        parentElement: HTMLElement | DocumentFragment,
        selection: BaseSelection | null = null,
      Severity: Major
      Found in resources/js/wysiwyg/lexical/html/index.ts - About 2 hrs to fix

        Function wrapContinuousInlines has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

        function wrapContinuousInlines(
          domNode: Node,
          nodes: Array<LexicalNode>,
          createWrapperFn: () => ElementNode,
        ): Array<LexicalNode> {
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/html/index.ts - 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 wrapContinuousInlines has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function wrapContinuousInlines(
          domNode: Node,
          nodes: Array<LexicalNode>,
          createWrapperFn: () => ElementNode,
        ): Array<LexicalNode> {
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/html/index.ts - About 1 hr to fix

          Function $createNodesFromDOM has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            node: Node,
            editor: LexicalEditor,
            allArtificialNodes: Array<ArtificialNode__DO_NOT_USE>,
            hasBlockAncestorLexicalNode: boolean,
            forChildMap: Map<string, DOMChildConversion> = new Map(),
          Severity: Minor
          Found in resources/js/wysiwyg/lexical/html/index.ts - About 45 mins to fix

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

            function getConversionFunction(
              domNode: Node,
              editor: LexicalEditor,
            ): DOMConversionFn | null {
              const {nodeName} = domNode;
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/html/index.ts - 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 $generateNodesFromDOM has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

            export function $generateNodesFromDOM(
              editor: LexicalEditor,
              dom: Document,
            ): Array<LexicalNode> {
              const elements = dom.body ? dom.body.childNodes : [];
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/html/index.ts - 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

            Function $unwrapArtificalNodes has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            function $unwrapArtificalNodes(
              allArtificialNodes: Array<ArtificialNode__DO_NOT_USE>,
            ) {
              for (const node of allArtificialNodes) {
                if (node.getNextSibling() instanceof ArtificialNode__DO_NOT_USE) {
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/html/index.ts - About 25 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

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

              if (selection !== null) {
                let clone = $cloneWithProperties(currentNode);
                clone =
                  $isTextNode(clone) && selection !== null
                    ? $sliceSelectedTextNodeContent(selection, clone)
            Severity: Major
            Found in resources/js/wysiwyg/lexical/html/index.ts and 1 other location - About 1 hr to fix
            resources/js/wysiwyg/lexical/clipboard/clipboard.ts on lines 266..273

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

            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

              for (let i = 0; i < topLevelChildren.length; i++) {
                const topLevelNode = topLevelChildren[i];
                $appendNodesToHTML(editor, topLevelNode, container, selection);
              }
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/html/index.ts and 1 other location - About 40 mins to fix
            resources/js/wysiwyg/lexical/clipboard/clipboard.ts on lines 347..350

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

            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