cjoudrey/graphql-schema-linter

Add --fix option

Open

#23 geöffnet am 9. Aug. 2017

Auf GitHub ansehen
 (24 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (62 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (669 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

In some error cases, the linter can programmatically know what the schema should have been.

It would be awesome to provide a --fix option that would automatically resolve these errors.

Some example rules that could be fixed by the linter this way:

  • EnumValuesAllCaps
  • EnumValuesSortedAlphabetically
  • FieldsAreCamelCased
  • InputObjectValuesAreCamelCased
  • TypesAreCapitalized

Contributor Guide

Research-Richtung
Untersuche zunächst die bestehenden Regelimplementierungen, um zu verstehen, wie Fehler erkannt und gemeldet werden. Sieh dir den CLI Einstiegspunkt an (wahrscheinlich in bin/ oder src/cli.js), um zu sehen, wie Optionen geparst werden. Untersuche die Testsuite nach Beispielen für Regel Tests. Schlage dann einen Entwurf vor, wie das Flag fix integriert werden könnte, vielleicht durch Hinzufügen einer optionalen Korrekturmethode zu jeder Regel. Prüfe, ob bestehende PRs oder Kommentare Implementierungsdetails diskutieren.
Tech Stack
javascriptnodejs
Domain
clideveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GraphQL schema linter internalsunderstanding of lint rule structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35