Automattic / Automattic/VIP-Coding-Standards

Review use of external sniffs

Ouverte
#553 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
PHP
Étoiles
261
Forks
44
Merge moyen
19 min
PR mergées (30 j)
1

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la liste externe de sniffs de cette issue et sélectionnez un sniff parmi les ensembles de règles Generic, PSR2, Squiz, VariableAnalysis ou WordPress. Examinez sa pertinence actuelle, son comportement, ses alternatives ainsi que les problèmes signalés ou observables au regard des deux ensembles de règles VIPCS et des informations du projet upstream. Le travail est considéré comme terminé lorsque chaque sniff fait l’objet d’une revue documentée et que des issues distinctes et ciblées ont été ouvertes lorsque des travaux de suivi sont nécessaires.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
php
Domaine
tooling
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.