BookStackApp/BookStack

View on GitHub
resources/js/wysiwyg/lexical/clipboard/clipboard.ts

Summary

Maintainability
D
3 days
Test Coverage

File clipboard.ts has 386 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/clipboard/clipboard.ts - About 5 hrs to fix

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

    export function $insertDataTransferForRichText(
      dataTransfer: DataTransfer,
      selection: BaseSelection,
      editor: LexicalEditor,
    ): void {
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - 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 $appendNodesToJSON has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    function $appendNodesToJSON(
      editor: LexicalEditor,
      selection: BaseSelection | null,
      currentNode: LexicalNode,
      targetArray: Array<BaseSerializedNode> = [],
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - 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 copyToClipboard has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function copyToClipboard(
      editor: LexicalEditor,
      event: null | ClipboardEvent,
      data?: LexicalClipboardData,
    ): Promise<boolean> {
    Severity: Major
    Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 2 hrs to fix

      Function $appendNodesToJSON has 49 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function $appendNodesToJSON(
        editor: LexicalEditor,
        selection: BaseSelection | null,
        currentNode: LexicalNode,
        targetArray: Array<BaseSerializedNode> = [],
      Severity: Minor
      Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 1 hr to fix

        Function $insertDataTransferForRichText has 49 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export function $insertDataTransferForRichText(
          dataTransfer: DataTransfer,
          selection: BaseSelection,
          editor: LexicalEditor,
        ): void {
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 1 hr to fix

          Function $copyToClipboardEvent has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function $copyToClipboardEvent(
            editor: LexicalEditor,
            event: ClipboardEvent,
            data?: LexicalClipboardData,
          ): boolean {
          Severity: Minor
          Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 1 hr to fix

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

            function $copyToClipboardEvent(
              editor: LexicalEditor,
              event: ClipboardEvent,
              data?: LexicalClipboardData,
            ): boolean {
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - 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

            Avoid deeply nested control flow statements.
            Open

                      if (part === '\n' || part === '\r\n') {
                        currentSelection.insertParagraph();
                      } else if (part === '\t') {
                        currentSelection.insertNodes([$createTabNode()]);
                      } else {
            Severity: Major
            Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 45 mins to fix

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

              export function $getClipboardDataFromSelection(
                selection: BaseSelection | null = $getSelection(),
              ): LexicalClipboardData {
                const clipboardData: LexicalClipboardData = {
                  'text/plain': selection ? selection.getTextContent() : '',
              Severity: Minor
              Found in resources/js/wysiwyg/lexical/clipboard/clipboard.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

              Avoid too many return statements within this function.
              Open

                return true;
              Severity: Major
              Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts - About 30 mins to fix

                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/clipboard/clipboard.ts and 1 other location - About 1 hr to fix
                resources/js/wysiwyg/lexical/html/index.ts on lines 103..110

                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];
                    $appendNodesToJSON(editor, selection, topLevelNode, nodes);
                  }
                Severity: Minor
                Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts and 1 other location - About 40 mins to fix
                resources/js/wysiwyg/lexical/html/index.ts on lines 83..86

                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

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

                const getDOMSelection = (targetWindow: Window | null): Selection | null =>
                  CAN_USE_DOM ? (targetWindow || window).getSelection() : null;
                Severity: Minor
                Found in resources/js/wysiwyg/lexical/clipboard/clipboard.ts and 1 other location - About 35 mins to fix
                resources/js/wysiwyg/lexical/table/LexicalTableSelectionHelpers.ts on lines 79..82

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

                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