ckeditor/ckeditor5-engine

View on GitHub
src/model/position.js

Summary

Maintainability
D
3 days
Test Coverage

File position.js has 400 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

Severity: Minor
Found in src/model/position.js - About 5 hrs to fix

    Position has 38 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export default class Position {
        /**
         * Creates a position.
         *
         * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} root Root of the position.
    Severity: Minor
    Found in src/model/position.js - About 5 hrs to fix

      Function _getTransformedByDeletion has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          _getTransformedByDeletion( deletePosition, howMany ) {
              const transformed = Position._createAt( this );
      
              // This position can't be affected if deletion was in a different root.
              if ( this.root != deletePosition.root ) {
      Severity: Minor
      Found in src/model/position.js - 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 isTouching has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          isTouching( otherPosition ) {
              let left = null;
              let right = null;
              const compare = this.compareWith( otherPosition );
      
      
      Severity: Minor
      Found in src/model/position.js - 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 isTouching has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          isTouching( otherPosition ) {
              let left = null;
              let right = null;
              const compare = this.compareWith( otherPosition );
      
      
      Severity: Minor
      Found in src/model/position.js - About 1 hr to fix

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

            static _createAt( itemOrPosition, offset, stickiness = 'toNone' ) {
                if ( itemOrPosition instanceof Position ) {
                    return new Position( itemOrPosition.root, itemOrPosition.path, itemOrPosition.stickiness );
                } else {
                    const node = itemOrPosition;
        Severity: Minor
        Found in src/model/position.js - About 1 hr to fix

          Function _createAt has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              static _createAt( itemOrPosition, offset, stickiness = 'toNone' ) {
                  if ( itemOrPosition instanceof Position ) {
                      return new Position( itemOrPosition.root, itemOrPosition.path, itemOrPosition.stickiness );
                  } else {
                      const node = itemOrPosition;
          Severity: Minor
          Found in src/model/position.js - About 55 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 _getTransformedByInsertion has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              _getTransformedByInsertion( insertPosition, howMany ) {
                  const transformed = Position._createAt( this );
          
                  // This position can't be affected if insertion was in a different root.
                  if ( this.root != insertPosition.root ) {
          Severity: Minor
          Found in src/model/position.js - About 45 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 _getTransformedByMove has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              _getTransformedByMove( sourcePosition, targetPosition, howMany ) {
                  // Update target position, as it could be affected by nodes removal.
                  targetPosition = targetPosition._getTransformedByDeletion( sourcePosition, howMany );
          
                  if ( sourcePosition.isEqual( targetPosition ) ) {
          Severity: Minor
          Found in src/model/position.js - 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 _getTransformedByMergeOperation has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              _getTransformedByMergeOperation( operation ) {
                  const movedRange = operation.movedRange;
                  const isContained = movedRange.containsPosition( this ) || movedRange.start.isEqual( this );
          
                  let pos;
          Severity: Minor
          Found in src/model/position.js - 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

          Function constructor has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              constructor( root, path, stickiness = 'toNone' ) {
                  if ( !root.is( 'element' ) && !root.is( 'documentFragment' ) ) {
                      /**
                       * Position root is invalid.
                       *
          Severity: Minor
          Found in src/model/position.js - 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

          Function _getTransformedBySplitOperation has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              _getTransformedBySplitOperation( operation ) {
                  const movedRange = operation.movedRange;
          
                  const isContained = movedRange.containsPosition( this ) ||
                      ( movedRange.start.isEqual( this ) && this.stickiness == 'toNext' );
          Severity: Minor
          Found in src/model/position.js - 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 2 locations. Consider refactoring.
          Open

              getCommonAncestor( position ) {
                  const ancestorsA = this.getAncestors();
                  const ancestorsB = position.getAncestors();
          
                  let i = 0;
          Severity: Major
          Found in src/model/position.js and 1 other location - About 3 hrs to fix
          src/view/position.js on lines 196..207

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

          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

              getLastMatchingPosition( skip, options = {} ) {
                  options.startPosition = this;
          
                  const treeWalker = new TreeWalker( options );
                  treeWalker.skip( skip );
          Severity: Major
          Found in src/model/position.js and 1 other location - About 1 hr to fix
          src/view/position.js on lines 167..174

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

          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