BookStackApp/BookStack

View on GitHub
resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts

Summary

Maintainability
C
1 day
Test Coverage

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

export function syncYjsChangesToLexical(
  binding: Binding,
  provider: Provider,
  events: Array<YEvent<YText>>,
  isFromUndoManger: boolean,
Severity: Minor
Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts - About 1 hr to fix

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

    function $handleNormalizationMergeConflicts(
      binding: Binding,
      normalizedNodes: Set<NodeKey>,
    ): void {
      // We handle the merge operations here
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.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 $syncEvent has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    function $syncEvent(binding: Binding, event: any): void {
      const {target} = event;
      const collabNode = $getOrInitCollabNodeFromSharedType(binding, target);
    
      if (collabNode instanceof CollabElementNode && event instanceof YTextEvent) {
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.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 $handleNormalizationMergeConflicts has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function $handleNormalizationMergeConflicts(
      binding: Binding,
      normalizedNodes: Set<NodeKey>,
    ): void {
      // We handle the merge operations here
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts - About 1 hr to fix

      Function $syncEvent has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function $syncEvent(binding: Binding, event: any): void {
        const {target} = event;
        const collabNode = $getOrInitCollabNodeFromSharedType(binding, target);
      
        if (collabNode instanceof CollabElementNode && event instanceof YTextEvent) {
      Severity: Minor
      Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts - About 1 hr to fix

        Function syncLexicalUpdateToYjs has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        export function syncLexicalUpdateToYjs(
          binding: Binding,
          provider: Provider,
          prevEditorState: EditorState,
          currEditorState: EditorState,
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts - About 1 hr to fix

          Function syncLexicalUpdateToYjs has 8 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            binding: Binding,
            provider: Provider,
            prevEditorState: EditorState,
            currEditorState: EditorState,
            dirtyElements: Map<NodeKey, IntentionallyMarkedAsDirtyElement>,
          Severity: Major
          Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts - About 1 hr to fix

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

              } else if (
                collabNode instanceof CollabDecoratorNode &&
                event instanceof YXmlEvent
              ) {
                const {attributesChanged} = event;
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts and 1 other location - About 40 mins to fix
            resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts on lines 56..78

            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

              } else if (
                collabNode instanceof CollabTextNode &&
                event instanceof YMapEvent
              ) {
                const {keysChanged} = event;
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts and 1 other location - About 40 mins to fix
            resources/js/wysiwyg/lexical/yjs/SyncEditorStates.ts on lines 66..78

            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