Page MenuHomePhabricator
Create Task
Maniphest T284895

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

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:

Details

Related Changes in Gerrit:
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

thiemowmde created this task.Jun 14 2021, 7:56 AM
Restricted Application removed a project: Patch-For-Review. · View Herald TranscriptJun 14 2021, 7:56 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
thiemowmde added a project: Patch-For-Review.Jun 14 2021, 7:57 AM
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.
matmarex awarded a token.Jun 14 2021, 8:26 AM
matmarex moved this task from To Triage to Triaged on the VisualEditor board.
thiemowmde added a parent task: T284631: [Epic] Preparatory clean-up ahead of sidebar work.Jun 14 2021, 11:53 AM
Lena_WMDE moved this task from Backlog to In sprint on the WMDE-Templates-FocusArea board.Jun 16 2021, 12:06 PM
awight updated the task description. (Show Details)Jun 17 2021, 8:35 AM
gerritbot added a comment.Jun 17 2021, 3:58 PM

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

gerritbot added a comment.Jun 17 2021, 4:20 PM

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

gerritbot added a comment.Jun 17 2021, 4:26 PM

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

gerritbot added a comment.Jun 17 2021, 4:31 PM

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

gerritbot added a comment.Jun 17 2021, 4:33 PM

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

gerritbot added a comment.Jun 17 2021, 4:36 PM

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

gerritbot added a comment.Jun 18 2021, 12:58 AM

Change 700226 merged by jenkins-bot:

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

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.11; 2021-06-21).Jun 18 2021, 1:00 AM
gerritbot added a comment.Jun 18 2021, 1:06 AM

Change 700225 merged by jenkins-bot:

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

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

gerritbot added a comment.Jun 18 2021, 8:34 AM

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

Biggs657 subscribed.Jun 18 2021, 8:35 AM
gerritbot added a comment.Jun 18 2021, 11:44 AM

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

gerritbot added a comment.Jun 18 2021, 12:21 PM

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

gerritbot added a comment.Jun 18 2021, 1:53 PM

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

gerritbot added a comment.Jun 18 2021, 2:14 PM

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

thiemowmde updated the task description. (Show Details)Jun 18 2021, 2:15 PM
gerritbot added a comment.Jun 21 2021, 8:17 AM

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

gerritbot added a comment.Jun 21 2021, 10:41 AM

Change 700388 merged by jenkins-bot:

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

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

thiemowmde updated the task description. (Show Details)Jun 23 2021, 7:58 AM
thiemowmde added a project: WMDE-TechWish-Sprint-2021-06-23.Jun 23 2021, 8:14 AM
thiemowmde moved this task from Sprint Backlog to Review on the WMDE-TechWish-Sprint-2021-06-23 board.
gerritbot added a comment.Jun 23 2021, 9:24 AM

Change 700476 merged by jenkins-bot:

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

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

gerritbot added a comment.Jul 1 2021, 11:18 AM

Change 700220 merged by jenkins-bot:

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

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

gerritbot added a comment.Jul 1 2021, 11:21 AM

Change 700227 merged by jenkins-bot:

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

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

gerritbot added a comment.Jul 1 2021, 11:52 AM

Change 700363 merged by jenkins-bot:

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

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

gerritbot added a comment.Jul 1 2021, 11:56 AM

Change 700369 merged by jenkins-bot:

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

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.14; 2021-07-12); removed MW-1.37-notes (1.37.0-wmf.11; 2021-06-21).Jul 1 2021, 12:00 PM
thiemowmde updated the task description. (Show Details)Jul 5 2021, 7:41 AM
thiemowmde updated the task description. (Show Details)Jul 5 2021, 12:51 PM
gerritbot added a comment.Jul 6 2021, 8:41 AM

Change 700382 merged by jenkins-bot:

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

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

gerritbot added a comment.Jul 6 2021, 9:15 AM

Change 700223 merged by jenkins-bot:

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

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

WMDE-Fisch updated the task description. (Show Details)Jul 6 2021, 10:27 AM
thiemowmde closed this task as Resolved.Jul 6 2021, 11:52 AM
thiemowmde moved this task from Review to Done on the WMDE-TechWish-Sprint-2021-06-23 board.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits