cjoudrey/graphql-schema-linter

Add --fix option

Open

#23 opened on Aug 9, 2017

View on GitHub
 (24 comments) (2 reactions) (0 assignees)JavaScript (62 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (669 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Contributor guide

Research direction
First, examine the existing rule implementations to understand how errors are detected and reported. Look at the CLI entry point (likely in bin/ or src/cli.js) to see how options are parsed. Investigate the test suite for examples of rule testing. Then, propose a design for how the fix flag would integrate, perhaps by adding an optional fix method to each rule. Check if any existing PRs or comments discuss implementation details.
Tech stack
javascriptnodejs
Domain
clideveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GraphQL schema linter internalsunderstanding of lint rule structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35