wikimedia/mediawiki-extensions-VisualEditor

View on GitHub
modules/ve-mw/init/targets/ve.init.mw.Target.js

Summary

Maintainability
D
1 day
Test Coverage

File ve.init.mw.Target.js has 371 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*!
 * VisualEditor MediaWiki Initialization Target class.
 *
 * @copyright See AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
Severity: Minor
Found in modules/ve-mw/init/targets/ve.init.mw.Target.js - About 4 hrs to fix

    Function initAutosave has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    ve.init.mw.Target.prototype.initAutosave = function ( config ) {
        // Old function signature
        // TODO: Remove after fixed downstream
        if ( typeof config === 'boolean' ) {
            config = { suppressNotification: config };
    Severity: Minor
    Found in modules/ve-mw/init/targets/ve.init.mw.Target.js - About 1 hr to fix

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

      ve.init.mw.Target.prototype.initAutosave = function ( config ) {
          // Old function signature
          // TODO: Remove after fixed downstream
          if ( typeof config === 'boolean' ) {
              config = { suppressNotification: config };
      Severity: Minor
      Found in modules/ve-mw/init/targets/ve.init.mw.Target.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 parseDocument has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

      ve.init.mw.Target.static.parseDocument = function ( documentString, mode, section, onlySection ) {
          let doc;
          if ( mode === 'source' ) {
              // Parent method
              doc = ve.init.mw.Target.super.static.parseDocument.call( this, documentString, mode );
      Severity: Minor
      Found in modules/ve-mw/init/targets/ve.init.mw.Target.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 parseDocument has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      ve.init.mw.Target.static.parseDocument = function ( documentString, mode, section, onlySection ) {
          let doc;
          if ( mode === 'source' ) {
              // Parent method
              doc = ve.init.mw.Target.super.static.parseDocument.call( this, documentString, mode );
      Severity: Minor
      Found in modules/ve-mw/init/targets/ve.init.mw.Target.js - About 1 hr to fix

        Function parseWikitextFragment has 29 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        ve.init.mw.Target.prototype.parseWikitextFragment = function ( wikitext, pst, doc ) {
            let abortable, aborted;
            const abortedPromise = ve.createDeferred().reject( 'http',
                { textStatus: 'abort', exception: 'abort' } ).promise();
        
        
        Severity: Minor
        Found in modules/ve-mw/init/targets/ve.init.mw.Target.js - About 1 hr to fix

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

          ve.init.mw.Target.prototype.getLocalApi = function ( options ) {
              options = options || {};
              options.parameters = ve.extendObject( { formatversion: 2 }, options.parameters );
              return new mw.Api( options );
          };
          Severity: Major
          Found in modules/ve-mw/init/targets/ve.init.mw.Target.js and 1 other location - About 1 hr to fix
          modules/ve-mw/init/targets/ve.init.mw.Target.js on lines 665..669

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

          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

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

          ve.init.mw.Target.prototype.getContentApi = function ( doc, options ) {
              options = options || {};
              options.parameters = ve.extendObject( { formatversion: 2 }, options.parameters );
              return new mw.Api( options );
          };
          Severity: Major
          Found in modules/ve-mw/init/targets/ve.init.mw.Target.js and 1 other location - About 1 hr to fix
          modules/ve-mw/init/targets/ve.init.mw.Target.js on lines 680..684

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

          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

          ve.init.mw.Target.static.importRules = ve.copy( ve.init.mw.Target.static.importRules );
          Severity: Major
          Found in modules/ve-mw/init/targets/ve.init.mw.Target.js and 2 other locations - About 1 hr to fix
          modules/ve-mw-collab/ve.init.mw.CollabTarget.js on lines 60..60
          modules/ve-mw-collab/ve.init.mw.CollabTarget.js on lines 96..96

          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.init.mw.Target.prototype.surfaceReady = function () {
              this.emit( 'surfaceReady' );
          };
          Severity: Minor
          Found in modules/ve-mw/init/targets/ve.init.mw.Target.js and 1 other location - About 35 mins to fix
          modules/ve-mw-collab/ve.init.mw.CollabTarget.js on lines 133..135

          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

          There are no issues that match your filters.

          Category
          Status