Comments in between multi-line variable assignments should validate

Offen

#1 erstellt am 29.11.2019 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: php
Bereich: tooling

Rechercherichtung

Beginne damit, die gemeldeten PHPCS-Fehler für die mehrzeiligen Zuweisungen und das Array-Beispiel zu reproduzieren, und untersuche anschließend den Regelsatz oder die Regel, die Leerzeichen vor dem Gleichheitszeichen erzwingt. Das Issue nennt keine Dateien oder Tests; als erledigt gilt es, wenn Kommentare zwischen ausgerichteten Zuweisungen und Array-Einträgen validiert werden, während die bestehende Ausrichtung weiterhin erzwungen wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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,
];

Vorherrschende Sprache: Keine Sprachdaten
Sterne: 0
Forks: 2
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Comments in between multi-line variable assignments should validate

Stimmt etwas nicht?

Bewertung

Rechercherichtung

Beschreibung

Entwicklungsumgebung

Erste Schritte

Ähnliche Issues

Stimmt etwas nicht?

Stimmt etwas nicht?

Stimmt etwas nicht?

Stimmt etwas nicht?

Stimmt etwas nicht?

Neue Issues direkt in Ihr Postfach