Sign upLogin

wikimedia/mediawiki-extensions-VisualEditor

View on GitHub
Star
modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js

Summary

Maintainability
F
3 days
Test Coverage

Function describeChanges has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

ve.dm.MWTransclusionNode.static.describeChanges = function ( attributeChanges ) {
    const descriptions = [ ve.msg( 'visualeditor-changedesc-mwtransclusion' ) ];

    // This method assumes that the behavior of isDiffComparable above remains
    // the same, so it doesn't have to consider whether the actual template
Severity: Minor
Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 4 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 toDomElements has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

ve.dm.MWTransclusionNode.static.toDomElements = function ( dataElement, doc, converter ) {
    const store = converter.getStore(),
        originalMw = dataElement.attributes.originalMw,
        originalDomElements = store.value( dataElement.originalDomElementsHash );
Severity: Minor
Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - 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 escapeParameter has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

ve.dm.MWTransclusionNode.static.escapeParameter = function ( param ) {
    let input = param,
        output = '',
        inNowiki = false,
        bracketStack = 0,
Severity: Minor
Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - 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

File ve.dm.MWTransclusionNode.js has 307 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*!
 * VisualEditor DataModel MWTransclusionNode class.
 *
 * @copyright See AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
Severity: Minor
Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 3 hrs to fix

    Function toDomElements has 65 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    ve.dm.MWTransclusionNode.static.toDomElements = function ( dataElement, doc, converter ) {
    const store = converter.getStore(),
        originalMw = dataElement.attributes.originalMw,
        originalDomElements = store.value( dataElement.originalDomElementsHash );
    Severity: Major
    Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 2 hrs to fix

      Function escapeParameter has 59 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      ve.dm.MWTransclusionNode.static.escapeParameter = function ( param ) {
    let input = param,
        output = '',
        inNowiki = false,
        bracketStack = 0,
      Severity: Major
      Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 2 hrs to fix

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

        ve.dm.MWTransclusionNode.static.describeChanges = function ( attributeChanges ) {
    const descriptions = [ ve.msg( 'visualeditor-changedesc-mwtransclusion' ) ];

    // This method assumes that the behavior of isDiffComparable above remains
    // the same, so it doesn't have to consider whether the actual template
        Severity: Minor
        Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 1 hr to fix

          Function getPartsList has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

          ve.dm.MWTransclusionNode.prototype.getPartsList = function () {
    if ( !this.partsList ) {
        this.partsList = [];
        const content = this.getAttribute( 'mw' );
        for ( let i = 0; i < content.parts.length; i++ ) {
          Severity: Minor
          Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.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

          Avoid deeply nested control flow statements.
          Open

                              if ( typeof change === 'string' ) {
                        listItem.appendChild( document.createTextNode( change ) );
                    } else {
                        change.forEach( ( node ) => {
                            listItem.appendChild( node );
          Severity: Major
          Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                if ( !paramChanges ) {
                        paramChanges = document.createElement( 'ul' );
                        descriptions.push( paramChanges );
                    }
            Severity: Major
            Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 45 mins to fix

              Function getWikitext has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
              Open

              ve.dm.MWTransclusionNode.static.getWikitext = function ( content ) {
    let wikitext = '';

    // Normalize to multi template format
    if ( content.params ) {
              Severity: Minor
              Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.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

              Consider simplifying this complex logical expression.
              Open

                  if ( attributeChanges.mw.from.parts.length === 1 && attributeChanges.mw.to.parts.length === 1 ) {
        // Single-template transclusion, before and after. Relatively easy to summarize.
        // TODO: expand this to well-represent transclusions that contain multiple templates.

        // The bits of a template we care about are deeply-nested inside an
              Severity: Major
              Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js - About 40 mins to fix

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

                ve.dm.MWTransclusionNode.static.cloneElement = function () {
    // Parent method
    const clone = ve.dm.MWTransclusionNode.super.static.cloneElement.apply( this, arguments );
    delete clone.attributes.originalMw;
    return clone;
                Severity: Major
                Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js and 1 other location - About 2 hrs to fix
                modules/ve-mw/dm/nodes/ve.dm.MWLanguageVariantNode.js on lines 260..265

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

                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

                ve.dm.MWTransclusionNode.prototype.getWikitext = function () {
    return this.constructor.static.getWikitext( this.getAttribute( 'mw' ) );
};
                Severity: Major
                Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js and 1 other location - About 1 hr to fix
                modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js on lines 207..209

                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

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

                        if (
            converter.doesModeNeedRendering() &&
            // Use getHashObjectForRendering to get the rendering from the store
            ( value = store.value( store.hashOfValue( null, OO.getHash( [ this.getHashObjectForRendering( dataElement ), undefined ] ) ) ) )
        ) {
                Severity: Major
                Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js and 1 other location - About 1 hr to fix
                modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js on lines 113..126

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

                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

                ve.dm.MWTransclusionNode.static.getHashObject = function ( dataElement ) {
    return {
        type: dataElement.type,
        mw: dataElement.attributes.mw
    };
                Severity: Minor
                Found in modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js and 1 other location - About 55 mins to fix
                modules/ve-mw/dm/nodes/ve.dm.MWLanguageVariantNode.js on lines 41..46

                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