[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Page MenuHomePhabricator
Create Task
Maniphest T168384

Fix codesniffer sniffs disabled with the update to 0.9
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

Codesniffer helps us write better code, that's better documented. Right now we're not reaping its full benefits.

From build: Updating mediawiki/mediawiki-codesniffer to 0.9.0

The following sniffs are failing and were disabled:
* MediaWiki.Commenting.FunctionComment.MissingParamComment
* MediaWiki.Commenting.FunctionComment.MissingParamTag
* MediaWiki.Commenting.FunctionComment.MissingReturn
* MediaWiki.Commenting.FunctionComment.ParamNameNoMatch
* MediaWiki.FunctionComment.Missing.Public
* MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment

Plan (YMMV)

  • Enable sniffs one by one and send patches fixing the problems

AC

  • As many of the sniffs are made to pass as is possible.
  • If a sniff can't be made to pass for some reason, then document it as close as possible to the line disabling the sniff.

Developer notes

The latest version fo mediawiki-codesniffer is 0.10.0 -> it would be nice to update and verify everything works on latest code sniffer

Details

SubjectRepoBranchLines +/-
Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniffmediawiki/extensions/Popupsmaster+37 -3
Re-enable MediaWiki.Commenting.FunctionComment.MissingReturn sniffmediawiki/extensions/Popupsmaster+1 -2
Re-enable MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment sniffmediawiki/extensions/Popupsmaster+16 -7
Re-enable MediaWiki.Commenting.FunctionComment.MissingParamTag sniffmediawiki/extensions/Popupsmaster+6 -7
Re-enable MediaWiki.Commenting.FunctionComment.MissingParamComment sniffmediawiki/extensions/Popupsmaster+29 -29
Customize query in gerrit

Related Objects
Search...

Event Timeline

• Jhernandez created this task.Jun 20 2017, 10:53 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 20 2017, 10:53 AM
ovasileva added a project: Web-Team-Backlog.Jun 20 2017, 1:02 PM
ovasileva moved this task from Backlog to Next Up on the Page-Previews board.
Jdlrobson triaged this task as Medium priority.Jun 20 2017, 4:05 PM
Jdlrobson added a project: good first task.
Restricted Application added a subscriber: TerraCodes. · View Herald TranscriptJun 20 2017, 4:05 PM
Jdlrobson moved this task from Incoming to Upcoming on the Web-Team-Backlog board.Jun 20 2017, 4:05 PM
Jdlrobson renamed this task from Fix codesniffer sniffs disabled with the udpate to 0.9 to Fix codesniffer sniffs disabled with the update to 0.9.Jun 21 2017, 6:54 PM
Jdlrobson lowered the priority of this task from Medium to Low.
Jdlrobson added a project: patch-welcome.
Jdlrobson updated the task description. (Show Details)
Jdlrobson raised the priority of this task from Low to Medium.Jun 28 2017, 6:50 PM
Jdlrobson subscribed.

bumping visibility

phuedx updated the task description. (Show Details)Jul 5 2017, 12:54 PM
Jdlrobson moved this task from Upcoming to 2016-17 Q4 on the Web-Team-Backlog board.Jul 11 2017, 6:22 PM
Jdlrobson added a project: Readers-Web-Kanbanana-Board-Old.
pmiazga updated the task description. (Show Details)Jul 12 2017, 5:25 PM
Jdlrobson set the point value for this task to 2.Jul 12 2017, 5:26 PM
Jdlrobson moved this task from To Do to Needs Design Review on the Readers-Web-Kanbanana-Board-Old board.
pmiazga updated the task description. (Show Details)Jul 12 2017, 5:27 PM
pmiazga claimed this task.Jul 12 2017, 7:50 PM
pmiazga moved this task from Needs Design Review to Doing on the Readers-Web-Kanbanana-Board-Old board.

I'm picking this task as a time-filler for today

gerritbot subscribed.Jul 12 2017, 8:18 PM

Change 364843 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingParamComment sniff

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

gerritbot added a project: Patch-For-Review.Jul 12 2017, 8:18 PM
gerritbot added a comment.Jul 12 2017, 8:27 PM

Change 364845 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingParamTag sniff

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

gerritbot added a comment.Jul 12 2017, 8:29 PM

Change 364846 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingReturn sniff

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

gerritbot added a comment.Jul 12 2017, 8:41 PM

Change 364850 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff

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

gerritbot added a comment.Jul 12 2017, 8:43 PM

Change 364851 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment sniff

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

pmiazga updated the task description. (Show Details)Jul 12 2017, 8:58 PM
pmiazga moved this task from Doing to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.
pmiazga added a comment.Jul 12 2017, 9:09 PM

Many different extensions (MobileFrontend, TextExtracts, Popups) have many disabled sniffs. Some extensions (BetaFeatures, PageImages) do not have phpcs config at all. I'll create tasks accordingly as it's too much work to fix everything in this task.

I'll also bind this task with T162936 as it is improving developer happiness.

pmiazga added a parent task: T162936: Improve developer happiness in reading web maintained extensions.Jul 12 2017, 9:09 PM
gerritbot added a comment.Jul 13 2017, 10:41 AM

Change 364843 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingParamComment sniff

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

gerritbot added a comment.Jul 13 2017, 10:49 AM

Change 364845 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingParamTag sniff

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

ReleaseTaggerBot added a project: MW-1.30-release-notes (WMF-deploy-2017-07-18_(1.30.0-wmf.10)).Jul 13 2017, 11:00 AM
• bmansurov subscribed.Jul 13 2017, 12:45 PM
In T168384#3432854, @pmiazga wrote:

Many different extensions (MobileFrontend, TextExtracts, Popups) have many disabled sniffs. Some extensions (BetaFeatures, PageImages) do not have phpcs config at all. I'll create tasks accordingly as it's too much work to fix everything in this task.

Good idea. I also thought this task was only about page previews.

pmiazga added a comment.Jul 13 2017, 1:42 PM

@bmansurov - you're right, in this task we had to fix PagePreviews code. I decided to check other extensions as fixing those could be quick and simple (this task took me less than an hour), but for an example, only MobileFrontend validation returned over 100 errors (I didn't count them but it was lots of scrolling ).

