BookStackApp/BookStack

View on GitHub

Showing 1,485 of 1,485 total issues

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

  getFirstDescendant<T extends LexicalNode>(): null | T {
    let node = this.getFirstChild<T>();
    while ($isElementNode(node)) {
      const child = node.getFirstChild<T>();
      if (child === null) {
resources/js/wysiwyg/lexical/core/nodes/LexicalElementNode.ts on lines 184..194

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

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

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 updateCursor has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

function updateCursor(
  binding: Binding,
  cursor: Cursor,
  nextSelection: null | CursorSelection,
  nodeMap: NodeMap,
Severity: Minor
Found in resources/js/wysiwyg/lexical/yjs/SyncCursors.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 resolveSelectionPointOnBoundary has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

function resolveSelectionPointOnBoundary(
  point: TextPointType,
  isBackward: boolean,
  isCollapsed: boolean,
): void {
Severity: Minor
Found in resources/js/wysiwyg/lexical/core/LexicalSelection.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 triggerCommandListeners has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

export function triggerCommandListeners<
  TCommand extends LexicalCommand<unknown>,
>(
  editor: LexicalEditor,
  type: TCommand,
Severity: Minor
Found in resources/js/wysiwyg/lexical/core/LexicalUpdates.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 processNestedUpdates has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

function processNestedUpdates(
  editor: LexicalEditor,
  initialSkipTransforms?: boolean,
): boolean {
  const queuedUpdates = editor._updates;
Severity: Minor
Found in resources/js/wysiwyg/lexical/core/LexicalUpdates.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 $garbageCollectDetachedNodes has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

export function $garbageCollectDetachedNodes(
  prevEditorState: EditorState,
  editorState: EditorState,
  dirtyLeaves: Set<NodeKey>,
  dirtyElements: Map<NodeKey, IntentionallyMarkedAsDirtyElement>,
Severity: Minor
Found in resources/js/wysiwyg/lexical/core/LexicalGC.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 createPageEditorInstance has 77 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function createPageEditorInstance(container: HTMLElement, htmlContent: string, options: Record<string, any> = {}): SimpleWysiwygEditorInterface {
    const config: CreateEditorArgs = {
        namespace: 'BookStackPageEditor',
        nodes: getNodesForPageEditor(),
        onError: console.error,
Severity: Major
Found in resources/js/wysiwyg/index.ts - About 3 hrs to fix

    Function syncChildrenFromLexical has 77 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      syncChildrenFromLexical(
        binding: Binding,
        nextLexicalNode: ElementNode,
        prevNodeMap: null | NodeMap,
        dirtyElements: null | Map<NodeKey, IntentionallyMarkedAsDirtyElement>,
    Severity: Major
    Found in resources/js/wysiwyg/lexical/yjs/CollabElementNode.ts - About 3 hrs to fix

      Function applyChildrenYjsDelta has 77 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        applyChildrenYjsDelta(
          binding: Binding,
          deltas: Array<{
            insert?: string | object | AbstractType<unknown>;
            delete?: number;
      Severity: Major
      Found in resources/js/wysiwyg/lexical/yjs/CollabElementNode.ts - About 3 hrs to fix

        File PageController.php has 293 lines of code (exceeds 250 allowed). Consider refactoring.
        Open

        <?php
        
        namespace BookStack\Entities\Controllers;
        
        use BookStack\Activity\Models\View;
        Severity: Minor
        Found in app/Entities/Controllers/PageController.php - About 3 hrs to fix

          Function getChangeType has 75 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function getChangeType(
            prevEditorState: null | EditorState,
            nextEditorState: EditorState,
            dirtyLeavesSet: Set<NodeKey>,
            dirtyElementsSet: Map<NodeKey, IntentionallyMarkedAsDirtyElement>,
          Severity: Major
          Found in resources/js/wysiwyg/lexical/history/index.ts - About 3 hrs to fix

            Function $reconcileNodeChildren has 75 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            function $reconcileNodeChildren(
              nextElement: ElementNode,
              prevChildren: Array<NodeKey>,
              nextChildren: Array<NodeKey>,
              prevChildrenLength: number,
            Severity: Major
            Found in resources/js/wysiwyg/lexical/core/LexicalReconciler.ts - About 3 hrs to fix

              File config.js has 291 lines of code (exceeds 250 allowed). Consider refactoring.
              Open

              import {register as registerShortcuts} from './shortcuts';
              import {listen as listenForCommonEvents} from './common-events';
              import {scrollToQueryString} from './scrolling';
              import {listenForDragAndPaste} from './drop-paste-handling';
              import {getPrimaryToolbar, registerAdditionalToolbars} from './toolbars';
              Severity: Minor
              Found in resources/js/wysiwyg-tinymce/config.js - About 3 hrs to fix

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

                export class ClipboardDataMock {
                  getData: jest.Mock<string, [string]>;
                  setData: jest.Mock<void, [string, string]>;
                
                  constructor() {
                Severity: Major
                Found in resources/js/wysiwyg/lexical/core/__tests__/utils/index.ts and 1 other location - About 2 hrs to fix
                resources/js/wysiwyg/lexical/table/__tests__/unit/LexicalTableNode.test.ts on lines 25..33

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

                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

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

                export class ClipboardDataMock {
                  getData: jest.Mock<string, [string]>;
                  setData: jest.Mock<void, [string, string]>;
                
                  constructor() {
                resources/js/wysiwyg/lexical/core/__tests__/utils/index.ts on lines 489..497

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

                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

                Function register has 73 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                function register(editor) {
                    // Tasklist UI buttons
                    editor.ui.registry.addIcon('tasklist', '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M22,8c0-0.55-0.45-1-1-1h-7c-0.55,0-1,0.45-1,1s0.45,1,1,1h7C21.55,9,22,8.55,22,8z M13,16c0,0.55,0.45,1,1,1h7 c0.55,0,1-0.45,1-1c0-0.55-0.45-1-1-1h-7C13.45,15,13,15.45,13,16z M10.47,4.63c0.39,0.39,0.39,1.02,0,1.41l-4.23,4.25 c-0.39,0.39-1.02,0.39-1.42,0L2.7,8.16c-0.39-0.39-0.39-1.02,0-1.41c0.39-0.39,1.02-0.39,1.41,0l1.42,1.42l3.54-3.54 C9.45,4.25,10.09,4.25,10.47,4.63z M10.48,12.64c0.39,0.39,0.39,1.02,0,1.41l-4.23,4.25c-0.39,0.39-1.02,0.39-1.42,0L2.7,16.16 c-0.39-0.39-0.39-1.02,0-1.41s1.02-0.39,1.41,0l1.42,1.42l3.54-3.54C9.45,12.25,10.09,12.25,10.48,12.64L10.48,12.64z"/></svg>');
                    editor.ui.registry.addToggleButton('tasklist', {
                        tooltip: 'Task list',
                Severity: Major
                Found in resources/js/wysiwyg-tinymce/plugins-tasklist.js - About 2 hrs to fix

                  Function $updateTextNodeFromDOMContent has 73 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                  export function $updateTextNodeFromDOMContent(
                    textNode: TextNode,
                    textContent: string,
                    anchorOffset: null | number,
                    focusOffset: null | number,
                  Severity: Major
                  Found in resources/js/wysiwyg/lexical/core/LexicalUtils.ts - About 2 hrs to fix

                    Function updateDOM has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
                    Open

                      updateDOM(
                        prevNode: LinkNode,
                        anchor: LinkHTMLElementType,
                        config: EditorConfig,
                      ): boolean {
                    Severity: Minor
                    Found in resources/js/wysiwyg/lexical/link/index.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 moveNativeSelectionForward has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
                    Open

                    function moveNativeSelectionForward() {
                      const domSelection = window.getSelection()!;
                      const anchorNode = domSelection.anchorNode!;
                      const anchorOffset = domSelection.anchorOffset!;
                    
                    
                    Severity: Minor
                    Found in resources/js/wysiwyg/lexical/selection/__tests__/utils/index.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

                    Severity
                    Category
                    Status
                    Source
                    Language