cjoudrey/graphql-schema-linter

Add --fix option

Open

#23 ouverte le 9 août 2017

Voir sur GitHub
 (24 commentaires) (2 réactions) (0 assignés)JavaScript (62 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (669 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Tout d'abord, examinez les implémentations de règles existantes pour comprendre comment les erreurs sont détectées et signalées. Regardez le point d'entrée CLI (probablement dans bin/ ou src/cli.js) pour voir comment les options sont analysées. Étudiez la suite de tests pour trouver des exemples de tests de règles. Ensuite, proposez une conception pour l'intégration du drapeau fix, peut être en ajoutant une méthode de correction facultative à chaque règle. Vérifiez si des PR ou commentaires existants discutent des détails d'implémentation.
Stack technique
javascriptnodejs
Domaine
clideveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GraphQL schema linter internalsunderstanding of lint rule structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35