Fix up PHPCS violations that are excluded in .phpcs.xml
Open, Needs TriagePublic
Actions

Assigned To

None

Authored By

	Reedy
	Oct 10 2017, 1:07 AM

Description

PHPCodeSniffer helps us stick to same coding standards across MediaWiki and its extensions.
In MediaWiki core and various MW extensions, we have PHP CS rules in a file called .phpcs.xml that are excluded because the code repository has various violations. In most cases, these can't be fixed automatically.

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.

Fix some (define a number here?) of these up.

https://tools.wmflabs.org/phpcs/

Details

	Subject	Repo	Branch	Lines +/-
	Remove ParamNameNoMatch phpcs sniff and fix errors	mediawiki/extensions/Cargo	master	+53 -26
	Namespace classes and give each its own file	mediawiki/extensions/PageTriage	master	+1 K -1 K

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T177810 Fix up PHPCS violations that are excluded in .phpcs.xml
Resolved	Pppery	T170580 Re-enable codesniffer sniffs disabled in TextExtracts
Resolved	Pppery	T170583 Re-enable codesniffer sniffs disabled in PageImages
Resolved	None	T170579 Re-enable codesniffer sniffs disabled in MobileFrontend
Open	None	T177809 Fix multiple PHP class declarations in one file
Resolved	None	T183676 Re-enable codesniffer sniffs disabled in TweetANew

Event Timeline

Reedy created this task.Oct 10 2017, 1:07 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 10 2017, 1:07 AM

Aklapper added projects: MediaWiki-General, MediaWiki-extensions-General.Oct 10 2017, 11:44 AM

Parent task maybe? https://phabricator.wikimedia.org/T170580 @Reedy

That could be a subtask of this, though this was designed as a GCI task specifically

Aklapper added subtasks: T170580: Re-enable codesniffer sniffs disabled in TextExtracts, T170583: Re-enable codesniffer sniffs disabled in PageImages, T170579: Re-enable codesniffer sniffs disabled in MobileFrontend.Nov 20 2017, 11:02 PM

Aklapper added a project: Epic.Nov 20 2017, 11:08 PM

Aklapper updated the task description. (Show Details)

I think 5-10 changes should be reasonable, wouldn't it? @Reedy Do you want to mentor this task together with me? :D

You mean, 5-10 separate changes?

Also see existing subtasks (especially for improving the task description). To get a list of excluded sniffs per MediaWiki extension repository:
find /home/user/git/mw/extensions/ -type f -name "*phpcs.xml" -printf "%h\n" -execdir grep -H '<exclude name=' '{}' +

Jdlrobson closed subtask T170580: Re-enable codesniffer sniffs disabled in TextExtracts as Resolved.Nov 30 2017, 10:28 PM

In T177810#3798447, @Reedy wrote:

You mean, 5-10 separate changes?

No, I mean 5-10 modified things inside one change to complete :) Sorry for the confusion.

Given the amount of work we've asked for in the existing 2 or 3 subtasks already I'd put that higher than 5-10.

Pppery added a subtask: T177809: Fix multiple PHP class declarations in one file.Dec 19 2017, 1:18 AM

jayvdb moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2017 board.Dec 19 2017, 10:12 AM

Pppery added a parent task: T162936: Improve developer happiness in reading web maintained extensions.Dec 21 2017, 3:38 PM

Jdlrobson closed subtask T170579: Re-enable codesniffer sniffs disabled in MobileFrontend as Resolved.Jan 12 2018, 4:40 PM

Kizule closed subtask T183676: Re-enable codesniffer sniffs disabled in TweetANew as Resolved.Jan 28 2018, 7:56 PM

Pppery closed subtask T170583: Re-enable codesniffer sniffs disabled in PageImages as Resolved.Mar 5 2018, 5:58 PM

Samwilson renamed this task from Fix up PHPCS violations that are excluded in phpcs.xml to Fix up PHPCS violations that are excluded in .phpcs.xml.Jun 6 2018, 11:28 PM

Change 437660 had a related patch set uploaded (by Samwilson; owner: Samwilson):
[mediawiki/extensions/PageTriage@master] Namespace classes and give each its own file

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

gerritbot added a project: Patch-For-Review.Jun 7 2018, 2:42 AM

Change 437660 merged by jenkins-bot:
[mediawiki/extensions/PageTriage@master] Namespace classes and give each its own file

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

Jdlrobson removed a parent task: T162936: Improve developer happiness in reading web maintained extensions.Jul 9 2018, 4:27 PM

Legoktm updated the task description. (Show Details)Aug 19 2018, 7:12 AM

Aklapper removed a project: Patch-For-Review.Oct 4 2018, 11:09 AM

Change 466839 had a related patch set uploaded (by Samwilson; owner: Samwilson):
[mediawiki/extensions/Cargo@master] Remove ParamNameNoMatch phpcs sniff and fix errors

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

gerritbot added a project: Patch-For-Review.Oct 12 2018, 9:11 AM

Change 466839 merged by jenkins-bot:
[mediawiki/extensions/Cargo@master] Remove ParamNameNoMatch phpcs sniff and fix errors

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

Maintenance_bot removed a project: Patch-For-Review.May 22 2019, 3:00 PM

DannyS712 subscribed.Apr 11 2020, 1:30 AM