cjoudrey/graphql-schema-linter

Add basic validation for inline configuration inputs

Open

#238 opened on Jul 4, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (669 stars) (62 forks)batch import
bugenhancementhelp wanted

Description

When specifying an invalid rule in an inline configuration, graphql-schema-linter should let the user know.

For example, this should raise an error:

# lint-disable some-invalid-rule

type Query {
  field: String
}

Perhaps the process could terminate with an error like:

The inline configuration on line 1 of `filename.graphql` references a non-existing rule: some-invalid-rule

Similarly, we should gracefully handle when an inline configuration is specified without any rules.

This currently crashes:

# lint-disable

type Query {
  field: String
}

We could either (1) make it raise an error like above or (2) support this as a feature and make it disable all rules.

/cc @mshwery in case you're bored 😄

Contributor guide

Tech stack
graphqljavascript
Domain
clitooling
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.
half day
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
familiarity with graphql schema linter codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the parsing logic for inline configuration comments in graphql schema linter, likely in src/. The issue proposes adding validation for invalid rule names and handling empty rule lists. Look at the existing rule registry to list valid rules. Consider both approaches: error on invalid rules or disabling all rules when none specified. The codebase is JavaScript, so you would modify the module that processes inline comments. No linked PRs or comments to reference.