BookStackApp/BookStack

View on GitHub
resources/js/wysiwyg/nodes/media.ts

Summary

Maintainability
C
1 day
Test Coverage

MediaNode has 30 functions (exceeds 20 allowed). Consider refactoring.
Open

export class MediaNode extends ElementNode {
    __id: string = '';
    __alignment: CommonBlockAlignment = '';
    __tag: MediaNodeTag;
    __attributes: Record<string, string> = {};
Severity: Minor
Found in resources/js/wysiwyg/nodes/media.ts - About 3 hrs to fix

    File media.ts has 308 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import {
        DOMConversion,
        DOMConversionMap, DOMConversionOutput, DOMExportOutput,
        ElementNode,
        LexicalEditor,
    Severity: Minor
    Found in resources/js/wysiwyg/nodes/media.ts - About 3 hrs to fix

      Function domElementToNode has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

      function domElementToNode(tag: MediaNodeTag, element: HTMLElement): MediaNode {
          const node = $createMediaNode(tag);
      
          const attributes: Record<string, string> = {};
          for (const attribute of element.attributes) {
      Severity: Minor
      Found in resources/js/wysiwyg/nodes/media.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 updateDOM has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          updateDOM(prevNode: MediaNode, dom: HTMLElement): boolean {
              if (prevNode.__tag !== this.__tag) {
                  return true;
              }
      
      
      Severity: Minor
      Found in resources/js/wysiwyg/nodes/media.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 updateDOM has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          updateDOM(prevNode: MediaNode, dom: HTMLElement): boolean {
              if (prevNode.__tag !== this.__tag) {
                  return true;
              }
      
      
      Severity: Minor
      Found in resources/js/wysiwyg/nodes/media.ts - About 1 hr to fix

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

            static importJSON(serializedNode: SerializedMediaNode): MediaNode {
                const node = $createMediaNode(serializedNode.tag);
                deserializeCommonBlockNode(serializedNode, node);
                return node;
            }
        Severity: Minor
        Found in resources/js/wysiwyg/nodes/media.ts and 2 other locations - About 35 mins to fix
        resources/js/wysiwyg/nodes/callout.ts on lines 160..164
        resources/js/wysiwyg/nodes/custom-heading.ts on lines 87..91

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

        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

            getWidth(): number {
                const self = this.getLatest();
                return sizeToPixels(self.__attributes.width || '0');
            }
        Severity: Minor
        Found in resources/js/wysiwyg/nodes/media.ts and 1 other location - About 30 mins to fix
        resources/js/wysiwyg/nodes/media.ts on lines 192..195

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

        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

            getHeight(): number {
                const self = this.getLatest();
                return sizeToPixels(self.__attributes.height || '0');
            }
        Severity: Minor
        Found in resources/js/wysiwyg/nodes/media.ts and 1 other location - About 30 mins to fix
        resources/js/wysiwyg/nodes/media.ts on lines 202..205

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

        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