Page MenuHomePhabricator
Create Task
Maniphest T170580

Re-enable codesniffer sniffs disabled in TextExtracts
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

PHPCodeSniffer helps us stick to same coding standards across MediaWiki and it's extensions. Currently TextExtracts phpcs config differs from the MediaWiki one - the following sniffs are disabled:

MediaWiki.Commenting.FunctionComment.MissingParamComment
MediaWiki.Commenting.FunctionComment.MissingParamTag
MediaWiki.Commenting.FunctionComment.MissingReturn
MediaWiki.Commenting.FunctionComment.ParamNameNoMatch
MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic
MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName
MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment

Runing phpcs without those sniffs gives 24 errors and 9 warnings in 4 files.

Plan (YMMV)

  • Remove a sniff from the .phpcs.xml file, run composer phpcs or phpcs -p -s, get a list of violations, provide patches in Wikimedia Gerrit to fix the violations. If you fix all violations for one sniff, also commit the removal of the exclusion from .phpcs.xml too.

Developer Notes

CodeSniffer output: P5743

Details

Related Changes in Gerrit:
SubjectAuthorRepoBranchLines +/-
Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniffPpperymediawiki/extensions/TextExtractsmaster+37 -4
Re-enable MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment sniffPpperymediawiki/extensions/TextExtractsmaster+18 -10
Re-enable MediaWiki.Commenting.FunctionComment.MissingParamComment sniffPpperymediawiki/extensions/TextExtractsmaster+10 -11
Customize query in gerrit

Related Objects
Search...

Event Timeline

pmiazga created this task.Jul 13 2017, 2:44 PM
Restricted Application added a subscriber: • Aklapper. · View Herald TranscriptJul 13 2017, 2:44 PM
pmiazga added a parent task: T162936: Improve developer happiness in reading web maintained extensions.Jul 13 2017, 2:45 PM
Jdlrobson moved this task from Incoming to Triaged but Future on the Web-Team-Backlog-Archived board.Jul 13 2017, 3:10 PM
Jdlrobson triaged this task as Low priority.Jul 13 2017, 4:11 PM
Jdlrobson raised the priority of this task from Low to Medium.Aug 17 2017, 3:09 PM
Jdlrobson moved this task from Triaged but Future to Upcoming on the Web-Team-Backlog-Archived board.
Jdlrobson moved this task from Upcoming to Triaged but Future on the Web-Team-Backlog-Archived board.Aug 22 2017, 6:37 PM
Jdlrobson moved this task from Triaged but Future to Upcoming on the Web-Team-Backlog-Archived board.
Jdlrobson moved this task from Upcoming to Triaged but Future on the Web-Team-Backlog-Archived board.Aug 24 2017, 2:04 PM
Jdlrobson moved this task from Triaged but Future to Upcoming on the Web-Team-Backlog-Archived board.Sep 28 2017, 9:16 PM
• Niedzielski added a project: good first task.Oct 11 2017, 2:05 PM
• Niedzielski subscribed.

The sniffs disabled appeared to be documentation or style-specific so I'm marking this easy. Please revert if you disagree.

Restricted Application added a subscriber: TerraCodes. · View Herald TranscriptOct 11 2017, 2:05 PM
Jdlrobson set the point value for this task to 2.Oct 11 2017, 4:45 PM
phuedx updated the task description. (Show Details)Oct 11 2017, 4:45 PM
phuedx subscribed.

^ Per T170580#3675695.

Jdlrobson added a project: Google-Code-in-2017.Oct 16 2017, 10:14 PM
Jdlrobson moved this task from Upcoming to Triaged but Future on the Web-Team-Backlog-Archived board.Oct 18 2017, 11:52 PM
• Aklapper updated the task description. (Show Details)Nov 20 2017, 10:47 PM
• Aklapper added a subscriber: Jdlrobson.Nov 20 2017, 10:51 PM

@Jdlrobson: Any guestimation into how many Google-Code-in-2017 tasks this ticket should be broken down ("about 2-3 hours for an experienced contributor")? And explicitly asking: Do you plan to mentor these?

• Aklapper added a parent task: T177810: Fix up PHPCS violations that are excluded in .phpcs.xml.Nov 20 2017, 11:02 PM
• Aklapper updated the task description. (Show Details)Nov 20 2017, 11:06 PM
Jdlrobson added a comment.Nov 21 2017, 6:29 PM

@Aklapper one 2 hour task should be enough and contributor doesn't need to be experienced - just needs to know how phpcs works. Yes I can mentor.

• Aklapper moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2017 board.Nov 29 2017, 4:28 PM

Thanks! Imported as https://codein.withgoogle.com/tasks/6023338226876416/

gerritbot subscribed.Nov 30 2017, 1:06 AM

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

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

gerritbot added a project: Patch-For-Review.Nov 30 2017, 1:06 AM
Pppery subscribed.Nov 30 2017, 1:57 AM

Oops, forgot to specify bug ID in https://gerrit.wikimedia.org/r/#/c/394234/

Pppery claimed this task.Nov 30 2017, 1:57 AM
gerritbot added a comment.Nov 30 2017, 3:00 AM

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

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

gerritbot added a comment.Nov 30 2017, 3:56 AM

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

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

gerritbot added a comment.Nov 30 2017, 7:11 PM

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

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

gerritbot added a comment.Nov 30 2017, 7:11 PM

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

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

ReleaseTaggerBot added a project: MW-1.31-release-notes (WMF-deploy-2017-12-05 (1.31.0-wmf.11)).Nov 30 2017, 8:00 PM
Jdlrobson closed this task as Resolved.Nov 30 2017, 10:28 PM

@pmiazga I'm resolving this as this looks to be done. Can you take a quick look when you have a chance just in case? Thanks @Pppery for taking care of this!

gerritbot added a comment.Nov 30 2017, 10:28 PM

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

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

Pppery removed a project: Patch-For-Review.Nov 30 2017, 11:51 PM
Pppery removed a parent task: T162936: Improve developer happiness in reading web maintained extensions.Dec 21 2017, 3:38 PM
MBinder_WMF moved this task from Triaged but Future to 2017-18 Q2 on the Web-Team-Backlog-Archived board.Mar 6 2018, 6:48 PM
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