Automattic / Automattic/VIP-Coding-Standards

Review use of external sniffs

Abierto
#553 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
PHP
Estrellas
261
Forks
44
Merge medio
19 min
PR fusionados (30 d)
1

Descripción

Both VIPCS rulesets currently use the following external sniffs:
```
Generic (5 sniffs)
------------------
Generic.NamingConventions.ConstructorName
Generic.PHP.DisallowShortOpenTag
Generic.PHP.NoSilencedErrors
Generic.PHP.Syntax
Generic.VersionControl.GitMergeConflict

PSR2 (1 sniff)
---------------
PSR2.Files.ClosingTag

Squiz (3 sniffs)
----------------
Squiz.PHP.CommentedOutCode
Squiz.PHP.Eval
Squiz.WhiteSpace.SuperfluousWhitespace

VariableAnalysis (1 sniff)
---------------------------
VariableAnalysis.CodeAnalysis.VariableAnalysis

WordPress (20 sniffs)
---------------------
WordPress.CodeAnalysis.AssignmentInCondition
WordPress.DB.DirectDatabaseQuery
WordPress.DB.PreparedSQL
WordPress.DB.SlowDBQuery
WordPress.DateTime.RestrictedFunctions
WordPress.PHP.DevelopmentFunctions
WordPress.PHP.DiscouragedPHPFunctions
WordPress.PHP.DontExtract
WordPress.PHP.IniSet
WordPress.PHP.StrictComparisons
WordPress.PHP.StrictInArray
WordPress.Security.EscapeOutput
WordPress.Security.NonceVerification
WordPress.Security.PluginMenuSlug
WordPress.Security.ValidatedSanitizedInput
WordPress.WP.AlternativeFunctions
WordPress.WP.CronInterval
WordPress.WP.EnqueuedResources
WordPress.WP.GlobalVariablesOverride
WordPress.WP.PostsPerPage
```

For each of these sniffs, a review should be done to verify the following:
* Is the sniff still relevant ?
* Does the sniff do what it should do ?
* Is this still the best sniff for the job or have other sniffs been published in the mean time which are better, i.e. should the current sniff inclusion be replaced with another sniff ?
* Are there known issues with the sniff, either reported here or upstream ? And if so, can we contribute to fixing these ?
* Are there unreported issues with the sniff based on a quick code review ? Things along the same lines as the VIPCS native sniffs are being reviewed for, like code style independence and correct handling of modern PHP code.

I'm opening this issue as a placeholder/reminder that this review needs to be done. When the time is right to address this, we may need to open individual issues for each sniff to allow for a more targeted discussion of each sniff.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con la lista externa de sniffs de este issue y selecciona un sniff de uno de los conjuntos de reglas Generic, PSR2, Squiz, VariableAnalysis o WordPress. Revisa su relevancia actual, comportamiento, alternativas y problemas reportados u observables en relación con los dos conjuntos de reglas de VIPCS y la información del proyecto upstream. Se considera terminado cuando cada sniff tiene una revisión documentada y se han abierto issues específicos y separados para el trabajo de seguimiento necesario.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
php
Área
tooling
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.