Sign upLogin

BookStackApp/BookStack

View on GitHub
Star
resources/js/wysiwyg/lexical/core/LexicalEditor.ts

Summary

Maintainability
F
6 days
Test Coverage

File LexicalEditor.ts has 867 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: Major
Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 2 days to fix

    Function createEditor has a Cognitive Complexity of 59 (exceeds 5 allowed). Consider refactoring.
    Open

    export function createEditor(editorConfig?: CreateEditorArgs): LexicalEditor {
  const config = editorConfig || {};
  const activeEditor = internalGetActiveEditor();
  const theme = config.theme || {};
  const parentEditor =
    Severity: Minor
    Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 day 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 createEditor has 125 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function createEditor(editorConfig?: CreateEditorArgs): LexicalEditor {
  const config = editorConfig || {};
  const activeEditor = internalGetActiveEditor();
  const theme = config.theme || {};
  const parentEditor =
    Severity: Major
    Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 5 hrs to fix

      LexicalEditor has 33 functions (exceeds 20 allowed). Consider refactoring.
      Open

      export class LexicalEditor {
  ['constructor']!: KlassConstructor<typeof LexicalEditor>;

  /** The version with build identifiers for this editor (since 0.17.1) */
  static version: string | undefined;
      Severity: Minor
      Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 4 hrs to fix

        Function setRootElement has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
        Open

          setRootElement(nextRootElement: null | HTMLElement): void {
    const prevRootElement = this._rootElement;

    if (nextRootElement !== prevRootElement) {
      const classNames = getCachedClassNameArray(this._config.theme, 'root');
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/core/LexicalEditor.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 setRootElement has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          setRootElement(nextRootElement: null | HTMLElement): void {
    const prevRootElement = this._rootElement;

    if (nextRootElement !== prevRootElement) {
      const classNames = getCachedClassNameArray(this._config.theme, 'root');
        Severity: Minor
        Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 hr to fix

          Function constructor has 36 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            constructor(
    editorState: EditorState,
    parentEditor: null | LexicalEditor,
    nodes: RegisteredNodes,
    config: EditorConfig,
          Severity: Minor
          Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 hr to fix

            Function registerCommand has 33 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              registerCommand<P>(
    command: LexicalCommand<P>,
    listener: CommandListener<P>,
    priority: CommandListenerPriority,
  ): () => void {
            Severity: Minor
            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 hr to fix

              Function focus has 32 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                focus(callbackFn?: () => void, options: EditorFocusOptions = {}): void {
    const rootElement = this._rootElement;

    if (rootElement !== null) {
      // This ensures that iOS does not trigger caps lock upon focus
              Severity: Minor
              Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 hr to fix

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

                function initializeConversionCache(
  nodes: RegisteredNodes,
  additionalConversions?: DOMConversionMap,
): DOMConversionCache {
  const conversionCache = new Map();
                Severity: Minor
                Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 1 hr to fix

                  Avoid deeply nested control flow statements.
                  Open

                              if (!klass.hasOwnProperty(method)) {
              console.warn(`${name} must implement static "${method}" method`);
            }
                  Severity: Major
                  Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                              if (proto instanceof DecoratorNode) {
            // eslint-disable-next-line no-prototype-builtins
            if (!proto.hasOwnProperty('decorate')) {
              console.warn(
                `${proto.constructor.name} must implement "decorate" method`,
                    Severity: Major
                    Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 45 mins to fix

                      Avoid deeply nested control flow statements.
                      Open

                                if (
            // eslint-disable-next-line no-prototype-builtins
            !klass.hasOwnProperty('importJSON')
          ) {
            console.warn(
                      Severity: Major
                      Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 45 mins to fix

                        Avoid deeply nested control flow statements.
                        Open

                                  if (
            // eslint-disable-next-line no-prototype-builtins
            !proto.hasOwnProperty('exportJSON')
          ) {
            console.warn(
                        Severity: Major
                        Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 45 mins to fix

                          Avoid deeply nested control flow statements.
                          Open

                                    if (
            // eslint-disable-next-line no-prototype-builtins
            !klass.hasOwnProperty('importDOM') &&
            // eslint-disable-next-line no-prototype-builtins
            klass.hasOwnProperty('exportDOM')
                          Severity: Major
                          Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts - About 45 mins to fix

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

                              setEditorState(editorState: EditorState, options?: EditorSetOptions): void {
    if (editorState.isEmpty()) {
      invariant(
        false,
        "setEditorState: the editor state is empty. Ensure the editor state's root node never becomes empty.",
                            Severity: Minor
                            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.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 focus has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                            Open

                              focus(callbackFn?: () => void, options: EditorFocusOptions = {}): void {
    const rootElement = this._rootElement;

    if (rootElement !== null) {
      // This ensures that iOS does not trigger caps lock upon focus
                            Severity: Minor
                            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.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

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

                              registerUpdateListener(listener: UpdateListener): () => void {
    const listenerSetOrMap = this._listeners.update;
    listenerSetOrMap.add(listener);
    return () => {
      listenerSetOrMap.delete(listener);
                            Severity: Major
                            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts and 2 other locations - About 1 hr to fix
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 716..722
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 749..755

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

                            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 3 locations. Consider refactoring.
                            Open

                              registerEditableListener(listener: EditableListener): () => void {
    const listenerSetOrMap = this._listeners.editable;
    listenerSetOrMap.add(listener);
    return () => {
      listenerSetOrMap.delete(listener);
                            Severity: Major
                            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts and 2 other locations - About 1 hr to fix
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 702..708
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 749..755

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

                            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 3 locations. Consider refactoring.
                            Open

                              registerTextContentListener(listener: TextContentListener): () => void {
    const listenerSetOrMap = this._listeners.textcontent;
    listenerSetOrMap.add(listener);
    return () => {
      listenerSetOrMap.delete(listener);
                            Severity: Major
                            Found in resources/js/wysiwyg/lexical/core/LexicalEditor.ts and 2 other locations - About 1 hr to fix
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 702..708
                            resources/js/wysiwyg/lexical/core/LexicalEditor.ts on lines 716..722

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

                            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