Document sniffs that support configuration properties
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	DannyS712
	Feb 5 2021, 11:03 PM

Description

Pointed out at https://gerrit.wikimedia.org/r/c/mediawiki/tools/codesniffer/+/661937/ that there isn't a place these are currently documented. There should be

Details

	Subject	Repo	Branch	Lines +/-
	README: Add Configuration section to document adjustable sniffs	mediawiki/tools/codesniffer	master	+62 -0

Customize query in gerrit

Event Timeline

DannyS712 created this task.Feb 5 2021, 11:03 PM

Restricted Application added a project: User-DannyS712. · View Herald TranscriptFeb 5 2021, 11:03 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

DannyS712 moved this task from Unsorted to Next on the User-DannyS712 board.Feb 5 2021, 11:04 PM

DannyS712 moved this task from Backlog to New Technical Documentation Request on the Documentation board.

Jdforrester-WMF awarded a token.Feb 5 2021, 11:06 PM

Jdforrester-WMF subscribed.

Scanning through the existing sniffs manually shows the following configuration properties:

FullQualifiedClassNameSniff: allowMainNamespace, allowInheritance, allowFunctions
ClassLevelLicenseSniff: license
PrefixedGlobalFunctionsSniff: ignoreList
ValidGlobalNameSniff: allowedPrefixes, ignoreList
ExtendClassUsageSniff: nonConfigGlobals

At least in the sniffs I wrote you will find longer pieces of documentation in comments at the top of the class as well as on these properties. I agree we should copy-paste them e.g. into the libraries README.md. That's where I would start looking for documentation.

Change 682272 had a related patch set uploaded (by Umherirrender; author: Umherirrender):

[mediawiki/tools/codesniffer@master] Add Customization section to README

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

gerritbot added a project: Patch-For-Review.Apr 24 2021, 10:39 PM

Umherirrender claimed this task.Apr 24 2021, 10:49 PM

Umherirrender triaged this task as Medium priority.

Change 682272 merged by jenkins-bot:

[mediawiki/tools/codesniffer@master] README: Add Configuration section to document adjustable sniffs

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

Maintenance_bot removed a project: Patch-For-Review.Apr 29 2021, 2:11 AM

Umherirrender closed this task as Resolved.Apr 29 2021, 6:32 PM

Document sniffs that support configuration propertiesClosed, ResolvedPublicActions

Description

Details

Event Timeline

Document sniffs that support configuration properties
Closed, ResolvedPublic
Actions