Re-enable codesniffer sniffs disabled in BetaFeatures
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	pmiazga
	Jul 13 2017, 3:08 PM

Description

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

Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
MediaWiki.Commenting.FunctionComment.MissingParamComment
MediaWiki.Commenting.FunctionComment.MissingParamName
MediaWiki.Commenting.FunctionComment.MissingParamTag
MediaWiki.Commenting.FunctionComment.MissingReturn
MediaWiki.Commenting.FunctionComment.ParamNameNoMatch
MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected
MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic
MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment

Runing phpcs without those sniffs gives 42 errors and 1 warnings in 12 files.

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.~~

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Get global $wgBetaFeatures from config object	mediawiki/extensions/BetaFeatures	master	+2 -6

Customize query in gerrit

Event Timeline

pmiazga created this task.Jul 13 2017, 3:08 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 13 2017, 3:08 PM

pmiazga added a parent task: T162936: Improve developer happiness in reading web maintained extensions.Jul 13 2017, 3:09 PM

(this extension is maintained by editing)

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

Change 669124 had a related patch set uploaded (by Umherirrender; owner: Umherirrender):
[mediawiki/extensions/BetaFeatures@master] Get global $wgBetaFeatures from config object

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

gerritbot added a project: Patch-For-Review.Mar 6 2021, 6:35 PM

Jdforrester-WMF closed this task as Resolved.Mar 6 2021, 7:02 PM

Jdforrester-WMF assigned this task to Umherirrender.

Jdforrester-WMF updated the task description. (Show Details)

Change 669124 merged by jenkins-bot:
[mediawiki/extensions/BetaFeatures@master] Get global $wgBetaFeatures from config object

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

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.34; 2021-03-09).Mar 6 2021, 8:00 PM

Maintenance_bot removed a project: Patch-For-Review.Mar 6 2021, 8:10 PM