Automattic / Automattic/VIP-Coding-Standards
Audit Public Sniff Properties
- Lingua principale
- PHP
- Stelle
- 261
- Fork
- 44
- Merge medio
- 19m
- PR unite (30g)
- 1
Descrizione
## What problem would the enhancement address for VIP?
There are 47 instances of public properties within sniff classes. Public properties allow changing sniff behaviour by customising a ruleset by passing different types of values via the ruleset. VIP [uses](https://github.com/Automattic/VIP-Coding-Standards/blob/918b0ca0fe986ae58babd77c7ab5e0ff7a6f7eb5/.phpcs.xml.dist#L29) itself to adjust how a WPCS sniff runs.
However, I suspect that some of the instances are NOT meant to be changed - whitelisted Batcache params, restricted constant names and declarations, etc.
## Describe the solution you'd like
Audit the uses and convert to `private` where suitable. Document the rest on a [wiki page](https://github.com/Automattic/VIP-Coding-Standards/wiki/Custom-properties-for-VIPCS-Sniffs).
I'll create a linked list of the 47 instances, possibly along with who added them, to check if they are meant to be public or not.
For those that are meant to be changeable, then a better approach for some cases is to have a private default list of values, and then a public custom list, and the two lists merged together - that way, the custom rulesets don't need to also add in the default values as well.
## Additional context
Note that this would technically be a breaking change, since it is possible that someone was already making use of these unintentional public properties in their own rulesets. As such, this would require a bump from `0.y.z` to `0.y+1.0`, or a normal major release if `1.0.0` has been released in the meantime.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Esamina le 47 proprietà pubbliche nelle classi sniff, iniziando dall’override VIP in .phpcs.xml.dist e dall’elenco collegato delle istanze quando disponibile. Per ogni proprietà, determina se deve essere configurabile o privata e registra le indicazioni sulle proprietà configurabili nella pagina wiki Custom properties for VIPCS Sniffs. Il lavoro è completato quando le proprietà appropriate sono private, le proprietà rimanenti sono documentate e l’impatto della release con breaking change è stato affrontato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- php
- Ambito
- documentation, tooling
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100