Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Comments in between multi-line variable assignments should validate

Ouverte
#1 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
php
Domaine
tooling

Piste de recherche

Commencez par reproduire les erreurs PHPCS signalées pour les affectations sur plusieurs lignes et l’exemple de tableau, puis examinez le ruleset ou la règle qui impose des espaces avant le signe égal. L’issue ne mentionne aucun fichier ni test ; le travail est considéré comme terminé lorsque les commentaires entre les affectations et les entrées de tableau alignées sont validés, tout en continuant à imposer l’alignement existant.

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

Description

Suppose you have:

// group 1

$foo        = 1;
$barbaz     = 'variable';
$boo        = null;
$anothervar = new \stdClass();

// group 2

// some comment about $foo
$foo        = 1;
// some comment about $barbaz
$barbaz     = 'variable';
$boo        = null;
// some comment about $anothervar
$anothervar = new \stdClass();

With the current PHPCS ruleset group 1 would pass but group 2 would not and generate errors.

In my opinion this should be legal for single line small comments to exist in a multi-line group.

I am not sure though that this would be supported by a PHPCS rule. Probably not? Maybe we could turn off spaces before equals sign or set to severity 0. The thing is this pattern often exists in our codebase (for example here). If we have a reason why we allow and like the alignment in group 1, we should allow here as well.

By the way this would also apply to values assignment in arrays:


$my_array = [
	'id'       => 0,
	// some comment about this key:
	'name'     => 'Foo',
    // some comment about this other key
	'location' => 123,
	'etc'      => null,
];
Langage dominant
Aucune donnée de langage
Étoiles
0
Forks
2
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

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