Codesniffer should warn if output functions like print are used
Open, Needs TriagePublic
Actions

Assigned To

None

Authored By

	Tpt
	Mar 26 2021, 4:33 PM

Description

print is used by a lot people for debugging. It might be nice to have a phpcs rule to warn if print is used. Most of code should be forbidden to use it.

For example, this change has a print hidden in the changed code.

Event Timeline

Tpt created this task.Mar 26 2021, 4:33 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 26 2021, 4:33 PM

Tpt moved this task from Untriaged to Proposed rule changes on the MediaWiki-Codesniffer board.Mar 26 2021, 4:33 PM

Not sure if there are too many places where it needs to be print/printf

Could search for var_export without a second argument as well.

https://codesearch.wmcloud.org/search/?q=%5Cbprintf%3F%5Cb%5Cs*%5C(%3F&i=nope&files=%5C.php&excludeFiles=&repos=

While I agree that leftover debug code is dangerous, doing this right is not easy. I should also note that phan has a RemoveDebugStatementPlugin sniff which does exactly this.

Umherirrender unsubscribed.Mar 13 2023, 7:48 PM

Codesniffer should warn if output functions like print are usedOpen, Needs TriagePublicActions

Description

Event Timeline

Codesniffer should warn if output functions like print are used
Open, Needs TriagePublic
Actions