ovasileva moved this task from 2016-17 Q4 to 2017-18 Q1 on the Web-Team-Backlog board.Jul 13 2017, 5:40 PM
gerritbot added a comment.Jul 13 2017, 5:42 PM

Change 364851 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment sniff

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

gerritbot added a comment.Jul 13 2017, 5:42 PM

Change 364846 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingReturn sniff

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

Jdlrobson moved this task from Needs Code Review to Needs More Work on the Readers-Web-Kanbanana-Board-Old board.Jul 13 2017, 6:17 PM

Looks like https://gerrit.wikimedia.org/r/364850 is the only remaining patch and it needs a rebase?

pmiazga moved this task from Needs More Work to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Jul 13 2017, 7:14 PM

@Jdlrobson : rebased. And yes, it was the only remaining patch.

gerritbot added a comment.Jul 13 2017, 7:24 PM

Change 364850 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff

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

Jdlrobson moved this task from Needs Code Review to Ready for Signoff on the Readers-Web-Kanbanana-Board-Old board.Jul 13 2017, 7:28 PM
phuedx removed pmiazga as the assignee of this task.Jul 14 2017, 8:42 AM
phuedx added subscribers: pmiazga, phuedx.

This task needs a Signer Offerer.

pmiazga mentioned this in T170589: Re-enable codesniffer sniffs disabled in RelatedArticles.Jul 14 2017, 3:42 PM
Jdlrobson closed this task as Resolved.Jul 14 2017, 11:44 PM
Jdlrobson claimed this task.

That will be me :)

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