cjoudrey/graphql-schema-linter

Add basic validation for inline configuration inputs

Open

#238 创建于 2020年7月4日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (669 star) (62 fork)batch import
bugenhancementhelp wanted

描述

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 😄

贡献者指南

技术栈
graphqljavascript
领域
clitooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
familiarity with graphql schema linter codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
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.