Page MenuHomePhabricator

VisualEditor codebase cleanup to prepare for sidebar changes
Closed, ResolvedPublic0 Estimated Story Points

Description

These patches prepare the codebase for what we actually want to do.

  • Improve source code documentation for the core classes that we will be touching. For example, the division of responsibility between MWTransclusionDialog and MWTemplateDialog.
  • Rename variables, methods, and parameters to make their purpose more obvious.
  • Consolidate like functionality when possible.
  • Clean up upper-/lower-case handing.
  • Style issues.

Patch-For-Review:

I'm not sure if we should block this task on this patch, but it would be really helpful to have it merged:

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
thiemowmde set the point value for this task to 0.
thiemowmde moved this task from Sprint Backlog to Review on the WMDE-TechWish-Sprint-2021-06-09 board.

Change 700220 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Update documentation for all getWikitext()/serialize() methods

https://gerrit.wikimedia.org/r/700220

Change 700223 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Remove unused .getWikitext() methods from transclusion classes

https://gerrit.wikimedia.org/r/700223

Change 700224 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Better variable names for the template dialog's "single" mode

https://gerrit.wikimedia.org/r/700224

Change 700225 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Remove unused .onAddParameterBeforeLoad() method

https://gerrit.wikimedia.org/r/700225

Change 700226 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Small documentation updates in transclusion model classes

https://gerrit.wikimedia.org/r/700226

Change 700227 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] [WIP] Rewrite several template related methods for readability

https://gerrit.wikimedia.org/r/700227

Change 700226 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Small documentation updates in transclusion model classes

https://gerrit.wikimedia.org/r/700226

Change 700225 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Remove unused .onAddParameterBeforeLoad() method

https://gerrit.wikimedia.org/r/700225

Change 700224 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Better variable names for the template dialog's "single" mode

https://gerrit.wikimedia.org/r/700224

Change 700363 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Remove unused "insert" action from MWTemplateDialog

https://gerrit.wikimedia.org/r/700363

Change 700369 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Rewrite MWTemplateDialog.setApplicableStatus for readability

https://gerrit.wikimedia.org/r/700369

Change 700382 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Add @private/@protected documentation to template dialog code

https://gerrit.wikimedia.org/r/700382

Change 700388 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Rewrite MWTransclusionDialog methods for readability

https://gerrit.wikimedia.org/r/700388

Change 700476 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/VisualEditor@master] Inline many var declarations in the code below

https://gerrit.wikimedia.org/r/700476

Change 700388 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Rewrite MWTransclusionDialog methods for readability

https://gerrit.wikimedia.org/r/700388

Change 700476 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Inline many var declarations in the code below

https://gerrit.wikimedia.org/r/700476

Change 700220 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Update documentation for all getWikitext()/serialize() methods

https://gerrit.wikimedia.org/r/700220

Change 700227 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Rewrite MWTransclusionNode.isSingleTemplate for readability

https://gerrit.wikimedia.org/r/700227

Change 700363 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Remove unused "insert" action from MWTemplateDialog

https://gerrit.wikimedia.org/r/700363

Change 700369 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Rewrite MWTemplateDialog.setApplicableStatus for readability

https://gerrit.wikimedia.org/r/700369

Change 700382 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Add @private/@protected documentation to template dialog code

https://gerrit.wikimedia.org/r/700382

Change 700223 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Remove unused .getWikitext() methods from transclusion classes

https://gerrit.wikimedia.org/r/700223