cjoudrey/graphql-schema-linter

Add basic validation for inline configuration inputs

Open

#238 opened on 2020年7月4日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)JavaScript (669 stars) (62 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.