Sign upLogin

superdesk/superdesk-client-core

View on GitHub
Star
scripts/core/editor3/helpers/highlights.ts

Summary

Maintainability
F
4 days
Test Coverage

File highlights.ts has 679 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import {RichUtils, EditorState} from 'draft-js';
import {getHighlightsConfig} from '../highlightsConfig';
import {editor3DataKeys, getCustomDataFromEditor, setCustomDataForEditor__deprecated} from './editor3CustomData';
import {getDraftCharacterListForSelection} from './getDraftCharacterListForSelection';
import {getDraftSelectionForEntireContent} from './getDraftSelectionForEntireContent';
Severity: Major
Found in scripts/core/editor3/helpers/highlights.ts - About 1 day to fix

    Function getRightRangeAndTextForStyle has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

    function getRightRangeAndTextForStyle(editorState, style) {
    /* eslint-disable complexity */
    const type = getHighlightTypeFromStyleName(style);
    const selection = editorState.getSelection();
    const content = editorState.getCurrentContent();
    Severity: Minor
    Found in scripts/core/editor3/helpers/highlights.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 getRightRangeAndTextForStyle has 62 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function getRightRangeAndTextForStyle(editorState, style) {
    /* eslint-disable complexity */
    const type = getHighlightTypeFromStyleName(style);
    const selection = editorState.getSelection();
    const content = editorState.getCurrentContent();
    Severity: Major
    Found in scripts/core/editor3/helpers/highlights.ts - About 2 hrs to fix

      Function getLeftRangeAndTextForStyle has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
      Open

      function getLeftRangeAndTextForStyle(editorState, style) {
    const type = getHighlightTypeFromStyleName(style);
    const selection = editorState.getSelection();
    const content = editorState.getCurrentContent();
    let startBlock = content.getBlockForKey(selection.getStartKey());
      Severity: Minor
      Found in scripts/core/editor3/helpers/highlights.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 getSuggestionData has 59 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export function getSuggestionData(editorState, styleName) {
    const type = getHighlightType(styleName);
    const {selection, highlightedText} = getRangeAndTextForStyle(editorState, styleName);

    const data = {
      Severity: Major
      Found in scripts/core/editor3/helpers/highlights.ts - About 2 hrs to fix

        Function getLeftRangeAndTextForStyle has 50 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function getLeftRangeAndTextForStyle(editorState, style) {
    const type = getHighlightTypeFromStyleName(style);
    const selection = editorState.getSelection();
    const content = editorState.getCurrentContent();
    let startBlock = content.getBlockForKey(selection.getStartKey());
        Severity: Minor
        Found in scripts/core/editor3/helpers/highlights.ts - About 2 hrs to fix

          Function addHighlight has 47 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          export function addHighlight(editorState, type, data, single = false) {
    let nextEditorState = editorState;

    const initialSelection = nextEditorState.getSelection().merge({
        hasFocus: true,
          Severity: Minor
          Found in scripts/core/editor3/helpers/highlights.ts - About 1 hr to fix

            Function getBlockAndOffset has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

            export const getBlockAndOffset = (
    editorState,
    selection,
    offset,
    startFromEnd = false,
            Severity: Minor
            Found in scripts/core/editor3/helpers/highlights.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 getBlockAndOffset has 35 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            export const getBlockAndOffset = (
    editorState,
    selection,
    offset,
    startFromEnd = false,
            Severity: Minor
            Found in scripts/core/editor3/helpers/highlights.ts - About 1 hr to fix

              Function getRangeAndTextForStyleInRawState has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

              export function getRangeAndTextForStyleInRawState(rawEditorState, highlightId) {
    let highlightedText = '';

    for (const {inlineStyleRanges, text} of rawEditorState.blocks) {
        for (const {offset, length, style} of inlineStyleRanges) {
              Severity: Minor
              Found in scripts/core/editor3/helpers/highlights.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 getSuggestionData has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

              export function getSuggestionData(editorState, styleName) {
    const type = getHighlightType(styleName);
    const {selection, highlightedText} = getRangeAndTextForStyle(editorState, styleName);

    const data = {
              Severity: Minor
              Found in scripts/core/editor3/helpers/highlights.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 canAddHighlight has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              export function canAddHighlight(editorState, highlightType) {
    if (highlightTypeValid(highlightType) !== true) {
        return false;
    }
              Severity: Minor
              Found in scripts/core/editor3/helpers/highlights.ts - About 1 hr to fix

                Function getHighlightStyleAtOffset has 6 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                    editorState, types, selection, offset, fromEnd = false, firstFound = true): string | Array<string> {
                Severity: Minor
                Found in scripts/core/editor3/helpers/highlights.ts - About 45 mins to fix

                  Function getHighlightDataAtOffset has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                  export function getHighlightDataAtOffset(editorState, types, selection, offset, fromEnd = false) {
                  Severity: Minor
                  Found in scripts/core/editor3/helpers/highlights.ts - About 35 mins to fix

                    Avoid too many return statements within this function.
                    Open

                        return {block, newOffset};
                    Severity: Major
                    Found in scripts/core/editor3/helpers/highlights.ts - About 30 mins to fix

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

                          const beforeSelection = selection.merge({
        anchorOffset: selection.getStartOffset(),
        anchorKey: selection.getStartKey(),
        focusOffset: selection.getStartOffset(),
        focusKey: selection.getStartKey(),
                      Severity: Major
                      Found in scripts/core/editor3/helpers/highlights.ts and 1 other location - About 1 hr to fix
                      scripts/core/editor3/helpers/highlights.ts on lines 961..967

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

                      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 afterSelection = selection.merge({
        anchorOffset: selection.getEndOffset(),
        anchorKey: selection.getEndKey(),
        focusOffset: selection.getEndOffset(),
        focusKey: selection.getEndKey(),
                      Severity: Major
                      Found in scripts/core/editor3/helpers/highlights.ts and 1 other location - About 1 hr to fix
                      scripts/core/editor3/helpers/highlights.ts on lines 954..960

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

                      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

                              if (found) {
            block = content.getBlockAfter(block.getKey());
            offset = null;
            newBlock = true;
        } else {
                      Severity: Minor
                      Found in scripts/core/editor3/helpers/highlights.ts and 1 other location - About 55 mins to fix
                      scripts/core/editor3/helpers/highlights.ts on lines 765..771

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

                      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

                              if (found) {
            block = content.getBlockBefore(block.getKey());
            offset = null;
            newBlock = true;
        } else {
                      Severity: Minor
                      Found in scripts/core/editor3/helpers/highlights.ts and 1 other location - About 55 mins to fix
                      scripts/core/editor3/helpers/highlights.ts on lines 845..851

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

                      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