rubocop/rubocop

Add styleGuideUrl property to offense when using --display-style-guide and --format=json flags

Offen

#7.201 geöffnet am 09.07.2019

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Ruby (3.103 Forks)batch import
feature requestgood first issue

Repository-Metriken

Stars
 (12.857 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 8h) (158 gemergte PRs in 30 T)

Beschreibung

Is your feature request related to a problem? Please describe.

It is very hard to get the display guide URL from the message, you are forced to parse it (e.g: using regex) which seems very fragile.

Describe the solution you'd like

Add a property like styleGuideUrl (or whatever) when use --display-style-guide and --format=json, by this way it should very easy to get and use it (e.g: with editor integrations)

Contributor Guide

Research-Richtung
Untersuche, wie Verstöße in RuboCop derzeit in JSON serialisiert werden. Finde den Code, der die JSON Ausgabe generiert, wenn format=json verwendet wird. Identifiziere, wo die styleGuideUrl zu jedem Verstoß Objekt hinzugefügt werden kann. Ändere die Serialisierung, um die neue Eigenschaft einzuschließen, wenn display style guide aktiv ist.
Tech Stack
ruby
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Ruby
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70